--- openapi: 3.1.0 info: title: API Documentation tags: - name: Activities description: |- Activities in Productive track changes made to various objects across the platform. Whenever an object is created, updated, or deleted, a new activity is logged. This activity records the type of change, the specific data that was modified, as well as the actor who made the change and the exact timestamp when it occurred. These activities are primarily used in Feeds for different objects, such as Tasks, Projects, People and other. _Note:_ Activities are created for most, but not all, objects in Productive. - name: Approval Policy description: Approval policies define who approves time entries, absences, or expenses. Configures the set of approvers and whether all approvers must approve (unanimous) or any single approver is sufficient. - name: Approval Policy Assignment description: |- **Approval policy assignments** link an approval policy to a person, determining who approves their time entries, expenses, or absence requests. Each person can have different policies for different approval types. Manage assignments to configure the approval chain for individuals across your organization. - name: Approval Workflow description: |- The ApprovalWorkflow entity serves as the core component of the [ApprovalPolicy](https://developer-staging.productive.io/approval_policies.html#approval-policies) object. It defines and manages information about approvers and subscribers, including the explicit and dynamic approvers and subscribers. Explicit approvers or subscribers can be assigned using the `approver_ids` or `subscriber_ids` arrays, which contain the IDs of the respective person objects designated as approvers or subscribers. Dynamic approvers and subscribers can be configured using the `dynamic_approvers_ids` or `dynamic_subscriber_ids` arrays, which include the ID of one of the following options: - Manager (id: 1) – The person's manager is automatically assigned as the approver or subscriber for the corresponding request. When creating an approval workflow, it is necessary to define the `approval_requirement_id`, which determines whether approval is required for the corresponding requests and, if so, it defines the level of the needed approval. The available values for `approval_requirement_id` are: - `approval_requirement_id: 1` - None -> No approval is required for the request to be considered approved. - `approval_requirement_id: 2` - Any of the listed approvers -> Approval from at least one approver is sufficient for the request to be considered approved. - `approval_requirement_id: 3` - All listed approvers -> Approval from all listed approvers is required for the request to be considered approved. Following diagram shows approval workflows in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors approval_policy: Approval Policy approval_workflows: Approval Workflows { class: primary } approval_policy_assignment: Approval Policy Assignment person: Person # define connections person -> approval_policy_assignment approval_policy -> approval_policy_assignment approval_policy -> approval_workflows ``` - name: Attachments description: |- The attachment object represents files such as images, PDFs and documents that can be assigned to other objects. These include, but are not limited, to tasks, comments, expenses and purchase orders. With attachments, users can provide relevant information, resources and additional context for related objects. You can find more about attachments in our Help documentation: [Working with attachments](https://help.productive.io/en/articles/2179672-working-with-attachments) For more details on how to work with attachment files through our API please refer to [Working with attachments](https://developer.productive.io/working_with_attachments.html#working_with_attachments) guide. - name: Automatic Invoicing Rules description: |- **Automatic invoicing rules** define conditions under which invoices are generated automatically from budget services — on time-based schedules, milestone completion, or budget consumption thresholds. Use these endpoints to configure recurring or event-driven billing without manual invoice creation. - name: BankAccounts description: |- **Bank accounts** store payment destination details for subsidiaries, displayed on invoices and financial documents. They contain IBAN, SWIFT/BIC, bank name, and account number fields. Manage which bank accounts are associated with each subsidiary to control what payment information appears on client-facing documents. - name: Bills description: Receipt records against a purchase order tracking vendor deliveries. Each bill captures the invoice number, date, due date, description, and amounts received. Bill items link PO expenses to received quantities. - name: Boards description: |- The Board object represents a board within the project management system. It sits between Projects and Task lists, meaning it belongs to a project and contains multiple task lists. In the application, `boards` are currently referred to as `folders`. You can find out more about boards in our Help documentation: [Boards](https://help.productive.io/en/articles/2179655-multiple-boards) Following diagram shows boards in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors project: Project board: Board { class: primary } task_list: Task list task: Task comments: Comments subtasks: Subtasks todos: Todos # define connections project -> board -> task_list -> task task -> comments task -> subtasks task -> todos ``` - name: Bookings description: |- The Booking object represents a scheduled time allocation for a person, serving as a core component for tracking time, managing availability, and organizing resource allocation. There are two main types of bookings: 1. Budget bookings - where a person is allocated to work on a specific deal/budget. These bookings are linked to a [service](https://developer.productive.io/services.html#services) object, which represents the actual work being done. 2. Absence bookings - which track time off and remote work absences. These bookings are linked to an [event](https://developer.productive.io/events.html#events) object, representing the type of absence (time off or remote work). Each booking method defines how time is allocated and requires specific attributes to be set: Per day (requires `hours` and `time` attributes to specify hours and time for each day), Percentage (requires `percentage` attribute to allocate a portion of a person's available time) and Total hours (requires `total_time` attribute to specify the total amount of hours for the selected period). Bookings can have different states depending on their type: - Budget bookings can be either Tentative (when there's a possibility of the time allocation but it's not yet confirmed, indicated by `draft: true`) or Confirmed - Absence bookings go through an approval workflow with the following states: Pending (waiting for approval), Approved, Rejected (with a reason), or Canceled (if cancelled after submitting for approval) Bookings can also be customized with custom fields to store additional information about booking. Custom fields allow you to add custom attributes or any other metadata relevant to your booking workflow. For more details on how to work with custom fields please refer to [Working with custom fields](https://developer.productive.io/working_with_custom_fields.html#working_with_custom_fields) guide. The following diagram shows bookings in our data hierarchy: ```d2 ...@template # template cant import globs just yet *: { class: default } # Define actors person: Person service: Service event: Event booking: Booking { class: primary } # Define connections person -> booking service -> booking event -> booking ``` - name: Comments description: Comments on tasks, deals, companies, persons, pages, projects, purchase orders, and invoices. Supports rich text with @mentions, emoji reactions, pinning, and edit history. Comments appear in the activity feed of the parent resource. - name: Companies description: |- Company resources are used to keep track of clients and manage their associated deals, budgets, contacts (people) and projects. More information about Companies can be found in our Help documentation: [Adding Client Companies](https://help.productive.io/en/articles/2179668-adding-client-companies). The `/companies` endpoint allows you to create, update, delete, archive or unarchive (restore) Companies. The following diagram shows Companies in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors company: Company { class: primary } deals: Deals projects: Projects people: People subsidiary: Subsidiary # define connections company -> deals company -> projects company -> people company <- subsidiary ``` Since companies can have custom fields, please refer to the [Working with custom fields](https://developer.productive.io/working_with_custom_fields.html#working_with_custom_fields) guide for more details on how to work with them. - name: Contact Entries description: Contact information records (email, phone, website, postal address) for companies and people. Multiple contact entries can be attached to a single company or person, each with a type (e.g. work, personal) and optional billing-specific fields. - name: Contracts description: |- For more details on contracts please refer to the [help article](https://help.productive.io/en/articles/2179582-recurring-budgets). The contract object represents recurring financial commitments such as recurring budgets. Recurring commitments are either created automatically or triggered manually. Please note that we rate limit POST requests for generating recurring budgets to 50 requests per minute. - name: Custom Field Options description: |- Custom field options define the choices available for custom fields with the select or multiple select data types. Following diagram shows custom field options in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors custom_field: Custom Field custom_field_options: Custom Field Options { class: primary } # define connections custom_field -> custom_field_options ``` - name: Custom Field Section description: |- CustomFieldSection is an entity that serves as a container for employee custom fields, enabling the grouping of those fields. Also in this way, employee custom fields cannot exist without belonging to a section. Each employee custom field belongs to a specific section and has section_id set, while one section contains several possible employee custom fields. For more details on how to work with custom fields please refer to [Working with custom fields](https://developer.productive.io/working_with_custom_fields.html#working_with_custom_fields) guide. Following diagram shows custom field sections in our data hierarchy: ```d2 ...@template # template cant import globs just yet *: { class: default } # Define actors custom_field_section: Custom Field Section { class: primary } custom_fields: Custom Fields # define connections custom_field_section -> custom_fields ``` - name: Custom Fields description: |- Custom fields allow you to use unique categorizations that are not available in Productive's default settings, allowing you to organize data based on your specific criteria and use it throughout the app. For more details on how to work with custom fields please refer to [Working with custom fields](https://developer.productive.io/working_with_custom_fields.html#working_with_custom_fields) guide. ### Aggregation type The `aggregation_type_id` attribute can have one of the following integer values: - 1 (sum) - 2 (avg) ### Customizable type The `customizable_type` attribute can have one of the following string values: - deals - projects - companies - budgets - invoices - tasks - projects - bookings - project_expenses - services - employees - contacts - pages - survey_responses ### Data type The `data_type_id` attribute can have one of the following integer values: - 1 (Text field) - 2 (Number field) - 3 (Select field) - 4 (Date field) - 5 (Multiple select field) - 6 (Person field) - 7 (Attachment field) ### Formatting type The `formatting_type_id` attribute can have one of the following integer values: - 1 (decimal) - 2 (percentage) - name: Custom domains description: |- **Custom domains** allow organizations to send transactional emails (invoices, proposals, notifications) from their own domain rather than a Productive-managed address. Configure and verify DNS records (`SPF`, `DKIM`, `MX`) for your domain through these endpoints. A verified custom domain improves email deliverability and reinforces brand identity. - name: Dashboards description: | The Dashboard object represents the main component of the dashboard system. It functions as a container for Widgets, enabling users to edit and arrange them as needed, allowing you to have all essential information in one place. You can find out more about dashboards in our Help documentation for [Dashboards](https://help.productive.io/en/articles/6423123-dashboards) - name: Deal Cost Rates description: |- For an overview of deal cost rates please refer to the [help article](https://help.productive.io/en/articles/8795140-custom-cost-rates-on-budgets-and-deals). Besides having default [cost rates](https://help.productive.io/en/articles/2179644-understanding-and-setting-up-cost-rates-in-productive) for the team, a custom cost rate for specific deal or budget can be set, which will override the default value. Only one per person, per deal can be created. Following depicts the Deal cost rate entity relationship diagram: ```d2 ...@template *: { class: default } # Define actors deal: Deal / Budget person: Person deal_cost_rate: DealCostRate { class: primary } deal -> deal_cost_rate <- person ``` - name: Deal Statuses description: Pipeline stages defining deal outcomes. Each status belongs to a pipeline and has an outcome category (open, won, lost, or delivered). Statuses can enable time tracking, expense tracking, booking tracking, and probability estimation. - name: Deals description: |- This endpoint contains both `budgets` and `deals`. When creating a new record, a budget or deal will be created based on the `budget` attribute in the request. If the request does not contain the `budget` attribute or has `budget: false` the new record will be a deal. If the request has `budget: true` the new record will be a budget. For more details on how to work with custom fields please refer to [Working with custom fields](https://developer.productive.io/working_with_custom_fields.html#working_with_custom_fields) guide. - name: Deleted Items description: |- The Deleted item object represents an deleted object (e.g., Task, Project, Doc) that can be found in the Recycle bin. Deleted items can be restored, meaning the object they reference will be restored and it will disappear from the Recycle bin. They can also be permanently deleted, meaning the object they reference will no longer be able to be retrieved from the Recycle bin. You can find out more about Recycle bin in our Help documentation for [Recycle bin](https://help.productive.io/en/articles/5609401-recycle-bin) - name: Discussions description: Discussion is a thread of comments related to the highlighted part of docs (page) content. - name: Document Styles description: |- **Document styles** control the visual presentation of generated PDFs — fonts, colors, logos, and layout settings. They are applied to document types to produce consistently branded, client-facing documents. Update a style to propagate branding changes across all documents that reference it. - name: Document Types description: |- **Document types** are PDF templates used to generate financial documents — invoices, proposals, and purchase orders. They define content blocks, layout, and branding applied when rendering documents. Assign document types to subsidiaries to set the default template for generated PDFs. - name: E-invoice Identities description: Manage e-invoicing routing identifiers for companies and subsidiaries. Each identity stores addresses like PEPPOL ID, Italian SDI code, or Spanish DIR3 codes needed to send or receive e-invoices. An identity belongs to **either** a company (the invoice recipient) **or** a subsidiary (the invoice sender), never both. - name: Emails description: |- **Emails** synced from external providers (Gmail, Outlook) and linked to deals, contacts, projects, or tasks. They surface client communication history directly within Productive for CRM context. List and retrieve email threads associated with records through these endpoints. - name: Entitlements description: Time-off balances for a person. Tracks allocated, used, and pending (approved but not taken) days for a specific absence category (event) and period. Updated automatically as bookings and approvals are processed. - name: Events description: |- Event resources represent Absence categories. More information about the Absence categories can be found in our Help documentation: [Configuring Your Time Off Settings](https://help.productive.io/en/articles/3154360-configuring-your-time-off-settings). The `/events` endpoint allows you to create, update, delete, archive or unarchive (restore) Events. The following diagram shows Events in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors event: Event { class: primary } bookings: Bookings entitlements: Entitlements approval_workflows: Approval Workflows # define connections event -> bookings event -> entitlements event -> approval_workflows ``` For limited Events, absence bookings can only be created if the assignee has sufficient available hours or days defined via [Entitlements](https://developer.productive.io/entitlements.html#entitlements). Approvers and subscribers for a Person’s absence booking on a specific Event can be managed through [ApprovalWorkflows](https://developer.productive.io/approval_workflows.html#approval-workflows). Also, we differentiate between time off (e.g. vacation, sick leave) and remote work (e.g. work from home) events. This is defined via the `absence_type` attribute. It is possible to change an event from the `remote_work` to the `time_off` absence type and vice versa, but please note that remote work events will always have the Unpaid event type. For more details on how to work with remote work events, please refer to the [Remote Work](https://help.productive.io/en/articles/11026966-remote-work-beta) help article. - name: Exchange Rates description: |- **Exchange rates** define currency conversion ratios applied across financial calculations in Productive — used when converting budget amounts, costs, and revenues between currencies in multi-currency organizations. Query exchange rates to understand the conversions applied to financial data for a given date. - name: Expenses description: |- For an overview of expenses please refer to the [help article](https://help.productive.io/en/articles/9154726-expenses-admin-overview) Expenses in productive are additional costs related to your budgets and deals. An expense always belongs to a service which in turn always belongs to a budget or deal. An expense can also belong to a Purchase Order (when it's on a budget service), but that is not mandatory. Following diagram shows expenses in our data hierarchy: ```d2 ...@template *: { class: default } # Define actors budget: Budget / Deal service: Service purchase_order: Purchase Order expense: Expense { class: primary } budget -> service -> expense budget -> purchase_order -> expense: { style: { stroke: black stroke-dash: 5 } } ``` Expenses support attachments and custom fields. - name: Expenses - Bulk description: |- **Bulk expense operations** allow creating or updating multiple expense records in a single request — useful for high-volume import workflows where individual API calls would be impractical. Bulk operations follow the same validation rules as single-record endpoints. - name: Filters description: Filters records are used to save the setup of your views, reports and widgets across Productive. - name: Folders description: |- The Folder object represents a folder within the project management system. It sits between Projects and Task lists, meaning it belongs to a project and contains multiple task lists. You can find out more about folders in our Help documentation: [Folders](https://help.productive.io/en/articles/2179655-multiple-boards) Following diagram shows folders in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors project: Project folder: Folder { class: primary } task_list: Task list task: Task comments: Comments subtasks: Subtasks todos: Todos # define connections project -> folder -> task_list -> task task -> comments task -> subtasks task -> todos ``` - name: Holiday calendars description: |- For more details on how to work with holiday calendars and holidays, please refer to [Holidays Settings](https://help.productive.io/en/articles/2179650-holidays-settings) article. Holiday calendar is an entity that represents an outer container for multiple holidays. Holidays within the calendar define the persons availability and capacity on a particular date. For more details on how to work with holidays, please refer to [Holidays](https://developer.productive.io/holidays.html#holidays) documentation. A holiday calendar is associated with person's cost rate (salary). Each cost rate has exactly one holiday calendar. You can find more about relationship between cost rates and holiday calendars in our help documentation: [Understanding and Setting Up Cost Rates in Productive](https://help.productive.io/en/articles/2179644-understanding-and-setting-up-cost-rates-in-productive). The following diagram shows holiday calendars in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors person: Person holiday_calendar: Holiday Calendar { class: primary } salaries: Salaries holidays: Holidays # define connections person -> salaries holiday_calendar -> salaries holiday_calendar -> holidays ``` - name: Holidays description: "For more details on how to work with holidays please refer to: [Holidays Settings](https://help.productive.io/en/articles/2179650-holidays-settings). \nThe Holiday entity represents a specific holiday that can be defined within the holiday calendar. One holiday calendar includes multiple holidays. \nThe primary function of the holiday entity is to define an employee's availability on a specific calendar date based on their defined cost rate ([Salary entity](https://developer-staging.productive.io/salaries.html#salaries)).\n\nYou can find out more about how holidays affect availability and capacity in our Help article: [Capacity vs. Availability: What You Need To Know](https://help.productive.io/en/articles/2651833-capacity-vs-availability-what-you-need-to-know)\n\nThe following diagram shows holidays in our data hierarchy:\n\n```d2\n...@template\n# template cant import globs just yet\n* {\n class: default\n}\n\n# Define actors\nperson: Person\nholiday_calendar: Holiday Calendar\nsalaries: Salaries\nholidays: Holidays {\n class: primary\n}\n\n# define connections\nperson -> salaries\nholiday_calendar -> salaries\nholiday_calendar -> holidays\n```" - name: Integration Exporter Configuration description: |- **Integration exporter configurations** define how data is exported from Productive to external accounting and ERP systems, storing connection credentials, entity mappings, and export preferences per integration type. Use these endpoints to set up and maintain accounting sync pipelines for QuickBooks, Xero, or NetSuite. - name: Integrations description: |- **Integrations** connect Productive to external systems — accounting software, SSO providers, and communication tools. Manage settings, credentials, and sync configuration for each connected service. Supported integrations include QuickBooks, Xero, NetSuite, Slack, and SAML-based single sign-on. - name: Invitations description: |- **Invitations** allow existing users to invite new members to join an organization in Productive. Manage pending invitations, resend emails, and revoke outstanding invites. Accepting an invitation creates a new user account and organization membership for the invitee. - name: Invoice Attributions description: |- An invoice attribution object represents a link between a budget and an invoice. Following diagram shows invoice attributions in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors budget: Budget invoice1: Invoice invoice2: Invoice invoice_attribution1: Invoice Attribution { class: primary } invoice_attribution2: Invoice Attribution { class: primary } # Define connections budget -> invoice_attribution1 invoice1 -> invoice_attribution1 budget -> invoice_attribution2 invoice2 -> invoice_attribution2 ``` ### Related resources - [Deals (Budget)](https://developer.productive.io/deals.html#deals) - [Invoice](https://developer.productive.io/invoice_attributions.html#invoices) - name: Invoice Templates description: |- **Invoice templates** (document types) define the layout, content, and branding for PDF-generated invoices and financial documents — controlling headers, footers, logos, and displayed fields. Assign templates to subsidiaries to produce consistently branded, client-facing billing documents. - name: Invoices description: |- For more details on how to work with custom fields please refer to [Working with custom fields](https://developer.productive.io/working_with_custom_fields.html#working_with_custom_fields) guide. The invoice object represents the main building block of the invoicing module. You can find out more about invoicing in our Help documentation: [Creating and Managing Invoices](https://help.productive.io/en/collections/8956111-creating-and-managing-invoices) Following diagram shows invoices in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors budget1: Budget budget2: Budget invoice_attribution1: "Invoice Attribution" invoice_attribution2: "Invoice Attribution" invoice_attribution3: "Invoice Attribution" invoice2: Invoice { class: primary } invoice3: Invoice { class: primary } line_item1: "Line Item" line_item2: "Line Item" line_item3: "Line Item" tax_rate1: "Tax Rate" tax_rate2: "Tax Rate" tax_rate3: "Tax Rate" # Define connections budget1 -> invoice_attribution1 <-> invoice2 -> line_item1 -> tax_rate1 budget2 -> invoice_attribution2 <-> invoice2 -> line_item2 -> tax_rate2 budget2 -> invoice_attribution3 <-> invoice3 -> line_item3 -> tax_rate3 ``` ### Tax changes On September 3, 2024, we've released new Tax rates system. That means that `tax1_name`, `tax1_value`, `tax2_name` and `tax2_value` attributes on Invoice object are no longer in use. You should, however, use `tax_rate_id` attribute on Line item objects to achieve the same goal. You can read more about this in [LineItems endpoint](https://developer.productive.io/line_items.html#header-setting-tax-data) documentation. ### Related resources - [Deals (Budget)](https://developer.productive.io/deals.html#deals) - [Invoice Attributions](https://developer.productive.io/invoice_attributions.html#invoice-attributions) - [Line Items](https://developer.productive.io/line_items.html#line-items) - name: Line Items description: |- A line item is a component of an invoice which represents an individual entry that details a specific good or service provided by the seller to the buyer. To find out more about managing invoices and line items, visit our Help documentation: [Creating and Managing Invoices](https://help.productive.io/en/collections/8956111-creating-and-managing-invoices). Following diagram shows line items in our data hierarchy: ```d2 ...@template # template cant import globs just yet *: { class: default } # Define actors invoice1: Invoice line_item1: Line Item { class: primary } line_item2: Line Item { class: primary } tax_rate1: Tax Rate tax_rate2: Tax Rate service: Service service_type: Service Type # Define connections invoice1 -> line_item1 -> tax_rate1 invoice1 -> line_item2 -> tax_rate2 line_item2 -> service line_item2 -> service_type ``` ### Setting tax data In an old workflow, adding tax data to a line item requires two values: `tax_name` and `tax_value`. For example, if you wanted to add a VAT 15%, you would send `tax_name: ‘VAT’` and `tax_value: 15`. In a new workflow (available for customers on our BETA program for now), you should send `tax_rate_id` instead, which points to a Tax rate object. So, in order to set VAT 15% to your line item, you would first need to have a tax rate object with those values and then send its ID to the desired line item. - name: Lost Reasons description: |- **Lost reasons** are labels that explain why a deal was marked as lost in the CRM pipeline. Create and manage the set of available options for your organization. Attaching a lost reason to a closed deal helps track pipeline health and surface patterns in lost opportunities. - name: Memberships description: |- Working with memberships: Membership objects are used for managing access to different resources in Productive. Currently it is used to manage access to projects, docs, dashboards, task views and deals. ### Resources accessible via memberships Depending on the resource you are giving access for, different attribute is required. Here is a list of resources that can be used with memberships and their required attributes: | Resource | Required attributes | |-----------|---------------------| | Project | `project_id` | | Doc | `page_id` | | Dashboard | `dashboard_id` | | Task view | `filter_id` | | Deal | `deal_id` | | Pulse | `pulse_id` | ### Membership types There are three types of membership: - `type_id: 1`, **person** -> gives access to a specific person - `type_id: 2`, **dynamic_group** -> gives access to a system predefined group of people - `type_id: 3`, **team** -> gives access to a team When working with memberships, depending on the type of membership, different attributes should be sent. For person membership, you need to provide `person_id`, for dynamic group membership, you need to provide `dynamic_group_id`, and for team membership, you need to provide `team_id`. ### Dynamic groups Dynamic groups are predefined groups of people that are created based on the person role and person assignment. There are five types of dynamic groups: - `dynamic_group_id: 2` - **employees** -> all employees in the organization - `dynamic_group_id: 6` - **project_members** -> all members of a resource's project - `dynamic_group_id: 8` - **project_manager** -> project manager of a resource's project - `dynamic_group_id: 9` - **deal_owner** -> owner of a deal - `dynamic_group_id: 10` - **users_that_can_manage_project** -> all users who are members of a resource's project and have the `Add, edit, and delete projects` permission When creating a membership for a dynamic group, you need to provide `dynamic_group_id`. Depending on the target resource you are giving access to, different dynamic groups are available, `dynamic_group_id` available for: - **Project** membership: 2 - **Doc** membership - if Doc is on a project: 2, 6, 8 - if Doc is not on a project: 2 - **Dashboard** membership - if Dashboard is on a project: 2, 6, 8, 10 - if Dashboard is not on a project: 2 - **Deal** membership: 2, 6, 8, 9 - **Task view** membership: 2 ### Access levels There are multiple access levels membership can have: - `access_type_id: 1` - full -> can edit and delete resource - `access_type_id: 2` - edit -> can edit resource - `access_type_id: 3` - view -> can only view resource - `access_type_id: 4` - comment -> can comment on resource - `access_type_id: 5` - member -> marks a subject as a member of a resource More about **member access**: Member access is used for resources where there is no need for different levels (projects, deals). Those resources use only one access type and that is member access. Having member access means you are a member of a resource. Depending on the target resource you are giving access to, different access levels are available: - **Project** memberships use level: 5 - **Doc** memberships use levels: 1, 2, 3, 4 - **Dashboard** memberships use levels: 1, 3 - **Deal** memberships use level: 5 - **Task view** memberships use level: 1, 3 - **Pulse** memberships use level: 1 ### Examples of creating membership **Example 1**: creating a membership for a person on a project `POST https://api.productive.io/api/v2/memberships` ``` { "data": { "attributes": { "type_id": 1, "person_id": 123, "access_type_id": 5, "project_id": 321 }, "type": "memberships" } } ``` Explanation of the example: - `type_id: 1` - membership is for a person - `person_id: 123` - person with id: 123 is getting access - `access_type_id: 5` - person is getting member access - `project_id: 321` - person is getting access to project with id: 321 **Example 2**: creating full access membership for an employees dynamic group on a dashboard `POST https://api.productive.io/api/v2/memberships` ``` { "data": { "attributes": { "type_id": 2, "dynamic_group_id": 2, "access_type_id": 1, "dashboard_id": 321 }, "type": "memberships" } } ``` Explanation of the example: - `type_id: 2` - membership is for a dynamic group - `dynamic_group_id: 2` - **employees** dynamic group is getting access - `access_type_id: 1` - employees are getting full access - `dashboard_id: 321` - employees are getting access to dashboard with id: 321 **Example 3**: creating view access membership for a team on a doc `POST https://api.productive.io/api/v2/memberships` ``` { "data": { "attributes": { "type_id": 3, "team_id": 123, "access_type_id": 3, "page_id": 321 }, "type": "memberships" } } ``` Explanation of the example: - `type_id: 3` - membership is for a team - `team_id: 123` - team with id: 123 is getting access - `access_type_id: 3` - team is getting view access - `page_id: 321` - team is getting access to doc with id: 321 - name: Notifications description: |- **Notifications** are inbox items generated by activity on tasks, deals, comments, and other resources — triggered by mentions, assignments, approval requests, and status changes. List a user's notifications and mark them as read through these endpoints. - name: Organization Memberships description: Organization memberships link users to organizations, granting login access. Stores per-user preferences including notification settings, default filters for each list view (tasks, deals, invoices, etc.), and UI layout preferences. - name: Organization Subscriptions description: |- **Organization subscriptions** represent the current pricing plan and active feature entitlements for an organization. Query subscription details to determine which modules and limits apply — such as maximum seats, advanced reporting, or resource planning. Subscriptions reflect the organization's billing tier and control access to premium features. - name: Organizations description: |- **Organizations** are the top-level accounts representing a company using Productive. Manage organization-wide settings, branding, localization, and configuration. Each organization contains subsidiaries, people, projects, and all associated financial and operational data. - name: Overheads description: |- For more details about what overheads are, please refer to the [help article](https://help.productive.io/en/articles/6839043-overhead-cost). The Overhead object represents overhead costs for a particular month of a fiscal year. Productive generates overhead objects automatically every month, starting the month when you opened your Productive account. Please note that some overhead settings are also defined at the organisation level. This settings can be changed by modifying the Organizations object. - name: PageVersions description: |- **Page versions** capture the revision history of a doc page — each significant edit creates a new version. List the version history of a page and retrieve previous content. Versions allow teams to review changes over time and restore earlier drafts. - name: Pages description: Rich text pages organized in a Doc hierarchy. Root pages (Docs) support public sharing and permission management. Child pages inherit from their parent Doc. Pages support custom fields, edit history, and inline discussions. - name: Passwords description: |- Manage **user password changes and resets**. These endpoints handle credential update flows for authenticated users and support administrative password reset operations. Password changes require the current password or a valid reset token. - name: Payment reminder sequences description: |- The Payment reminder sequence object represents payment reminder templates. You can find out more about them in our Help documentation: [Invoice Payment Reminders](https://help.productive.io/en/articles/7907557-invoice-payment-reminders). Following diagram shows Payment reminder sequences in our data hierarchy: ```d2 ...@template # template cant import globs just yet *: { class: default } # Define actors payment_reminder_sequence: Payment Reminder Sequence { class: primary } payment_reminder1: Payment Reminder payment_reminder2: Payment Reminder payment_reminder3: Payment Reminder # Define connections payment_reminder_sequence -> payment_reminder1 payment_reminder_sequence -> payment_reminder2 payment_reminder_sequence -> payment_reminder3 ``` - name: Payments description: |- The Payment object represents an invoice payment in invoicing system. You can find out more about payments in our Help documentation: [Recording Payments](https://help.productive.io/en/articles/2179635-recording-payments). Following diagram shows payments in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors invoice: Invoice payment1: Payment { class: primary } payment2: Payment { class: primary } invoice -> payment1 invoice -> payment2 ``` - name: People description: For more details on how to work with custom fields please refer to [Working with custom fields](https://developer.productive.io/working_with_custom_fields.html#working_with_custom_fields) guide. - name: Permission Sets description: | The Permission Set object represents a set of permissions that can be assigned to a user. You can find out more about permission sets in our Help documentation: [Permission Sets](https://help.productive.io/en/articles/8517221-permission-builder) - name: Pipelines description: |- For more details about pipelines and how to use them with deal statuses, please refer to the [help article](https://help.productive.io/en/articles/2179572-setting-up-your-sales-pipelines). Pipelines serve as a tool for grouping deal statuses (i.e. folders for better organisation of sales phases). Following depicts the Pipeline entity relationship diagram: ```d2 ...@template *: { class: default } # Define actors deal_status_1: Deal Status 1 deal_status_2: Deal Status 2 deal_status_3: Deal Status 3 deal_status_4: Deal Status 4 pipeline_1: Sales Pipeline { class: primary } pipeline_2: Another Pipeline { class: primary } pipeline_1 -> deal_status_1 pipeline_1 -> deal_status_2 pipeline_2 -> deal_status_3 pipeline_2 -> deal_status_4 ``` - name: Placeholder Usages description: |- **Placeholder usages** track how a placeholder's allocated capacity is distributed across projects and time periods. Query usages to understand utilization of unfilled resource slots and identify over- or under-allocated placeholders in your resource plan. - name: Placeholders description: |- **Placeholders** are unnamed resource slots used in capacity planning before a specific person is assigned. They represent a role, skill, or headcount requirement on a project — allowing teams to schedule capacity without committing to a named individual. Placeholders can be converted to real person assignments once staffing decisions are made. - name: Prices description: Rate card line items with billing configuration. Each price belongs to a rate card and defines a service type, billing type (hourly, fixed, etc.), unit, rate, and optional tracking defaults. Supports discounts, markups, budget caps, and custom fields. - name: Project Assignments description: |- **Project assignments** link people to projects, granting access and [Memberships](openapi:group:memberships). They determine which projects appear in a person's task lists and time tracking views. Manage assignments to control team composition and project visibility across your organization. - name: Projects description: |- For more details on how to work with custom fields please refer to [Working with custom fields](https://developer.productive.io/working_with_custom_fields.html#working_with_custom_fields) guide. > Note: For archived projects, only the `name` and `project_manager_id` attributes can be updated. All other attributes will be ignored during update operations. - name: Proposals description: |- **Proposals** are sales quotes attached to deals, presenting scope and pricing for client review and e-signature. A proposal mirrors the deal's sections and services in a client-facing layout with a pricing breakdown and acceptance workflow. Track proposal status, send for signing, and record approvals through these endpoints. - name: Pulses description: |- A Pulse is an automated report delivery service that makes it easy to stay updated without having to manually check your reports. You can set up Pulses for any of your reports, choosing how often you’d like to receive them — whether it's daily, weekly, bi-weekly, or monthly. This way, important data arrives straight to your inbox or Slack, keeping you informed at your preferred schedule. Email recipients are managed in two ways: - Memberships: link existing Productive users or teams to a pulse (done via the [memberships endpoint](https://developer.productive.io/memberships.html#memberships)). - `recipients` attribute: specify additional email addresses that are not linked to any user in the app. More about Pulses in our [help center](https://help.productive.io/en/articles/5178713-using-pulse-to-automate-your-reports) - name: Purchase Orders description: |- In Productive purchase orders are documents that serve as a buyer's request to a seller to order goods or services. You can find out more about purchase orders in our Help documentation: [Purchase Orders](https://help.productive.io/en/articles/8266926-purchase-orders) Purchase Orders always belong to a budget and a vendor (seller). They can have multiple expenses, bills and bill items. Following diagram shows services in our data hierarchy: ```d2 ...@template *: { class: default } # Define actors budget: Budget purchase_order: Purchase Order { class: primary } expense: Expense bill: Bill bill_item: Bill Item # define connections budget -> purchase_order -> expense -> bill_item purchase_order -> bill -> bill_item ``` The enumeration `status_id` can be: - 1 (Draft) - 2 (Finalized) The enumeration `payment_status_id` can be: - 1 (Not received) - 2 (Partially received) - 3 (Fully received) - name: Purchase Orders - Bulk description: Bulk update and delete operations on purchase orders. - name: Rate cards description: Price lists for services. Rate cards define company-wide or client-specific pricing templates. Each rate card contains prices for service types with billing configuration. Client-specific rate cards override defaults for that company. - name: Report Category description: 'Report categories help you organize and categorize your reports. You can assign each category a unique name and color code, making it easier to navigate through and manage your saved reports. This visual organization allows you to quickly find the reports you need and keep your workspace more streamlined. ' - name: Reports description: |- **Reports** provide aggregated, filtered views of time, financial, and project data across the organization — budget summaries, resource utilization, time entry totals, and financial KPIs. Use report endpoints to query data by date range and grouping. Reports power the analytics and business intelligence views in Productive. - name: Resource Requests description: Operations for managing resource requests — requests to allocate or hire resources for a project service. - name: Revenue Distributions description: |- **Revenue distributions** define how recognized revenue is allocated across time periods for a service, supporting accrual-based revenue recognition. Configure and query revenue schedules — specifying what portion of a service's value is recognized in each period — for accurate financial reporting. - name: Salaries description: |- For more details on salaries (also called cost rates) please refer to the [help article](https://help.productive.io/en/articles/2179644-understanding-and-setting-up-cost-rates-in-productive). The cost rate object represents invidual's cost rate defined for a certain period of time. A person can have multiple cost rates, however they cannot overlap in time. Cost rates can be defined for various period of times, such as hourly, monthly, etc. Note that different periods affect overheads differently (see the help article). For defining persons' cost rates specific to deals and budgets, please refer to [deal cost rates](https://developer.productive.io/deal_cost_rates.html#deal-cost-rates). Please note that we rate limit PATCH and POST api requests for editing salaries to 30 requests per two minutes. - name: Sections description: |- **Sections** group services within a deal or budget — typically organized by phase, deliverable type, or billing period. They provide structure for complex budgets and are reflected in proposals, invoices, and financial reporting. A deal or budget can have multiple sections, each containing one or more services. - name: Service Assignments description: |- To restrict time tracking & expense logging, there is an option to assign specific people to specific services. After enabling "Restricted by person" option on a budget, services with no one assigned will ignore this restriction, until you assign someone. For more details about how to achieve that, please refer to the [help article](https://help.productive.io/en/articles/6202423-restricting-time-tracking-and-expense-logging-in-productive#h_a5e53cc9b0). ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors person: Person service: Service service_assignment: ServiceAssignment { class: primary } # define connections service_assignment <- person service_assignment <- service ``` - name: Service Type Assignments description: |- Service type assignments are tightly coupled with service types. For more details about what service types are, please refer to the [help article](https://help.productive.io/en/articles/2179629-service-types-building-blocks-of-your-budget). Assignments are described under the [Assigning People to Service Types](https://help.productive.io/en/articles/2179629-service-types-building-blocks-of-your-budget?q=service+type+assignment#h_01af697e91). To set everything up, here is [additional help article](https://help.productive.io/en/articles/6202423-restricting-time-tracking-and-expense-logging-in-productive#h_48e1951cc5). Assignments are optional, but after assigning someone to specific service types and restricting time tracking by service type in the budget, you are ensuring that this person can only log their hours against assigned services categorized under assigned types. ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors person: Person service_type: ServiceType service_type_assignment: ServiceTypeAssignment { class: primary } # define connections service_type_assignment <- person service_type_assignment <- service_type ``` - name: Service Types description: |- For more details about what service types are, please refer to the [help article](https://help.productive.io/en/articles/2179629-service-types-building-blocks-of-your-budget). The service type object represents one category or type for a service your company offers. This categorization helps in organizing your workflows, time tracking and analyzing profitability. Following diagram shows service types in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors person: Person service_type: ServiceType { class: primary } service_type_assignment: ServiceTypeAssignment # define connections person -> service_type_assignment service_type -> service_type_assignment ``` - name: Services description: |- **Services** are line items on a deal or budget that define the scope, pricing, and tracking for a deliverable. Each service specifies a billing type (`fixed_fee`, `hourly`, or `days`), a budget amount, and links time tracking to invoicing. Services can have **per-person assignments** that restrict who can log time against them. - name: Sessions description: "**Sessions** represent authenticated login sessions for users accessing Productive." - name: Subsidiaries description: |- ### Subsidiary Tax ID The Tax ID displayed in **Settings → Company info → Edit Subsidiary** can be retrieved through the API via the related bill_from contact entry by calling: `GET /api/v2/subsidiaries/{id}?include=bill_from` The Tax ID is returned in the included section, inside the contact_entries object, where type is bill_from, under the `vat` attribute. - name: Survey Field Options description: Selectable options for dropdown and multi-select survey fields. Each option has a label and position for ordering in the dropdown. - name: Survey Fields description: Form fields on a survey. Each field has a data type (text, number, date, dropdown, checkbox, file) and optional configuration. Dropdown and multi-select fields have selectable options managed via survey_field_options. - name: Survey Responses description: Submitted survey responses. Each response links to a survey and contains field values for each survey field. Responses can trigger automations on submission. - name: Surveys description: Project forms for structured data collection. Surveys can trigger automations on submission, making them useful for intake forms, onboarding workflows, and status updates. Supports custom fields for form fields. - name: Tags description: |- **Tags** are labels applied to tasks and other resources for categorization and filtering. Create and manage the tag definitions available in your organization, then attach them to records to enable tag-based search and reporting. - name: Task Lists description: |- The Task list object represents a task list within the project management system. It sits between Boards and Tasks, meaning it belongs to a board and contains multiple tasks. You can find out more about task lists in our Help documentation: [Task lists](https://help.productive.io/en/articles/2179617-task-lists) Following diagram shows task lists in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors project: Project board: Board task_list: Task list { class: primary } task: Task comments: Comments subtasks: Subtasks todos: Todos # define connections project -> board -> task_list -> task task -> comments task -> subtasks task -> todos ``` - name: TaskDependency description: |- **Task dependencies** define ordering relationships between tasks: blocking, waiting on, or linked. Create and remove dependency links to enforce task sequencing. Dependencies are reflected in Gantt charts and can prevent downstream tasks from starting until blockers are resolved. - name: Tasks description: |- For more details on how to work with custom fields please refer to [Working with custom fields](https://developer.productive.io/working_with_custom_fields.html#working_with_custom_fields) guide. The Task object represents a task within the project management system. You can find out more about tasks in our Help documentation: [Tasks and task lists](https://help.productive.io/en/collections/38789-tasks-and-task-lists) Task can be one of two types: - milestone - task Following diagram shows tasks in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors project: Project board: Board task_list: Task list task: Task { class: primary } comments: Comments subtasks: Subtasks todos: Todos # define connections project -> board -> task_list -> task task -> comments task -> subtasks task -> todos ``` For Task dependencies please refer to [TaskDependency endpoint](https://developer.productive.io/taskdependency.html#taskdependency) documentation - name: TaxRates description: |- The Tax rate object represents tax data in the invoicing system. You can find out more about tax rates in our Help documentation: [Setting up and Managing Tax Rates in Invoicing](https://help.productive.io/en/articles/9374894-setting-up-and-managing-tax-rates-in-invoicing). Following diagram shows tax rates in our data hierarchy: ```d2 ...@template # template cant import globs just yet * { class: default } # Define actors subsidiary1: Subsidiary line_item1: Line Item line_item2: Line Item line_item3: Line Item tax_rate1: Tax Rate { class: primary } tax_rate2: Tax Rate { class: primary } # Define connections subsidiary1 -> tax_rate1 -> line_item1 subsidiary1 -> tax_rate2 -> line_item2 tax_rate2 -> line_item3 ``` - name: Team Memberships description: Person-team links. Each membership adds a person to a team. Teams are used for access control on projects and other resources, and for reporting groupings. - name: Teams description: Named groups of people used for reporting and access control. Teams can be granted access to projects and other resources via memberships. Each team has a list of member people. - name: Time Entries description: |- Time entry object represents spent time for a person. Time can be spent tracking on a service or on a time off event. When tracked on a service, time entry can also belong to a task. When time entry belongs to a task, time tracked on time entry represents task worked time and will decrease time to complete on the task. Time entry can represent: - Worked hours (without start and end time) - Worked time period (with start and end time) - in a form of a timer. More on timers [here](https://developer.productive.io/timers.html#timers). Following diagram shows time entries in our data hierarchy: ```d2 ...@template # template cant import globs just yet *: { class: default } # Define actors service: Service task: Task time_entry: Time Entry { class: primary } timer: Timer # define connections service -> time_entry task -> time_entry: { style: { stroke-dash: 3 multiple: true } } time_entry -> timer ``` You can find out more about Time entries in our Help documentation for [My Time](https://help.productive.io/en/articles/2179597-my-time) - name: Time Entries - Bulk description: "The Time Entries Bulk endpoint enables efficient management of multiple time entries simultaneously. \nThis API provides bulk operations for creating, updating, deleting, and managing approval state for time entries." - name: Time Entry Versions description: "Time entry versions store the history of changes on a time entry.\n\nTime entry versions are automatically created on every time entry create, update or delete event.\n\nTime entry version tracks the event that triggered its creation. This event can be: \n- create\n- update\n- delete\n- restore\n- approve\n- unapprove\n- reject\n- unreject\n\n```d2\n...@template\n# template cant import globs just yet\n*: {\n class: default\n}\n\n# Define actors\ntime_entry: Time Entry\ntime_entry_version: Time entry version {\n class: primary\n style: {\n multiple: true\n }\n}\n\n# define connections\ntime_entry -> time_entry_version\n```" - name: Time Tracking Policies description: |- **Time tracking policies** define rules governing how and when time entries can be logged — restricting tracking to specific services, enforcing duration limits, or requiring prior approval. Policies are assigned to people or projects to ensure time tracking compliance across teams. - name: Timers description: "Timer is an object belonging to a Time Entry.\n\nTimer represents one time tracking sessions (on a time entry) and keeps track when a session was started and when it was stopped.\n\nTimer object gets created when a person starts a timer.\n\nCreating a Timer is possible (on API) providing either time_entry_id or service_id in parameters. \n- When providing time_entry_id, a Timer object will be related to provided Time Entry. \n- When providing service_id, new Time Entry belonging to provided Service will be created and a Timer will belong to it.\n\n```d2\n...@template\n# template cant import globs just yet\n*: {\n class: default\n}\n\n# Define actors\nservice: Service\ntask: Task\ntime_entry: Time Entry\ntimer: Timer {\n class: primary\n}\n\n# define connections\nservice -> time_entry\ntask -> time_entry: {\n style: {\n stroke-dash: 3\n multiple: true\n }\n}\ntime_entry -> timer\n```\n\nYou can find out more about Timers in our [Help documentation] (https://help.productive.io/en/articles/3903111-timer)" - name: Timesheets description: |- **Timesheets** aggregate a person's time entries by day and are the unit of submission in the time approval workflow. Manage daily timesheet submissions, track approval status, and retrieve timesheet data by person or date range. Timesheets move through `draft` → `submitted` → `approved` / `rejected` states. - name: Todos description: "A to-do is a component of a task that requires completion and can be assigned to an individual. \n\nOnce to-do is assigned, task appears in the assignee's list of assigned tasks. \n\nThere's no cap on the number of to-dos a single task can include. \n\nTo-dos can be either open or closed.\n\n```d2\n...@template\n# template cant import globs just yet\n* {\n class: default\n}\n\n# Define actors\nproject: Project\nboard: Board\ntask_list: Task list\ntask: Task\ncomments: Comments\nsubtasks: Subtasks\ntodos: Todos {\n class: primary\n}\n\n# define connections\nproject -> board -> task_list -> task\ntask -> comments\ntask -> subtasks\ntask -> todos\n```\n\nYou can find out more about To-dos in our [Help documentation] (https://help.productive.io/en/articles/4097412-task-to-do)" - name: Users description: |- **User accounts** for people who log into Productive. Manage credentials, preferences, and authentication settings. Each user is linked to one or more **organization memberships** that control their access level and permissions across the platform. - name: Webhook Logs description: The Webhook Log object represents a record of an unsuccessful webhook delivery attempt. When a webhook fails to deliver, a log is created with details about the failure. - name: Webhooks description: |- For more details on webhooks please refer to the [help article](https://help.productive.io/en/articles/3693279-using-webhooks-in-productive). The Webhook object enables real-time notifications for events occurring in Productive. - name: Widgets description: |- The Widget object represents the fundamental dynamic component of the Dashboard system. These customizable blocks provide various filtering options, allowing you to effortlessly organize all essential information in one place. You can find out more about widgets in our Help documentation for Dashboards under section: [Widgets](https://help.productive.io/en/articles/6423123-dashboards#h_231c96112f) - name: Workflow Statuses description: |- The Workflow Status object represents the current state of a task, enabling users to define and monitor task stages. Every Workflow can have multiple Workflow statuses. There are three Workflow status categories: - not_started - started - closed - name: Workflows description: |- The Workflow object enables organizing tasks into distinct phases or stages, each with its own set of statuses. This allows tracking the progress of tasks from initiation to completion. You can learn more about Workflows in our Help documentation: [Workflows](https://help.productive.io/en/articles/5813154-workflows) paths: "/api/v2/survey_fields/{id}": get: tags: - Survey Fields summary: Gets a survey field responses: '200': "$ref": "#/components/responses/single_survey_field" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the survey field to retrieve. operationId: survey_fields-show description: Retrieve a single survey field by ID. patch: tags: - Survey Fields summary: Updates a survey field responses: '200': "$ref": "#/components/responses/single_survey_field" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the survey field to update. operationId: survey_fields-update requestBody: "$ref": "#/components/requestBodies/survey_field" description: Update a survey field. "/api/v2/prices/{id}": delete: tags: - Prices summary: Deletes a price responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: prices-destroy description: Delete a price by ID. patch: tags: - Prices summary: Update a price responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_price" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: prices-update requestBody: "$ref": "#/components/requestBodies/price" description: Update a price. get: tags: - Prices summary: Gets a price responses: '200': "$ref": "#/components/responses/single_price" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: prices-show description: Retrieve a single price by ID. "/api/v2/deals/{id}": get: tags: - Deals summary: Gets a deal responses: '200': "$ref": "#/components/responses/single_deal" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: deals-show description: Retrieve a single deal by ID. delete: tags: - Deals summary: Deletes a deal responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: deals-destroy description: Delete a deal. patch: tags: - Deals summary: Update a deal responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_deal" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: deals-update requestBody: "$ref": "#/components/requestBodies/deal" description: Update a deal's attributes or relationships. "/api/v2/time_entries": delete: tags: - Time Entries - Bulk summary: Deletes time entries responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" operationId: time_entries-destroy-bulk description: Delete multiple time entries. post: tags: - Time Entries - Bulk summary: Create time entries responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_time_entry" parameters: - "$ref": "#/components/parameters/header_organization" operationId: time_entries-create-bulk requestBody: "$ref": "#/components/requestBodies/time_entry" description: Create a new time entry. patch: tags: - Time Entries - Bulk summary: Update time entries responses: '200': "$ref": "#/components/responses/single_time_entry" parameters: - "$ref": "#/components/parameters/header_organization" operationId: time_entries-update-bulk requestBody: "$ref": "#/components/requestBodies/time_entry" description: Update multiple time entries. get: tags: - Time Entries summary: Get time entries responses: '400': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Bad Request '200': "$ref": "#/components/responses/collection_time_entry" parameters: - "$ref": "#/components/parameters/sort_time_entry" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_time_entry" operationId: time_entries-index description: List time entries with optional filters and pagination. "/api/v2/filters/{id}": get: tags: - Filters summary: Gets a filter responses: '200': "$ref": "#/components/responses/single_filter" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: filters-show description: Retrieve a single filter. patch: tags: - Filters summary: Update a filter responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_filter" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: filters-update requestBody: "$ref": "#/components/requestBodies/filter" description: Update a filter. delete: tags: - Filters summary: Deletes a filter responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: filters-destroy description: Delete a filter. "/api/v2/surveys": get: tags: - Surveys summary: Get surveys responses: '200': "$ref": "#/components/responses/collection_survey" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_survey" - "$ref": "#/components/parameters/filter_survey" operationId: surveys-index description: List all surveys. post: tags: - Surveys summary: Create a survey responses: '201': "$ref": "#/components/responses/single_survey" parameters: - "$ref": "#/components/parameters/header_organization" operationId: surveys-create requestBody: "$ref": "#/components/requestBodies/survey" description: Create a new survey. "/api/v2/dashboards": get: tags: - Dashboards summary: Get all dashboards responses: '200': "$ref": "#/components/responses/collection_dashboard" parameters: - "$ref": "#/components/parameters/filter_dashboard" - "$ref": "#/components/parameters/sort_dashboard" - "$ref": "#/components/parameters/header_organization" operationId: dashboards-index description: List dashboards with optional filters and pagination. post: tags: - Dashboards summary: Create a dashboard responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_dashboard" parameters: - "$ref": "#/components/parameters/header_organization" operationId: dashboards-create requestBody: "$ref": "#/components/requestBodies/dashboard" description: Create a new dashboard. "/api/v2/projects/{id}": get: tags: - Projects summary: Gets a project responses: '200': "$ref": "#/components/responses/single_project" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: projects-show description: Get a project. Returns a single project by ID. patch: tags: - Projects summary: Update a project responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_project" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: projects-update requestBody: "$ref": "#/components/requestBodies/project" description: Update a project. Updates attributes of an existing project. delete: tags: - Projects summary: Deletes a project responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: projects-destroy description: Delete a project. Permanently deletes a project and all its associated data. "/api/v2/pipelines": get: tags: - Pipelines summary: Get pipelines responses: '200': "$ref": "#/components/responses/collection_pipeline" parameters: - "$ref": "#/components/parameters/sort_pipeline" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_pipeline" operationId: pipelines-index description: List all pipelines. post: tags: - Pipelines summary: Create a pipeline responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '201': "$ref": "#/components/responses/single_pipeline" parameters: - "$ref": "#/components/parameters/header_organization" operationId: pipelines-create requestBody: "$ref": "#/components/requestBodies/pipeline" description: Create a new pipeline. "/api/v2/todos/{id}": get: tags: - Todos summary: Gets a todo responses: '200': "$ref": "#/components/responses/single_todo" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: todos-show description: Retrieve a single todo by ID. delete: tags: - Todos summary: Deletes a todo responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: todos-destroy description: Delete a todo by ID. patch: tags: - Todos summary: Update a todo responses: '200': "$ref": "#/components/responses/single_todo" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: todos-update requestBody: "$ref": "#/components/requestBodies/todo" description: Update a todo. "/api/v2/revenue_distributions": get: tags: - Revenue Distributions summary: Get revenue distributions responses: '200': "$ref": "#/components/responses/collection_revenue_distribution" parameters: - "$ref": "#/components/parameters/sort_revenue_distribution" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_revenue_distribution" operationId: revenue_distributions-index description: List all revenue distributions. post: tags: - Revenue Distributions summary: Create a revenue distribution responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_revenue_distribution" parameters: - "$ref": "#/components/parameters/header_organization" operationId: revenue_distributions-create description: Create a new revenue distribution. "/api/v2/timesheets/{id}": get: tags: - Timesheets summary: Gets a timesheet responses: '200': "$ref": "#/components/responses/single_timesheet" parameters: - in: path name: id schema: type: string required: true description: The ID of the timesheet to retrieve. - "$ref": "#/components/parameters/header_organization" operationId: timesheets-show description: Retrieve a single timesheet by ID. delete: tags: - Timesheets summary: Deletes a timesheet responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: The ID of the timesheet to delete. - "$ref": "#/components/parameters/header_organization" operationId: timesheets-destroy description: Delete a timesheet by ID. "/api/v2/memberships/{id}": get: tags: - Memberships summary: Gets a membership responses: '200': "$ref": "#/components/responses/single_membership" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: memberships-show description: Retrieve a single membership. patch: tags: - Memberships summary: Update a membership responses: '200': "$ref": "#/components/responses/single_membership" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: memberships-update requestBody: "$ref": "#/components/requestBodies/membership" description: Update a membership. delete: tags: - Memberships summary: Deletes a membership responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: memberships-destroy description: Delete a membership. "/api/v2/rate_cards/{id}": delete: tags: - Rate cards summary: Deletes a price responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: rate_cards-destroy description: Delete a rate card by ID. patch: tags: - Rate cards summary: Update a price responses: '200': "$ref": "#/components/responses/single_rate_card" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: rate_cards-update requestBody: "$ref": "#/components/requestBodies/rate_card" description: Update a rate card. get: tags: - Rate cards summary: Gets a rate card responses: '200': "$ref": "#/components/responses/single_rate_card" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: rate_cards-show description: Retrieve a single rate card by ID. "/api/v2/custom_fields": get: tags: - Custom Fields summary: Get custom fields responses: '200': "$ref": "#/components/responses/collection_custom_field" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_custom_field" - "$ref": "#/components/parameters/filter_custom_field" operationId: custom_fields-index description: List custom fields with optional filters and pagination. post: tags: - Custom Fields summary: Creates a custom field responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_custom_field" parameters: - "$ref": "#/components/parameters/header_organization" operationId: custom_fields-create requestBody: "$ref": "#/components/requestBodies/custom_field" description: Create a new custom field. "/api/v2/integrations/{id}": get: tags: - Integrations summary: Gets an integration responses: '200': "$ref": "#/components/responses/single_integration" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: integrations-show description: Retrieve a single integration. delete: tags: - Integrations summary: Deletes an integration responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: integrations-destroy description: Delete an integration. "/api/v2/custom_field_options": post: tags: - Custom Field Options summary: Creates a custom field option responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_custom_field_option" parameters: - "$ref": "#/components/parameters/header_organization" operationId: custom_field_options-create requestBody: "$ref": "#/components/requestBodies/custom_field_option" description: Create a new custom field option. get: tags: - Custom Field Options summary: Get custom field options responses: '200': "$ref": "#/components/responses/collection_custom_field_option" parameters: - "$ref": "#/components/parameters/filter_custom_field_option" - "$ref": "#/components/parameters/sort_custom_field_option" - "$ref": "#/components/parameters/header_organization" operationId: custom_field_options-index description: List custom field options with optional filters and pagination. "/api/v2/invoice_templates/{id}": get: tags: - Invoice Templates summary: Gets an invoice template responses: '200': "$ref": "#/components/responses/single_invoice_template" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the invoice template to retrieve. operationId: invoice_templates-show description: Retrieve a single invoice template. delete: tags: - Invoice Templates summary: Deletes an invoice template responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: The ID of the invoice template to delete. - "$ref": "#/components/parameters/header_organization" operationId: invoice_templates-destroy description: Delete an invoice template. patch: tags: - Invoice Templates summary: Update an invoice template responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_invoice_template" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the invoice template to update. operationId: invoice_templates-update requestBody: "$ref": "#/components/requestBodies/invoice_template" description: Update an invoice template. "/api/v2/bookings/{id}/unapprove": patch: tags: - Bookings summary: Unapproves a booking responses: '200': "$ref": "#/components/responses/single_booking" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: bookings-unapprove-unapprove description: Unapprove a booking. "/api/v2/approval_policies": post: tags: - Approval Policy summary: Creates the approval policy responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_approval_policy" parameters: - "$ref": "#/components/parameters/header_organization" operationId: approval_policies-create requestBody: "$ref": "#/components/requestBodies/approval_policy" description: Create a new approval policy. get: tags: - Approval Policy summary: Get approval policies responses: '200': "$ref": "#/components/responses/collection_approval_policy" parameters: - "$ref": "#/components/parameters/sort_approval_policy" - "$ref": "#/components/parameters/filter_approval_policy" - "$ref": "#/components/parameters/header_organization" operationId: approval_policies-index description: List approval policies with optional filters and pagination. "/api/v2/tasks/{id}": get: tags: - Tasks summary: Gets a task responses: '200': "$ref": "#/components/responses/single_task" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: tasks-show description: Returns a single task by ID. patch: tags: - Tasks summary: Update a task responses: '200': "$ref": "#/components/responses/single_task" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: tasks-update requestBody: "$ref": "#/components/requestBodies/task" description: Updates an existing task by ID. Only the provided attributes are modified. delete: tags: - Tasks summary: Deletes a task responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: tasks-destroy description: Permanently deletes a task by ID. "/api/v2/people/merge": patch: tags: - People summary: Merge a person responses: '200': "$ref": "#/components/responses/single_person" parameters: - "$ref": "#/components/parameters/header_organization" operationId: people-merge-merge description: Merge two person records into one, transferring all associated data to the target person. "/api/v2/expenses/copy": post: tags: - Expenses summary: Copy an expense responses: '200': "$ref": "#/components/responses/single_expense" '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created parameters: - "$ref": "#/components/parameters/header_organization" operationId: expenses-copy-copy description: Copy an expense to create a duplicate. "/api/v2/expenses/{id}/approve": patch: tags: - Expenses summary: Approves an expense responses: '200': "$ref": "#/components/responses/single_expense" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: expenses-approve-approve description: Approve an expense by ID. "/api/v2/expenses/{id}/export": patch: tags: - Expenses summary: Exports an expense responses: '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict '200': "$ref": "#/components/responses/single_expense" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: expenses-export-export description: Export an expense to an external accounting system. "/api/v2/document_types": get: tags: - Document Types summary: Get document_types responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '200': "$ref": "#/components/responses/collection_document_type" parameters: - "$ref": "#/components/parameters/filter_document_type" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_document_type" operationId: document_types-index description: List document types. post: tags: - Document Types summary: Create a document_type responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_document_type" parameters: - "$ref": "#/components/parameters/header_organization" operationId: document_types-create requestBody: "$ref": "#/components/requestBodies/document_type" description: Create a new document type. "/api/v2/lost_reasons": post: tags: - Lost Reasons summary: Create a lost reason responses: '201': "$ref": "#/components/responses/single_lost_reason" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: lost_reasons-create requestBody: "$ref": "#/components/requestBodies/lost_reason" description: Create a new lost reason. get: tags: - Lost Reasons summary: Get lost reasons responses: '200': "$ref": "#/components/responses/collection_lost_reason" parameters: - "$ref": "#/components/parameters/sort_lost_reason" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_lost_reason" operationId: lost_reasons-index description: List lost reasons. "/api/v2/resource_requests/{id}/resolve": post: tags: - Resource Requests summary: Resolve a resource request by creating bookings responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: The resource request could not be resolved due to validation errors. '200': "$ref": "#/components/responses/single_resource_request" parameters: - in: path name: id schema: type: string required: true description: The ID of the resource request to resolve. - "$ref": "#/components/parameters/header_organization" operationId: resource_requests-resolve-resolve description: Resolves a resource request by ID, setting its status to resolved. "/api/v2/boards": post: tags: - Boards summary: Create a board responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_board" parameters: - "$ref": "#/components/parameters/header_organization" operationId: boards-create requestBody: "$ref": "#/components/requestBodies/board" description: Create a new board. get: tags: - Boards summary: Get boards responses: '200': "$ref": "#/components/responses/collection_board" parameters: - "$ref": "#/components/parameters/sort_board" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_board" operationId: boards-index description: List boards with optional filters and pagination. "/api/v2/roles/{id}": patch: tags: - Permission Sets summary: Update a permission set responses: '200': "$ref": "#/components/responses/single_role" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true operationId: roles-update requestBody: "$ref": "#/components/requestBodies/role" get: tags: - Permission Sets summary: Get a permission set responses: '200': "$ref": "#/components/responses/single_role" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: roles-show description: Retrieve a single role by ID. delete: tags: - Permission Sets summary: Delete a permission set responses: '204': content: any: {} headers: {} description: No Content parameters: - in: path name: id schema: type: string required: true - "$ref": "#/components/parameters/header_organization" operationId: roles-destroy "/api/v2/einvoice_identities": post: tags: - E-invoice Identities summary: Creates an e-invoice identity responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Validation error — the request body contains invalid or missing fields. '201': "$ref": "#/components/responses/single_einvoice_identity" parameters: - "$ref": "#/components/parameters/header_organization" operationId: einvoice_identities-create requestBody: "$ref": "#/components/requestBodies/einvoice_identity" description: Creates a new e-invoice identity for a company or subsidiary. get: tags: - E-invoice Identities summary: Gets a list of e-invoice identities responses: '200': "$ref": "#/components/responses/collection_einvoice_identity" parameters: - "$ref": "#/components/parameters/filter_einvoice_identity" - "$ref": "#/components/parameters/header_organization" operationId: einvoice_identities-index description: Lists e-invoice identities. Supports filtering by company or subsidiary. "/api/v2/comments": get: tags: - Comments summary: Get comments responses: '200': "$ref": "#/components/responses/collection_comment" parameters: - "$ref": "#/components/parameters/sort_comment" - "$ref": "#/components/parameters/filter_comment" - "$ref": "#/components/parameters/header_organization" operationId: comments-index description: List comments with optional filters and pagination. post: tags: - Comments summary: Create a comment responses: '201': "$ref": "#/components/responses/single_comment" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: comments-create requestBody: "$ref": "#/components/requestBodies/comment" description: Create a new comment. "/api/v2/comments/{id}": patch: tags: - Comments summary: Update a comment responses: '200': "$ref": "#/components/responses/single_comment" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: comments-update requestBody: "$ref": "#/components/requestBodies/comment" description: Update a comment. delete: tags: - Comments summary: Deletes a comment responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: comments-destroy description: Delete a comment. get: tags: - Comments summary: Gets a comment responses: '200': "$ref": "#/components/responses/single_comment" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: comments-show description: Retrieve a single comment by ID. "/api/v2/pages/{id}": get: tags: - Pages summary: Gets a page responses: '200': "$ref": "#/components/responses/single_page" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the page to retrieve. operationId: pages-show description: Retrieve a single page. delete: tags: - Pages summary: Deletes a page responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the page to delete. operationId: pages-destroy description: Delete a page. patch: tags: - Pages summary: Update a page responses: '200': "$ref": "#/components/responses/single_page" parameters: - in: path name: id schema: type: string required: true description: The ID of the page to update. - "$ref": "#/components/parameters/header_organization" operationId: pages-update requestBody: "$ref": "#/components/requestBodies/page" description: Update a page. "/api/v2/tasks/copy": post: tags: - Tasks summary: Copies a task responses: '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_task" parameters: - "$ref": "#/components/parameters/header_organization" operationId: tasks-copy-copy description: Copies an existing task, duplicating its attributes and optionally its subtasks and attachments. "/api/v2/discussions/{id}": patch: tags: - Discussions summary: Update an discussion responses: '200': "$ref": "#/components/responses/single_discussion" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: discussions-update requestBody: "$ref": "#/components/requestBodies/discussion" description: Update a discussion. get: tags: - Discussions summary: Gets a discussion responses: '200': "$ref": "#/components/responses/single_discussion" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: discussions-show description: Retrieve a single discussion. delete: tags: - Discussions summary: Deletes a discussion responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: discussions-destroy description: Delete a discussion. "/api/v2/proposals/{id}": patch: tags: - Proposals summary: Update a proposal responses: '200': "$ref": "#/components/responses/single_proposal" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the proposal to update. operationId: proposals-update description: Update a proposal. get: tags: - Proposals summary: Gets a proposal responses: '200': "$ref": "#/components/responses/single_proposal" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the proposal to retrieve. operationId: proposals-show description: Retrieve a single proposal by ID. delete: tags: - Proposals summary: Deletes a proposal responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: The ID of the proposal to delete. - "$ref": "#/components/parameters/header_organization" operationId: proposals-destroy description: Delete a proposal by ID. "/api/v2/invoices/{id}": get: tags: - Invoices summary: Gets an invoice responses: '200': "$ref": "#/components/responses/single_invoice" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: invoices-show description: Retrieve a single invoice. delete: tags: - Invoices summary: Deletes an invoice responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: invoices-destroy description: Delete an invoice. patch: tags: - Invoices summary: Update an invoice responses: '200': "$ref": "#/components/responses/single_invoice" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: invoices-update requestBody: "$ref": "#/components/requestBodies/invoice" description: Update an invoice. "/api/v2/deal_statuses/{id}/archive": patch: tags: - Deal Statuses summary: Archives a deal status responses: '200': "$ref": "#/components/responses/single_deal_status" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: deal_statuses-archive-archive description: Archive a deal status. "/api/v2/sections/{id}": patch: tags: - Sections summary: Update a section responses: '200': "$ref": "#/components/responses/single_section" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: sections-update requestBody: "$ref": "#/components/requestBodies/section" description: Update a section. get: tags: - Sections summary: Gets a section responses: '200': "$ref": "#/components/responses/single_section" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: sections-show description: Retrieve a single section by ID. delete: tags: - Sections summary: Deletes a section responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: sections-destroy description: Delete a section by ID. "/api/v2/boards/{id}/move": patch: tags: - Boards summary: Move a board responses: '200': "$ref": "#/components/responses/single_board" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: boards-move-move description: Move a board. "/api/v2/invoice_attributions": post: tags: - Invoice Attributions summary: Create an invoice attribution responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_invoice_attribution" parameters: - "$ref": "#/components/parameters/header_organization" operationId: invoice_attributions-create requestBody: "$ref": "#/components/requestBodies/invoice_attribution" description: Create a new invoice attribution. get: tags: - Invoice Attributions summary: Get invoice attributions responses: '200': "$ref": "#/components/responses/collection_invoice_attribution" parameters: - "$ref": "#/components/parameters/sort_invoice_attribution" - "$ref": "#/components/parameters/filter_invoice_attribution" - "$ref": "#/components/parameters/header_organization" operationId: invoice_attributions-index description: List invoice attributions. "/api/v2/survey_responses/{id}": get: tags: - Survey Responses summary: Gets a survey response responses: '200': "$ref": "#/components/responses/single_survey_response" parameters: - in: path name: id schema: type: string required: true description: The ID of the survey response to retrieve. - "$ref": "#/components/parameters/header_organization" operationId: survey_responses-show description: Retrieve a single survey response by ID. delete: tags: - Survey Responses summary: Deletes a survey response responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: The ID of the survey response to delete. - "$ref": "#/components/parameters/header_organization" operationId: survey_responses-destroy description: Delete a survey response by ID. "/api/v2/pages": get: tags: - Pages summary: Get pages responses: '200': "$ref": "#/components/responses/collection_page" parameters: - "$ref": "#/components/parameters/filter_page" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_page" operationId: pages-index description: List pages. post: tags: - Pages summary: Create a page responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_page" parameters: - "$ref": "#/components/parameters/header_organization" operationId: pages-create requestBody: "$ref": "#/components/requestBodies/page" description: Create a new page. "/api/v2/bills/{id}": patch: tags: - Bills summary: Update a bill responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_bill" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: bills-update requestBody: "$ref": "#/components/requestBodies/bill" description: Update a bill. delete: tags: - Bills summary: Deletes a bill responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: bills-destroy description: Delete a bill. get: tags: - Bills summary: Gets a bill responses: '200': "$ref": "#/components/responses/single_bill" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: bills-show description: Retrieve a single bill by ID. "/api/v2/exchange_rates": get: tags: - Exchange Rates summary: Get exchange rates responses: '200': "$ref": "#/components/responses/collection_exchange_rate" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_exchange_rate" - "$ref": "#/components/parameters/filter_exchange_rate" operationId: exchange_rates-index description: List exchange rates. "/api/v2/folders/{id}/move": patch: tags: - Folders summary: Move a folder responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: The folder could not be moved due to validation errors. '200': "$ref": "#/components/responses/single_folder" parameters: - in: path name: id schema: type: string required: true description: The numeric ID of the folder. - "$ref": "#/components/parameters/header_organization" operationId: folders-move-move description: Moves a folder to a different project. "/api/v2/users/{id}": patch: tags: - Users summary: Update a user responses: '200': "$ref": "#/components/responses/single_user" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: users-update requestBody: "$ref": "#/components/requestBodies/user" description: Update a user. get: tags: - Users summary: Gets a user responses: '200': "$ref": "#/components/responses/single_user" '404': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Not Found parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: users-show description: Retrieve a single user by ID. "/api/v2/contracts": post: tags: - Contracts summary: Create a contract responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_contract" parameters: - "$ref": "#/components/parameters/header_organization" operationId: contracts-create requestBody: "$ref": "#/components/requestBodies/contract" description: Create a new contract. get: tags: - Contracts summary: Get contracts responses: '200': "$ref": "#/components/responses/collection_contract" parameters: - "$ref": "#/components/parameters/sort_contract" - "$ref": "#/components/parameters/filter_contract" - "$ref": "#/components/parameters/header_organization" operationId: contracts-index description: List contracts with optional filters and pagination. "/api/v2/integration_exporter_configurations": get: tags: - Integration Exporter Configuration summary: Get integration exporter configurations responses: '200': "$ref": "#/components/responses/collection_integration_exporter_configuration" parameters: - "$ref": "#/components/parameters/sort_integration_exporter_configuration" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_integration_exporter_configuration" operationId: integration_exporter_configurations-index description: List integration exporter configurations. post: tags: - Integration Exporter Configuration summary: Create integration exporter configuration responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_integration_exporter_configuration" parameters: - "$ref": "#/components/parameters/header_organization" operationId: integration_exporter_configurations-create requestBody: "$ref": "#/components/requestBodies/integration_exporter_configuration" description: Create a new integration exporter configuration. "/api/v2/revenue_distributions/{id}": delete: tags: - Revenue Distributions summary: Deletes a revenue distribution responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the revenue distribution to delete. operationId: revenue_distributions-destroy description: Delete a revenue distribution by ID. patch: tags: - Revenue Distributions summary: Update a revenue distribution responses: '200': "$ref": "#/components/responses/single_revenue_distribution" parameters: - in: path name: id schema: type: string required: true description: The ID of the revenue distribution to update. - "$ref": "#/components/parameters/header_organization" operationId: revenue_distributions-update description: Update a revenue distribution. get: tags: - Revenue Distributions summary: Gets a revenue distribution responses: '200': "$ref": "#/components/responses/single_revenue_distribution" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the revenue distribution to retrieve. operationId: revenue_distributions-show description: Retrieve a single revenue distribution by ID. "/api/v2/invoices/{id}/export": patch: tags: - Invoices summary: Exports an invoice responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_invoice" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: invoices-export-export description: Export an invoice to an external accounting system. "/api/v2/approval_policies/{id}": get: tags: - Approval Policy summary: Gets the approval policy responses: '200': "$ref": "#/components/responses/single_approval_policy" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the approval policy to retrieve. operationId: approval_policies-show description: Retrieve a single approval policy by ID. patch: tags: - Approval Policy summary: Updates the approval policy responses: '200': "$ref": "#/components/responses/single_approval_policy" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the approval policy to update. operationId: approval_policies-update requestBody: "$ref": "#/components/requestBodies/approval_policy" description: Update an approval policy. "/api/v2/surveys/{id}": get: tags: - Surveys summary: Gets a survey responses: '200': "$ref": "#/components/responses/single_survey" parameters: - in: path name: id schema: type: string required: true description: The ID of the survey to retrieve. - "$ref": "#/components/parameters/header_organization" operationId: surveys-show description: Retrieve a single survey by ID. delete: tags: - Surveys summary: Deletes a survey responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the survey to delete. operationId: surveys-destroy description: Delete a survey by ID. patch: tags: - Surveys summary: Update a survey responses: '200': "$ref": "#/components/responses/single_survey" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the survey to update. operationId: surveys-update requestBody: "$ref": "#/components/requestBodies/survey" description: Update a survey. "/api/v2/line_items": get: tags: - Line Items summary: Get line items responses: '200': "$ref": "#/components/responses/collection_line_item" parameters: - "$ref": "#/components/parameters/sort_line_item" - "$ref": "#/components/parameters/filter_line_item" - "$ref": "#/components/parameters/header_organization" operationId: line_items-index description: List line items. post: tags: - Line Items summary: Create a line item responses: '201': "$ref": "#/components/responses/single_line_item" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: line_items-create requestBody: "$ref": "#/components/requestBodies/line_item" description: Create a new line item. "/api/v2/webhook_logs": get: tags: - Webhook Logs summary: Get webhook logs responses: '200': "$ref": "#/components/responses/collection_webhook_log" parameters: - "$ref": "#/components/parameters/filter_webhook_log" - "$ref": "#/components/parameters/sort_webhook_log" - "$ref": "#/components/parameters/header_organization" operationId: webhook_logs-index description: List all webhook logs. "/api/v2/time_entries/{id}/reject": patch: tags: - Time Entries summary: Reject a time entry responses: '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict '200': "$ref": "#/components/responses/single_time_entry" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: time_entries-reject-reject description: Reject a time entry. "/api/v2/pulses": post: tags: - Pulses summary: Creates a pulse responses: '201': "$ref": "#/components/responses/single_pulse" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: pulses-create requestBody: "$ref": "#/components/requestBodies/pulse" description: Create a new pulse. get: tags: - Pulses summary: Get pulses responses: '200': "$ref": "#/components/responses/collection_pulse" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_pulse" - "$ref": "#/components/parameters/sort_pulse" operationId: pulses-index description: List all pulses. "/api/v2/deleted_items/{id}": get: tags: - Deleted Items summary: Gets a deleted item responses: '200': "$ref": "#/components/responses/single_deleted_item" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: deleted_items-show description: Retrieve a single deleted item. "/api/v2/reports/entitlement_reports": get: tags: - Reports summary: Get entitlement reports responses: '200': "$ref": "#/components/responses/collection_entitlement_report" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_entitlement_report" - "$ref": "#/components/parameters/group_entitlement_report" - "$ref": "#/components/parameters/filter_entitlement_report" operationId: reports-entitlement_reports-index description: Retrieve aggregated entitlement report data grouped by configurable dimensions. "/api/v2/tasks/{id}/reposition": patch: tags: - Tasks summary: Repositions a task responses: '200': "$ref": "#/components/responses/single_task" '204': content: any: {} headers: {} description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: tasks-reposition-reposition description: Repositions a task within its task list, changing its display order. "/api/v2/reports/payroll_item_reports": get: tags: - Reports summary: Get payroll item reports responses: '200': "$ref": "#/components/responses/collection_payroll_item_report" parameters: - "$ref": "#/components/parameters/sort_payroll_item_report" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/group_payroll_item_report" - "$ref": "#/components/parameters/filter_payroll_item_report" operationId: reports-payroll_item_reports-index description: Retrieve aggregated payroll item report data grouped by configurable dimensions. "/api/v2/tax_rates": post: tags: - TaxRates summary: Create a tax rate responses: '201': "$ref": "#/components/responses/single_tax_rate" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: tax_rates-create requestBody: "$ref": "#/components/requestBodies/tax_rate" description: Create a new tax rate. get: tags: - TaxRates summary: Get tax rates responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '200': "$ref": "#/components/responses/collection_tax_rate" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_tax_rate" - "$ref": "#/components/parameters/sort_tax_rate" operationId: tax_rates-index description: List all tax rates. "/api/v2/line_items/{id}": delete: tags: - Line Items summary: Deletes a line item responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: line_items-destroy description: Delete a line item. patch: tags: - Line Items summary: Update a line item responses: '200': "$ref": "#/components/responses/single_line_item" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: line_items-update requestBody: "$ref": "#/components/requestBodies/line_item" description: Update a line item. get: tags: - Line Items summary: Gets a line item responses: '200': "$ref": "#/components/responses/single_line_item" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: line_items-show description: Retrieve a single line item. "/api/v2/approval_workflows": post: tags: - Approval Workflow summary: Creates the approval workflow responses: '201': "$ref": "#/components/responses/single_approval_workflow" parameters: - "$ref": "#/components/parameters/header_organization" operationId: approval_workflows-create requestBody: "$ref": "#/components/requestBodies/approval_workflow" description: Create a new approval workflow. "/api/v2/projects": post: tags: - Projects summary: Create a project responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_project" parameters: - "$ref": "#/components/parameters/header_organization" operationId: projects-create requestBody: "$ref": "#/components/requestBodies/project" description: Create a project. Creates a new project with the specified attributes. Requires a client company, project manager, project type, and workflow. get: tags: - Projects summary: Get projects responses: '200': "$ref": "#/components/responses/collection_project" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_project" - "$ref": "#/components/parameters/sort_project" operationId: projects-index description: List projects. Returns a paginated collection of projects accessible to the authenticated user. Supports filtering, sorting, and including related resources. "/api/v2/approval_workflows/{id}": delete: tags: - Approval Workflow summary: Deletes the approval workflow responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: approval_workflows-destroy description: Delete an approval workflow. get: tags: - Approval Workflow summary: Gets the approval workflow responses: '200': "$ref": "#/components/responses/single_approval_workflow" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: approval_workflows-show description: Retrieve a single approval workflow by ID. patch: tags: - Approval Workflow summary: Updates the approval workflow responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_approval_workflow" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: approval_workflows-update requestBody: "$ref": "#/components/requestBodies/approval_workflow" description: Update an approval workflow. "/api/v2/integrations/{id}/connect": patch: tags: - Integrations responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: The integration could not be connected due to validation errors. '200': "$ref": "#/components/responses/single_integration" parameters: - in: path name: id schema: type: string required: true description: The numeric ID of the integration. - "$ref": "#/components/parameters/header_organization" operationId: integrations-connect-connect description: Completes the OAuth connection flow for an integration by exchanging the authorization code for access tokens. "/api/v2/memberships": get: tags: - Memberships summary: Get memberships responses: '200': "$ref": "#/components/responses/collection_membership" parameters: - "$ref": "#/components/parameters/sort_membership" - "$ref": "#/components/parameters/filter_membership" - "$ref": "#/components/parameters/header_organization" operationId: memberships-index description: List memberships. post: tags: - Memberships summary: Create a membership responses: '201': "$ref": "#/components/responses/single_membership" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden parameters: - "$ref": "#/components/parameters/header_organization" operationId: memberships-create requestBody: "$ref": "#/components/requestBodies/membership" description: Create a new membership. "/api/v2/workflows/{id}": patch: tags: - Workflows summary: Update an workflow responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_workflow" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: workflows-update requestBody: "$ref": "#/components/requestBodies/workflow" description: Update a workflow. get: tags: - Workflows summary: Gets a workflow responses: '200': "$ref": "#/components/responses/single_workflow" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: workflows-show description: Retrieve a single workflow by ID. delete: tags: - Workflows summary: Deletes a workflow responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: workflows-destroy description: Delete a workflow by ID. "/api/v2/invoice_attributions/{id}": delete: tags: - Invoice Attributions summary: Deletes an invoice attribution responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: invoice_attributions-destroy description: Delete an invoice attribution. get: tags: - Invoice Attributions summary: Gets an invoice attribution responses: '200': "$ref": "#/components/responses/single_invoice_attribution" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: invoice_attributions-show description: Retrieve a single invoice attribution. patch: tags: - Invoice Attributions summary: Update an invoice attribution responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_invoice_attribution" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: invoice_attributions-update requestBody: "$ref": "#/components/requestBodies/invoice_attribution" description: Update an invoice attribution. "/api/v2/approval_policy_assignments": get: tags: - Approval Policy Assignment summary: Get approval policy assignments responses: '200': "$ref": "#/components/responses/collection_approval_policy_assignment" parameters: - "$ref": "#/components/parameters/sort_approval_policy_assignment" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_approval_policy_assignment" operationId: approval_policy_assignments-index description: List approval policy assignments with optional filters and pagination. post: tags: - Approval Policy Assignment summary: Creates the approval policy assignment responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_approval_policy_assignment" parameters: - "$ref": "#/components/parameters/header_organization" operationId: approval_policy_assignments-create requestBody: "$ref": "#/components/requestBodies/approval_policy_assignment" description: Create a new approval policy assignment. "/api/v2/service_types": post: tags: - Service Types summary: Create a service type responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_service_type" parameters: - "$ref": "#/components/parameters/header_organization" operationId: service_types-create requestBody: "$ref": "#/components/requestBodies/service_type" description: Create a new service type. get: tags: - Service Types summary: Get service types responses: '200': "$ref": "#/components/responses/collection_service_type" parameters: - "$ref": "#/components/parameters/sort_service_type" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_service_type" operationId: service_types-index description: List all service types. "/api/v2/invitations/{id}": patch: tags: - Invitations summary: Update an invitation responses: '204': content: any: {} headers: {} description: No Content '200': "$ref": "#/components/responses/single_invitation" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: invitations-update requestBody: "$ref": "#/components/requestBodies/invitation" description: Accept an invitation. get: tags: - Invitations summary: Get an invitation responses: '404': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Not Found '200': "$ref": "#/components/responses/single_invitation" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: invitations-show description: Retrieve a single invitation. "/api/v2/subsidiaries/{id}": patch: tags: - Subsidiaries summary: Update a subsidiary responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_subsidiary" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: subsidiaries-update requestBody: "$ref": "#/components/requestBodies/subsidiary" description: Update a subsidiary. get: tags: - Subsidiaries summary: Gets a subsidiary responses: '200': "$ref": "#/components/responses/single_subsidiary" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: subsidiaries-show description: Retrieve a single subsidiary by ID. "/api/v2/deals": post: tags: - Deals summary: Create a deal responses: '201': "$ref": "#/components/responses/single_deal" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: deals-create requestBody: "$ref": "#/components/requestBodies/deal" description: Create a new deal. get: tags: - Deals summary: Get deals responses: '200': "$ref": "#/components/responses/collection_deal" parameters: - "$ref": "#/components/parameters/filter_deal" - "$ref": "#/components/parameters/sort_deal" - "$ref": "#/components/parameters/header_organization" operationId: deals-index description: List deals with optional filters. Returns paginated deal records the caller has access to. "/api/v2/payment_reminder_sequences/{id}": delete: tags: - Payment reminder sequences summary: Deletes a payment reminder sequence responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: payment_reminder_sequences-destroy description: Delete a payment reminder sequence by ID. patch: tags: - Payment reminder sequences summary: Update a payment reminder sequence responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_payment_reminder_sequence" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: payment_reminder_sequences-update requestBody: "$ref": "#/components/requestBodies/payment_reminder_sequence" description: Update a payment reminder sequence. get: tags: - Payment reminder sequences summary: Gets a payment reminder sequence responses: '200': "$ref": "#/components/responses/single_payment_reminder_sequence" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: payment_reminder_sequences-show description: Retrieve a single payment reminder sequence by ID. "/api/v2/survey_fields/{id}/archive": patch: tags: - Survey Fields summary: Archives a survey field responses: '200': "$ref": "#/components/responses/single_survey_field" parameters: - in: path name: id schema: type: string required: true description: The ID of the survey field to archive. - "$ref": "#/components/parameters/header_organization" operationId: survey_fields-archive-archive description: Archive a survey field to deactivate it. "/api/v2/pages/{id}/move": patch: tags: - Pages summary: Moves a page responses: '200': "$ref": "#/components/responses/single_page" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the page to move. operationId: pages-move-move description: Move a page to a different location. "/api/v2/time_entries/{id}": get: tags: - Time Entries summary: Gets a time entry responses: '200': "$ref": "#/components/responses/single_time_entry" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: time_entries-show description: Retrieve a single time entry by ID. patch: tags: - Time Entries summary: Update a time entry responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_time_entry" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: time_entries-update requestBody: "$ref": "#/components/requestBodies/time_entry" description: Update a time entry. delete: tags: - Time Entries summary: Deletes a time entry responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: time_entries-destroy description: Delete a time entry. "/api/v2/companies/{id}": get: tags: - Companies summary: Gets a company responses: '200': "$ref": "#/components/responses/single_company" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: companies-show description: Retrieve a single company by ID. patch: tags: - Companies summary: Update a company responses: '200': "$ref": "#/components/responses/single_company" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: companies-update requestBody: "$ref": "#/components/requestBodies/company" description: Update a company. "/api/v2/widgets/{id}": get: tags: - Widgets summary: Get a widget responses: '200': "$ref": "#/components/responses/single_widget" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: widgets-show description: Retrieve a single widget by ID. patch: tags: - Widgets summary: Update a widget responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_widget" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: widgets-update requestBody: "$ref": "#/components/requestBodies/widget" description: Update a widget. delete: tags: - Widgets summary: Deletes a widget responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: widgets-destroy description: Delete a widget by ID. "/api/v2/expenses": patch: tags: - Expenses - Bulk summary: Update expenses responses: '200': "$ref": "#/components/responses/single_expense" parameters: - "$ref": "#/components/parameters/header_organization" operationId: expenses-update-bulk requestBody: "$ref": "#/components/requestBodies/expense" description: Bulk update expenses. get: tags: - Expenses summary: Get expenses responses: '200': "$ref": "#/components/responses/collection_expense" parameters: - "$ref": "#/components/parameters/filter_expense" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_expense" operationId: expenses-index description: List expenses. Returns a paginated collection of expenses matching the specified filters. delete: tags: - Expenses - Bulk summary: Delete expenses responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" operationId: expenses-destroy-bulk description: Bulk delete expenses. post: tags: - Expenses summary: Create a expense responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_expense" parameters: - "$ref": "#/components/parameters/header_organization" operationId: expenses-create requestBody: "$ref": "#/components/requestBodies/expense" description: Create a new expense and associate it with a budget service. "/api/v2/projects/{id}/subscribe": patch: tags: - Projects summary: Subscribes to project responses: '200': "$ref": "#/components/responses/single_project" parameters: - in: path name: id schema: type: string required: true description: The numeric ID of the project. - "$ref": "#/components/parameters/header_organization" operationId: projects-subscribe-subscribe description: Subscribes the current user to project notifications. "/api/v2/time_entries/unapprove": patch: tags: - Time Entries - Bulk summary: Unapproves time entries responses: '200': "$ref": "#/components/responses/single_time_entry" parameters: - "$ref": "#/components/parameters/header_organization" operationId: time_entries-unapprove-update-bulk requestBody: "$ref": "#/components/requestBodies/time_entry" description: Revoke approval of a time entry (alternate endpoint). "/api/v2/approval_policy_assignments/{id}": delete: tags: - Approval Policy Assignment summary: Deletes the approval policy assignment responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the approval policy assignment to delete. operationId: approval_policy_assignments-destroy description: Delete an approval policy assignment. patch: tags: - Approval Policy Assignment summary: Updates the approval policy assignment responses: '200': "$ref": "#/components/responses/single_approval_policy_assignment" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: The ID of the approval policy assignment to update. - "$ref": "#/components/parameters/header_organization" operationId: approval_policy_assignments-update requestBody: "$ref": "#/components/requestBodies/approval_policy_assignment" description: Update an approval policy assignment. get: tags: - Approval Policy Assignment summary: Gets the approval policy assignment responses: '200': "$ref": "#/components/responses/single_approval_policy_assignment" parameters: - in: path name: id schema: type: string required: true description: The ID of the approval policy assignment to retrieve. - "$ref": "#/components/parameters/header_organization" operationId: approval_policy_assignments-show description: Retrieve a single approval policy assignment by ID. "/api/v2/bookings/{id}": patch: tags: - Bookings summary: Update a booking responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_booking" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: bookings-update requestBody: "$ref": "#/components/requestBodies/booking" description: Update a booking. delete: tags: - Bookings summary: Deletes a booking responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: bookings-destroy description: Delete a booking. get: tags: - Bookings summary: Gets a booking responses: '200': "$ref": "#/components/responses/single_booking" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: bookings-show description: Retrieve a single booking by ID. "/api/v2/payments/{id}": delete: tags: - Payments summary: Deletes a payment responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: payments-destroy description: Delete a payment by ID. get: tags: - Payments summary: Gets a payment responses: '200': "$ref": "#/components/responses/single_payment" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: payments-show description: Retrieve a single payment by ID. patch: tags: - Payments summary: Update a payment responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_payment" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: payments-update requestBody: "$ref": "#/components/requestBodies/payment" description: Update a payment. "/api/v2/events/{id}": patch: tags: - Events summary: Update an event responses: '200': "$ref": "#/components/responses/single_event" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: events-update requestBody: "$ref": "#/components/requestBodies/event" description: Update an event. delete: tags: - Events summary: Deletes an event responses: '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: events-destroy description: Delete an event. get: tags: - Events summary: Get an event responses: '200': "$ref": "#/components/responses/single_event" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: events-show description: Retrieve a single event. "/api/v2/emails": get: tags: - Emails summary: Get emails responses: '200': "$ref": "#/components/responses/collection_email" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_email" - "$ref": "#/components/parameters/filter_email" operationId: emails-index description: List emails. "/api/v2/organization_memberships/{id}": delete: tags: - Organization Memberships summary: Destroy organization membership responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: organization_memberships-destroy description: Delete an organization membership. patch: tags: - Organization Memberships summary: Update an organization membership responses: '200': "$ref": "#/components/responses/single_organization_membership" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: organization_memberships-update requestBody: "$ref": "#/components/requestBodies/organization_membership" description: Update an organization membership. get: tags: - Organization Memberships summary: Get an organization membership responses: '200': "$ref": "#/components/responses/single_organization_membership" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: organization_memberships-show description: Retrieve a single organization membership. "/api/v2/reports/payment_reports": get: tags: - Reports summary: Get payment reports responses: '200': "$ref": "#/components/responses/collection_payment_report" parameters: - "$ref": "#/components/parameters/filter_payment_report" - "$ref": "#/components/parameters/sort_payment_report" - "$ref": "#/components/parameters/group_payment_report" - "$ref": "#/components/parameters/header_organization" operationId: reports-payment_reports-index description: Retrieve aggregated payment report data grouped by configurable dimensions. "/api/v2/pipelines/{id}": delete: tags: - Pipelines summary: Deletes a pipeline responses: '204': description: No Content '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: pipelines-destroy description: Delete a pipeline by ID. patch: tags: - Pipelines summary: Update a pipeline responses: '200': "$ref": "#/components/responses/single_pipeline" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: pipelines-update requestBody: "$ref": "#/components/requestBodies/pipeline" description: Update a pipeline. get: tags: - Pipelines summary: Gets a pipeline responses: '200': "$ref": "#/components/responses/single_pipeline" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: pipelines-show description: Retrieve a single pipeline by ID. "/api/v2/custom_domains/{id}": get: tags: - Custom domains summary: Gets a custom domain responses: '200': "$ref": "#/components/responses/single_custom_domain" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: custom_domains-show description: Retrieve a single custom domain by ID. delete: tags: - Custom domains summary: Deletes a custom domain responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: custom_domains-destroy description: Delete a custom domain. "/api/v2/timesheets": post: tags: - Timesheets summary: Create a timesheet responses: '201': "$ref": "#/components/responses/single_timesheet" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: timesheets-create requestBody: "$ref": "#/components/requestBodies/timesheet" description: Create a new timesheet. get: tags: - Timesheets summary: Get timesheets responses: '200': "$ref": "#/components/responses/collection_timesheet" parameters: - "$ref": "#/components/parameters/sort_timesheet" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_timesheet" operationId: timesheets-index description: List all timesheets. "/api/v2/service_type_assignments": get: tags: - Service Type Assignments summary: Get service type assignments responses: '200': "$ref": "#/components/responses/collection_service_type_assignment" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_service_type_assignment" - "$ref": "#/components/parameters/sort_service_type_assignment" operationId: service_type_assignments-index description: List all service type assignments. post: tags: - Service Type Assignments summary: Create a service type assignment responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_service_type_assignment" parameters: - "$ref": "#/components/parameters/header_organization" operationId: service_type_assignments-create requestBody: "$ref": "#/components/requestBodies/service_type_assignment" description: Create a new service type assignment. "/api/v2/tax_rates/{id}/restore": patch: tags: - TaxRates summary: Restores an archived tax rate responses: '200': "$ref": "#/components/responses/single_tax_rate" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: tax_rates-restore-restore description: Restore an archived tax rate. "/api/v2/holiday_calendars/{id}": delete: tags: - Holiday calendars summary: Deletes a holiday calendar responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: holiday_calendars-destroy description: Delete a holiday calendar. get: tags: - Holiday calendars summary: Get a holiday calendar responses: '200': "$ref": "#/components/responses/single_holiday_calendar" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: holiday_calendars-show description: Retrieve a single holiday calendar. patch: tags: - Holiday calendars summary: Update a holiday calendar responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_holiday_calendar" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: holiday_calendars-update requestBody: "$ref": "#/components/requestBodies/holiday_calendar" description: Update a holiday calendar. "/api/v2/organization_memberships/{id}/clear_notifications": patch: tags: - Organization Memberships summary: Clear notifications for organization membership responses: '200': "$ref": "#/components/responses/single_organization_membership" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: organization_memberships-clear_notifications-clear_notifications description: Clear all notifications for an organization membership. "/api/v2/attachments/{id}": patch: tags: - Attachments summary: Update an attachment responses: '200': "$ref": "#/components/responses/single_attachment" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: attachments-update requestBody: "$ref": "#/components/requestBodies/attachment" description: Update an attachment. get: tags: - Attachments summary: Get an attachment responses: '200': "$ref": "#/components/responses/single_attachment" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: attachments-show description: Retrieve a single attachment by ID. delete: tags: - Attachments summary: Delete an attachment responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: attachments-destroy description: Delete an attachment. "/api/v2/entitlements/{id}": delete: tags: - Entitlements summary: Deletes an entitlement responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: entitlements-destroy description: Delete an entitlement. get: tags: - Entitlements summary: Get an entitlement responses: '200': "$ref": "#/components/responses/single_entitlement" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: entitlements-show description: Retrieve a single entitlement. patch: tags: - Entitlements summary: Updates an entitlement responses: '200': "$ref": "#/components/responses/single_entitlement" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: entitlements-update requestBody: "$ref": "#/components/requestBodies/entitlement" description: Update an entitlement. "/api/v2/webhooks": get: tags: - Webhooks summary: Get webhooks responses: '200': "$ref": "#/components/responses/collection_webhook" parameters: - "$ref": "#/components/parameters/sort_webhook" - "$ref": "#/components/parameters/filter_webhook" - "$ref": "#/components/parameters/header_organization" operationId: webhooks-index description: List all webhooks. post: tags: - Webhooks summary: Create a webhook responses: '201': "$ref": "#/components/responses/single_webhook" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: webhooks-create requestBody: "$ref": "#/components/requestBodies/webhook" description: Create a new webhook. "/api/v2/report_categories": get: tags: - Report Category summary: Get report categories responses: '200': "$ref": "#/components/responses/collection_report_category" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_report_category" - "$ref": "#/components/parameters/filter_report_category" operationId: report_categories-index description: List all report categories. post: tags: - Report Category summary: Create a report category responses: '201': "$ref": "#/components/responses/single_report_category" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: report_categories-create requestBody: "$ref": "#/components/requestBodies/report_category" description: Create a new report category. "/api/v2/teams/{id}": patch: tags: - Teams summary: Update a team responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_team" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: teams-update requestBody: "$ref": "#/components/requestBodies/team" description: Update a team. get: tags: - Teams summary: Gets a team responses: '200': "$ref": "#/components/responses/single_team" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: teams-show description: Retrieve a single team by ID. delete: tags: - Teams summary: Deletes a team responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: teams-destroy description: Delete a team by ID. "/api/v2/page_versions/{id}": patch: tags: - PageVersions summary: Update a page_version responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_page_version" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: page_versions-update requestBody: "$ref": "#/components/requestBodies/page_version" description: Restore a page to a specific version. get: tags: - PageVersions summary: Gets a page_version responses: '200': "$ref": "#/components/responses/single_page_version" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: page_versions-show description: Retrieve a single page version. "/api/v2/pages/{id}/unpublish": patch: tags: - Pages summary: Unpublishes a page responses: '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict '200': "$ref": "#/components/responses/single_page" parameters: - in: path name: id schema: type: string required: true description: The ID of the page to unpublish. - "$ref": "#/components/parameters/header_organization" operationId: pages-unpublish-unpublish description: Unpublish a page to remove it from public visibility. "/api/v2/time_entry_versions/{id}": get: tags: - Time Entry Versions summary: Gets a time entry version responses: '200': "$ref": "#/components/responses/single_time_entry_version" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: time_entry_versions-show description: Retrieve a single time entry version by ID. "/api/v2/lost_reasons/{id}": patch: tags: - Lost Reasons summary: Update a lost reason responses: '200': "$ref": "#/components/responses/single_lost_reason" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: lost_reasons-update requestBody: "$ref": "#/components/requestBodies/lost_reason" description: Update a lost reason. get: tags: - Lost Reasons summary: Gets a lost reason responses: '200': "$ref": "#/components/responses/single_lost_reason" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: lost_reasons-show description: Retrieve a single lost reason. "/api/v2/deals/create_from_origin": post: tags: - Deals summary: Creates a budget from origin deal responses: '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created '200': "$ref": "#/components/responses/single_deal" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: deals-create_from_origin-create_from_origin description: Create a new deal from an origin deal. "/api/v2/task_dependencies/{id}": get: tags: - TaskDependency summary: Gets a task dependency responses: '200': "$ref": "#/components/responses/single_task_dependency" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: task_dependencies-show description: Retrieve a single task dependency by ID. delete: tags: - TaskDependency summary: Deletes a task dependency responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: task_dependencies-destroy description: Delete a task dependency by ID. patch: tags: - TaskDependency summary: Update a task dependency responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_task_dependency" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: task_dependencies-update requestBody: "$ref": "#/components/requestBodies/task_dependency" description: Update a task dependency. "/api/v2/reports/time_entry_reports": get: tags: - Reports summary: Get time entry reports responses: '200': "$ref": "#/components/responses/collection_time_entry_report" parameters: - "$ref": "#/components/parameters/filter_time_entry_report" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/group_time_entry_report" - "$ref": "#/components/parameters/sort_time_entry_report" operationId: reports-time_entry_reports-index description: Retrieve aggregated time entry report data grouped by configurable dimensions. "/api/v2/pages/{id}/publish": patch: tags: - Pages summary: Publishes a page responses: '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict '200': "$ref": "#/components/responses/single_page" parameters: - in: path name: id schema: type: string required: true description: The ID of the page to publish. - "$ref": "#/components/parameters/header_organization" operationId: pages-publish-publish description: Publish a page to make it publicly visible. "/api/v2/attachments": get: tags: - Attachments summary: Get attachments responses: '200': "$ref": "#/components/responses/collection_attachment" parameters: - "$ref": "#/components/parameters/filter_attachment" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_attachment" operationId: attachments-index description: List attachments with optional filters and pagination. post: tags: - Attachments summary: Create an attachment responses: '201': "$ref": "#/components/responses/single_attachment" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: attachments-create requestBody: "$ref": "#/components/requestBodies/attachment" description: Create a new attachment. "/api/v2/organization_memberships/{id}/dismiss_notifications": patch: tags: - Organization Memberships summary: Dismiss notifications for organization membership responses: '200': "$ref": "#/components/responses/single_organization_membership" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: organization_memberships-dismiss_notifications-dismiss_notifications description: Dismiss all notifications for an organization membership. "/api/v2/invoices/{id}/export_update": patch: tags: - Invoices summary: Updates an exported invoice responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_invoice" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: invoices-export_update-export_update description: Update the export data on an already-exported invoice. "/api/v2/service_type_assignments/{id}": delete: tags: - Service Type Assignments summary: Deletes a service type assignment responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: service_type_assignments-destroy description: Delete a service type assignment by ID. patch: tags: - Service Type Assignments summary: Update a service type assignment responses: '200': "$ref": "#/components/responses/single_service_type_assignment" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: service_type_assignments-update requestBody: "$ref": "#/components/requestBodies/service_type_assignment" description: Update a service type assignment. get: tags: - Service Type Assignments summary: Gets a service type assignment responses: '200': "$ref": "#/components/responses/single_service_type_assignment" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: service_type_assignments-show description: Retrieve a single service type assignment by ID. "/api/v2/reports/deal_reports": get: tags: - Reports summary: Get deal reports responses: '200': "$ref": "#/components/responses/collection_deal_report" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_deal_report" - "$ref": "#/components/parameters/sort_deal_report" - "$ref": "#/components/parameters/group_deal_report" operationId: reports-deal_reports-index description: Retrieve aggregated deal report data grouped by configurable dimensions. "/api/v2/invoices": get: tags: - Invoices summary: Get invoices responses: '200': "$ref": "#/components/responses/collection_invoice" parameters: - "$ref": "#/components/parameters/filter_invoice" - "$ref": "#/components/parameters/sort_invoice" - "$ref": "#/components/parameters/header_organization" operationId: invoices-index description: List invoices. post: tags: - Invoices summary: Create an invoice responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_invoice" parameters: - "$ref": "#/components/parameters/header_organization" operationId: invoices-create requestBody: "$ref": "#/components/requestBodies/invoice" description: Create a new invoice. "/api/v2/purchase_orders/{id}": patch: tags: - Purchase Orders summary: Update a purchase order responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_purchase_order" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: purchase_orders-update requestBody: "$ref": "#/components/requestBodies/purchase_order" description: Update a purchase order. delete: tags: - Purchase Orders summary: Deletes a purchase order responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: purchase_orders-destroy description: Delete a purchase order by ID. get: tags: - Purchase Orders summary: Gets a purchase order responses: '200': "$ref": "#/components/responses/single_purchase_order" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: purchase_orders-show description: Retrieve a single purchase order by ID. "/api/v2/folders/{id}/restore": patch: tags: - Folders summary: Restores a folder responses: '200': "$ref": "#/components/responses/single_folder" parameters: - in: path name: id schema: type: string required: true description: The numeric ID of the folder. - "$ref": "#/components/parameters/header_organization" operationId: folders-restore-restore description: Restores a previously archived folder. "/api/v2/discussions": post: tags: - Discussions summary: Create an discussion responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_discussion" parameters: - "$ref": "#/components/parameters/header_organization" operationId: discussions-create requestBody: "$ref": "#/components/requestBodies/discussion" description: Create a new discussion. get: tags: - Discussions summary: Get discussions responses: '200': "$ref": "#/components/responses/collection_discussion" parameters: - "$ref": "#/components/parameters/filter_discussion" - "$ref": "#/components/parameters/sort_discussion" - "$ref": "#/components/parameters/header_organization" operationId: discussions-index description: List discussions. "/api/v2/tasks": get: tags: - Tasks summary: Get tasks responses: '200': "$ref": "#/components/responses/collection_task" parameters: - "$ref": "#/components/parameters/sort_task" - "$ref": "#/components/parameters/filter_task" - "$ref": "#/components/parameters/header_organization" operationId: tasks-index description: Returns a paginated list of tasks. Supports filtering by project, assignee, status, dates, tags, and more. post: tags: - Tasks summary: Create a task responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_task" parameters: - "$ref": "#/components/parameters/header_organization" operationId: tasks-create requestBody: "$ref": "#/components/requestBodies/task" description: Creates a new task. Provide attributes such as title, project, assignee, due date, and workflow status. "/api/v2/teams": get: tags: - Teams summary: Get teams responses: '200': "$ref": "#/components/responses/collection_team" parameters: - "$ref": "#/components/parameters/sort_team" - "$ref": "#/components/parameters/filter_team" - "$ref": "#/components/parameters/header_organization" operationId: teams-index description: List all teams. post: tags: - Teams summary: Create a team responses: '201': "$ref": "#/components/responses/single_team" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: teams-create requestBody: "$ref": "#/components/requestBodies/team" description: Create a new team. "/api/v2/reports/expense_reports": get: tags: - Reports summary: Get expense reports responses: '200': "$ref": "#/components/responses/collection_expense_report" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/group_expense_report" - "$ref": "#/components/parameters/sort_expense_report" - "$ref": "#/components/parameters/filter_expense_report" operationId: reports-expense_reports-index description: Retrieve aggregated expense report data grouped by configurable dimensions. "/api/v2/tax_rates/{id}": patch: tags: - TaxRates summary: Update a tax rate responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '200': "$ref": "#/components/responses/single_tax_rate" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: tax_rates-update requestBody: "$ref": "#/components/requestBodies/tax_rate" description: Update a tax rate. get: tags: - TaxRates summary: Gets a tax rate responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '200': "$ref": "#/components/responses/single_tax_rate" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: tax_rates-show description: Retrieve a single tax rate by ID. "/api/v2/proposals": get: tags: - Proposals summary: Get proposals responses: '200': "$ref": "#/components/responses/collection_proposal" parameters: - "$ref": "#/components/parameters/sort_proposal" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_proposal" operationId: proposals-index description: List all proposals. post: tags: - Proposals summary: Create a proposal responses: '201': "$ref": "#/components/responses/single_proposal" parameters: - "$ref": "#/components/parameters/header_organization" operationId: proposals-create description: Create a new proposal. "/api/v2/reports/deal_funnel_reports": get: tags: - Reports summary: Get funnel reports responses: '200': "$ref": "#/components/responses/collection_deal_funnel_report" parameters: - "$ref": "#/components/parameters/group_deal_funnel_report" - "$ref": "#/components/parameters/sort_deal_funnel_report" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_deal_funnel_report" operationId: reports-deal_funnel_reports-index description: Retrieve aggregated deal funnel report data grouped by configurable dimensions. "/api/v2/activities/{id}": get: tags: - Activities summary: Get an activity responses: '200': "$ref": "#/components/responses/single_activity" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: activities-show description: Retrieve a single activity by ID. "/api/v2/task_lists/{id}/move": patch: tags: - Task Lists summary: Moves a task list responses: '200': "$ref": "#/components/responses/single_task_list" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: task_lists-move-move description: Move a task list to a different folder or project. "/api/v2/services/{id}": delete: tags: - Services summary: Deletes a service responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: The numeric ID of the service. - "$ref": "#/components/parameters/header_organization" operationId: services-destroy description: Delete a service. get: tags: - Services summary: Gets a service responses: '200': "$ref": "#/components/responses/single_service" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The numeric ID of the service. operationId: services-show description: Retrieve a single service by ID. patch: tags: - Services summary: Update a service responses: '200': "$ref": "#/components/responses/single_service" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: The numeric ID of the service. - "$ref": "#/components/parameters/header_organization" operationId: services-update requestBody: "$ref": "#/components/requestBodies/service" description: Update a service. "/api/v2/salaries/{id}": delete: tags: - Salaries summary: Deletes a salary responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: salaries-destroy description: Delete a salary by ID. get: tags: - Salaries summary: Gets a salary responses: '200': "$ref": "#/components/responses/single_salary" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: salaries-show description: Retrieve a single salary by ID. patch: tags: - Salaries summary: Update a salary responses: '200': "$ref": "#/components/responses/single_salary" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: salaries-update requestBody: "$ref": "#/components/requestBodies/salary" description: Update a salary. "/api/v2/custom_domains": get: tags: - Custom domains summary: Get custom domains responses: '200': "$ref": "#/components/responses/collection_custom_domain" parameters: - "$ref": "#/components/parameters/sort_custom_domain" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_custom_domain" operationId: custom_domains-index description: List custom domains with optional filters and pagination. post: tags: - Custom domains summary: Create a custom domain responses: '201': "$ref": "#/components/responses/single_custom_domain" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: custom_domains-create requestBody: "$ref": "#/components/requestBodies/custom_domain" description: Create a new custom domain. "/api/v2/approval_policies/{id}/restore": patch: tags: - Approval Policy summary: Restores the approval policy responses: '200': "$ref": "#/components/responses/single_approval_policy" '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the approval policy to restore. operationId: approval_policies-restore-restore description: Restore an approval policy. "/api/v2/companies/{id}/archive": patch: tags: - Companies summary: Archives a company responses: '200': "$ref": "#/components/responses/single_company" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: companies-archive-archive description: Archive a company. "/api/v2/page_versions": post: tags: - PageVersions summary: Create a page_version responses: '201': "$ref": "#/components/responses/single_page_version" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: page_versions-create requestBody: "$ref": "#/components/requestBodies/page_version" description: Create a new page version. get: tags: - PageVersions summary: Get page_versions responses: '200': "$ref": "#/components/responses/collection_page_version" parameters: - "$ref": "#/components/parameters/filter_page_version" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_page_version" operationId: page_versions-index description: List page versions. "/api/v2/deals/{id}/open": patch: tags: - Deals summary: Opens a deal responses: '200': "$ref": "#/components/responses/single_deal" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: deals-open-open description: Reopen a closed deal. "/api/v2/rate_cards/copy": post: tags: - Rate cards summary: Copy a rate card responses: '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '404': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Not Found '200': "$ref": "#/components/responses/single_rate_card" parameters: - "$ref": "#/components/parameters/header_organization" operationId: rate_cards-copy-copy description: Copy an existing rate card. "/api/v2/boards/{id}": get: tags: - Boards summary: Gets a board responses: '200': "$ref": "#/components/responses/single_board" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: boards-show description: Retrieve a single board by ID. patch: tags: - Boards summary: Update a board responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_board" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: boards-update requestBody: "$ref": "#/components/requestBodies/board" description: Update a board. "/api/v2/team_memberships/{id}": get: tags: - Team Memberships summary: Gets a team membership responses: '200': "$ref": "#/components/responses/single_team_membership" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: team_memberships-show description: Retrieve a single team membership by ID. delete: tags: - Team Memberships summary: Deletes a team membership responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: team_memberships-destroy description: Delete a team membership by ID. "/api/v2/emails/{id}": delete: tags: - Emails summary: Delete an email responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: emails-destroy description: Delete an email. get: tags: - Emails summary: Get an email responses: '200': "$ref": "#/components/responses/single_email" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: emails-show description: Retrieve a single email. "/api/v2/sessions/{id}/validate_otp": put: tags: - Sessions summary: Validate session OTP responses: '401': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unauthorized '200': "$ref": "#/components/responses/single_session" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: sessions-validate_otp-validate_otp description: Validate a one-time password for a session. "/api/v2/webhooks/{id}": delete: tags: - Webhooks summary: Deletes a webhook responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: webhooks-destroy description: Delete a webhook by ID. get: tags: - Webhooks summary: Gets a webhook responses: '200': "$ref": "#/components/responses/single_webhook" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: webhooks-show description: Retrieve a single webhook by ID. "/api/v2/emails/{id}/attach": patch: tags: - Emails summary: Attach an email responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_email" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: emails-attach-attach description: Attach an email to a resource. "/api/v2/sessions": post: tags: - Sessions summary: Create a session responses: '201': "$ref": "#/components/responses/single_session" '401': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unauthorized parameters: - "$ref": "#/components/parameters/header_organization" operationId: sessions-create requestBody: "$ref": "#/components/requestBodies/session" description: Create a new session (sign in). get: tags: - Sessions summary: Get all sessions responses: '200': "$ref": "#/components/responses/collection_session" parameters: - "$ref": "#/components/parameters/sort_session" - "$ref": "#/components/parameters/filter_session" - "$ref": "#/components/parameters/header_organization" operationId: sessions-index description: List all active sessions. "/api/v2/expenses/{id}": delete: tags: - Expenses summary: Deletes a expense responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: expenses-destroy description: Delete an expense by ID. patch: tags: - Expenses summary: Update a expense responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_expense" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: expenses-update requestBody: "$ref": "#/components/requestBodies/expense" description: Update an existing expense. get: tags: - Expenses summary: Gets a expense responses: '200': "$ref": "#/components/responses/single_expense" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: expenses-show description: Retrieve a single expense by ID. "/api/v2/survey_responses": post: tags: - Survey Responses summary: Create a survey response responses: '201': "$ref": "#/components/responses/single_survey_response" parameters: - "$ref": "#/components/parameters/header_organization" operationId: survey_responses-create requestBody: "$ref": "#/components/requestBodies/survey_response" description: Create a new survey response. get: tags: - Survey Responses summary: Get survey responses responses: '200': "$ref": "#/components/responses/collection_survey_response" parameters: - "$ref": "#/components/parameters/filter_survey_response" - "$ref": "#/components/parameters/sort_survey_response" - "$ref": "#/components/parameters/header_organization" operationId: survey_responses-index description: List all survey responses. "/api/v2/organizations": get: tags: - Organizations summary: Get organizations responses: '200': "$ref": "#/components/responses/collection_organization" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_organization" - "$ref": "#/components/parameters/sort_organization" operationId: organizations-index description: List organizations. "/api/v2/comments/{id}/add_reaction": patch: tags: - Comments summary: Adds reaction to a comment responses: '200': "$ref": "#/components/responses/single_comment" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: comments-add_reaction-add_reaction description: Add a reaction to a comment. "/api/v2/placeholders": get: tags: - Placeholders summary: Get placeholders responses: '200': "$ref": "#/components/responses/collection_placeholder" parameters: - "$ref": "#/components/parameters/sort_placeholder" - "$ref": "#/components/parameters/filter_placeholder" - "$ref": "#/components/parameters/header_organization" operationId: placeholders-index description: List all placeholders. post: tags: - Placeholders summary: Create a placeholder responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_placeholder" parameters: - "$ref": "#/components/parameters/header_organization" operationId: placeholders-create requestBody: "$ref": "#/components/requestBodies/placeholder" description: Create a new placeholder. "/api/v2/folders": post: tags: - Folders summary: Create a folder responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: The folder could not be created due to validation errors. '201': "$ref": "#/components/responses/single_folder" parameters: - "$ref": "#/components/parameters/header_organization" operationId: folders-create requestBody: "$ref": "#/components/requestBodies/folder" description: Creates a new folder in a project. get: tags: - Folders summary: Get folders responses: '200': "$ref": "#/components/responses/collection_folder" parameters: - "$ref": "#/components/parameters/filter_folder" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_folder" operationId: folders-index description: Returns a paginated list of folders across all projects. "/api/v2/reports/budget_reports": get: tags: - Reports summary: Get budget reports responses: '200': "$ref": "#/components/responses/collection_budget_report" parameters: - "$ref": "#/components/parameters/group_budget_report" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_budget_report" - "$ref": "#/components/parameters/filter_budget_report" operationId: reports-budget_reports-index description: Retrieve a paginated list of aggregated budget report rows. Supports filtering, grouping, and sorting by budget dimensions and metrics. "/api/v2/overheads/{id}": get: tags: - Overheads summary: Gets an overhead responses: '200': "$ref": "#/components/responses/single_overhead" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: overheads-show description: Retrieve a single overhead record. patch: tags: - Overheads summary: Update an overhead responses: '200': "$ref": "#/components/responses/single_overhead" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: overheads-update requestBody: "$ref": "#/components/requestBodies/overhead" description: Update an overhead record. "/api/v2/prices": post: tags: - Prices summary: Create a price responses: '201': "$ref": "#/components/responses/single_price" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: prices-create requestBody: "$ref": "#/components/requestBodies/price" description: Create a new price. get: tags: - Prices summary: Get prices responses: '200': "$ref": "#/components/responses/collection_price" parameters: - "$ref": "#/components/parameters/filter_price" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_price" operationId: prices-index description: List all prices. "/api/v2/deleted_items": get: tags: - Deleted Items summary: Get deleted items responses: '200': "$ref": "#/components/responses/collection_deleted_item" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_deleted_item" - "$ref": "#/components/parameters/sort_deleted_item" operationId: deleted_items-index description: List deleted items in the recycle bin. "/api/v2/team_memberships": get: tags: - Team Memberships summary: Get team memberships responses: '200': "$ref": "#/components/responses/collection_team_membership" parameters: - "$ref": "#/components/parameters/filter_team_membership" - "$ref": "#/components/parameters/sort_team_membership" - "$ref": "#/components/parameters/header_organization" operationId: team_memberships-index description: List all team memberships. post: tags: - Team Memberships summary: Create a team membership responses: '201': "$ref": "#/components/responses/single_team_membership" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: team_memberships-create requestBody: "$ref": "#/components/requestBodies/team_membership" description: Create a new team membership. "/api/v2/holidays": post: tags: - Holidays summary: Create a holiday responses: '201': "$ref": "#/components/responses/single_holiday" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: holidays-create requestBody: "$ref": "#/components/requestBodies/holiday" description: Create a new holiday. get: tags: - Holidays summary: Get all holidays responses: '200': "$ref": "#/components/responses/collection_holiday" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_holiday" - "$ref": "#/components/parameters/filter_holiday" operationId: holidays-index description: List holidays. "/api/v2/bank_accounts/{id}/restore": patch: tags: - BankAccounts summary: Restores an archived bank account responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '200': "$ref": "#/components/responses/single_bank_account" parameters: - in: path name: id schema: type: string required: true description: The ID of the bank account to restore. - "$ref": "#/components/parameters/header_organization" operationId: bank_accounts-restore-restore description: Restore a bank account. "/api/v2/services": get: tags: - Services summary: Get services responses: '200': "$ref": "#/components/responses/collection_service" parameters: - "$ref": "#/components/parameters/sort_service" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_service" operationId: services-index description: List services with optional filters and pagination. post: tags: - Services summary: Create a service responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_service" parameters: - "$ref": "#/components/parameters/header_organization" operationId: services-create requestBody: "$ref": "#/components/requestBodies/service" description: Create a new service on a deal. "/api/v2/custom_field_sections/{id}": get: tags: - Custom Field Section summary: Gets the custom field section responses: '200': "$ref": "#/components/responses/single_custom_field_section" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: custom_field_sections-show description: Retrieve a single custom field section by ID. patch: tags: - Custom Field Section summary: Updates the custom field section responses: '200': "$ref": "#/components/responses/single_custom_field_section" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: custom_field_sections-update requestBody: "$ref": "#/components/requestBodies/custom_field_section" description: Update a custom field section. "/api/v2/discussions/{id}/subscribe": patch: tags: - Discussions summary: Subscribes to discussion responses: '200': "$ref": "#/components/responses/single_discussion" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: discussions-subscribe-subscribe description: Subscribe to a discussion. "/api/v2/project_assignments": get: tags: - Project Assignments summary: Get project assignments responses: '200': "$ref": "#/components/responses/collection_project_assignment" parameters: - "$ref": "#/components/parameters/sort_project_assignment" - "$ref": "#/components/parameters/filter_project_assignment" - "$ref": "#/components/parameters/header_organization" operationId: project_assignments-index description: List all project assignments. post: tags: - Project Assignments summary: Create a project assignment responses: '201': "$ref": "#/components/responses/single_project_assignment" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: project_assignments-create requestBody: "$ref": "#/components/requestBodies/project_assignment" description: Create a new project assignment. "/api/v2/reports/financial_item_reports": get: tags: - Reports summary: Get financial item reports responses: '200': "$ref": "#/components/responses/collection_financial_item_report" parameters: - "$ref": "#/components/parameters/sort_financial_item_report" - "$ref": "#/components/parameters/filter_financial_item_report" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/group_financial_item_report" operationId: reports-financial_item_reports-index description: Retrieve aggregated financial item report data grouped by configurable dimensions. "/api/v2/companies": post: tags: - Companies summary: Create a company responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_company" parameters: - "$ref": "#/components/parameters/header_organization" operationId: companies-create requestBody: "$ref": "#/components/requestBodies/company" description: Create a new company. get: tags: - Companies summary: Get companies responses: '200': "$ref": "#/components/responses/collection_company" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_company" - "$ref": "#/components/parameters/sort_company" operationId: companies-index description: List companies with optional filters and pagination. "/api/v2/reports/price_reports": get: tags: - Reports summary: Get price reports responses: '200': "$ref": "#/components/responses/collection_price_report" parameters: - "$ref": "#/components/parameters/sort_price_report" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/group_price_report" - "$ref": "#/components/parameters/filter_price_report" operationId: reports-price_reports-index description: Retrieve aggregated price report data grouped by configurable dimensions. "/api/v2/notifications/{id}/read": patch: tags: - Notifications summary: Reads a notification responses: '200': "$ref": "#/components/responses/single_notification" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: notifications-read-read description: Mark a notification as read. "/api/v2/users": get: tags: - Users summary: Gets users responses: '401': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unauthorized '200': "$ref": "#/components/responses/collection_user" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_user" - "$ref": "#/components/parameters/sort_user" operationId: users-index description: List all users. "/api/v2/service_types/{id}/archive": patch: tags: - Service Types summary: Archives a service type responses: '200': "$ref": "#/components/responses/single_service_type" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: service_types-archive-archive description: Archive a service type to deactivate it. "/api/v2/sessions/machine": post: tags: - Sessions summary: Create a machine session responses: '201': content: application/json: {} application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_session" parameters: - "$ref": "#/components/parameters/header_organization" operationId: sessions-machine-machine description: Create a machine session for API access. "/api/v2/deal_statuses": get: tags: - Deal Statuses summary: Get deal statuses responses: '200': "$ref": "#/components/responses/collection_deal_status" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_deal_status" - "$ref": "#/components/parameters/sort_deal_status" operationId: deal_statuses-index description: List deal statuses with optional filters and pagination. post: tags: - Deal Statuses summary: Create a deal status responses: '201': "$ref": "#/components/responses/single_deal_status" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: deal_statuses-create requestBody: "$ref": "#/components/requestBodies/deal_status" description: Create a new deal status. "/api/v2/pulses/{id}": patch: tags: - Pulses summary: Updates a pulse responses: '200': "$ref": "#/components/responses/single_pulse" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: pulses-update requestBody: "$ref": "#/components/requestBodies/pulse" description: Update a pulse. delete: tags: - Pulses summary: Deletes a pulse responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: pulses-destroy description: Delete a pulse by ID. get: tags: - Pulses summary: Gets a pulse responses: '200': "$ref": "#/components/responses/single_pulse" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: pulses-show description: Retrieve a single pulse by ID. "/api/v2/timers": post: tags: - Timers summary: Create an timer responses: '201': "$ref": "#/components/responses/single_timer" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: timers-create requestBody: "$ref": "#/components/requestBodies/timer" description: Create a new timer. get: tags: - Timers summary: Get timers responses: '200': "$ref": "#/components/responses/collection_timer" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_timer" - "$ref": "#/components/parameters/sort_timer" operationId: timers-index description: List all timers. "/api/v2/holiday_calendars": get: tags: - Holiday calendars summary: Get all holiday calendars responses: '200': "$ref": "#/components/responses/collection_holiday_calendar" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_holiday_calendar" - "$ref": "#/components/parameters/filter_holiday_calendar" operationId: holiday_calendars-index description: List holiday calendars. post: tags: - Holiday calendars summary: Create a holiday calendar responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_holiday_calendar" parameters: - "$ref": "#/components/parameters/header_organization" operationId: holiday_calendars-create requestBody: "$ref": "#/components/requestBodies/holiday_calendar" description: Create a new holiday calendar. "/api/v2/survey_field_options/{id}": patch: tags: - Survey Field Options summary: Updates a survey field option responses: '200': "$ref": "#/components/responses/single_survey_field_option" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: The ID of the survey field option to update. - "$ref": "#/components/parameters/header_organization" operationId: survey_field_options-update requestBody: "$ref": "#/components/requestBodies/survey_field_option" description: Update a survey field option. get: tags: - Survey Field Options summary: Gets a survey field option responses: '200': "$ref": "#/components/responses/single_survey_field_option" parameters: - in: path name: id schema: type: string required: true description: The ID of the survey field option to retrieve. - "$ref": "#/components/parameters/header_organization" operationId: survey_field_options-show description: Retrieve a single survey field option by ID. "/api/v2/tags": get: tags: - Tags summary: Get tags responses: '200': "$ref": "#/components/responses/collection_tag" parameters: - "$ref": "#/components/parameters/sort_tag" - "$ref": "#/components/parameters/filter_tag" - "$ref": "#/components/parameters/header_organization" operationId: tags-index description: List all tags. "/api/v2/task_lists/{id}": patch: tags: - Task Lists summary: Update a task list responses: '200': "$ref": "#/components/responses/single_task_list" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: task_lists-update requestBody: "$ref": "#/components/requestBodies/task_list" description: Update a task list. get: tags: - Task Lists summary: Gets a task list responses: '200': "$ref": "#/components/responses/single_task_list" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: task_lists-show description: Retrieve a single task list by ID. "/api/v2/sections": get: tags: - Sections summary: Get sections responses: '200': "$ref": "#/components/responses/collection_section" parameters: - "$ref": "#/components/parameters/filter_section" - "$ref": "#/components/parameters/sort_section" - "$ref": "#/components/parameters/header_organization" operationId: sections-index description: List all sections. post: tags: - Sections summary: Create a section responses: '201': "$ref": "#/components/responses/single_section" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: sections-create requestBody: "$ref": "#/components/requestBodies/section" description: Create a new section. "/api/v2/dashboards/copy": post: tags: - Dashboards summary: Copy a dashboard responses: '200': "$ref": "#/components/responses/single_dashboard" '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created parameters: - "$ref": "#/components/parameters/header_organization" operationId: dashboards-copy-copy description: Copy a dashboard. "/api/v2/time_entry_versions": get: tags: - Time Entry Versions summary: Get time entry versions responses: '200': "$ref": "#/components/responses/collection_time_entry_version" parameters: - "$ref": "#/components/parameters/sort_time_entry_version" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_time_entry_version" operationId: time_entry_versions-index description: List all time entry versions. "/api/v2/workflows/{id}/restore": patch: tags: - Workflows summary: Restores a workflow responses: '200': "$ref": "#/components/responses/single_workflow" '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: workflows-restore-restore description: Restore an archived workflow. "/api/v2/payment_reminder_sequences": post: tags: - Payment reminder sequences summary: Create a payment reminder sequence responses: '201': "$ref": "#/components/responses/single_payment_reminder_sequence" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: payment_reminder_sequences-create requestBody: "$ref": "#/components/requestBodies/payment_reminder_sequence" description: Create a new payment reminder sequence. get: tags: - Payment reminder sequences summary: Get payment reminder sequences responses: '200': "$ref": "#/components/responses/collection_payment_reminder_sequence" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_payment_reminder_sequence" - "$ref": "#/components/parameters/sort_payment_reminder_sequence" operationId: payment_reminder_sequences-index description: List all payment reminder sequences. "/api/v2/holidays/{id}": get: tags: - Holidays summary: Get a holiday responses: '200': "$ref": "#/components/responses/single_holiday" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: holidays-show description: Retrieve a single holiday. patch: tags: - Holidays summary: Update a holiday responses: '200': "$ref": "#/components/responses/single_holiday" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: holidays-update requestBody: "$ref": "#/components/requestBodies/holiday" description: Update a holiday. delete: tags: - Holidays summary: Deletes a holiday responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: holidays-destroy description: Delete a holiday. "/api/v2/folders/copy": post: tags: - Folders summary: Copy a folder responses: '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: The folder was successfully copied. '200': "$ref": "#/components/responses/single_folder" parameters: - "$ref": "#/components/parameters/header_organization" operationId: folders-copy-copy description: Creates a copy of an existing folder, including its task lists. "/api/v2/time_tracking_policies": get: tags: - Time Tracking Policies summary: Get time tracking policies responses: '200': "$ref": "#/components/responses/collection_time_tracking_policy" parameters: - "$ref": "#/components/parameters/sort_time_tracking_policy" - "$ref": "#/components/parameters/filter_time_tracking_policy" - "$ref": "#/components/parameters/header_organization" operationId: time_tracking_policies-index description: List all time tracking policies. post: tags: - Time Tracking Policies summary: Create a time tracking policy responses: '201': "$ref": "#/components/responses/single_time_tracking_policy" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: time_tracking_policies-create requestBody: "$ref": "#/components/requestBodies/time_tracking_policy" description: Create a new time tracking policy. "/api/v2/boards/{id}/reposition": patch: tags: - Boards summary: Repoisition a board responses: '200': "$ref": "#/components/responses/single_board" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: boards-reposition-reposition description: Reposition a board. "/api/v2/bills": post: tags: - Bills summary: Create a bill responses: '201': "$ref": "#/components/responses/single_bill" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: bills-create requestBody: "$ref": "#/components/requestBodies/bill" description: Create a new bill. "/api/v2/placeholders/{id}": delete: tags: - Placeholders summary: Deletes a placeholder responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the placeholder to delete. operationId: placeholders-destroy description: Delete a placeholder by ID. patch: tags: - Placeholders summary: Update a placeholder responses: '200': "$ref": "#/components/responses/single_placeholder" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the placeholder to update. operationId: placeholders-update requestBody: "$ref": "#/components/requestBodies/placeholder" description: Update a placeholder. get: tags: - Placeholders summary: Gets a placeholder responses: '200': "$ref": "#/components/responses/single_placeholder" parameters: - in: path name: id schema: type: string required: true description: The ID of the placeholder to retrieve. - "$ref": "#/components/parameters/header_organization" operationId: placeholders-show description: Retrieve a single placeholder by ID. "/api/v2/purchase_orders/{id}/send": patch: tags: - Purchase Orders summary: Sends a purchase order responses: '200': "$ref": "#/components/responses/single_purchase_order" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: purchase_orders-send-send_mail requestBody: "$ref": "#/components/requestBodies/purchase_order_send" description: Send a purchase order to a vendor. "/api/v2/payments": post: tags: - Payments summary: Create a payment responses: '201': "$ref": "#/components/responses/single_payment" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: payments-create requestBody: "$ref": "#/components/requestBodies/payment" description: Create a new payment. get: tags: - Payments summary: Get payments responses: '200': "$ref": "#/components/responses/collection_payment" parameters: - "$ref": "#/components/parameters/sort_payment" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_payment" operationId: payments-index description: List all payments. "/api/v2/report_categories/{id}": patch: tags: - Report Category summary: Update a report category responses: '200': "$ref": "#/components/responses/single_report_category" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: report_categories-update requestBody: "$ref": "#/components/requestBodies/report_category" description: Update an existing report category. get: tags: - Report Category summary: Gets a report category responses: '200': "$ref": "#/components/responses/single_report_category" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: report_categories-show description: Retrieve a specific report category by ID. delete: tags: - Report Category summary: Deletes a report category responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: report_categories-destroy description: Delete a report category. "/api/v2/deal_cost_rates/{id}": patch: tags: - Deal Cost Rates summary: Update a deal cost rate responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_deal_cost_rate" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: deal_cost_rates-update requestBody: "$ref": "#/components/requestBodies/deal_cost_rate" description: Update a deal cost rate. get: tags: - Deal Cost Rates summary: Gets a deal cost rate responses: '200': "$ref": "#/components/responses/single_deal_cost_rate" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: deal_cost_rates-show description: Retrieve a single deal cost rate by ID. delete: tags: - Deal Cost Rates summary: Deletes a deal cost rate responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: deal_cost_rates-destroy description: Delete a deal cost rate. "/api/v2/service_assignments/{id}": get: tags: - Service Assignments summary: Gets a service assignment responses: '200': "$ref": "#/components/responses/single_service_assignment" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: service_assignments-show description: Retrieve a single service assignment by ID. delete: tags: - Service Assignments summary: Deletes a service assignment responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: service_assignments-destroy description: Delete a service assignment by ID. patch: tags: - Service Assignments summary: Update a service assignment responses: '200': "$ref": "#/components/responses/single_service_assignment" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: service_assignments-update requestBody: "$ref": "#/components/requestBodies/service_assignment" description: Update a service assignment. "/api/v2/people/{id}/restore": patch: tags: - People summary: Restore a person responses: '200': "$ref": "#/components/responses/single_person" '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: The person could not be restored due to validation errors. parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: people-restore-restore description: Restore an archived person, making them active again. "/api/v2/line_items/generate": post: tags: - Line Items summary: Create line items responses: '200': "$ref": "#/components/responses/single_line_item" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: line_items-generate-generate description: | The `generate` method provides a way to automatically create line items for an invoice based on the provided invoicing method. This [help article](https://help.productive.io/en/articles/4656350-understanding-invoicing-methods) explains the supported invoicing methods. "/api/v2/invoices/{id}/finalize": patch: tags: - Invoices summary: Finalizes an invoice responses: '200': "$ref": "#/components/responses/single_invoice" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: invoices-finalize-finalize description: Finalize a draft invoice. "/api/v2/subsidiaries": get: tags: - Subsidiaries summary: Gets all subsidiaries responses: '200': "$ref": "#/components/responses/collection_subsidiary" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_subsidiary" - "$ref": "#/components/parameters/sort_subsidiary" operationId: subsidiaries-index description: List all subsidiaries. post: tags: - Subsidiaries summary: Create a subsidiary responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_subsidiary" parameters: - "$ref": "#/components/parameters/header_organization" operationId: subsidiaries-create requestBody: "$ref": "#/components/requestBodies/subsidiary" description: Create a new subsidiary. "/api/v2/organizations/{id}/resend_code": patch: tags: - Organizations summary: Resend verification code responses: '204': content: any: {} headers: {} description: No Content '200': "$ref": "#/components/responses/single_organization" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: organizations-resend_code-resend_code description: Resend the verification code for an organization. "/api/v2/organizations/{id}": get: tags: - Organizations summary: Get an organization responses: '200': "$ref": "#/components/responses/single_organization" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: organizations-show description: Retrieve a single organization. patch: tags: - Organizations summary: Update an organization responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_organization" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: organizations-update requestBody: "$ref": "#/components/requestBodies/organization" description: Update an organization. delete: tags: - Organizations summary: Delete an organization responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: organizations-destroy description: Delete an organization. "/api/v2/passwords/{id}": patch: tags: - Passwords summary: Update a password responses: '200': "$ref": "#/components/responses/single_password" '204': content: any: {} headers: {} description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: passwords-update requestBody: "$ref": "#/components/requestBodies/password" description: Update a password reset. get: tags: - Passwords summary: Gets a password responses: '200': "$ref": "#/components/responses/single_password" '404': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Not Found parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: passwords-show description: Retrieve a single password reset by ID. "/api/v2/reports/person_reports": get: tags: - Reports summary: Get person reports responses: '200': "$ref": "#/components/responses/collection_person_report" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_person_report" - "$ref": "#/components/parameters/group_person_report" - "$ref": "#/components/parameters/sort_person_report" operationId: reports-person_reports-index description: Retrieve aggregated person report data grouped by configurable dimensions. "/api/v2/expenses/{id}/export_update": patch: tags: - Expenses summary: Updates exported expense responses: '200': "$ref": "#/components/responses/single_expense" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: expenses-export_update-export_update description: Update the export status of an expense in the external accounting system. "/api/v2/deal_statuses/{id}": patch: tags: - Deal Statuses summary: Update a deal status responses: '200': "$ref": "#/components/responses/single_deal_status" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: deal_statuses-update requestBody: "$ref": "#/components/requestBodies/deal_status" description: Update a deal status. get: tags: - Deal Statuses summary: Gets a deal status responses: '200': "$ref": "#/components/responses/single_deal_status" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: deal_statuses-show description: Retrieve a single deal status by ID. delete: tags: - Deal Statuses summary: Destroy a deal status responses: '204': description: No Content '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: deal_statuses-destroy description: Delete a deal status. "/api/v2/rate_cards/{id}/restore": patch: tags: - Rate cards summary: Restores a rate card responses: '200': "$ref": "#/components/responses/single_rate_card" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: rate_cards-restore-restore description: Restore an archived rate card. "/api/v2/automatic_invoicing_rules": get: tags: - Automatic Invoicing Rules summary: Get automatic invoicing rules responses: '200': "$ref": "#/components/responses/collection_automatic_invoicing_rule" parameters: - "$ref": "#/components/parameters/filter_automatic_invoicing_rule" - "$ref": "#/components/parameters/sort_automatic_invoicing_rule" - "$ref": "#/components/parameters/header_organization" operationId: automatic_invoicing_rules-index description: List automatic invoicing rules with optional filters and pagination. post: tags: - Automatic Invoicing Rules summary: Create an automatic invoicing rule responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_automatic_invoicing_rule" parameters: - "$ref": "#/components/parameters/header_organization" operationId: automatic_invoicing_rules-create requestBody: "$ref": "#/components/requestBodies/automatic_invoicing_rule" description: Create a new automatic invoicing rule. "/api/v2/reports/project_reports": get: tags: - Reports summary: Get project reports responses: '200': "$ref": "#/components/responses/collection_project_report" parameters: - "$ref": "#/components/parameters/filter_project_report" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/group_project_report" - "$ref": "#/components/parameters/sort_project_report" operationId: reports-project_reports-index description: Retrieve aggregated project report data grouped by configurable dimensions. "/api/v2/expenses/{id}/unapprove": patch: tags: - Expenses summary: Unapproves an expense responses: '200': "$ref": "#/components/responses/single_expense" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: expenses-unapprove-unapprove description: Unapprove an expense by ID. "/api/v2/project_assignments/{id}": delete: tags: - Project Assignments summary: Deletes a project assignment responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: project_assignments-destroy description: Delete a project assignment by ID. patch: tags: - Project Assignments summary: Update a project assignment responses: '200': "$ref": "#/components/responses/single_project_assignment" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: project_assignments-update requestBody: "$ref": "#/components/requestBodies/project_assignment" description: Update a project assignment. get: tags: - Project Assignments summary: Gets a project assignment responses: '200': "$ref": "#/components/responses/single_project_assignment" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: project_assignments-show description: Retrieve a single project assignment by ID. "/api/v2/bank_accounts/{id}": patch: tags: - BankAccounts summary: Update a bank account responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_bank_account" parameters: - in: path name: id schema: type: string required: true description: The ID of the bank account to update. - "$ref": "#/components/parameters/header_organization" operationId: bank_accounts-update requestBody: "$ref": "#/components/requestBodies/bank_account" description: Update a bank account. get: tags: - BankAccounts summary: Gets a bank account responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '200': "$ref": "#/components/responses/single_bank_account" parameters: - in: path name: id schema: type: string required: true description: The ID of the bank account to retrieve. - "$ref": "#/components/parameters/header_organization" operationId: bank_accounts-show description: Retrieve a single bank account by ID. "/api/v2/placeholder_usages": get: tags: - Placeholder Usages summary: Get placeholder usages responses: '200': "$ref": "#/components/responses/collection_placeholder_usage" parameters: - "$ref": "#/components/parameters/filter_placeholder_usage" - "$ref": "#/components/parameters/sort_placeholder_usage" - "$ref": "#/components/parameters/header_organization" operationId: placeholder_usages-index description: List all placeholder usages. post: tags: - Placeholder Usages summary: Create a placeholder usage responses: '201': "$ref": "#/components/responses/single_placeholder_usage" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: placeholder_usages-create description: Create a new placeholder usage. "/api/v2/reports/page_reports": get: tags: - Reports summary: Get page reports responses: '200': "$ref": "#/components/responses/collection_page_report" parameters: - "$ref": "#/components/parameters/group_page_report" - "$ref": "#/components/parameters/sort_page_report" - "$ref": "#/components/parameters/filter_page_report" - "$ref": "#/components/parameters/header_organization" operationId: reports-page_reports-index description: Retrieve aggregated page report data grouped by configurable dimensions. "/api/v2/custom_field_sections": get: tags: - Custom Field Section summary: Get custom field sections responses: '200': "$ref": "#/components/responses/collection_custom_field_section" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_custom_field_section" - "$ref": "#/components/parameters/sort_custom_field_section" operationId: custom_field_sections-index description: List custom field sections with optional filters and pagination. post: tags: - Custom Field Section summary: Creates the custom field section responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_custom_field_section" parameters: - "$ref": "#/components/parameters/header_organization" operationId: custom_field_sections-create requestBody: "$ref": "#/components/requestBodies/custom_field_section" description: Create a new custom field section. "/api/v2/reports/proposal_reports": get: tags: - Reports summary: Get proposal reports responses: '200': "$ref": "#/components/responses/collection_proposal_report" parameters: - "$ref": "#/components/parameters/sort_proposal_report" - "$ref": "#/components/parameters/group_proposal_report" - "$ref": "#/components/parameters/filter_proposal_report" - "$ref": "#/components/parameters/header_organization" operationId: reports-proposal_reports-index description: Returns a paginated list of proposal report records, suitable for building custom proposal analytics. "/api/v2/entitlements": post: tags: - Entitlements summary: Creates an entitlement responses: '201': "$ref": "#/components/responses/single_entitlement" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: entitlements-create requestBody: "$ref": "#/components/requestBodies/entitlement" description: Create a new entitlement. get: tags: - Entitlements summary: Get entitlements responses: '200': "$ref": "#/components/responses/collection_entitlement" parameters: - "$ref": "#/components/parameters/filter_entitlement" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_entitlement" operationId: entitlements-index description: List entitlements. "/api/v2/people/{id}": get: tags: - People summary: Get a person responses: '200': "$ref": "#/components/responses/single_person" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: people-show description: Retrieve a single person by ID. patch: tags: - People summary: Update a person responses: '200': "$ref": "#/components/responses/single_person" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: people-update requestBody: "$ref": "#/components/requestBodies/person" description: Update an existing person's attributes, relationships, or settings. "/api/v2/time_tracking_policies/{id}/archive": patch: tags: - Time Tracking Policies summary: Archives a time tracking policy responses: '200': "$ref": "#/components/responses/single_time_tracking_policy" parameters: - in: path name: id schema: type: string required: true description: The numeric ID of the time tracking policy. - "$ref": "#/components/parameters/header_organization" operationId: time_tracking_policies-archive-archive description: Archives a time tracking policy. "/api/v2/workflow_statuses": post: tags: - Workflow Statuses summary: Create an workflow status responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_workflow_status" parameters: - "$ref": "#/components/parameters/header_organization" operationId: workflow_statuses-create requestBody: "$ref": "#/components/requestBodies/workflow_status" description: Create a new workflow status. get: tags: - Workflow Statuses summary: Get workflow statuses responses: '200': "$ref": "#/components/responses/collection_workflow_status" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_workflow_status" - "$ref": "#/components/parameters/filter_workflow_status" operationId: workflow_statuses-index description: List all workflow statuses. "/api/v2/document_styles/{id}": get: tags: - Document Styles summary: Gets a document_style responses: '200': "$ref": "#/components/responses/single_document_style" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: document_styles-show description: Retrieve a single document style. patch: tags: - Document Styles summary: Update a document_style responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_document_style" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: document_styles-update requestBody: "$ref": "#/components/requestBodies/document_style" description: Update a document style. delete: tags: - Document Styles summary: Destroys a document style responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: document_styles-destroy description: Delete a document style. "/api/v2/time_tracking_policies/{id}": get: tags: - Time Tracking Policies summary: Gets a time tracking policy responses: '200': "$ref": "#/components/responses/single_time_tracking_policy" parameters: - in: path name: id schema: type: string required: true description: The ID of the time tracking policy to retrieve. - "$ref": "#/components/parameters/header_organization" operationId: time_tracking_policies-show description: Retrieve a single time tracking policy by ID. delete: tags: - Time Tracking Policies summary: Deletes a time tracking policy responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: The ID of the time tracking policy to delete. - "$ref": "#/components/parameters/header_organization" operationId: time_tracking_policies-destroy description: Delete a time tracking policy by ID. patch: tags: - Time Tracking Policies summary: Update a time tracking policy responses: '200': "$ref": "#/components/responses/single_time_tracking_policy" parameters: - in: path name: id schema: type: string required: true description: The ID of the time tracking policy to update. - "$ref": "#/components/parameters/header_organization" operationId: time_tracking_policies-update requestBody: "$ref": "#/components/requestBodies/time_tracking_policy" description: Update a time tracking policy. "/api/v2/invoice_templates": get: tags: - Invoice Templates summary: Get invoice templates responses: '200': "$ref": "#/components/responses/collection_invoice_template" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_invoice_template" - "$ref": "#/components/parameters/sort_invoice_template" operationId: invoice_templates-index description: List invoice templates. post: tags: - Invoice Templates summary: Create an invoice template responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_invoice_template" parameters: - "$ref": "#/components/parameters/header_organization" operationId: invoice_templates-create requestBody: "$ref": "#/components/requestBodies/invoice_template" description: Create a new invoice template. "/api/v2/rate_cards": post: tags: - Rate cards summary: Create a price responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_rate_card" parameters: - "$ref": "#/components/parameters/header_organization" operationId: rate_cards-create requestBody: "$ref": "#/components/requestBodies/rate_card" description: Create a new rate card. get: tags: - Rate cards summary: Get rate cards responses: '200': "$ref": "#/components/responses/collection_rate_card" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_rate_card" - "$ref": "#/components/parameters/filter_rate_card" operationId: rate_cards-index description: List all rate cards. "/api/v2/integrations": get: tags: - Integrations summary: Get integration responses: '200': "$ref": "#/components/responses/collection_integration" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_integration" - "$ref": "#/components/parameters/filter_integration" operationId: integrations-index description: List integrations. post: tags: - Integrations summary: Create an integration responses: '201': "$ref": "#/components/responses/single_integration" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: integrations-create requestBody: "$ref": "#/components/requestBodies/integration" description: Create a new integration. "/api/v2/overheads/{id}/recalculate": patch: tags: - Overheads summary: Recalculate an overhead responses: '200': "$ref": "#/components/responses/single_overhead" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: overheads-recalculate-recalculate description: Recalculate overhead costs for a period. "/api/v2/reports/time_reports": get: tags: - Reports summary: Get time reports responses: '200': "$ref": "#/components/responses/collection_new_time_report" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_new_time_report" - "$ref": "#/components/parameters/group_new_time_report" - "$ref": "#/components/parameters/sort_new_time_report" operationId: reports-time_reports-index description: Retrieve aggregated time report data grouped by configurable dimensions. "/api/v2/workflow_statuses/{id}": patch: tags: - Workflow Statuses summary: Update an workflow status responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_workflow_status" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: workflow_statuses-update requestBody: "$ref": "#/components/requestBodies/workflow_status" description: Update a workflow status. get: tags: - Workflow Statuses summary: Gets a workflow status responses: '200': "$ref": "#/components/responses/single_workflow_status" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: workflow_statuses-show description: Retrieve a single workflow status by ID. delete: tags: - Workflow Statuses summary: Deletes a workflow status and moves tasks to other workflow status responses: '204': description: No Content '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: workflow_statuses-destroy description: Delete a workflow status by ID. "/api/v2/activities": get: tags: - Activities summary: Get activities responses: '200': "$ref": "#/components/responses/collection_activity" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_activity" - "$ref": "#/components/parameters/filter_activity" operationId: activities-index description: List activities with optional filters and pagination. "/api/v2/resource_requests/{id}/reject": patch: tags: - Resource Requests summary: Reject a resource request responses: '200': "$ref": "#/components/responses/single_resource_request" parameters: - in: path name: id schema: type: string required: true description: The ID of the resource request to reject. - "$ref": "#/components/parameters/header_organization" operationId: resource_requests-reject-reject description: Rejects a resource request by ID, setting its status to rejected. "/api/v2/deals/{id}/close": patch: tags: - Deals summary: Closes a deal responses: '200': "$ref": "#/components/responses/single_deal" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: deals-close-close description: Close a deal. "/api/v2/people/{id}/archive": patch: tags: - People summary: Archive a person responses: '200': "$ref": "#/components/responses/single_person" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: people-archive-archive description: Archive a person record. Archived people are hidden from most views and cannot log in. "/api/v2/survey_fields": post: tags: - Survey Fields summary: Creates a survey field responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_survey_field" parameters: - "$ref": "#/components/parameters/header_organization" operationId: survey_fields-create requestBody: "$ref": "#/components/requestBodies/survey_field" description: Create a new survey field. get: tags: - Survey Fields summary: Get survey fields responses: '200': "$ref": "#/components/responses/collection_survey_field" parameters: - "$ref": "#/components/parameters/sort_survey_field" - "$ref": "#/components/parameters/filter_survey_field" - "$ref": "#/components/parameters/header_organization" operationId: survey_fields-index description: List all survey fields. "/api/v2/task_lists/{id}/archive": patch: tags: - Task Lists summary: Archives a task list responses: '200': "$ref": "#/components/responses/single_task_list" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: task_lists-archive-archive description: Archive a task list to deactivate it. "/api/v2/people/{id}/invite": patch: tags: - People summary: Invite a person responses: '200': "$ref": "#/components/responses/single_person" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: people-invite-invite description: 'Action used to invite contacts into your Productive organization. By doing so, the contact can accept that invitation and then become a user. ' "/api/v2/lost_reasons/{id}/archive": patch: tags: - Lost Reasons summary: Archives a lost reason responses: '200': "$ref": "#/components/responses/single_lost_reason" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: lost_reasons-archive-archive description: Archive a lost reason. "/api/v2/proposals/{id}/sync_status": get: tags: - Proposals summary: Get proposal's sync status responses: '200': "$ref": "#/components/responses/single_proposal" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the proposal to check sync status for. operationId: proposals-sync_status-sync_status description: Retrieve the sync status of a proposal. "/api/v2/einvoice_identities/{id}": patch: tags: - E-invoice Identities summary: Updates an e-invoice identity responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Validation error — the request body contains invalid or missing fields. '200': "$ref": "#/components/responses/single_einvoice_identity" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The unique identifier of the resource. operationId: einvoice_identities-update requestBody: "$ref": "#/components/requestBodies/einvoice_identity" description: Updates an existing e-invoice identity. get: tags: - E-invoice Identities summary: Gets an e-invoice identity responses: '200': "$ref": "#/components/responses/single_einvoice_identity" parameters: - in: path name: id schema: type: string required: true description: The unique identifier of the resource. - "$ref": "#/components/parameters/header_organization" operationId: einvoice_identities-show description: Returns a single e-invoice identity by ID. "/api/v2/bookings": post: tags: - Bookings summary: Create a booking responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_booking" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '400': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Bad Request parameters: - "$ref": "#/components/parameters/header_organization" operationId: bookings-create requestBody: "$ref": "#/components/requestBodies/booking" description: Create a new booking. get: tags: - Bookings summary: Get bookings responses: '200': "$ref": "#/components/responses/collection_booking" parameters: - "$ref": "#/components/parameters/sort_booking" - "$ref": "#/components/parameters/filter_booking" - "$ref": "#/components/parameters/header_organization" operationId: bookings-index description: List bookings with optional filters and pagination. "/api/v2/placeholder_usages/{id}": delete: tags: - Placeholder Usages summary: Deletes a placeholder usage responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: The ID of the placeholder usage to delete. - "$ref": "#/components/parameters/header_organization" operationId: placeholder_usages-destroy description: Delete a placeholder usage by ID. get: tags: - Placeholder Usages summary: Gets a placeholder usage responses: '200': "$ref": "#/components/responses/single_placeholder_usage" parameters: - in: path name: id schema: type: string required: true description: The ID of the placeholder usage to retrieve. - "$ref": "#/components/parameters/header_organization" operationId: placeholder_usages-show description: Retrieve a single placeholder usage by ID. patch: tags: - Placeholder Usages summary: Update a placeholder usage responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_placeholder_usage" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the placeholder usage to update. operationId: placeholder_usages-update description: Update a placeholder usage. "/api/v2/boards/{id}/restore": patch: tags: - Boards summary: Restores a board responses: '200': "$ref": "#/components/responses/single_board" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: boards-restore-restore description: Restore a board. "/api/v2/projects/{id}/archive": patch: tags: - Projects summary: Archives a project responses: '200': "$ref": "#/components/responses/single_project" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: projects-archive-archive description: Archive a project. Moves a project to archived status, hiding it from active project lists. "/api/v2/task_lists": get: tags: - Task Lists summary: Get task lists responses: '200': "$ref": "#/components/responses/collection_task_list" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_task_list" - "$ref": "#/components/parameters/filter_task_list" operationId: task_lists-index description: List all task lists. post: tags: - Task Lists summary: Create a task list responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_task_list" parameters: - "$ref": "#/components/parameters/header_organization" operationId: task_lists-create requestBody: "$ref": "#/components/requestBodies/task_list" description: Create a new task list. "/api/v2/document_types/{id}": get: tags: - Document Types summary: Gets a document_type responses: '200': "$ref": "#/components/responses/single_document_type" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: document_types-show description: Retrieve a single document type. patch: tags: - Document Types summary: Update a document_type responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '200': "$ref": "#/components/responses/single_document_type" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: document_types-update requestBody: "$ref": "#/components/requestBodies/document_type" description: Update a document type. "/api/v2/salaries": get: tags: - Salaries summary: Get salaries responses: '200': "$ref": "#/components/responses/collection_salary" parameters: - "$ref": "#/components/parameters/sort_salary" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_salary" operationId: salaries-index description: List all salaries. post: tags: - Salaries summary: Create a salary responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_salary" parameters: - "$ref": "#/components/parameters/header_organization" operationId: salaries-create requestBody: "$ref": "#/components/requestBodies/salary" description: Create a new salary. "/api/v2/contact_entries/{id}": delete: tags: - Contact Entries summary: Deletes a contact entry responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: contact_entries-destroy description: Delete a contact entry. get: tags: - Contact Entries summary: Gets a contact entry responses: '200': "$ref": "#/components/responses/single_contact_entry" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: contact_entries-show description: Retrieve a single contact entry by ID. patch: tags: - Contact Entries summary: Update a contact entry responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_contact_entry" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: contact_entries-update requestBody: "$ref": "#/components/requestBodies/contact_entry" description: Update a contact entry. "/api/v2/sessions/{id}": delete: tags: - Sessions summary: Deletes a session responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: sessions-destroy description: Delete a session (sign out) by ID. "/api/v2/document_styles": post: tags: - Document Styles summary: Create a document_style responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '201': "$ref": "#/components/responses/single_document_style" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: document_styles-create requestBody: "$ref": "#/components/requestBodies/document_style" description: Create a new document style. get: tags: - Document Styles summary: Get document_styles responses: '200': "$ref": "#/components/responses/collection_document_style" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden parameters: - "$ref": "#/components/parameters/filter_document_style" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_document_style" operationId: document_styles-index description: List document styles. "/api/v2/events": post: tags: - Events summary: Create an event responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_event" parameters: - "$ref": "#/components/parameters/header_organization" operationId: events-create requestBody: "$ref": "#/components/requestBodies/event" description: Create a new event. get: tags: - Events summary: Get events responses: '200': "$ref": "#/components/responses/collection_event" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_event" - "$ref": "#/components/parameters/sort_event" operationId: events-index description: List events. "/api/v2/task_lists/{id}/reposition": patch: tags: - Task Lists summary: Repoisition a task list responses: '200': "$ref": "#/components/responses/single_task_list" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: task_lists-reposition-reposition description: Reposition a task list within its folder. "/api/v2/reports/booking_reports": get: tags: - Reports summary: Get booking reports responses: '200': "$ref": "#/components/responses/collection_booking_report" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_booking_report" - "$ref": "#/components/parameters/sort_booking_report" - "$ref": "#/components/parameters/group_booking_report" operationId: reports-booking_reports-index description: Retrieve aggregated booking report data grouped by configurable dimensions. "/api/v2/integrations/{id}/check": get: tags: - Integrations summary: Checks if integration is valid responses: '405': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Method Not Allowed '200': "$ref": "#/components/responses/single_integration" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: integrations-check-check description: Check the connection status of an integration. "/api/v2/deal_cost_rates": get: tags: - Deal Cost Rates summary: Get deal cost rates responses: '200': "$ref": "#/components/responses/collection_deal_cost_rate" parameters: - "$ref": "#/components/parameters/sort_deal_cost_rate" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_deal_cost_rate" operationId: deal_cost_rates-index description: List deal cost rates with optional filters and pagination. post: tags: - Deal Cost Rates summary: Create a deal cost rate responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_deal_cost_rate" parameters: - "$ref": "#/components/parameters/header_organization" operationId: deal_cost_rates-create requestBody: "$ref": "#/components/requestBodies/deal_cost_rate" description: Create a new deal cost rate. "/api/v2/purchase_orders": post: tags: - Purchase Orders summary: Create a purchase order responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_purchase_order" parameters: - "$ref": "#/components/parameters/header_organization" operationId: purchase_orders-create requestBody: "$ref": "#/components/requestBodies/purchase_order" description: Create a new purchase order. get: tags: - Purchase Orders summary: Get purchase orders responses: '200': "$ref": "#/components/responses/collection_purchase_order" parameters: - "$ref": "#/components/parameters/sort_purchase_order" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_purchase_order" operationId: purchase_orders-index description: Lists purchase orders in the current account with pagination, filtering, sorting, and sparse fieldsets. Returns a JSON:API collection of `purchase_orders` resources. delete: tags: - Purchase Orders - Bulk summary: Delete purchase orders responses: '204': description: Purchase orders deleted successfully. No response body. parameters: - "$ref": "#/components/parameters/header_organization" operationId: purchase_orders-destroy-bulk description: Bulk-deletes purchase orders by ID in a single request. patch: tags: - Purchase Orders - Bulk summary: Update purchase orders responses: '200': "$ref": "#/components/responses/collection_purchase_order" parameters: - "$ref": "#/components/parameters/header_organization" operationId: purchase_orders-update-bulk requestBody: "$ref": "#/components/requestBodies/purchase_order" description: Bulk-updates multiple purchase orders in a single request. Accepts a JSON:API array of partial `purchase_orders` resources keyed by ID. "/api/v2/automatic_invoicing_rules/{id}": delete: tags: - Automatic Invoicing Rules summary: Deletes an automatic invoicing rule responses: '204': description: No Content parameters: - in: path name: id schema: type: string required: true description: The ID of the automatic invoicing rule to delete. - "$ref": "#/components/parameters/header_organization" operationId: automatic_invoicing_rules-destroy description: Delete an automatic invoicing rule. patch: tags: - Automatic Invoicing Rules summary: Update an automatic invoicing rule responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_automatic_invoicing_rule" parameters: - in: path name: id schema: type: string required: true description: The ID of the automatic invoicing rule to update. - "$ref": "#/components/parameters/header_organization" operationId: automatic_invoicing_rules-update requestBody: "$ref": "#/components/requestBodies/automatic_invoicing_rule" description: Update an automatic invoicing rule. get: tags: - Automatic Invoicing Rules summary: Gets an automatic invoicing rule responses: '200': "$ref": "#/components/responses/single_automatic_invoicing_rule" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the automatic invoicing rule to retrieve. operationId: automatic_invoicing_rules-show description: Retrieve a single automatic invoicing rule by ID. "/api/v2/resource_requests": post: tags: - Resource Requests summary: Create a resource request responses: '201': "$ref": "#/components/responses/single_resource_request" '400': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: The request body is missing required fields or contains invalid data. '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: The resource request could not be created due to validation errors. parameters: - "$ref": "#/components/parameters/header_organization" operationId: resource_requests-create description: Creates a new resource request for a service. get: tags: - Resource Requests summary: Get resource requests responses: '200': "$ref": "#/components/responses/collection_resource_request" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_resource_request" - "$ref": "#/components/parameters/sort_resource_request" operationId: resource_requests-index description: Returns a paginated list of resource requests, optionally filtered and sorted. "/api/v2/companies/{id}/restore": patch: tags: - Companies summary: Restores a company responses: '200': "$ref": "#/components/responses/single_company" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: companies-restore-restore description: Restore a company. "/api/v2/folders/{id}": patch: tags: - Folders summary: Update a folder responses: '200': "$ref": "#/components/responses/single_folder" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: The folder could not be updated due to validation errors. parameters: - in: path name: id schema: type: string required: true description: The numeric ID of the folder. - "$ref": "#/components/parameters/header_organization" operationId: folders-update requestBody: "$ref": "#/components/requestBodies/folder" description: Updates an existing folder. get: tags: - Folders summary: Gets a folder responses: '200': "$ref": "#/components/responses/single_folder" parameters: - in: path name: id schema: type: string required: true description: The numeric ID of the folder. - "$ref": "#/components/parameters/header_organization" operationId: folders-show description: Returns a single folder by ID. "/api/v2/service_types/{id}": patch: tags: - Service Types summary: Update a service type responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_service_type" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: service_types-update requestBody: "$ref": "#/components/requestBodies/service_type" description: Update a service type. get: tags: - Service Types summary: Gets a service type responses: '200': "$ref": "#/components/responses/single_service_type" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: service_types-show description: Retrieve a single service type by ID. "/api/v2/reports/service_reports": get: tags: - Reports summary: Get service reports responses: '200': "$ref": "#/components/responses/collection_service_report" parameters: - "$ref": "#/components/parameters/sort_service_report" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/group_service_report" - "$ref": "#/components/parameters/filter_service_report" operationId: reports-service_reports-index description: Retrieve aggregated service report data grouped by configurable dimensions. "/api/v2/custom_field_options/{id}": get: tags: - Custom Field Options summary: Gets a custom field option responses: '200': "$ref": "#/components/responses/single_custom_field_option" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: custom_field_options-show description: Retrieve a single custom field option by ID. patch: tags: - Custom Field Options summary: Updates a custom field option responses: '200': "$ref": "#/components/responses/single_custom_field_option" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: custom_field_options-update requestBody: "$ref": "#/components/requestBodies/custom_field_option" description: Update a custom field option. "/api/v2/todos": get: tags: - Todos summary: Get todos responses: '200': "$ref": "#/components/responses/collection_todo" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_todo" - "$ref": "#/components/parameters/filter_todo" operationId: todos-index description: List all todos. post: tags: - Todos summary: Create a todo responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '201': "$ref": "#/components/responses/single_todo" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: todos-create requestBody: "$ref": "#/components/requestBodies/todo" description: Create a new todo. "/api/v2/reports/salary_reports": get: tags: - Reports summary: Get salary reports responses: '200': "$ref": "#/components/responses/collection_new_salary_report" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/group_new_salary_report" - "$ref": "#/components/parameters/sort_new_salary_report" - "$ref": "#/components/parameters/filter_new_salary_report" operationId: reports-salary_reports-index description: Retrieve aggregated salary report data grouped by configurable dimensions. "/api/v2/integration_exporter_configurations/{id}": get: tags: - Integration Exporter Configuration summary: Get integration exporter configuration responses: '200': "$ref": "#/components/responses/single_integration_exporter_configuration" parameters: - in: path name: id schema: type: string required: true description: The ID of the integration exporter configuration to retrieve. - "$ref": "#/components/parameters/header_organization" operationId: integration_exporter_configurations-show description: Retrieve a single integration exporter configuration. patch: tags: - Integration Exporter Configuration summary: Update integration exporter configuration responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_integration_exporter_configuration" parameters: - in: path name: id schema: type: string required: true description: The ID of the integration exporter configuration to update. - "$ref": "#/components/parameters/header_organization" operationId: integration_exporter_configurations-update requestBody: "$ref": "#/components/requestBodies/integration_exporter_configuration" description: Update an integration exporter configuration. delete: tags: - Integration Exporter Configuration summary: Delete integration exporter configuration responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the integration exporter configuration to delete. operationId: integration_exporter_configurations-destroy description: Delete an integration exporter configuration. "/api/v2/approval_policies/{id}/archive": patch: tags: - Approval Policy summary: Archives the approval policy responses: '200': "$ref": "#/components/responses/single_approval_policy" '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the approval policy to archive. operationId: approval_policies-archive-archive description: Archive an approval policy. "/api/v2/bank_accounts": get: tags: - BankAccounts summary: Get bank accounts responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '200': "$ref": "#/components/responses/collection_bank_account" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_bank_account" - "$ref": "#/components/parameters/filter_bank_account" operationId: bank_accounts-index description: List bank accounts with optional filters and pagination. post: tags: - BankAccounts summary: Create a bank account responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_bank_account" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden parameters: - "$ref": "#/components/parameters/header_organization" operationId: bank_accounts-create requestBody: "$ref": "#/components/requestBodies/bank_account" description: Create a new bank account. "/api/v2/document_types/copy": post: tags: - Document Types summary: Duplicates a document type responses: '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '200': "$ref": "#/components/responses/single_document_type" parameters: - "$ref": "#/components/parameters/header_organization" operationId: document_types-copy-copy description: Copy an existing document type. "/api/v2/users/{id}/update_password": patch: tags: - Users summary: Update password for a user responses: '200': "$ref": "#/components/responses/single_user" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: users-update_password-update_password description: Update the password for a user. "/api/v2/invoices/{id}/send": patch: tags: - Invoices summary: Sends an invoice responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_invoice" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: invoices-send-send_mail description: Send an invoice to the client. "/api/v2/roles": get: tags: - Permission Sets summary: Get permission sets responses: '200': "$ref": "#/components/responses/collection_role" parameters: - "$ref": "#/components/parameters/filter_role" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_role" operationId: roles-index description: List all roles. post: tags: - Permission Sets summary: Create a permission set responses: '201': "$ref": "#/components/responses/single_role" parameters: - "$ref": "#/components/parameters/header_organization" operationId: roles-create requestBody: "$ref": "#/components/requestBodies/role" "/api/v2/resource_requests/{id}": patch: tags: - Resource Requests summary: Update a resource request responses: '200': "$ref": "#/components/responses/single_resource_request" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: The resource request could not be updated due to validation errors. parameters: - in: path name: id schema: type: string required: true description: The ID of the resource request to update. - "$ref": "#/components/parameters/header_organization" operationId: resource_requests-update description: Updates an existing resource request by ID. get: tags: - Resource Requests summary: Gets a resource request responses: '200': "$ref": "#/components/responses/single_resource_request" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The ID of the resource request to retrieve. operationId: resource_requests-show description: Returns a single resource request by ID. delete: tags: - Resource Requests summary: Deletes a resource request responses: '204': description: The resource request was successfully deleted. parameters: - in: path name: id schema: type: string required: true description: The ID of the resource request to delete. - "$ref": "#/components/parameters/header_organization" operationId: resource_requests-destroy description: Deletes a resource request by ID. "/api/v2/contact_entries": get: tags: - Contact Entries summary: Get contact entries responses: '200': "$ref": "#/components/responses/collection_contact_entry" parameters: - "$ref": "#/components/parameters/filter_contact_entry" - "$ref": "#/components/parameters/sort_contact_entry" - "$ref": "#/components/parameters/header_organization" operationId: contact_entries-index description: List contact entries with optional filters and pagination. post: tags: - Contact Entries summary: Create a contact entry responses: '201': "$ref": "#/components/responses/single_contact_entry" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: contact_entries-create requestBody: "$ref": "#/components/requestBodies/contact_entry" description: Create a new contact entry. "/api/v2/comments/{id}/remove_reaction": patch: tags: - Comments summary: Removes reaction from comment responses: '200': "$ref": "#/components/responses/single_comment" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: comments-remove_reaction-remove_reaction description: Remove a reaction from a comment. "/api/v2/filters": get: tags: - Filters summary: Get filters responses: '200': "$ref": "#/components/responses/collection_filter" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_filter" - "$ref": "#/components/parameters/sort_filter" operationId: filters-index description: List filters. post: tags: - Filters summary: Create a filter responses: '201': "$ref": "#/components/responses/single_filter" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: filters-create requestBody: "$ref": "#/components/requestBodies/filter" description: Create a new filter. "/api/v2/contracts/{id}/generate": post: tags: - Contracts summary: Generates new budget responses: '200': "$ref": "#/components/responses/single_contract" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: contracts-generate-generate description: Generate a contract. "/api/v2/rate_cards/{id}/archive": patch: tags: - Rate cards summary: Archives a rate card responses: '200': "$ref": "#/components/responses/single_rate_card" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: rate_cards-archive-archive description: Archive a rate card to deactivate it. "/api/v2/folders/{id}/archive": patch: tags: - Folders summary: Archives a folder responses: '200': "$ref": "#/components/responses/single_folder" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The numeric ID of the folder. operationId: folders-archive-archive description: Archives a folder, hiding it from the default view while preserving its data. "/api/v2/people/{id}/virtualize": patch: tags: - People summary: Virtualize a person responses: '200': "$ref": "#/components/responses/single_person" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: people-virtualize-virtualize description: Convert a person to a virtual (non-seat) record, used for system or integration purposes. "/api/v2/discussions/{id}/resolve": patch: tags: - Discussions summary: Resolves a discussion responses: '200': "$ref": "#/components/responses/single_discussion" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: discussions-resolve-resolve description: Resolve an open discussion. "/api/v2/task_lists/copy": post: tags: - Task Lists summary: Copies a task list responses: '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created '200': "$ref": "#/components/responses/single_task_list" parameters: - "$ref": "#/components/parameters/header_organization" operationId: task_lists-copy-copy description: Copy an existing task list. "/api/v2/boards/copy": post: tags: - Boards summary: Copy a board responses: '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created '200': "$ref": "#/components/responses/single_board" parameters: - "$ref": "#/components/parameters/header_organization" operationId: boards-copy-copy description: Copy a board. "/api/v2/reports/company_reports": get: tags: - Reports summary: Get company reports responses: '200': "$ref": "#/components/responses/collection_company_report" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_company_report" - "$ref": "#/components/parameters/group_company_report" - "$ref": "#/components/parameters/sort_company_report" operationId: reports-company_reports-index description: Retrieve aggregated company report data grouped by configurable dimensions. "/api/v2/workflows": post: tags: - Workflows summary: Create an workflow responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '201': "$ref": "#/components/responses/single_workflow" parameters: - "$ref": "#/components/parameters/header_organization" operationId: workflows-create requestBody: "$ref": "#/components/requestBodies/workflow" description: Create a new workflow. get: tags: - Workflows summary: Get workflows responses: '200': "$ref": "#/components/responses/collection_workflow" parameters: - "$ref": "#/components/parameters/sort_workflow" - "$ref": "#/components/parameters/filter_workflow" - "$ref": "#/components/parameters/header_organization" operationId: workflows-index description: List all workflows. "/api/v2/custom_fields/{id}": get: tags: - Custom Fields summary: Gets a custom field responses: '200': "$ref": "#/components/responses/single_custom_field" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: custom_fields-show description: Retrieve a single custom field by ID. patch: tags: - Custom Fields summary: Updates a custom field responses: '200': "$ref": "#/components/responses/single_custom_field" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: custom_fields-update requestBody: "$ref": "#/components/requestBodies/custom_field" description: Update a custom field. "/api/v2/service_assignments": get: tags: - Service Assignments summary: Get service assignments responses: '200': "$ref": "#/components/responses/collection_service_assignment" parameters: - "$ref": "#/components/parameters/sort_service_assignment" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_service_assignment" operationId: service_assignments-index description: List all service assignments. post: tags: - Service Assignments summary: Create a service assignment responses: '201': "$ref": "#/components/responses/single_service_assignment" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: service_assignments-create requestBody: "$ref": "#/components/requestBodies/service_assignment" description: Create a new service assignment. "/api/v2/custom_fields/{id}/archive": patch: tags: - Custom Fields summary: Archives a custom field responses: '200': "$ref": "#/components/responses/single_custom_field" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: custom_fields-archive-archive description: Archive a custom field. "/api/v2/time_entries/{id}/unapprove": patch: tags: - Time Entries summary: Unapproves a time entry responses: '200': "$ref": "#/components/responses/single_time_entry" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: time_entries-unapprove-unapprove description: Revoke approval of a time entry. "/api/v2/organization_subscriptions/{id}/retry_last_payment": patch: tags: - Organization Subscriptions summary: Retry last payment for a organization subscription responses: '200': "$ref": "#/components/responses/single_organization_subscription" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: organization_subscriptions-retry_last_payment-retry_last_payment description: Retry the last failed payment for an organization subscription. "/api/v2/projects/{id}/restore": patch: tags: - Projects summary: Restores a project responses: '200': "$ref": "#/components/responses/single_project" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: projects-restore-restore description: Restore a project. Restores an archived project back to active status. "/api/v2/widgets": get: tags: - Widgets summary: Get all widgets responses: '200': "$ref": "#/components/responses/collection_widget" parameters: - "$ref": "#/components/parameters/sort_widget" - "$ref": "#/components/parameters/filter_widget" - "$ref": "#/components/parameters/header_organization" operationId: widgets-index description: List all widgets. post: tags: - Widgets summary: Create a widget responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_widget" parameters: - "$ref": "#/components/parameters/header_organization" operationId: widgets-create requestBody: "$ref": "#/components/requestBodies/widget" description: Create a new widget. "/api/v2/people/{id}/regenerate_recovery_codes": patch: tags: - People summary: Regenerate 2FA recovery codes responses: '204': content: any: {} headers: {} description: No Content '200': "$ref": "#/components/responses/single_person" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: people-regenerate_recovery_codes-regenerate_recovery_codes description: Regenerate two-factor authentication recovery codes for the person. "/api/v2/people/{id}/resend": patch: tags: - People summary: Resend email to a person responses: '200': "$ref": "#/components/responses/single_person" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: people-resend-resend description: Resend the invitation email to a person who has not yet accepted their invite. "/api/v2/timers/{id}": get: tags: - Timers summary: Gets a timer responses: '200': "$ref": "#/components/responses/single_timer" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: timers-show description: Retrieve a single timer by ID. "/api/v2/people/{id}/deactivate": patch: tags: - People summary: Deactivate a person responses: '200': "$ref": "#/components/responses/single_person" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: people-deactivate-deactivate description: Deactivate a person, removing their platform access. Their data is retained. "/api/v2/contracts/{id}": get: tags: - Contracts summary: Gets a contract responses: '200': "$ref": "#/components/responses/single_contract" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: contracts-show description: Retrieve a single contract by ID. patch: tags: - Contracts summary: Update a contract responses: '200': "$ref": "#/components/responses/single_contract" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: contracts-update requestBody: "$ref": "#/components/requestBodies/contract" description: Update a contract. delete: tags: - Contracts summary: Deletes a contract responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: contracts-destroy description: Delete a contract. "/api/v2/discussions/{id}/unsubscribe": patch: tags: - Discussions summary: Unsubscribes from discussion responses: '200': "$ref": "#/components/responses/single_discussion" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: discussions-unsubscribe-unsubscribe description: Unsubscribe from a discussion. "/api/v2/dashboards/{id}": get: tags: - Dashboards summary: Get a dashboard responses: '200': "$ref": "#/components/responses/single_dashboard" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: dashboards-show description: Retrieve a single dashboard by ID. delete: tags: - Dashboards summary: Delete a dashboard responses: '204': description: No Content parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: dashboards-destroy description: Delete a dashboard. patch: tags: - Dashboards summary: Update a dashboard responses: '200': "$ref": "#/components/responses/single_dashboard" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: dashboards-update requestBody: "$ref": "#/components/requestBodies/dashboard" description: Update a dashboard. "/api/v2/notifications/{id}": get: tags: - Notifications summary: Shows a notification responses: '200': "$ref": "#/components/responses/single_notification" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: notifications-show description: Retrieve a single notification. "/api/v2/projects/{id}/change_workflow": patch: tags: - Projects summary: Changes workflow on project responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '200': "$ref": "#/components/responses/single_project" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: projects-change_workflow-change_workflow description: Change workflow. Changes the task workflow used by this project, remapping existing task statuses to the new workflow. "/api/v2/reports/invoice_reports": get: tags: - Reports summary: Get invoice reports responses: '200': "$ref": "#/components/responses/collection_invoice_report" parameters: - "$ref": "#/components/parameters/sort_invoice_report" - "$ref": "#/components/parameters/group_invoice_report" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_invoice_report" operationId: reports-invoice_reports-index description: Retrieve aggregated invoice report data grouped by configurable dimensions. "/api/v2/overheads": get: tags: - Overheads summary: Get overheads responses: '200': "$ref": "#/components/responses/collection_overhead" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_overhead" - "$ref": "#/components/parameters/sort_overhead" operationId: overheads-index description: List overheads. "/api/v2/organization_subscriptions/{id}": patch: tags: - Organization Subscriptions summary: Update a organization subscription responses: '200': "$ref": "#/components/responses/single_organization_subscription" '402': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Payment Required '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: organization_subscriptions-update requestBody: "$ref": "#/components/requestBodies/organization_subscription" description: Update an organization subscription. get: tags: - Organization Subscriptions summary: Gets a organization subscription responses: '200': "$ref": "#/components/responses/single_organization_subscription" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: organization_subscriptions-show description: Retrieve a single organization subscription. "/api/v2/custom_field_sections/{id}/archive": patch: tags: - Custom Field Section summary: Archives the custom field section responses: '200': "$ref": "#/components/responses/single_custom_field_section" '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: custom_field_sections-archive-archive description: Archive a custom field section. "/api/v2/survey_field_options": post: tags: - Survey Field Options summary: Creates a survey field option responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_survey_field_option" parameters: - "$ref": "#/components/parameters/header_organization" operationId: survey_field_options-create requestBody: "$ref": "#/components/requestBodies/survey_field_option" description: Create a new survey field option. get: tags: - Survey Field Options summary: Get survey field options responses: '200': "$ref": "#/components/responses/collection_survey_field_option" parameters: - "$ref": "#/components/parameters/sort_survey_field_option" - "$ref": "#/components/parameters/filter_survey_field_option" - "$ref": "#/components/parameters/header_organization" operationId: survey_field_options-index description: List all survey field options. "/api/v2/folders/{id}/reposition": patch: tags: - Folders summary: Reposition a folder responses: '200': "$ref": "#/components/responses/single_folder" parameters: - in: path name: id schema: type: string required: true description: The numeric ID of the folder. - "$ref": "#/components/parameters/header_organization" operationId: folders-reposition-reposition description: Changes the sort order position of a folder within its project. "/api/v2/time_entries/{id}/approve": patch: tags: - Time Entries summary: Approves a time entry responses: '200': "$ref": "#/components/responses/single_time_entry" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: time_entries-approve-approve description: Approve a time entry. "/api/v2/notifications/{id}/dismiss": patch: tags: - Notifications summary: Dismisses a notification responses: '200': "$ref": "#/components/responses/single_notification" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: notifications-dismiss-dismiss description: Dismiss a notification. "/api/v2/comments/{id}/unpin": patch: tags: - Comments summary: Unpins a comment responses: '200': "$ref": "#/components/responses/single_comment" '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: comments-unpin-unpin description: Unpin a comment. "/api/v2/reports/timesheet_reports": get: tags: - Reports summary: Get timesheet reports responses: '200': "$ref": "#/components/responses/collection_timesheet_report" parameters: - "$ref": "#/components/parameters/sort_timesheet_report" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_timesheet_report" - "$ref": "#/components/parameters/group_timesheet_report" operationId: reports-timesheet_reports-index description: Retrieve aggregated timesheet report data grouped by configurable dimensions. "/api/v2/invitations": post: tags: - Invitations summary: Create an invitation responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_invitation" parameters: - "$ref": "#/components/parameters/header_organization" operationId: invitations-create requestBody: "$ref": "#/components/requestBodies/invitation" description: Create a new invitation. "/api/v2/people": post: tags: - People summary: Create a person responses: '201': "$ref": "#/components/responses/single_person" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: people-create requestBody: "$ref": "#/components/requestBodies/person" description: Create a new person. Depending on the role and company assignment, the person will be classified as an employee, contractor, client contact, or placeholder. get: tags: - People summary: Get people responses: '200': "$ref": "#/components/responses/collection_person" parameters: - "$ref": "#/components/parameters/sort_person" - "$ref": "#/components/parameters/filter_person" - "$ref": "#/components/parameters/header_organization" operationId: people-index description: List people in the organization. Supports filtering by name, email, type, status, team, company, manager, tags, and custom fields. "/api/v2/custom_field_options/{id}/archive": patch: tags: - Custom Field Options summary: Archives a custom field option responses: '200': "$ref": "#/components/responses/single_custom_field_option" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: custom_field_options-archive-archive description: Archive a custom field option. "/api/v2/proposals/{id}/sync": patch: tags: - Proposals summary: Sync a proposal responses: '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict '200': "$ref": "#/components/responses/single_proposal" parameters: - in: path name: id schema: type: string required: true description: The ID of the proposal to sync. - "$ref": "#/components/parameters/header_organization" operationId: proposals-sync-sync description: Sync a proposal with the associated deal. "/api/v2/organization_subscriptions/{id}/reactivate": patch: tags: - Organization Subscriptions summary: Reactivates a organization subscription responses: '503': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Service Unavailable '405': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Method Not Allowed '200': "$ref": "#/components/responses/single_organization_subscription" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: organization_subscriptions-reactivate-reactivate description: Reactivate a cancelled organization subscription. "/api/v2/comments/{id}/pin": patch: tags: - Comments summary: Pins a comment responses: '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict '200': "$ref": "#/components/responses/single_comment" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: comments-pin-pin description: Pin a comment. "/api/v2/task_dependencies": get: tags: - TaskDependency summary: Get task dependncies responses: '200': "$ref": "#/components/responses/collection_task_dependency" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_task_dependency" - "$ref": "#/components/parameters/sort_task_dependency" operationId: task_dependencies-index description: List all task dependencies. post: tags: - TaskDependency summary: Create a task dependency responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': "$ref": "#/components/responses/single_task_dependency" parameters: - "$ref": "#/components/parameters/header_organization" operationId: task_dependencies-create requestBody: "$ref": "#/components/requestBodies/task_dependency" description: Create a new task dependency. "/api/v2/time_entries/approve": patch: tags: - Time Entries - Bulk summary: Approves time entries responses: '200': "$ref": "#/components/responses/single_time_entry" parameters: - "$ref": "#/components/parameters/header_organization" operationId: time_entries-approve-update-bulk requestBody: "$ref": "#/components/requestBodies/time_entry" description: Approve a time entry (alternate endpoint). "/api/v2/tags/{id}": get: tags: - Tags summary: Gets a tag responses: '200': "$ref": "#/components/responses/single_tag" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: tags-show description: Retrieve a single tag by ID. "/api/v2/pages/copy": post: tags: - Pages summary: Copies a page responses: '200': "$ref": "#/components/responses/single_page" '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: pages-copy-copy description: Copy an existing page. "/api/v2/pulses/{id}/send": patch: tags: - Pulses summary: Send a pulse responses: '200': "$ref": "#/components/responses/single_pulse" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: pulses-send-send_pulse description: Send a pulse to recipients. "/api/v2/deals/copy": post: tags: - Deals summary: Copies a deal responses: '200': "$ref": "#/components/responses/single_deal" '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created parameters: - "$ref": "#/components/parameters/header_organization" operationId: deals-copy-copy description: Create a copy of an existing deal. "/api/v2/invoices/{id}/send_einvoice": patch: tags: - Invoices summary: Sends an e-invoice responses: '200': "$ref": "#/components/responses/single_invoice" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden — e-invoicing is not enabled or the user lacks permission. '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Validation error — the invoice cannot be sent as an e-invoice (e.g., missing required identity or configuration). parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The unique identifier of the resource. operationId: invoices-send_einvoice requestBody: "$ref": "#/components/requestBodies/send_einvoice" description: Sends the specified invoice as an e-invoice using the given format. Creates an e-invoice transaction and submits it to the appropriate external service. "/api/v2/deleted_items/{id}/restore": patch: tags: - Deleted Items summary: Restores deleted object responses: '200': "$ref": "#/components/responses/single_deleted_item" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: deleted_items-restore-restore description: Restore a deleted item from the recycle bin. "/api/v2/boards/{id}/archive": patch: tags: - Boards summary: Archives a board responses: '200': "$ref": "#/components/responses/single_board" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: boards-archive-archive description: Archive a board. "/api/v2/organization_subscriptions/{id}/cancel": patch: tags: - Organization Subscriptions summary: Cancels a organization subscription responses: '503': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Service Unavailable '200': "$ref": "#/components/responses/single_organization_subscription" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: organization_subscriptions-cancel-cancel description: Cancel an organization subscription. "/api/v2/subsidiaries/{id}/archive": patch: tags: - Subsidiaries summary: Archives a subsidiary responses: '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict '200': "$ref": "#/components/responses/single_subsidiary" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: subsidiaries-archive-archive description: Archive a subsidiary to deactivate it. "/api/v2/document_types/{id}/archive": patch: tags: - Document Types summary: Archives a document type responses: '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '200': "$ref": "#/components/responses/single_document_type" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: document_types-archive-archive description: Archive a document type. "/api/v2/time_entries/{id}/unreject": patch: tags: - Time Entries summary: Unreject a time entry responses: '200': "$ref": "#/components/responses/single_time_entry" '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: time_entries-unreject-unreject description: Revoke rejection of a time entry. "/api/v2/organization_memberships": get: tags: - Organization Memberships summary: Get organization memberships responses: '200': "$ref": "#/components/responses/collection_organization_membership" parameters: - "$ref": "#/components/parameters/filter_organization_membership" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/sort_organization_membership" operationId: organization_memberships-index description: List organization memberships. "/api/v2/reports/line_item_reports": get: tags: - Reports summary: Get line item reports responses: '200': "$ref": "#/components/responses/collection_line_item_report" parameters: - "$ref": "#/components/parameters/sort_line_item_report" - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/group_line_item_report" - "$ref": "#/components/parameters/filter_line_item_report" operationId: reports-line_item_reports-index description: Retrieve aggregated line item report data grouped by configurable dimensions. "/api/v2/projects/copy": post: tags: - Projects summary: Copies a project responses: '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created '200': "$ref": "#/components/responses/single_project" parameters: - "$ref": "#/components/parameters/header_organization" operationId: projects-copy-copy description: Copy a project. Creates a copy of an existing project, duplicating its structure and optionally its tasks and other content. "/api/v2/service_types/merge": patch: tags: - Service Types summary: Merge a service type responses: '200': "$ref": "#/components/responses/single_service_type" parameters: - "$ref": "#/components/parameters/header_organization" operationId: service_types-merge-merge description: Merge two or more service types into one. "/api/v2/reports/task_reports": get: tags: - Reports summary: Get task reports responses: '200': "$ref": "#/components/responses/collection_task_report" parameters: - "$ref": "#/components/parameters/header_organization" - "$ref": "#/components/parameters/filter_task_report" - "$ref": "#/components/parameters/group_task_report" - "$ref": "#/components/parameters/sort_task_report" operationId: reports-task_reports-index description: Retrieve aggregated task report data grouped by configurable dimensions. "/api/v2/deal_statuses/merge": patch: tags: - Deal Statuses summary: Merges a deal status responses: '200': "$ref": "#/components/responses/single_deal_status" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: deal_statuses-merge-merge description: Merge deal statuses. "/api/v2/surveys/copy": post: tags: - Surveys summary: Copies a survey responses: '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created '200': "$ref": "#/components/responses/single_survey" parameters: - "$ref": "#/components/parameters/header_organization" operationId: surveys-copy-copy description: Copy an existing survey. "/api/v2/resource_requests/{id}/cancel": patch: tags: - Resource Requests summary: Cancel a resource request responses: '200': "$ref": "#/components/responses/single_resource_request" parameters: - in: path name: id schema: type: string required: true description: The ID of the resource request to cancel. - "$ref": "#/components/parameters/header_organization" operationId: resource_requests-cancel-cancel description: Cancels a resource request by ID, setting its status to canceled. "/api/v2/discussions/{id}/reopen": patch: tags: - Discussions summary: Reopens a discussion responses: '200': "$ref": "#/components/responses/single_discussion" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: discussions-reopen-reopen description: Reopen a resolved discussion. "/api/v2/notifications": get: tags: - Notifications summary: Get notifications responses: '200': "$ref": "#/components/responses/collection_notification" parameters: - "$ref": "#/components/parameters/sort_notification" - "$ref": "#/components/parameters/filter_notification" - "$ref": "#/components/parameters/header_organization" operationId: notifications-index description: List notifications. "/api/v2/passwords": post: tags: - Passwords summary: Create a password responses: '201': "$ref": "#/components/responses/single_password" '204': content: any: {} headers: {} description: No Content parameters: - "$ref": "#/components/parameters/header_organization" operationId: passwords-create requestBody: "$ref": "#/components/requestBodies/password" description: Create a new password reset request. "/api/v2/workflows/{id}/archive": patch: tags: - Workflows summary: Archives a workflow responses: '200': "$ref": "#/components/responses/single_workflow" '409': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Conflict parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: workflows-archive-archive description: Archive a workflow to deactivate it. "/api/v2/document_styles/copy": post: tags: - Document Styles summary: Duplicates a document style responses: '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created '200': "$ref": "#/components/responses/single_document_style" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" operationId: document_styles-copy-copy description: Copy an existing document style. "/api/v2/task_lists/{id}/restore": patch: tags: - Task Lists summary: Restores a task list responses: '200': "$ref": "#/components/responses/single_task_list" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: task_lists-restore-restore description: Restore an archived task list. "/api/v2/survey_field_options/{id}/archive": patch: tags: - Survey Field Options summary: Archives a survey field option responses: '200': "$ref": "#/components/responses/single_survey_field_option" parameters: - in: path name: id schema: type: string required: true description: The ID of the survey field option to archive. - "$ref": "#/components/parameters/header_organization" operationId: survey_field_options-archive-archive description: Archive a survey field option to deactivate it. "/api/v2/people/{id}/activate": patch: tags: - People summary: Activate a person responses: '200': "$ref": "#/components/responses/single_person" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: people-activate-activate description: Reactivate a previously deactivated person, restoring their access to the organization. "/api/v2/tax_rates/{id}/archive": patch: tags: - TaxRates summary: Archives a tax rate responses: '200': "$ref": "#/components/responses/single_tax_rate" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: tax_rates-archive-archive description: Archive a tax rate to deactivate it. "/api/v2/time_tracking_policies/{id}/restore": patch: tags: - Time Tracking Policies summary: Restores an archived time tracking policy responses: '200': "$ref": "#/components/responses/single_time_tracking_policy" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The numeric ID of the time tracking policy. operationId: time_tracking_policies-restore-restore description: Restores a previously archived time tracking policy. "/api/v2/purchase_orders/{id}/export": patch: tags: - Purchase Orders summary: Exports a purchase order responses: '200': "$ref": "#/components/responses/single_purchase_order" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: purchase_orders-export-export requestBody: "$ref": "#/components/requestBodies/purchase_order_export" description: Export a purchase order to an external format. "/api/v2/events/{id}/archive": patch: tags: - Events summary: Archives an event responses: '200': "$ref": "#/components/responses/single_event" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: events-archive-archive description: Archive an event. "/api/v2/emails/{id}/dismiss": patch: tags: - Emails summary: Dismiss an email responses: '200': "$ref": "#/components/responses/single_email" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: emails-dismiss-dismiss description: Dismiss an email from the inbox. "/api/v2/purchase_orders/copy": post: tags: - Purchase Orders summary: Copies a purchase order responses: '200': "$ref": "#/components/responses/single_purchase_order" '201': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Created parameters: - "$ref": "#/components/parameters/header_organization" operationId: purchase_orders-copy-copy requestBody: "$ref": "#/components/requestBodies/purchase_order_copy" description: Copy an existing purchase order. "/api/v2/notifications/{id}/undismiss": patch: tags: - Notifications summary: Undismisses a notification responses: '200': "$ref": "#/components/responses/single_notification" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: notifications-undismiss-undismiss description: Restore a dismissed notification to the inbox. "/api/v2/purchase_orders/{id}/export_update": patch: tags: - Purchase Orders summary: Updates exported purchase order responses: '200': "$ref": "#/components/responses/single_purchase_order" parameters: - in: path name: id schema: type: string required: true description: ID - "$ref": "#/components/parameters/header_organization" operationId: purchase_orders-export_update-export_update requestBody: "$ref": "#/components/requestBodies/purchase_order_export" description: Update the export status of a purchase order. "/api/v2/bank_accounts/{id}/archive": patch: tags: - BankAccounts summary: Archives a bank account responses: '200': "$ref": "#/components/responses/single_bank_account" '403': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Forbidden parameters: - in: path name: id schema: type: string required: true description: The ID of the bank account to archive. - "$ref": "#/components/parameters/header_organization" operationId: bank_accounts-archive-archive description: Archive a bank account. "/api/v2/reports/survey_reports": get: tags: - Reports summary: Get survey reports responses: '200': "$ref": "#/components/responses/collection_survey_report" parameters: - "$ref": "#/components/parameters/sort_survey_report" - "$ref": "#/components/parameters/filter_survey_report" - "$ref": "#/components/parameters/group_survey_report" - "$ref": "#/components/parameters/header_organization" operationId: reports-survey_reports-index description: Retrieve aggregated survey report data grouped by configurable dimensions. "/api/v2/invoices/{id}/preview": get: tags: - Invoices summary: Preview invoice responses: '200': "$ref": "#/components/responses/single_invoice" '422': content: application/vnd.api+json: {} headers: Content-Type: schema: type: string description: Unprocessable Entity parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: invoices-preview-preview description: | The preview endpoint lets you simulate invoice line item generation without persisting any changes. It returns the exact line items and invoice attributions that would be created for a given invoice based on the selected invoicing method and options. - Builds line items using the same logic as the line items "[generate](openapi:group:line-items)" method - Returns data only, does not modify the invoice "/api/v2/projects/{id}/unsubscribe": patch: tags: - Projects summary: Unsubscribes from project responses: '200': "$ref": "#/components/responses/single_project" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: The numeric ID of the project. operationId: projects-unsubscribe-unsubscribe description: Unsubscribes the current user from project notifications. "/api/v2/timers/{id}/stop": patch: tags: - Timers summary: Stops a timer responses: '200': "$ref": "#/components/responses/single_timer" parameters: - "$ref": "#/components/parameters/header_organization" - in: path name: id schema: type: string required: true description: ID operationId: timers-stop-stop description: Stop a running timer. components: schemas: _filter_root_new_time_report: oneOf: - "$ref": "#/components/schemas/filter_new_time_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_new_time_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `new_time_report` list endpoints — pass a single condition or a logical group. _filter_root_timesheet_report: oneOf: - "$ref": "#/components/schemas/filter_timesheet_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_timesheet_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `timesheet_report` list endpoints — pass a single condition or a logical group. filter_task_report: type: object title: Filter task report properties: workflow_status_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_report/properties/workflow_status_id" eq: "$ref": "#/components/schemas/resource_task_report/properties/workflow_status_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/workflow_status_id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/workflow_status_id" description: Filter operator object for workflow status id. - "$ref": "#/components/schemas/resource_task_report/properties/workflow_status_id" description: Filter task report results by workflow status id. board_status: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/board_status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/board_status" eq: "$ref": "#/components/schemas/resource_task_report/properties/board_status" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/board_status" contains: "$ref": "#/components/schemas/resource_task_report/properties/board_status" description: Match tasks where the board status satisfies the specified condition. description: 'Filter task reports by the status of the task list (board) the task belongs to. Values: open or closed.' query: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/query" contains: "$ref": "#/components/schemas/resource_task_report/properties/query" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/query" description: Match tasks where the search query satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/query" description: Filter task reports using a text search query against task titles and descriptions. service_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/service_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/service_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/service_id" description: Match tasks where the service ID satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/service_id" description: Filter task reports by the ID of the service the task is tracked against. title: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/title" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_report/properties/title" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/title" eq: "$ref": "#/components/schemas/resource_task_report/properties/title" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/title" description: Match tasks where the title satisfies the specified condition. description: Filter task reports by the task's title. subtask: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/subtask" contains: "$ref": "#/components/schemas/resource_task_report/properties/subtask" eq: "$ref": "#/components/schemas/resource_task_report/properties/subtask" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/subtask" description: Match tasks where the subtask flag satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/subtask" description: Filter task reports to include only subtasks (tasks that have a parent task). worked_time: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/worked_time" eq: "$ref": "#/components/schemas/resource_task_report/properties/worked_time" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/worked_time" contains: "$ref": "#/components/schemas/resource_task_report/properties/worked_time" description: Filter operator object for worked time. - "$ref": "#/components/schemas/resource_task_report/properties/worked_time" description: Filter task report results by worked time. fuzzy_people: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_report/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_task_report/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_task_report/properties/fuzzy_people" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/fuzzy_people" description: Match tasks where the fuzzy person value satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/fuzzy_people" description: Filter task reports using fuzzy person matching for flexible people queries. billable_time: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/billable_time" contains: "$ref": "#/components/schemas/resource_task_report/properties/billable_time" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/billable_time" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/billable_time" description: Match tasks where billable time satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/billable_time" description: Filter task reports by billable time logged against the task, in seconds. fuzzy_dates: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_task_report/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_task_report/properties/fuzzy_dates" description: Match tasks where the fuzzy date satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/fuzzy_dates" description: Filter task reports using fuzzy date matching for flexible date queries. start_date: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/start_date" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/start_date" contains: "$ref": "#/components/schemas/resource_task_report/properties/start_date" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/start_date" description: Match tasks where the start date satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/start_date" description: Filter task reports by the task's start date. person_type: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/person_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/person_type" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/person_type" contains: "$ref": "#/components/schemas/resource_task_report/properties/person_type" eq: "$ref": "#/components/schemas/resource_task_report/properties/person_type" description: Match tasks where the person type satisfies the specified condition. description: Filter task reports by the type of person assigned to the task (e.g. employee, client, placeholder). task_number: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/task_number" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/task_number" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/task_number" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/task_number" contains: "$ref": "#/components/schemas/resource_task_report/properties/task_number" description: Match tasks where the task number satisfies the specified condition. description: Filter task reports by the task's sequential number within its project. due_date: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_report/properties/due_date" eq: "$ref": "#/components/schemas/resource_task_report/properties/due_date" contains: "$ref": "#/components/schemas/resource_task_report/properties/due_date" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/due_date" description: Match tasks where the due date satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/due_date" description: Filter task reports by the task's due date. tags: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/tags" contains: "$ref": "#/components/schemas/resource_task_report/properties/tags" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/tags" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/tags" description: Match tasks where tags satisfy the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/tags" description: Filter task reports by tags assigned to the task. jump_query: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/jump_query" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/jump_query" contains: "$ref": "#/components/schemas/resource_task_report/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/jump_query" description: Match tasks where the jump query satisfies the specified condition. description: Filter task reports using a jump navigation query for quick task lookup. trackable_by_person_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/trackable_by_person_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/trackable_by_person_id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/trackable_by_person_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/trackable_by_person_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_task_report/properties/trackable_by_person_id" description: Filter tasks that the specified person is permitted to track time on. remaining_time: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/remaining_time" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/remaining_time" contains: "$ref": "#/components/schemas/resource_task_report/properties/remaining_time" eq: "$ref": "#/components/schemas/resource_task_report/properties/remaining_time" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/remaining_time" description: Match tasks where the remaining time satisfies the specified condition. description: Filter task reports by the task's remaining time estimate, in seconds. bookable_after: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/bookable_after" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_report/properties/bookable_after" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/bookable_after" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/bookable_after" eq: "$ref": "#/components/schemas/resource_task_report/properties/bookable_after" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter tasks whose linked service becomes bookable on or after this date. last_actor_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/last_actor_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/last_actor_id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/last_actor_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/last_actor_id" description: Match tasks where the last actor ID satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/last_actor_id" description: Filter task reports by the ID of the person who last acted on the task. due_date_before: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/due_date_before" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/due_date_before" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/due_date_before" contains: "$ref": "#/components/schemas/resource_task_report/properties/due_date_before" description: Match tasks where the due-date-before value satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/due_date_before" description: Filter task reports to tasks with a due date before the specified date. due_date_after: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/due_date_after" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_report/properties/due_date_after" eq: "$ref": "#/components/schemas/resource_task_report/properties/due_date_after" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/due_date_after" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/due_date_after" description: Match tasks where the due-date-after value satisfies the specified condition. description: Filter task reports to tasks with a due date after the specified date. parent_task_id: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/parent_task_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/parent_task_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/parent_task_id" eq: "$ref": "#/components/schemas/resource_task_report/properties/parent_task_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/parent_task_id" description: Match tasks where the parent task ID satisfies the specified condition. description: Filter task reports by the ID of the parent task (for subtasks). project_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/project_id" description: Match tasks where the project ID satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/project_id" description: Filter task reports by the ID of the project the task belongs to. task_list_id: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/task_list_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/task_list_id" eq: "$ref": "#/components/schemas/resource_task_report/properties/task_list_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/task_list_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/task_list_id" description: Match tasks where the task list ID satisfies the specified condition. description: Filter task reports by the ID of the task list the task belongs to. creator_id: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/creator_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/creator_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/creator_id" eq: "$ref": "#/components/schemas/resource_task_report/properties/creator_id" description: Match tasks where the creator ID satisfies the specified condition. description: Filter task reports by the ID of the person who created the task. board_id: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/board_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/board_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/board_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/board_id" eq: "$ref": "#/components/schemas/resource_task_report/properties/board_id" description: Match tasks where the board ID satisfies the specified condition. description: Filter task reports by the ID of the task list (board) the task belongs to. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/id" contains: "$ref": "#/components/schemas/resource_task_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/id" description: Match tasks where the ID satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/id" description: Filter task reports by the task's numeric ID. project_manager_id: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/project_manager_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/project_manager_id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/project_manager_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/project_manager_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/project_manager_id" description: Match tasks where the project manager ID satisfies the specified condition. description: Filter task reports by the ID of the project manager of the task's project. before: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_report/properties/before" contains: "$ref": "#/components/schemas/resource_task_report/properties/before" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/before" eq: "$ref": "#/components/schemas/resource_task_report/properties/before" description: Match tasks where the before date satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/before" description: Filter task reports by the date/time before which the task's due date falls. start_date_after: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_report/properties/start_date_after" eq: "$ref": "#/components/schemas/resource_task_report/properties/start_date_after" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/start_date_after" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/start_date_after" description: Match tasks where the start-date-after value satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/start_date_after" description: Filter task reports to tasks with a start date after the specified date. public_access: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/public_access" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/public_access" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/public_access" contains: "$ref": "#/components/schemas/resource_task_report/properties/public_access" description: Match tasks where the public access flag satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/public_access" description: Filter task reports by whether the task is publicly accessible. task_type: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/task_type" eq: "$ref": "#/components/schemas/resource_task_report/properties/task_type" contains: "$ref": "#/components/schemas/resource_task_report/properties/task_type" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/task_type" description: Match tasks where the task type satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/task_type" description: Filter task reports by the task type (task or issue). last_activity: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/last_activity" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_report/properties/last_activity" eq: "$ref": "#/components/schemas/resource_task_report/properties/last_activity" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/last_activity" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/last_activity" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by last activity date range (last_activity_at). folder_status: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/folder_status" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_report/properties/folder_status" contains: "$ref": "#/components/schemas/resource_task_report/properties/folder_status" eq: "$ref": "#/components/schemas/resource_task_report/properties/folder_status" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/folder_status" description: Match tasks where the folder status satisfies the specified condition. description: 'Filter task reports by the status of the folder the task''s task list belongs to. Values: open or closed.' last_activity_after: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_report/properties/last_activity_after" contains: "$ref": "#/components/schemas/resource_task_report/properties/last_activity_after" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/last_activity_after" eq: "$ref": "#/components/schemas/resource_task_report/properties/last_activity_after" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_task_report/properties/last_activity_after" description: Return tasks with last activity after this timestamp. bookable_before: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/bookable_before" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/bookable_before" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/bookable_before" contains: "$ref": "#/components/schemas/resource_task_report/properties/bookable_before" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/bookable_before" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter tasks whose linked service is bookable before this date. after: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/after" eq: "$ref": "#/components/schemas/resource_task_report/properties/after" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/after" contains: "$ref": "#/components/schemas/resource_task_report/properties/after" description: Match tasks where the after date satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/after" description: Filter task reports by the date/time after which the task's due date falls. project_type: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/project_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_report/properties/project_type" eq: "$ref": "#/components/schemas/resource_task_report/properties/project_type" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/project_type" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/project_type" description: Match tasks where the project type satisfies the specified condition. description: Filter task reports by the type of the task's project (billable or internal). task_list_name: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/task_list_name" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_report/properties/task_list_name" eq: "$ref": "#/components/schemas/resource_task_report/properties/task_list_name" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/task_list_name" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/task_list_name" description: Match tasks where the task list name satisfies the specified condition. description: Filter task reports by the name of the task list the task belongs to. workflow_status_category_id: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/workflow_status_category_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/workflow_status_category_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/workflow_status_category_id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/workflow_status_category_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/workflow_status_category_id" description: Filter operator object for workflow status category id. description: Filter task report results by workflow status category id. formulas: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/formulas" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/formulas" contains: "$ref": "#/components/schemas/resource_task_report/properties/formulas" description: Match tasks where a formula field value satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/formulas" description: Filter task reports by computed formula field values on the task. date_range: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/date_range" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/date_range" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/date_range" contains: "$ref": "#/components/schemas/resource_task_report/properties/date_range" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/date_range" description: Match tasks where the date range satisfies the specified condition. description: Filter task reports by a predefined date range (e.g. this_week, this_month, last_month). template: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/template" contains: "$ref": "#/components/schemas/resource_task_report/properties/template" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/template" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/template" description: Match tasks where the template flag satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/template" description: Filter task reports by whether the task is a template. overdue_status: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/overdue_status" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/overdue_status" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/overdue_status" contains: "$ref": "#/components/schemas/resource_task_report/properties/overdue_status" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/overdue_status" description: Match tasks where the overdue status satisfies the specified condition. description: 'Filter task reports by the task''s overdue status. Values: overdue (past due date and not closed) or not_overdue.' full_query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_report/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/full_query" eq: "$ref": "#/components/schemas/resource_task_report/properties/full_query" description: Match tasks where the full query satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/full_query" description: Filter task reports using a full-text search query across all task text fields. initial_estimate: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/initial_estimate" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/initial_estimate" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/initial_estimate" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/initial_estimate" contains: "$ref": "#/components/schemas/resource_task_report/properties/initial_estimate" description: Match tasks where the initial estimate satisfies the specified condition. description: Filter task reports by the task's initial time estimate, in seconds. created_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_report/properties/created_at" contains: "$ref": "#/components/schemas/resource_task_report/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/created_at" eq: "$ref": "#/components/schemas/resource_task_report/properties/created_at" description: Match tasks where the created-at timestamp satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/created_at" description: Filter task reports by the date and time the task was created. last_activity_before: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_report/properties/last_activity_before" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/last_activity_before" eq: "$ref": "#/components/schemas/resource_task_report/properties/last_activity_before" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/last_activity_before" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_task_report/properties/last_activity_before" description: Return tasks with last activity before this timestamp. closed_after: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/closed_after" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_report/properties/closed_after" eq: "$ref": "#/components/schemas/resource_task_report/properties/closed_after" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/closed_after" contains: "$ref": "#/components/schemas/resource_task_report/properties/closed_after" description: Match tasks where the closed-after date satisfies the specified condition. description: Filter task reports to tasks closed after the specified date. type_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/type_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/type_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/type_id" eq: "$ref": "#/components/schemas/resource_task_report/properties/type_id" description: Match tasks where the type ID satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/type_id" description: Filter task reports by the ID of the task type definition. query_extended: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/query_extended" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_report/properties/query_extended" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/query_extended" eq: "$ref": "#/components/schemas/resource_task_report/properties/query_extended" contains: "$ref": "#/components/schemas/resource_task_report/properties/query_extended" description: Match tasks where the extended query satisfies the specified condition. description: Filter task reports using an extended text search query with additional field coverage. subscriber_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/subscriber_id" eq: "$ref": "#/components/schemas/resource_task_report/properties/subscriber_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/subscriber_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/subscriber_id" description: Match tasks where the subscriber ID satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/subscriber_id" description: Filter task reports by the ID of a person subscribed to the task. due_date_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/due_date_on" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/due_date_on" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/due_date_on" contains: "$ref": "#/components/schemas/resource_task_report/properties/due_date_on" description: Match tasks where the due-date-on value satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/due_date_on" description: Filter task reports to tasks with a due date on the specified date. status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_report/properties/status" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/status" contains: "$ref": "#/components/schemas/resource_task_report/properties/status" eq: "$ref": "#/components/schemas/resource_task_report/properties/status" description: Match tasks where the status satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/status" description: 'Filter task reports by the task''s workflow status category. Values: not_started, started, or closed.' closed_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/closed_at" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/closed_at" eq: "$ref": "#/components/schemas/resource_task_report/properties/closed_at" contains: "$ref": "#/components/schemas/resource_task_report/properties/closed_at" description: Match tasks where the closed-at timestamp satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/closed_at" description: Filter task reports by the date and time the task was closed. updated_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_report/properties/updated_at" eq: "$ref": "#/components/schemas/resource_task_report/properties/updated_at" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/updated_at" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/updated_at" description: Match tasks where the updated-at timestamp satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/updated_at" description: Filter task reports by the date and time the task was last updated. start_date_before: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/start_date_before" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/start_date_before" eq: "$ref": "#/components/schemas/resource_task_report/properties/start_date_before" contains: "$ref": "#/components/schemas/resource_task_report/properties/start_date_before" description: Match tasks where the start-date-before value satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/start_date_before" description: Filter task reports to tasks with a start date before the specified date. board_name: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/board_name" eq: "$ref": "#/components/schemas/resource_task_report/properties/board_name" contains: "$ref": "#/components/schemas/resource_task_report/properties/board_name" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/board_name" description: Match tasks where the board name satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/board_name" description: Filter task reports by the name of the task list (board) the task belongs to. assignee_id: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/assignee_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_report/properties/assignee_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/assignee_id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/assignee_id" eq: "$ref": "#/components/schemas/resource_task_report/properties/assignee_id" description: Match tasks where the assignee ID satisfies the specified condition. description: Filter task reports by the ID of the person assigned to the task. task_list_status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/task_list_status" eq: "$ref": "#/components/schemas/resource_task_report/properties/task_list_status" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/task_list_status" contains: "$ref": "#/components/schemas/resource_task_report/properties/task_list_status" description: Match tasks where the task list status satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/task_list_status" description: 'Filter task reports by the status of the task list the task belongs to. Values: open or closed.' template_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_report/properties/template_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/template_id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/template_id" eq: "$ref": "#/components/schemas/resource_task_report/properties/template_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_task_report/properties/template_id" description: Filter tasks by the template they were created from. closed_before: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/closed_before" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/closed_before" contains: "$ref": "#/components/schemas/resource_task_report/properties/closed_before" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/closed_before" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/closed_before" description: Match tasks where the closed-before date satisfies the specified condition. description: Filter task reports to tasks closed before the specified date. repeating: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/repeating" contains: "$ref": "#/components/schemas/resource_task_report/properties/repeating" eq: "$ref": "#/components/schemas/resource_task_report/properties/repeating" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/repeating" description: Match tasks where the repeating flag satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/repeating" description: Filter task reports by whether the task has a repeating schedule. workflow_id: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/workflow_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/workflow_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/workflow_id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/workflow_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/workflow_id" description: Filter operator object for workflow id. description: Filter task report results by workflow id. custom_fields: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_report/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_task_report/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_task_report/properties/custom_fields" description: Match tasks where a custom field value satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/custom_fields" description: Filter task reports by custom field values defined on the task. folder_name: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/folder_name" contains: "$ref": "#/components/schemas/resource_task_report/properties/folder_name" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/folder_name" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/folder_name" description: Match tasks where the folder name satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/folder_name" description: Filter task reports by the name of the folder the task's task list belongs to. company_id: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/company_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/company_id" eq: "$ref": "#/components/schemas/resource_task_report/properties/company_id" description: Match tasks where the company ID satisfies the specified condition. description: Filter task reports by the ID of the client company linked to the task's project. folder_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/folder_id" contains: "$ref": "#/components/schemas/resource_task_report/properties/folder_id" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/folder_id" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/folder_id" description: Match tasks where the folder ID satisfies the specified condition. - "$ref": "#/components/schemas/resource_task_report/properties/folder_id" description: Filter task reports by the ID of the folder the task's task list belongs to. due_date_new: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/due_date_new" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/due_date_new" contains: "$ref": "#/components/schemas/resource_task_report/properties/due_date_new" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/due_date_new" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/due_date_new" description: Match tasks where the new due date field satisfies the specified condition. description: Filter task reports by the task's due date using the newer date field format. dependency_type: oneOf: - "$ref": "#/components/schemas/resource_task_report/properties/dependency_type" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_report/properties/dependency_type" not_contain: "$ref": "#/components/schemas/resource_task_report/properties/dependency_type" not_eq: "$ref": "#/components/schemas/resource_task_report/properties/dependency_type" contains: "$ref": "#/components/schemas/resource_task_report/properties/dependency_type" description: Match tasks where the dependency type satisfies the specified condition. description: Filter task reports by the dependency type relationship (blocking, waiting_on, or linked). patternProperties: "^creator..*$": title: Creator relationship "^project..*$": title: Project relationship "^service..*$": title: Service relationship "^assignee..*$": title: Assignee relationship "^task_list..*$": title: Task list relationship "^last_actor..*$": title: Last actor relationship description: Available filter parameters for querying aggregated task report data. resource_company: type: object title: Company Resource properties: vat: type: string title: Vat description: Tax ID / VAT number. invoice_email_recipients: type: string title: Invoice Email Recipients description: Email addresses to receive invoices for this company. status: enum: - 1 - 2 type: integer title: Status description: The current status of this company (e.g. active or archived). project_id: type: integer title: Project description: ID of the project associated with this company. name: type: string title: Name description: The name of this company. einvoice_identity: title: Einvoice Identity description: E-invoicing identity configuration for this company. example: data: type: einvoice_identities id: '567' custom_fields: type: object title: Custom Fields description: Custom field values for this company. avatar_url: type: string title: Avatar Url description: URL of the company avatar image. has_parent_company: type: boolean title: Has Parent Company description: When true, this company has a parent company in the hierarchy. subscriber_ids: title: Subscriber Ids description: IDs of people subscribed to follow updates on this company. default_document_type_id: type: integer title: Default Document Type description: ID of the default document type template used for PDF generation. payment_terms: type: integer title: Payment Terms description: Payment terms label (e.g. Net 30). fuzzy_dates: type: string title: Fuzzy Dates description: Company-level settings for displaying approximate or fuzzy dates on documents. default_document_type: title: Default Document Type description: The default document type applied to invoices and proposals for this company. subscriber_id: type: integer title: Subscriber description: ID of a person subscribed to follow updates on this company. archived_at: type: string title: Archived At format: date-time description: Timestamp when the company was archived. organization: title: Organization description: The organization this company belongs to. jump_query: type: string title: Jump Query description: Quick jump search query used to navigate to this company. custom_field_attachments: title: Custom Field Attachments description: Files in file-type custom fields. default_tax_rate: title: Default Tax Rate description: Default tax rate for this company. query: type: string title: Query description: Keyword query used for searching this company. domain: type: string title: Domain description: Email domain associated with this company. settings: type: object title: Settings description: Company-level settings controlling notification preferences and other configuration options. projectless_budgets: type: boolean title: Projectless Budgets description: Whether this company allows budgets without an associated project. company_code: type: string title: Company Code description: An internal or external company code used for integrations or accounting references. exclude_company_and_children: type: integer title: Exclude Company And Children description: When true, excludes this company and all its subsidiaries from results when filtering by parent company. custom_field_people: title: Custom Field People description: People in person-type custom fields. fuzzy_people: type: string title: Fuzzy People description: Fuzzy person search value. default_currency: type: string title: Default Currency description: Default currency for this company's deals and invoices. default_subsidiary: title: Default Subsidiary description: Default subsidiary for this company's invoices. parent_company: title: Parent Company description: The parent company of this company in the hierarchy. last_activity_at: type: string title: Last Activity At format: date-time description: Timestamp of the most recent activity on this company. sample_data: type: boolean title: Sample Data description: Whether this record is demo/sample data. full_query: type: string title: Full Query description: A concatenated string used for full-text search across company fields. default_tax_rate_id: type: integer title: Default Tax Rate description: ID of the default tax rate applied to this company's invoices. external_id: type: string title: External description: External ID from an integrated third-party system. id: type: integer title: Id description: Unique identifier for this company. default_subsidiary_id: type: integer title: Default Subsidiary description: ID of the default subsidiary used for this company's invoices. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary associated with this company. tag_list: type: string title: Tag List description: Tags applied to this company. tags: type: string title: Tags description: Tags applied to this company. company_id: type: integer title: Company description: The parent company ID if this company is a subsidiary of another company. due_days: type: integer title: Due Days description: Default payment terms in days. billing_name: type: string title: Billing Name description: The billing name used on invoices, if different from the company's display name. contact: type: object title: Contact description: Primary contact details for the company (name, email, phone). parent_company_id: type: integer title: Parent Company description: ID of the parent company in the organizational hierarchy. external_sync: type: boolean title: External Sync description: Indicates whether this company is synced with an external integration (e.g. accounting software). created_at: type: string title: Created At format: date-time description: Date when the company was created. integration_exporter_configuration: title: Integration Exporter Configuration description: Integration exporter configuration linked to this company. original_avatar_url: title: Original Avatar Url description: URL of the original full-size avatar image for this company before resizing. description: A client company linked to deals, budgets, projects, and invoices, with invoicing settings and rate card configuration. filter_deal_funnel_report: type: object title: Filter deal funnel report properties: budget_total: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/budget_total" contains: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/budget_total" not_contain: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/budget_total" not_eq: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/budget_total" description: Filter operator object for budget total. - "$ref": "#/components/schemas/resource_deal_funnel_report/properties/budget_total" description: Filter deal funnel report results by budget total. created_at: oneOf: - "$ref": "#/components/schemas/resource_deal_funnel_report/properties/created_at" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/created_at" eq: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/created_at" description: Filter operator object for created at. description: Filter deal funnel report results by created at. pipeline_id: oneOf: - "$ref": "#/components/schemas/resource_deal_funnel_report/properties/pipeline_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/pipeline_id" not_contain: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/pipeline_id" eq: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/pipeline_id" not_eq: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/pipeline_id" description: Filter operator object for pipeline id. description: Filter deal funnel report results by pipeline id. formulas: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/formulas" contains: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/formulas" description: Filter operator object for formulas. - "$ref": "#/components/schemas/resource_deal_funnel_report/properties/formulas" description: Filter deal funnel report results by formulas. projected_revenue: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/projected_revenue" not_contain: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/projected_revenue" eq: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/projected_revenue" not_eq: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/projected_revenue" description: Filter operator object for projected revenue. - "$ref": "#/components/schemas/resource_deal_funnel_report/properties/projected_revenue" description: Filter deal funnel report results by projected revenue. date: oneOf: - "$ref": "#/components/schemas/resource_deal_funnel_report/properties/date" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/date" not_contain: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/date" not_eq: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/date" eq: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/date" description: Filter operator object for date. description: Filter deal funnel report results by date. patternProperties: "^deal..*$": title: Deal relationship "^company..*$": title: Company relationship "^project..*$": title: Project relationship "^pipeline..*$": title: Pipeline relationship "^deal_status..*$": title: Deal status relationship "^responsible..*$": title: Responsible relationship description: Available filter parameters for querying aggregated deal funnel report data. resource_custom_domain: type: object title: Custom domain Resource properties: mailgun_dkim: type: string title: Mailgun Dkim description: The DKIM DNS record required for email authentication via Mailgun for this custom domain. organization: title: Organization description: The organization this custom domain belongs to. id: type: integer title: Id description: The unique identifier of this custom domain. email_sender_address: type: string title: Email Sender Address description: The email address used as the sender when sending emails via this custom domain. email_sender_name: type: string title: Email Sender Name description: The sender name for emails. subsidiaries: title: Subsidiaries description: The subsidiaries that use this custom domain. allow_user_email: type: boolean title: Allow User Email description: Whether to allow user email. name: type: string title: Name description: The custom domain name (hostname) used for client-facing portals. mailgun_mx: title: Mailgun Mx description: The MX DNS records required for Mailgun email routing for this custom domain. mailgun_spf: type: string title: Mailgun Spf description: The SPF DNS record required for email sender authentication via Mailgun for this custom domain. verified_at: type: string title: Verified At format: date-time description: Timestamp when this custom domain was verified, or null if verification is still pending. description: A custom URL domain configured for an organization's client-facing portals, with optional email sending settings. filter_invoice_attribution: type: object title: Filter invoice attribution properties: budget_id: oneOf: - "$ref": "#/components/schemas/resource_invoice_attribution/properties/budget_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice_attribution/properties/budget_id" eq: "$ref": "#/components/schemas/resource_invoice_attribution/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_invoice_attribution/properties/budget_id" not_eq: "$ref": "#/components/schemas/resource_invoice_attribution/properties/budget_id" description: Filter using explicit operator syntax. description: Filter by the associated budget or deal. invoice_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_attribution/properties/invoice_id" not_contain: "$ref": "#/components/schemas/resource_invoice_attribution/properties/invoice_id" contains: "$ref": "#/components/schemas/resource_invoice_attribution/properties/invoice_id" not_eq: "$ref": "#/components/schemas/resource_invoice_attribution/properties/invoice_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_invoice_attribution/properties/invoice_id" description: Filter by the associated invoice. patternProperties: "^budget..*$": title: Budget relationship "^invoice..*$": title: Invoice relationship description: Filter parameters for invoice attributions linking invoices to budgets. _filter_root_deal_funnel_report: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_deal_funnel_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_deal_funnel_report" description: Filter schema for `deal_funnel_report` list endpoints — pass a single condition or a logical group. filter_financial_item_report: type: object title: Filter financial item report properties: group: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/group" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/group" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/group" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/group" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_financial_item_report/properties/group" description: Filter by grouping dimension value (the grouped row key). overhead_cost: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/overhead_cost" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/overhead_cost" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/overhead_cost" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/overhead_cost" description: Filter operator object for overhead cost. - "$ref": "#/components/schemas/resource_financial_item_report/properties/overhead_cost" description: Filter financial item report results by overhead cost. stage_type: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/stage_type" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/stage_type" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/stage_type" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/stage_type" description: Filter operator object for stage type. - "$ref": "#/components/schemas/resource_financial_item_report/properties/stage_type" description: Filter financial item report results by stage type. section_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/section_id" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/section_id" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/section_id" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/section_id" description: Filter operator object for section id. - "$ref": "#/components/schemas/resource_financial_item_report/properties/section_id" description: Filter financial item report results by section id. revenue: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/revenue" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/revenue" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/revenue" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/revenue" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/revenue" description: Filter operator object for revenue. description: Filter financial item report results by revenue. total_recognized_time: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/total_recognized_time" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_recognized_time" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_recognized_time" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_recognized_time" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_recognized_time" description: Filter operator object for total recognized time. description: Filter financial item report results by total recognized time. total_billable_time: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_billable_time" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_billable_time" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_billable_time" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_billable_time" description: Filter operator object for total billable time. - "$ref": "#/components/schemas/resource_financial_item_report/properties/total_billable_time" description: Filter financial item report results by total billable time. probability: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/probability" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/probability" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/probability" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/probability" description: Filter operator object for probability. - "$ref": "#/components/schemas/resource_financial_item_report/properties/probability" description: Filter financial item report results by probability. scheduled_revenue: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/scheduled_revenue" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/scheduled_revenue" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/scheduled_revenue" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/scheduled_revenue" description: Filter operator object for scheduled revenue. - "$ref": "#/components/schemas/resource_financial_item_report/properties/scheduled_revenue" description: Filter financial item report results by scheduled revenue. cost: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/cost" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/cost" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/cost" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/cost" description: Filter operator object for cost. - "$ref": "#/components/schemas/resource_financial_item_report/properties/cost" description: Filter financial item report results by cost. parent_company_id: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/parent_company_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/parent_company_id" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/parent_company_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the parent company of the financial item's company. credited: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/credited" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/credited" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/credited" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/credited" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_financial_item_report/properties/credited" description: Filter by credited amount range. responsible_id: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/responsible_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/responsible_id" description: Filter operator object for responsible id. description: Filter financial item report results by responsible id. company_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/company_id" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_financial_item_report/properties/company_id" description: Filter by client company. draft_invoiced: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/draft_invoiced" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/draft_invoiced" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/draft_invoiced" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/draft_invoiced" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_financial_item_report/properties/draft_invoiced" description: Filter by the draft invoiced amount on the financial item. locked: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/locked" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/locked" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/locked" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/locked" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/locked" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the financial item is locked (period closed). project_type_id: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/project_type_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/project_type_id" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/project_type_id" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/project_type_id" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/project_type_id" description: Filter operator object for project type id. description: Filter financial item report results by project type id. formulas: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/formulas" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/formulas" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/formulas" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/formulas" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by calculated formula field values. invoiced: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/invoiced" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/invoiced" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/invoiced" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/invoiced" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/invoiced" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by invoiced amount range. project_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/project_id" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/project_id" description: Filter operator object for project id. - "$ref": "#/components/schemas/resource_financial_item_report/properties/project_id" description: Filter financial item report results by project id. billing_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/billing_type" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/billing_type" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/billing_type" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/billing_type" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_financial_item_report/properties/billing_type" description: Filter by the billing type of the service. deal_status_id: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/deal_status_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/deal_status_id" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/deal_status_id" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/deal_status_id" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/deal_status_id" description: Filter operator object for deal status id. description: Filter financial item report results by deal status id. total_budgeted_time: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_budgeted_time" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_budgeted_time" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_budgeted_time" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_budgeted_time" description: Filter operator object for total budgeted time. - "$ref": "#/components/schemas/resource_financial_item_report/properties/total_budgeted_time" description: Filter financial item report results by total budgeted time. service_type_id: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/service_type_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/service_type_id" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/service_type_id" description: Filter operator object for service type id. description: Filter financial item report results by service type id. subsidiary_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/subsidiary_id" description: Filter operator object for subsidiary id. - "$ref": "#/components/schemas/resource_financial_item_report/properties/subsidiary_id" description: Filter financial item report results by subsidiary id. person_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/person_id" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/person_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_financial_item_report/properties/person_id" description: Filter by the associated person. estimated_cost: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/estimated_cost" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/estimated_cost" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/estimated_cost" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/estimated_cost" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/estimated_cost" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by estimated cost amount range. total_time: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/total_time" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_time" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_time" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_time" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_time" description: Filter operator object for total time. description: Filter financial item report results by total time. custom_fields: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/custom_fields" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by custom field values. stage_status: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/stage_status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/stage_status" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/stage_status" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/stage_status" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/stage_status" description: Filter operator object for stage status. description: Filter financial item report results by stage status. total_estimated_time: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_estimated_time" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_estimated_time" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_estimated_time" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_estimated_time" description: Filter operator object for total estimated time. - "$ref": "#/components/schemas/resource_financial_item_report/properties/total_estimated_time" description: Filter financial item report results by total estimated time. date: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/date" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/date" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/date" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/date" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/date" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by financial item date range (`date`). origin_deal_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/origin_deal_id" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/origin_deal_id" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/origin_deal_id" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/origin_deal_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_financial_item_report/properties/origin_deal_id" description: Filter by the originating deal this budget was created from. scheduled_cost: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/scheduled_cost" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/scheduled_cost" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/scheduled_cost" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/scheduled_cost" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/scheduled_cost" description: Filter operator object for scheduled cost. description: Filter financial item report results by scheduled cost. approval_status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/approval_status" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/approval_status" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/approval_status" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/approval_status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_financial_item_report/properties/approval_status" description: Filter by the approval status of the financial item. pipeline_id: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/pipeline_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/pipeline_id" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/pipeline_id" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/pipeline_id" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/pipeline_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated pipeline. future: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/future" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/future" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/future" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/future" description: Filter operator object for future. - "$ref": "#/components/schemas/resource_financial_item_report/properties/future" description: Filter financial item report results by future. unit: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/unit" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/unit" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/unit" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/unit" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/unit" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the billing unit type of the service (e.g. hours, days, items). budget_status: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_status" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_status" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_status" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_status" description: Filter by budget status (open or closed). budget_id: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_id" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_id" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated budget or deal. blended_rate: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/blended_rate" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/blended_rate" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/blended_rate" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/blended_rate" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/blended_rate" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by blended rate (effective hourly rate based on tracking unit type). budget_used: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_used" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_used" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_used" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_used" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_used" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by budget amount used (actual spend against budget). service_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/service_id" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/service_id" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/service_id" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/service_id" description: Filter operator object for service id. - "$ref": "#/components/schemas/resource_financial_item_report/properties/service_id" description: Filter financial item report results by service id. budget_total: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_total" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_total" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_total" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_total" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_total" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total budget amount range. financial_item_type: oneOf: - "$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_type" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_type" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_type" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_type" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by type of financial item (service unused budget, booking, time entry, invoice, expense, etc.). total_scheduled_time: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_scheduled_time" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_scheduled_time" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_scheduled_time" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_scheduled_time" description: Filter operator object for total scheduled time. - "$ref": "#/components/schemas/resource_financial_item_report/properties/total_scheduled_time" description: Filter financial item report results by total scheduled time. profit: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/profit" contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/profit" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/profit" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/profit" description: Filter operator object for profit. - "$ref": "#/components/schemas/resource_financial_item_report/properties/profit" description: Filter financial item report results by profit. total_worked_time: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_worked_time" eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_worked_time" not_contain: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_worked_time" not_eq: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_worked_time" description: Filter operator object for total worked time. - "$ref": "#/components/schemas/resource_financial_item_report/properties/total_worked_time" description: Filter financial item report results by total worked time. patternProperties: "^budget..*$": title: Budget relationship "^person..*$": title: Person relationship "^company..*$": title: Company relationship "^project..*$": title: Project relationship "^section..*$": title: Section relationship "^service..*$": title: Service relationship "^origin_deal..*$": title: Origin deal relationship "^responsible..*$": title: Responsible relationship description: Available filter parameters for querying aggregated financial item report data. resource_invoice_template: type: object title: Invoice template Resource properties: issuer: title: Issuer description: The person designated as the issuer on invoices generated from this template. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary used as the issuing entity on invoices generated from this template. creator_id: type: integer title: Creator description: ID of the person who created this invoice template. organization: title: Organization description: The organization this invoice template belongs to. invoice_creation_options: type: object title: Invoice Creation Options description: A JSON object containing rules used to determine which services or time entries to include when auto-generating invoice line items. document_type_id: type: integer title: Document Type description: ID of the document type used for invoices generated from this template. note: type: string title: Note description: The default note text to include on invoices generated from this template. issuer_id: type: integer title: Issuer description: ID of the person designated as the issuer on invoices generated from this template. bank_account: title: Bank Account description: The bank account associated with this invoice template, used on generated invoices. subsidiary: title: Subsidiary description: The subsidiary used as the issuing entity on invoices generated from this template. created_at: title: Created At description: Timestamp when this invoice template was created. id: type: integer title: Id description: Unique identifier of this invoice template. bank_account_id: type: integer title: Bank Account description: ID of the bank account used for invoices generated from this template. invoice_due_in_days: type: integer title: Invoice Due In Days description: The invoice due in days. custom_fields: type: object title: Custom Fields description: Custom field values for this invoice template. budget: title: Budget description: The budget this invoice template is linked to. budget_id: type: integer title: Budget description: ID of the budget this invoice template is linked to. document_type: title: Document Type description: The document type used for invoices generated from this template. company_id: type: integer title: Company description: ID of the company (client) associated with the budget for this invoice template. creator: title: Creator description: The person who created this invoice template. bank_account_details: type: object title: Bank Account Details description: Custom bank account details (as a JSON object) to display on generated invoices, overriding the default bank account details. subject: title: Subject description: The default subject line used on invoices generated from this template, typically the budget name. description: An invoice template is linked to a specific budget and stores the default settings (document type, bank account, issuer, etc.) used when automatically generating invoice drafts for that budget. resource_project_assignment: type: object title: Project assignment Resource properties: project_id: type: integer title: Project description: ID of the project this assignment belongs to. invoices_filter_id: type: integer title: Invoices Filter description: ID of the saved filter used as the default invoices view for this person in this project. id: type: integer title: Id description: The unique identifier of this project assignment. docs_favorite_filter: title: Docs Favorite Filter description: The saved filter used as the default docs view for this person in this project. docs_filter_id: type: integer title: Docs Filter description: ID of the saved filter used as the default docs view for this person in this project. deals_filter_id: type: integer title: Deals Filter description: ID of the saved filter used as the default deals view for this person in this project. project: title: Project description: The project this assignment belongs to. default_filter_id: type: integer title: Default Filter description: ID of the saved filter used as the default tasks view for this person in this project. created_at: type: string title: Created At format: date-time description: Timestamp when this project assignment was created. watched: title: Watched description: Whether the person is watching (auto-subscribed to notifications for) this project. tasks_layout_id: type: integer title: Tasks Layout description: ID of the layout preset used for the tasks view in this project for this person. subscribe: title: Subscribe description: When true, the person is automatically subscribed to notifications for activity on this project. preferences: type: string title: Preferences description: User-specific preferences for this project assignment, stored as key-value settings. budgets_filter_id: type: integer title: Budgets Filter description: ID of the saved filter used as the default budgets view for this person in this project. person: title: Person description: The person assigned to this project. invoices_favorite_filter: title: Invoices Favorite Filter description: The saved filter used as the default invoices view for this person in this project. unsubscribe: title: Unsubscribe description: When true, the person is not subscribed to notifications for this project (write-only, use watched to read the current state). favorite_filter: title: Favorite Filter description: The saved filter used as the default tasks view for this person in this project. deals_favorite_filter: title: Deals Favorite Filter description: The saved filter used as the default deals view for this person in this project. person_id: type: integer title: Person description: ID of the person assigned to this project. organization: title: Organization description: The organization this project assignment belongs to. budgets_favorite_filter: title: Budgets Favorite Filter description: The saved filter used as the default budgets view for this person in this project. description: Represents a person's membership in a project, including their notification preferences, default filters, and layout settings. filter_custom_field: type: object title: Filter custom field properties: project_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_custom_field/properties/project_id" contains: "$ref": "#/components/schemas/resource_custom_field/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_custom_field/properties/project_id" eq: "$ref": "#/components/schemas/resource_custom_field/properties/project_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_custom_field/properties/project_id" description: Filter by the associated project. archived: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_custom_field/properties/archived" contains: "$ref": "#/components/schemas/resource_custom_field/properties/archived" eq: "$ref": "#/components/schemas/resource_custom_field/properties/archived" not_contain: "$ref": "#/components/schemas/resource_custom_field/properties/archived" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_custom_field/properties/archived" description: Filter by whether the custom field is archived. show_in_add_edit_views: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_custom_field/properties/show_in_add_edit_views" eq: "$ref": "#/components/schemas/resource_custom_field/properties/show_in_add_edit_views" not_contain: "$ref": "#/components/schemas/resource_custom_field/properties/show_in_add_edit_views" contains: "$ref": "#/components/schemas/resource_custom_field/properties/show_in_add_edit_views" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_custom_field/properties/show_in_add_edit_views" description: Filter by whether the custom field is shown in add/edit views. customizable_type: oneOf: - "$ref": "#/components/schemas/resource_custom_field/properties/customizable_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_custom_field/properties/customizable_type" not_contain: "$ref": "#/components/schemas/resource_custom_field/properties/customizable_type" not_eq: "$ref": "#/components/schemas/resource_custom_field/properties/customizable_type" eq: "$ref": "#/components/schemas/resource_custom_field/properties/customizable_type" description: Filter using explicit operator syntax. description: Filter by the resource type the custom field is attached to. survey_id: oneOf: - "$ref": "#/components/schemas/resource_custom_field/properties/survey_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_custom_field/properties/survey_id" not_eq: "$ref": "#/components/schemas/resource_custom_field/properties/survey_id" contains: "$ref": "#/components/schemas/resource_custom_field/properties/survey_id" not_contain: "$ref": "#/components/schemas/resource_custom_field/properties/survey_id" description: Filter using explicit operator syntax. description: Filter by the associated survey. global: oneOf: - "$ref": "#/components/schemas/resource_custom_field/properties/global" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_custom_field/properties/global" contains: "$ref": "#/components/schemas/resource_custom_field/properties/global" not_eq: "$ref": "#/components/schemas/resource_custom_field/properties/global" eq: "$ref": "#/components/schemas/resource_custom_field/properties/global" description: Filter using explicit operator syntax. description: Filter by whether the custom field is global (applies to all records of its type). name: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_custom_field/properties/name" contains: "$ref": "#/components/schemas/resource_custom_field/properties/name" not_eq: "$ref": "#/components/schemas/resource_custom_field/properties/name" not_contain: "$ref": "#/components/schemas/resource_custom_field/properties/name" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_custom_field/properties/name" description: Filter by custom field name (text search). patternProperties: {} description: Filter parameters for listing custom fields. Supports filtering by customizable type (task, deal, person, etc.), project, section, name, archived status, and data type. Standard string and ID operators apply. resource_role: type: object title: Role Resource properties: base_role_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 type: integer title: Base Role description: ID of the base role type this custom role is derived from (determines the permission baseline). description: type: string title: Description people_count: type: integer title: People Count description: The number of people currently assigned to this role. editable_by_user: type: boolean title: Editable By User description: Whether this role can be modified by regular users, or is a system-managed role. active_users_count: type: integer title: Active Users Count description: The number of active users currently assigned to this role. inactive_users_count: type: integer title: Inactive Users Count description: The number of inactive users assigned to this role. user_type_id: enum: - 1 - 2 type: integer title: User Type description: ID of the user type associated with this role (e.g. full user, limited user). permissions: type: object title: Permissions description: The explicit permission settings configured for this role. organization: title: Organization description: The organization this role belongs to. inactive_agents_count: type: integer title: Inactive Agents Count description: The number of inactive AI agents assigned to this role. active_agents_count: type: integer title: Active Agents Count description: The number of active AI agents currently assigned to this role. resolved_permissions: title: Resolved Permissions description: The effective resolved permissions for this role, including inherited permissions from the base role. id: type: integer title: Id description: The unique identifier of this role. name: type: string title: Name description: The display name of this role. description: A role defines a set of permissions that control what members assigned to it can access and do within the organization. resource_webhook_log: type: object title: Webhook log Resource properties: target_url: type: string title: Target Url description: The URL to which the webhook payload was delivered. retry_job_id: type: string title: Retry Job description: The background job ID for a scheduled retry of this delivery, or null if no retry is pending. after: type: string title: After format: date description: Filter to return only webhook log entries created after this date. retry_attempt: type: integer title: Retry Attempt description: The retry attempt number for this delivery, where 0 is the initial attempt. webhook: title: Webhook description: The webhook that generated this log entry. status_code: type: integer title: Status Code description: The HTTP response status code returned by the target URL. created_at: type: string title: Created At format: date-time description: Timestamp when this webhook delivery attempt was made. organization: title: Organization description: The organization this webhook log entry belongs to. payload: type: string title: Payload description: The JSON payload that was sent to the target URL. webhook_id: type: integer title: Webhook description: ID of the webhook that generated this log entry. id: type: integer title: Id description: The unique identifier of this webhook log entry. before: type: string title: Before format: date description: Filter to return only webhook log entries created before this date. description: A webhook log records a single delivery attempt of a webhook event to its target URL, capturing the payload sent, HTTP response code, and retry details. resource_organization: type: object title: Organization Resource properties: force_single_sign_on: type: boolean title: Force Single Sign On description: Whether SSO login is enforced, requiring all users to authenticate via the configured identity provider. expense_markup: type: number title: Expense Markup description: Default markup percentage applied to expenses on deals. currency: type: string title: Currency description: Default currency code for the organization (e.g. USD, EUR). invoice_rounding_method_id: type: integer title: Invoice Rounding Method description: Rounding method applied when generating invoice line item amounts. time_locking_interval: type: integer title: Time Locking Interval description: Number of periods (days or weeks) after which time entries are automatically locked. allow_user_email: type: boolean title: Allow User Email description: Whether members can use their personal email address as the sender for invoice emails. sample_data_imported_at: type: string title: Sample Data Imported At format: date-time description: Timestamp when sample data was imported into the organization. invoice_timesheet_export_configuration: type: object title: Invoice Timesheet Export Configuration description: Configuration for how timesheet data is exported and attached to invoices. single_sign_on: type: boolean title: Single Sign On description: Whether SAML-based single sign-on is enabled. time_format_id: enum: - 1 - 2 type: integer title: Time Format description: Time format preference for the organization (e.g. decimal hours vs. HH:MM). verification_status_id: enum: - 1 - 2 - 3 type: integer title: Verification Status description: Verification status of the organization account. subsidiary_count: title: Subsidiary Count description: Number of active subsidiaries within the organization. self_attribution_comment: type: string title: Self Attribution Comment description: Additional comment or detail on how the organization discovered Productive. email_sender_name: title: Email Sender Name description: Display name shown as the sender of outgoing invoice emails. facility_costs_default: title: Facility Costs Default description: Facility costs in the default currency. owner_id: type: integer title: Owner description: ID of the person who owns the organization account. rounding_interval_id: enum: - 1 - 2 - 3 type: integer title: Rounding Interval description: Time rounding interval applied to time entries (e.g. 15 minutes, 30 minutes). currency_normalized: title: Currency Normalized description: Normalized currency code used internally. date_format_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 type: integer title: Date Format description: Date format preference for the organization. Controls how dates are displayed throughout the platform. time_tracking_policies_enabled: type: boolean title: Time Tracking Policies Enabled description: When true, time tracking policies are enforced across the organization. time_locking: type: boolean title: Time Locking description: Whether time locking is enabled, preventing edits to time entries in locked periods. timesheet_submission_reminders: type: boolean title: Timesheet Submission Reminders description: Whether reminder emails are sent for pending timesheet submissions. numbering_format_settings: type: object title: Numbering Format Settings description: Settings controlling the numbering format for invoices and other financial documents. delivered_budget_recognition_date_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 type: integer title: Delivered Budget Recognition Date description: Revenue recognition date rule applied to delivered budgets. weight: title: Weight description: Internal weight value used for organization ranking (calculated as 1 / seat count). exchange_rate_provider_id: enum: - 1 - 2 - 3 - 4 type: integer title: Exchange Rate Provider description: Exchange rate data provider used for multi-currency calculations. overhead_subsidiary_switched_at: type: string title: Overhead Subsidiary Switched At format: date-time description: Timestamp when overhead tracking was switched to per-subsidiary mode. email_key: type: string title: Email Key description: Unique email key (inbox key) for receiving emails into the organization. revenue_recognition_type_id: enum: - 1 - 2 type: integer title: Revenue Recognition Type description: Revenue recognition method used for the organization (e.g. percentage of completion, fixed fee). time_reminder_at: type: integer title: Time Reminder At description: Hour of the day (0–23) when time reminder emails are sent. erector_id: type: integer title: Erector description: ID of the Productive user who set up (erected) the organization. flags: type: object title: Flags description: Feature flags for the organization, keyed by flag name with boolean values. quick_start_config: type: string title: Quick Start Config description: Quick start configuration used during initial setup. scim_bearer_token: type: string title: SCIM Bearer Token description: The SCIM bearer token for provisioning users via an identity provider (SCIM 2.0). open_budget_recognition_date_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 type: integer title: Open Budget Recognition Date description: Revenue recognition date rule applied to open (in-progress) budgets. onboarding_progress: type: string title: Onboarding Progress description: Tracks the user's progress through the onboarding flow. invitation_token: type: string title: Invitation Token description: Token used to invite new members to the organization. overhead_recalculation_day: type: integer title: Overhead Recalculation Day description: The day of the month on which overhead costs are recalculated. overhead_amortization_period: type: integer title: Overhead Amortization Period description: The number of months over which overhead costs are amortized. force_two_factor_auth: type: boolean title: Force Two Factor Auth description: Whether two-factor authentication is required for all organization members. organization_type_id: type: integer title: Organization Type description: Type of organization (e.g. agency, consultancy). facility_costs_breakdown: type: object title: Facility Costs Breakdown description: Breakdown of facility costs by category or subsidiary. week_start_day_id: enum: - 1 - 2 - 3 type: integer title: Week Start Day description: First day of the work week for the organization (e.g. Monday, Sunday). email_domain_name: title: Email Domain Name description: Custom domain name used for the organization's invoice email sender address. booked_demo: type: boolean title: Booked Demo description: Whether the organization has booked a demo with Productive. customer_success_specialist_id: type: integer title: Customer Success Specialist description: ID of the Productive user assigned as the customer success specialist for this organization. autotracking_schedule_id: enum: - 1 - 2 type: integer title: Autotracking Schedule description: ID of the autotracking schedule assigned to this organization for automatic time entry creation. time_tracking_policy_id: type: integer title: Time Tracking Policy description: The ID of the active time tracking policy for the organization. financial_month_locking_date: type: integer title: Financial Month Locking Date description: Day of the month on which financial months are locked (1–28). domain_verified: title: Domain Verified description: Whether the custom email domain has been verified for sending invoice emails. limited_service_types: title: Limited Service Types description: Whether service types are restricted to a limited set for the organization. time_display_id: enum: - 1 - 2 type: integer title: Time Display description: Time display format preference (e.g. 12-hour or 24-hour clock). working_hours: type: object title: Working Hours description: Default working hours schedule for the organization, defining hours per day of the week. overhead: type: boolean title: Overhead description: Whether overhead cost tracking is enabled for the organization. name: type: string title: Name description: Name of the organization. remove_branding: type: boolean title: Remove Branding description: Whether the Productive branding is removed from outgoing documents and emails. ai_enabled: type: boolean title: AI Enabled description: Whether AI-powered features are enabled for the organization. locale: enum: - en_US - de_DE - fr_FR - es_ES - it_IT type: string title: Locale description: Locale setting for the organization (e.g. en_US, de_DE). metrics: title: Metrics description: Base64-encoded JSON containing UTM attribution metrics for the organization's acquisition source. number_format_id: enum: - 1 - 2 - 3 - 4 - 5 type: integer title: Number Format description: Number format preference for the organization. Controls how numbers are formatted (e.g. decimal separator). organization_subscription: title: Organization Subscription description: The organization's pricing plan subscription details. verified_at: type: string title: Verified At format: date-time description: Timestamp when the organization account was verified. allow_time_off: type: boolean title: Allow Time Off description: Whether time-off tracking is enabled for the organization. request_for_resource_enabled: type: boolean title: Request For Resource Enabled description: Whether the resource request workflow is enabled, allowing managers to request people for projects. deal_settings: type: object title: Deal Settings description: Deal-level settings for time rounding, including rounding method and interval. overhead_type_id: enum: - 1 - 2 type: integer title: Overhead Type description: Type of overhead calculation applied (e.g. fixed, percentage-based). self_attribution: type: string title: Self Attribution description: How the organization discovered Productive (self-reported attribution). addons: title: Addons description: Active add-ons enabled for the organization. owner: title: Owner description: The person who owns the organization account. time_locking_reminders: type: boolean title: Time Locking Reminders description: Whether email reminders are sent before time entries are locked. analytics_uid: title: Analytics Uid description: Google Analytics tracking ID associated with the organization. time_zone: type: string title: Time Zone description: Default timezone for the organization (Rails TimeZone name, e.g. Eastern Time (US & Canada)). original_avatar_url: title: Original Avatar Url description: URL of the original full-size avatar image for this organization before resizing. currency_format_id: enum: - 1 - 2 type: integer title: Currency Format description: Currency display format preference. Controls how currency symbols and amounts are positioned. expense_settings: type: object title: Expense Settings description: Organization-level expense settings (e.g. approval defaults, categories). man_day_minutes: type: integer title: Man Day Minutes description: Number of minutes in a man-day, used to convert between hours and days in reports and scheduling. facility_costs: title: Facility Costs description: Monthly facility cost amount in the organization's default currency. company: title: Company description: The client company linked to the organization. billing_email: type: object title: Billing Email description: Email address used for billing correspondence. time_reminders: type: boolean title: Time Reminders description: Time reminder settings for prompting people to log their time. currency_default: title: Currency Default description: Default currency code used as the base for monetary values. time_locking_period_id: enum: - 1 - 2 - 3 type: integer title: Time Locking Period description: Period unit used for time locking (e.g. days, weeks). avatar_url: type: string title: Avatar Url description: URL of the organization's avatar image (thumbnail size). email_type_id: type: integer title: Email Type description: Email client type used for sending invoices (e.g. SMTP, Sendgrid). due_days: type: integer title: Due Days description: Default number of days after invoice date that payment is due. timesheet_submission: type: boolean title: Timesheet Submission description: Whether timesheet submission and approval workflow is enabled. decimal_places_id: enum: - 1 - 2 - 3 - 4 type: integer title: Decimal Places description: Number of decimal places used when displaying monetary values. sample_data_reverted_at: type: string title: Sample Data Reverted At format: date-time description: Timestamp when sample data was reverted (removed) from the organization. financial_months: title: Financial Months description: List of financial months with their start/end dates and lock status. time_reminder_condition: type: integer title: Time Reminder Condition description: Minimum tracked time percentage required before a time reminder is triggered. rounding_method_id: enum: - 1 - 2 - 3 - 4 type: integer title: Rounding Method description: Rounding method applied to time entries (e.g. round up, round down, round to nearest). facility_costs_normalized: title: Facility Costs Normalized description: Facility costs normalized to the base currency. financial_month_locking_partial_edit: type: boolean title: Financial Month Locking Partial Edit description: Whether partial editing is allowed within a locked financial month. timesheet_submission_settings: type: object title: Timesheet Submission Settings description: Configuration settings for the timesheet submission workflow. conflict_resolver_active: type: boolean title: Conflict Resolver Active description: Whether the scheduling conflict resolver is active, automatically detecting and flagging overbooking conflicts. time_reminder_id: enum: - 1 - 2 - 3 - 4 - 5 type: integer title: Time Reminder description: The ID of the time reminder schedule used by the organization. email_local_name: title: Email Local Name description: Local part (username) of the custom invoice email sender address. fiscal_year_start: type: string title: Fiscal Year Start format: date description: Start date of the fiscal year if the organization uses a non-calendar fiscal year. description: The organization resource representing the top-level account with global settings, preferences, and configuration. resource_membership: type: object title: Membership Resource properties: survey_id: type: integer title: Survey description: The ID of the survey this membership grants access to, if applicable. target_type: type: string title: Target Type description: The type of resource this membership applies to (e.g. project, page, survey). project_id: type: integer title: Project description: The ID of the project this membership grants access to, if applicable. person_id: type: integer title: Person description: The ID of the person this membership belongs to. pulse_id: type: integer title: Pulse description: The ID of the pulse (view) this membership applies to, if applicable. deal: title: Deal description: The deal this membership grants access to, if the target is a deal. team: title: Team description: The team this membership applies to, if it grants team-level access. options: type: object title: Options description: Additional options and settings for this membership. page: title: Page description: The page this membership grants access to, if the target is a page. access_type_id: enum: - 1 - 2 - 3 - 4 - 5 type: integer title: Access Type description: ID of the access type determining the permission level of this membership (e.g. viewer, editor). deal_id: type: integer title: Deal description: ID of the deal this membership grants access to, if the target is a deal. person: title: Person description: The person this membership belongs to. filter: title: Filter description: The filter this membership grants access to, if the target is a filter. project: title: Project description: The project this membership grants access to, if applicable. organization: title: Organization description: The organization this membership belongs to. type_id: enum: - 1 - 2 - 3 type: integer title: Type description: Numeric identifier for the membership type (e.g. viewer, editor, manager). dynamic_group_id: enum: - 2 - 6 - 8 - 9 - 10 - 11 - 12 type: integer title: Dynamic Group description: ID of the dynamic group this membership is assigned to, if assigned via a group rather than an individual. agent_id: type: integer title: Agent description: ID of the AI agent associated with this membership, if the member is an agent. dashboard_id: type: integer title: Dashboard description: ID of the dashboard this membership grants access to, if the target is a dashboard. survey: title: Survey description: The survey this membership grants access to, if applicable. dashboard: title: Dashboard description: The dashboard this membership grants access to, if the target is a dashboard. id: type: integer title: Id description: The unique identifier of this membership. page_id: type: integer title: Page description: The ID of the page this membership grants access to, if applicable. agent: title: Agent description: The AI agent associated with this membership, if the member is an agent rather than a person. filter_id: type: integer title: Filter description: ID of the filter this membership grants access to, if the target is a filter. target_id: type: integer title: Target description: The ID of the target resource this membership applies to. description: Access control record granting a person or team access to a project, deal, page, dashboard, filter, survey, or agent. Defines the access level (type_id) and optional restrictions (options). Memberships drive visibility and edit permissions for shared resources. resource_service: type: object title: Service Resource properties: price_default: title: Price Default description: Unit price for this service in the organization's default currency. bookable_date: type: string title: Bookable Date format: date description: Specific date for resource bookings on this service. project_name: title: Project Name description: Name of the project this service is linked to. left_to_schedule_time: type: integer title: Left To Schedule Time description: Time remaining to be scheduled on this service. expense_cost: title: Expense Cost description: Labor cost from worked time at cost rates. expense_amount: title: Expense Amount description: Total expense amount on this service. profit: type: integer title: Profit description: 'Service profit: revenue minus costs.' billing_type_id: enum: - 1 - 2 - 3 - 4 type: integer title: Billing Type description: 'How this service is billed: hourly, daily, fixed price, or non-billable.' future_budget_used_default: title: Future Budget Used Default description: Budget that will be consumed by future bookings in the organization's default currency. worked_cost: title: Worked Cost description: Labor cost calculated from worked time. future_budget_used_normalized: title: Future Budget Used Normalized description: Budget that will be consumed by future bookings in the organization's normalized currency. future_revenue_normalized: title: Future Revenue Normalized description: Revenue projected from future bookings in the organization's normalized currency. updated_at: type: string title: Updated At format: date description: Timestamp of the last update to this service. project_type: enum: - 1 - 2 type: integer title: Project Type description: Type of the project (billable or overhead). name: type: string title: Name description: Name of the service. budget_remaining: type: integer title: Budget Remaining description: Budget amount remaining unused. work_cost_normalized: title: Work Cost Normalized description: Labor cost from tracked time in the organization's normalized currency. pipeline_id: type: integer title: Pipeline description: The pipeline the parent deal belongs to. custom_field_people: title: Custom Field People description: People in person-type custom fields. cost: title: Cost description: Total cost including labor and expenses. after: type: string title: After format: date description: Earliest bookable date for this service. projected_revenue_normalized: title: Projected Revenue Normalized description: Expected revenue including future scheduled work in the organization's normalized currency. discount_amount: title: Discount Amount description: Total discount in monetary terms. explicit_access: type: boolean title: Explicit Access description: When true, filters services to those the current user has been explicitly granted access to. deal_status_id: type: integer title: Deal Status description: The deal status of the parent deal. revenue_normalized: title: Revenue Normalized description: Total revenue from this service in the organization's normalized currency. revenue_default: title: Revenue Default description: Total revenue from this service in the organization's default currency. bookable_date_for_period: type: string title: Bookable Date For Period format: date description: Filter services to those bookable on the specified date, considering the deal's bookable period. query: type: string title: Query description: Full-text search query to filter services by name or description. deal: title: Deal description: The deal or budget this service is part of. contract_id: type: integer title: Contract description: The recurring contract this service originated from. billable_time: type: integer title: Billable Time description: Billable hours tracked on the service. worked_time: type: integer title: Worked Time description: Total hours tracked on this service. markup: type: number title: Markup description: Markup amount added to the service price. profit_margin: type: number title: Profit Margin description: Profit as a percentage of revenue. stage_status_id: enum: - 1 - 2 - 3 - 4 type: integer title: Stage Status description: The stage status ID of the parent deal. bookable_before: type: string title: Bookable Before format: date description: End date until which resource bookings are allowed. currency_normalized: title: Currency Normalized description: Currency code in the organization's normalized currency. price: type: number title: Price description: Unit price for this service. profit_default: title: Profit Default description: Service profit in the organization's default currency. service_type: title: Service Type description: The work category this service belongs to. future_revenue_default: title: Future Revenue Default description: Revenue projected from future bookings in the organization's default currency. discount_amount_default: title: Discount Amount Default description: Total discount in monetary terms in the organization's default currency. with_memberships: type: boolean title: With Memberships description: Whether this service has membership restrictions. expense_amount_default: title: Expense Amount Default description: Total expense amount on this service in the organization's default currency. budget_status: enum: - 1 - 2 type: integer title: Budget Status description: Current status of the service budget (e.g. on track, over budget). unapproved_time: type: integer title: Unapproved Time description: Total unapproved time entries in minutes. estimated_cost: type: number title: Estimated Cost description: Estimated cost based on estimated time and cost rates. projectless_budgets: type: boolean title: Projectless Budgets description: Whether this service belongs to a budget without a linked project. custom_fields: type: object title: Custom Fields description: Custom field values on this service. markup_amount: title: Markup Amount description: Total markup in monetary terms. future_cost: title: Future Cost description: Projected cost from future scheduled bookings. budget: title: Budget description: The deal budget this service is part of. template: type: boolean title: Template description: Whether this service is a template. cost_default: title: Cost Default description: Total cost including labor and expenses in the organization's default currency. deal_stage_id: type: integer title: Deal Stage description: The pipeline stage the parent deal is in. price_normalized: title: Price Normalized description: Unit price for this service in the organization's normalized currency. before: type: string title: Before format: date description: Latest bookable date for this service. id: type: integer title: Id description: Unique identifier of the service. custom_field_attachments: title: Custom Field Attachments description: Files in file-type custom fields. service_type_id: type: integer title: Service Type description: The work category this service belongs to. expense_amount_normalized: title: Expense Amount Normalized description: Total expense amount on this service in the organization's normalized currency. origin_service_id: type: integer title: Origin Service description: ID of the original service if this was duplicated or rolled over. work_cost: title: Work Cost description: Labor cost from tracked time. person_id: type: integer title: Person description: The person assigned to this service (for person-scoped services). section_id: type: integer title: Section description: The section grouping this service within the deal. markup_amount_normalized: title: Markup Amount Normalized description: Total markup in monetary terms in the organization's normalized currency. expense_billable_amount_normalized: title: Expense Billable Amount Normalized description: Billable portion of expenses in the organization's normalized currency. budgets_and_deals: type: boolean title: Budgets And Deals description: List of related deals and budgets for this service. budget_used: title: Budget Used description: Budget consumed so far. booking_tracking_enabled: type: boolean title: Booking Tracking Enabled description: Whether resource bookings are enabled for this service. budget_used_normalized: title: Budget Used Normalized description: Budget consumed so far in the organization's normalized currency. unit_id: enum: - 1 - 2 - 3 type: integer title: Unit description: 'Tracking unit: hours, days, or pieces.' position: type: integer title: Position description: Sort order within the deal's service list. bookable_after: type: string title: Bookable After format: date description: Start date from which resource bookings are allowed. estimated_cost_default: title: Estimated Cost Default description: Estimated cost based on estimated time and cost rates in the organization's default currency. subsidiary_id: type: integer title: Subsidiary description: The subsidiary associated with the parent deal. billing_type: enum: - 1 - 2 - 3 - 4 type: integer title: Billing Type description: Billing type display name. currency: title: Currency description: Currency code for this service's financial values. sales_status_id: enum: - 1 - 2 - 3 - 4 type: integer title: Sales Status description: The sales status ID of the parent deal. budget_total: title: Budget Total description: Total budget for this service. expense_billable_amount_default: title: Expense Billable Amount Default description: Billable portion of expenses in the organization's default currency. probability: type: integer title: Probability description: Win probability of the parent deal (percentage). trackable_by_person_id: type: integer title: Trackable By Person description: Whether this service is trackable by a specific person. budget_total_normalized: title: Budget Total Normalized description: Total budget for this service in the organization's normalized currency. future_budget_used: title: Future Budget Used description: Budget that will be consumed by future bookings. responsible_id: type: integer title: Responsible description: The person responsible for this service. origin_deal_id: type: integer title: Origin Deal description: The ID of the original deal before rollover. profit_normalized: title: Profit Normalized description: Service profit in the organization's normalized currency. cost_normalized: title: Cost Normalized description: Total cost including labor and expenses in the organization's normalized currency. revenue: title: Revenue description: Total revenue from this service. estimated_cost_normalized: title: Estimated Cost Normalized description: Estimated cost based on estimated time and cost rates in the organization's normalized currency. unit: enum: - 1 - 2 - 3 type: integer title: Unit description: The tracking unit (hours, days, or pieces) for this service. projected_revenue: title: Projected Revenue description: Expected revenue including future scheduled work. company: title: Company description: The company (client) linked to the deal this service is on. for_tracking: type: boolean title: For Tracking description: Whether this service is available for time tracking. future_revenue: title: Future Revenue description: Revenue projected from future bookings. stage_type: enum: - 1 - 2 type: integer title: Stage Type description: The stage type of the parent deal. limitation_type: enum: - no_limitation - estimate_limitation - quantity_limitation - budget_fully_used type: string title: Limitation Type description: Budget cap enforcement type (soft warning vs hard cap). budget_id: type: integer title: Budget description: The ID of the budget this service belongs to. remaining_scheduled_time: type: integer title: Remaining Scheduled Time description: Time remaining to be scheduled on this service. currency_default: title: Currency Default description: Currency code in the organization's default currency. budget_total_default: title: Budget Total Default description: Total budget for this service in the organization's default currency. budgeted_time: type: integer title: Budgeted Time description: Budgeted hours allocated for this service. initial_service_id: type: integer title: Initial Service description: ID of the first service in a rollover chain. booked_time: type: integer title: Booked Time description: Total scheduled (booked) time for this service. organization: title: Organization description: The organization this service belongs to. billable: type: boolean title: Billable description: Whether this service is billable to the client. person: title: Person description: The person assigned to this service (for person-scoped services). future_cost_normalized: title: Future Cost Normalized description: Projected cost from future scheduled bookings in the organization's normalized currency. time_tracking_enabled: type: boolean title: Time Tracking Enabled description: Whether team members can track time against this service. discount_amount_normalized: title: Discount Amount Normalized description: Total discount in monetary terms in the organization's normalized currency. budget_used_default: title: Budget Used Default description: Budget consumed so far in the organization's default currency. expense_tracking_enabled: type: boolean title: Expense Tracking Enabled description: Whether expenses can be logged against this service. projected_revenue_default: title: Projected Revenue Default description: Expected revenue including future scheduled work in the organization's default currency. deal_id: type: integer title: Deal description: The deal or budget this service is part of. revamped_unit: enum: - 1 - 2 - 3 type: integer title: Revamped Unit description: Whether this service uses the revamped unit system. section: title: Section description: The section grouping this service within the deal. markup_amount_default: title: Markup Amount Default description: Total markup in monetary terms in the organization's default currency. editor_config: type: object title: Editor Config description: Rich text editor configuration. future_cost_default: title: Future Cost Default description: Projected cost from future scheduled bookings in the organization's default currency. deleted_at: type: string title: Deleted At format: date-time description: Soft-deletion timestamp. budget_date: type: string title: Budget Date format: date description: The date of the budget period this service belongs to. rolled_over_time: type: integer title: Rolled Over Time description: Time rolled over from a previous retainer period. estimated_time: type: integer title: Estimated Time description: Estimated hours for this service. future_booked_time: type: integer title: Future Booked Time description: Future scheduled time remaining. company_id: type: integer title: Company description: The company (client) linked to the deal this service is on. quantity: type: number title: Quantity description: Number of units (hours, days, or pieces) for this service. task_id: type: integer title: Task description: The task this service is linked to. project_id: type: integer title: Project description: The project this service is linked to. discount: type: number title: Discount description: Discount amount subtracted from the service price. work_cost_default: title: Work Cost Default description: Labor cost from tracked time in the organization's default currency. budget_cap_enabled: type: boolean title: Budget Cap Enabled description: Whether a hard budget cap prevents tracking beyond the budget total. type: type: integer title: Type description: JSON:API resource type identifier. expense_billable_amount: title: Expense Billable Amount description: Billable portion of expenses. description: A line item on a deal or budget that defines billing type, rate, and tracking rules. Services connect time tracking, resource scheduling, and invoicing for a specific scope of work. resource_project_report: type: object title: Project report Resource properties: total_cost: title: Total Cost description: Sum of cost across all records in this project report group. total_revenue: title: Total Revenue description: Sum of revenue across all records in this project report group. last_activity_at: title: Last Activity At description: Timestamp of the most recent activity on this project. worked_time: type: integer title: Worked Time description: Worked time for this project report group. estimated_time: type: integer title: Estimated Time description: Estimated time for this project report group. profit: title: Profit description: Profit for this project report group. project_id: type: integer title: Project description: Project id for this project report group. report: title: Report description: Report for this project report group. pending_invoicing: title: Pending Invoicing description: Pending invoicing for this project report group. project: title: Project description: Project for this project report group. profit_margin: type: integer title: Profit Margin description: Profit margin for this project report group. total_projected_revenue: title: Total Projected Revenue description: Sum of projected revenue across all records in this project report group. project_manager_report: title: Project Manager Report description: Project manager report for this project report group. project_last_activity_at: title: Project Last Activity At description: Timestamp of the most recent activity on the project associated with this report row. query: type: string title: Query description: Query for this project report group. project_type: enum: - 1 - 2 type: integer title: Project Type description: Project type for this project report group. total_cost_normalized: title: Total Cost Normalized description: Sum of cost in the normalized currency across all records in this project report group. last_activity_at_period: title: Last Activity At Period description: Time period grouping for last activity date (e.g. week, month, quarter). total_pending_invoicing_normalized: title: Total Pending Invoicing Normalized description: Sum of pending invoicing in the normalized currency across all records in this project report group. currency: type: string title: Currency description: Currency for this project report group. quarter: type: string title: Quarter description: Quarter grouping for this project report row. id: type: integer title: Id description: Unique identifier for this project report row. year: type: string title: Year description: Year grouping for this project report row. public_access: type: boolean title: Public Access description: Public access for this project report group. formulas: type: integer title: Formulas description: Formulas for this project report group. project_name: title: Project Name description: Project name for this project report group. project_created_at: title: Project Created At description: Project created at for this project report group. total_revenue_default: title: Total Revenue Default description: Sum of revenue in the organization's default currency across all records in this project report group. jump_query: type: string title: Jump Query description: Jump query for this project report group. budget_id: type: integer title: Budget description: Budget id for this project report group. fuzzy_people: type: integer title: Fuzzy People description: Fuzzy people for this project report group. created_at: type: string title: Created At format: date description: Created at for this project report group. revenue: title: Revenue description: Revenue for this project report group. group: type: string title: Group description: The grouping dimension for this project report row. count: type: integer title: Count description: Number of projects in this report group. total_needs_invoicing: title: Total Needs Invoicing description: Sum of needs invoicing across all records in this project report group. total_profit: title: Total Profit description: Sum of profit across all records in this project report group. custom_fields: type: string title: Custom Fields description: Custom fields for this project report group. formula_fields: title: Formula Fields description: Formula fields for this project report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this project report group. cost: title: Cost description: Cost for this project report group. total_estimated_time: type: number title: Total Estimated Time description: Sum of estimated time across all records in this project report group. month: type: string title: Month description: Month grouping for this project report row. total_projected_revenue_normalized: title: Total Projected Revenue Normalized description: Sum of projected revenue in the normalized currency across all records in this project report group. total_pending_invoicing: title: Total Pending Invoicing description: Sum of pending invoicing across all records in this project report group. average_profit_margin_default: type: number title: Average Profit Margin Default description: Average profit margin in the organization's default currency for this project report group. with_templates: type: boolean title: With Templates description: When true, includes project templates in the report results. total_needs_invoicing_normalized: title: Total Needs Invoicing Normalized description: Sum of needs invoicing in the normalized currency across all records in this project report group. organization: title: Organization description: Organization for this project report group. currency_normalized: title: Currency Normalized description: Currency in the normalized currency for this project report group. parent_company_id: type: integer title: Parent Company description: ID of the parent company of the client linked to projects in this group, used for hierarchical company filtering. project_manager: title: Project Manager description: Project manager for this project report group. company_report: title: Company Report description: Company report for this project report group. for_tracking: type: boolean title: For Tracking description: For tracking for this project report group. company: title: Company description: Company for this project report group. project_status: type: integer title: Project Status description: Project status for this project report group. number: type: string title: Number description: Number for this project report group. projected_revenue: title: Projected Revenue description: Projected revenue for this project report group. responsible_id: type: integer title: Responsible description: Responsible id for this project report group. person_id: type: integer title: Person description: Person id for this project report group. created_at_period: title: Created At Period description: Time period grouping for created at (e.g. week, month, quarter). name: type: string title: Name description: Name for this project report group. full_query: type: string title: Full Query description: Full query for this project report group. total_worked_time: type: number title: Total Worked Time description: Sum of worked time across all records in this project report group. average_profit_margin_normalized: title: Average Profit Margin Normalized description: Average profit margin in the normalized currency for this project report group. workflow_id: type: integer title: Workflow description: Workflow id for this project report group. total_cost_default: title: Total Cost Default description: Sum of cost in the organization's default currency across all records in this project report group. week: type: string title: Week description: Week grouping for this project report row. status: enum: - 1 - 2 type: integer title: Status description: Status for this project report group. template: type: string title: Template description: Template for this project report group. total_revenue_normalized: title: Total Revenue Normalized description: Sum of revenue in the normalized currency across all records in this project report group. total_profit_normalized: title: Total Profit Normalized description: Sum of profit in the normalized currency across all records in this project report group. total_pending_invoicing_default: title: Total Pending Invoicing Default description: Sum of pending invoicing in the organization's default currency across all records in this project report group. project_number: type: string title: Project Number description: Project number for this project report group. total_profit_default: title: Total Profit Default description: Sum of profit in the organization's default currency across all records in this project report group. company_id: type: integer title: Company description: Company id for this project report group. total_projected_revenue_default: title: Total Projected Revenue Default description: Sum of projected revenue in the organization's default currency across all records in this project report group. project_custom_fields: title: Project Custom Fields description: Project custom fields for this project report group. total_needs_invoicing_default: title: Total Needs Invoicing Default description: Sum of needs invoicing in the organization's default currency across all records in this project report group. fuzzy_dates: type: string title: Fuzzy Dates format: date description: Fuzzy dates for this project report group. project_color: type: integer title: Project Color description: Project color for this project report group. average_profit_margin: type: number title: Average Profit Margin description: Average profit margin for this project report group. description: An aggregated project report row grouping projects by configurable dimensions with utilization, financial, and delivery metrics. filter_einvoice_transaction: type: object title: Filter einvoice transaction properties: created_at: oneOf: - type: object title: Operation properties: gt: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/created_at" lte: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/created_at" gte: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/created_at" lt: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/created_at" eq: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/created_at" description: Comparison operators for this filter field. example: gte: '2025-01-01' lte: '2025-12-31' - "$ref": "#/components/schemas/resource_einvoice_transaction/properties/created_at" description: Filter by the date the transaction was created. example: '2025-03-15T10:30:00.000Z' invoice_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/invoice_id" not_eq: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/invoice_id" not_contain: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/invoice_id" eq: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/invoice_id" description: Comparison operators for this filter field. example: eq: '3456' - "$ref": "#/components/schemas/resource_einvoice_transaction/properties/invoice_id" description: Filter by the ID of the associated invoice. example: '3456' description: Available filter fields for e-invoice transaction resources. example: invoice_id: '3456' filter_document_type: type: object title: Filter document type properties: status: oneOf: - "$ref": "#/components/schemas/resource_document_type/properties/status" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_document_type/properties/status" contains: "$ref": "#/components/schemas/resource_document_type/properties/status" eq: "$ref": "#/components/schemas/resource_document_type/properties/status" not_contain: "$ref": "#/components/schemas/resource_document_type/properties/status" description: Filter using explicit operator syntax. description: Filter by active/archived status. exportable_type_id: oneOf: - "$ref": "#/components/schemas/resource_document_type/properties/exportable_type_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_document_type/properties/exportable_type_id" not_contain: "$ref": "#/components/schemas/resource_document_type/properties/exportable_type_id" contains: "$ref": "#/components/schemas/resource_document_type/properties/exportable_type_id" eq: "$ref": "#/components/schemas/resource_document_type/properties/exportable_type_id" description: Filter using explicit operator syntax. description: Filter by the exportable type ID the document type applies to. id: oneOf: - "$ref": "#/components/schemas/resource_document_type/properties/id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_document_type/properties/id" not_eq: "$ref": "#/components/schemas/resource_document_type/properties/id" not_contain: "$ref": "#/components/schemas/resource_document_type/properties/id" contains: "$ref": "#/components/schemas/resource_document_type/properties/id" description: Filter using explicit operator syntax. description: Filter by document type ID. subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_document_type/properties/subsidiary_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_document_type/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_document_type/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_document_type/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_document_type/properties/subsidiary_id" description: Filter using explicit operator syntax. description: Filter by the associated subsidiary. document_template_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_document_type/properties/document_template_id" not_contain: "$ref": "#/components/schemas/resource_document_type/properties/document_template_id" contains: "$ref": "#/components/schemas/resource_document_type/properties/document_template_id" not_eq: "$ref": "#/components/schemas/resource_document_type/properties/document_template_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_document_type/properties/document_template_id" description: Filter by the associated document template. patternProperties: "^subsidiary..*$": title: Subsidiary relationship description: Filter parameters for document types. resource_invoice_attribution: type: object title: Invoice attribution Resource properties: invoice_id: type: integer title: Invoice description: ID of the invoice this attribution belongs to. date_to: type: string title: Date To format: date description: Date on which the attributed period ends, or null if not specified. amount_default: title: Amount Default description: The attributed amount converted to the organization's default currency. amount_normalized: title: Amount Normalized description: The attributed amount converted to the normalized (reporting) currency. amount: type: integer title: Amount description: The attributed amount in the invoice's currency. budget: title: Budget description: The budget (deal) this invoice attribution is linked to. currency_normalized: title: Currency Normalized description: The normalized (reporting) currency for this invoice attribution. currency: title: Currency description: The currency of this invoice attribution, inherited from the associated invoice. currency_default: title: Currency Default description: The organization's default currency for this invoice attribution. invoice: title: Invoice description: The invoice this attribution belongs to. organization: title: Organization description: The organization this invoice attribution belongs to. date_from: type: string title: Date From format: date description: Date from which the attributed period starts, or null if not specified. budget_id: type: integer title: Budget description: ID of the budget (deal) this invoice attribution is linked to. description: An invoice attribution links a portion of an invoice amount to a specific budget (deal), tracking which budget a part of the invoice covers and optionally the date range it applies to. _filter_root_organization_membership: oneOf: - "$ref": "#/components/schemas/filter_organization_membership" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_organization_membership" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `organization_membership` list endpoints — pass a single condition or a logical group. resource_revenue_distribution: type: object title: Revenue distribution Resource properties: amount: title: Amount description: The revenue amount for this distribution period in the deal's currency. deal: title: Deal description: The deal this revenue distribution belongs to. id: type: integer title: Id description: The unique identifier of this revenue distribution. creator_id: type: integer title: Creator description: ID of the person who created this revenue distribution. start_on: type: string title: Start On format: date description: Date when this revenue distribution period starts. currency: title: Currency description: The currency code of the deal this revenue distribution belongs to. organization: title: Organization description: The organization this revenue distribution belongs to. amount_percent: type: number title: Amount Percent description: The percentage of the deal's total revenue allocated to this distribution period. amount_default: title: Amount Default description: The revenue amount for this distribution period in the organization's default currency. currency_normalized: title: Currency Normalized description: The currency code of the deal this revenue distribution belongs to. end_on: type: string title: End On format: date description: Date when this revenue distribution period ends. deal_id: type: integer title: Deal description: ID of the deal this revenue distribution belongs to. currency_default: title: Currency Default description: The organization's default currency code. created_at: type: string title: Created At format: date description: Timestamp when this revenue distribution was created. amount_normalized: title: Amount Normalized description: The revenue amount for this distribution period in the deal's currency. description: A record defining how deal revenue is distributed across a specific date range. resource_proposal: type: object title: Proposal Resource properties: responsible_id: type: integer title: Responsible description: ID of the person responsible for this proposal. link_status: enum: - active - inactive type: string title: Link Status description: The public sharing link status of the proposal (e.g. active, disabled). creator_id: type: integer title: Creator description: ID of the person who created this proposal. signed: title: Signed description: When true, the proposal has been signed by the client. responder_name: type: string title: Responder Name description: The name of the person who responded to (signed) the proposal. responsible: title: Responsible description: The project manager responsible for this proposal. name: type: string title: Name description: The display name of the proposal. updated_at: type: string title: Updated At format: date description: Timestamp of the last update to this proposal. sent_at: type: string title: Sent At format: date-time description: Timestamp when the proposal was sent to the client. public_uuid: type: string title: Public Uuid description: The unique public UUID used to generate the proposal's public sharing link. status_changed_at: type: string title: Status Changed At format: date-time description: Timestamp when the proposal status last changed. project: title: Project description: The project associated with this proposal. budget_total: title: Budget Total description: The total budget amount of this proposal in the proposal's currency. original_pdf_url: type: string title: Original Pdf Url description: The URL of the generated PDF for this proposal. proposal_from: title: Proposal From description: The sender details (subsidiary contact) shown on the proposal. deal_id: type: integer title: Deal description: The ID of the deal this proposal belongs to. purchase_order_number: type: string title: Purchase Order Number description: The client's purchase order number associated with this proposal. example: PO-2024-017 deal_creator: title: Deal Creator description: The person who created the deal associated with this proposal. company_id: type: integer title: Company description: ID of the client company associated with this proposal. document_type: title: Document Type description: The document type template applied to this proposal for PDF generation. budget_total_default: title: Budget Total Default description: The total budget amount of this proposal in the organization's default currency. footer_interpolated: title: Footer Interpolated description: The footer text with all interpolation variables resolved. responder_email: type: string title: Responder Email description: The email address of the person who responded to (signed) the proposal. exchange_date: type: string title: Exchange Date format: date description: The date used to determine the exchange rate applied to this proposal. tax_rate: title: Tax Rate description: The tax rate applied to proposal line items. disclaimer: type: string title: Disclaimer description: The optional disclaimer text appended to the proposal. custom_fields: type: object title: Custom Fields description: Custom field values for this proposal. currency: type: string title: Currency description: The currency code used for amounts in this proposal. organization: title: Organization description: The organization this proposal belongs to. currency_default: title: Currency Default description: The organization's default currency code. disclaimer_enabled: type: boolean title: Disclaimer Enabled description: When true, the disclaimer text is shown on the proposal. id: type: integer title: Id description: Unique identifier for the proposal. footer: title: Footer description: The footer text template for the proposal, may contain interpolation variables. note: type: string title: Note description: The body text of the proposal note, may contain interpolation variables. exchange_rate: type: number title: Exchange Rate description: The exchange rate used to convert proposal amounts to the billing currency. subsidiary: title: Subsidiary description: The subsidiary (legal entity) issuing this proposal. client: title: Client description: The client company this proposal is addressed to. date: type: string title: Date format: date description: Date when this proposal was issued. end_date: type: string title: End Date format: date description: The end date of the proposal's validity or service period. currency_normalized: title: Currency Normalized description: The normalized (reporting) currency code used across the organization. status: enum: - draft - sent - accepted - rejected type: string title: Status description: The current status of the proposal (e.g. draft, sent, approved, rejected). proposal_to: title: Proposal To description: The recipient details (client contact) shown on the proposal. creator: title: Creator description: The person who created this proposal. deal: title: Deal description: The deal (sales opportunity) this proposal belongs to. created_at: type: string title: Created At format: date-time description: Timestamp when this proposal was created. budget_total_normalized: title: Budget Total Normalized description: The total budget amount of this proposal in the normalized (reporting) currency. contact: title: Contact description: The contact person this proposal is addressed to. note_interpolated: title: Note Interpolated description: The proposal note with all interpolation variables resolved. audit_pdf_url: type: string title: Audit Pdf Url description: URL of the audit trail PDF for this proposal, capturing signature and viewing history. description: A document sent to a client summarizing proposed work, budget, and terms for a deal. filter_project_report: type: object title: Filter project report properties: profit: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/profit" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project_report/properties/profit" contains: "$ref": "#/components/schemas/resource_project_report/properties/profit" eq: "$ref": "#/components/schemas/resource_project_report/properties/profit" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/profit" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total profit across open budgets. workflow_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_project_report/properties/workflow_id" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/workflow_id" contains: "$ref": "#/components/schemas/resource_project_report/properties/workflow_id" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/workflow_id" description: Filter operator object for workflow id. - "$ref": "#/components/schemas/resource_project_report/properties/workflow_id" description: Filter project report results by workflow id. parent_company_id: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/parent_company_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_report/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_project_report/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_project_report/properties/parent_company_id" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/parent_company_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the parent company of the project's company. total_worked_time: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/total_worked_time" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_report/properties/total_worked_time" eq: "$ref": "#/components/schemas/resource_project_report/properties/total_worked_time" contains: "$ref": "#/components/schemas/resource_project_report/properties/total_worked_time" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/total_worked_time" description: Filter operator object for total worked time. description: Filter project report results by total worked time. id: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_report/properties/id" eq: "$ref": "#/components/schemas/resource_project_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/id" contains: "$ref": "#/components/schemas/resource_project_report/properties/id" description: Filter operator object for id. description: Filter project report results by id. revenue: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/revenue" eq: "$ref": "#/components/schemas/resource_project_report/properties/revenue" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/revenue" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/revenue" description: Filter operator object for revenue. - "$ref": "#/components/schemas/resource_project_report/properties/revenue" description: Filter project report results by revenue. template: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/template" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project_report/properties/template" eq: "$ref": "#/components/schemas/resource_project_report/properties/template" contains: "$ref": "#/components/schemas/resource_project_report/properties/template" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/template" description: Filter operator object for template. description: Filter project report results by template. name: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/name" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_report/properties/name" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/name" contains: "$ref": "#/components/schemas/resource_project_report/properties/name" eq: "$ref": "#/components/schemas/resource_project_report/properties/name" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by project name (text search). project_type: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/project_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/project_type" eq: "$ref": "#/components/schemas/resource_project_report/properties/project_type" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/project_type" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/project_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the project type (client or internal). worked_time: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/worked_time" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/worked_time" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/worked_time" eq: "$ref": "#/components/schemas/resource_project_report/properties/worked_time" description: Filter operator object for worked time. - "$ref": "#/components/schemas/resource_project_report/properties/worked_time" description: Filter project report results by worked time. status: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/status" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/status" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/status" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/status" eq: "$ref": "#/components/schemas/resource_project_report/properties/status" description: Filter operator object for status. description: Filter project report results by status. full_query: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/full_query" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/full_query" eq: "$ref": "#/components/schemas/resource_project_report/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/full_query" description: Operator object — supports eq, not_eq, contains, not_contain. description: Search projects by full-text match across all searchable fields. company_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project_report/properties/company_id" eq: "$ref": "#/components/schemas/resource_project_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/company_id" contains: "$ref": "#/components/schemas/resource_project_report/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project_report/properties/company_id" description: Filter by client company. number: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/number" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/number" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/number" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/number" eq: "$ref": "#/components/schemas/resource_project_report/properties/number" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by project number (text search). project_color: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_report/properties/project_color" eq: "$ref": "#/components/schemas/resource_project_report/properties/project_color" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/project_color" contains: "$ref": "#/components/schemas/resource_project_report/properties/project_color" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project_report/properties/project_color" description: Filter by the project's color label. project_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project_report/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/project_id" eq: "$ref": "#/components/schemas/resource_project_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_project_report/properties/project_id" description: Filter operator object for project id. - "$ref": "#/components/schemas/resource_project_report/properties/project_id" description: Filter project report results by project id. custom_fields: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/custom_fields" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_project_report/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by custom field values. fuzzy_people: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_report/properties/fuzzy_people" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_project_report/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_project_report/properties/fuzzy_people" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project_report/properties/fuzzy_people" description: Filter by fuzzy person references (e.g. me, my_team). for_tracking: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/for_tracking" eq: "$ref": "#/components/schemas/resource_project_report/properties/for_tracking" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/for_tracking" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/for_tracking" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project_report/properties/for_tracking" description: Filter to active projects available for time tracking. public_access: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/public_access" eq: "$ref": "#/components/schemas/resource_project_report/properties/public_access" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/public_access" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/public_access" description: Filter operator object for public access. - "$ref": "#/components/schemas/resource_project_report/properties/public_access" description: Filter project report results by public access. query: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_report/properties/query" eq: "$ref": "#/components/schemas/resource_project_report/properties/query" contains: "$ref": "#/components/schemas/resource_project_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/query" description: Filter operator object for query. description: Filter project report results by query. jump_query: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/jump_query" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/jump_query" eq: "$ref": "#/components/schemas/resource_project_report/properties/jump_query" description: Operator object — supports eq, not_eq, contains, not_contain. description: Search projects using a jump (quick prefix) text search. pending_invoicing: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/pending_invoicing" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_project_report/properties/pending_invoicing" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/pending_invoicing" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/pending_invoicing" contains: "$ref": "#/components/schemas/resource_project_report/properties/pending_invoicing" description: Filter operator object for pending invoicing. description: Filter project report results by pending invoicing. budget_id: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/budget_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_report/properties/budget_id" contains: "$ref": "#/components/schemas/resource_project_report/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/budget_id" eq: "$ref": "#/components/schemas/resource_project_report/properties/budget_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated budget (deal). cost: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/cost" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_project_report/properties/cost" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/cost" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/cost" contains: "$ref": "#/components/schemas/resource_project_report/properties/cost" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total cost across budgets. estimated_time: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/estimated_time" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_report/properties/estimated_time" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/estimated_time" eq: "$ref": "#/components/schemas/resource_project_report/properties/estimated_time" contains: "$ref": "#/components/schemas/resource_project_report/properties/estimated_time" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total estimated time across budgets. person_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/person_id" eq: "$ref": "#/components/schemas/resource_project_report/properties/person_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project_report/properties/person_id" description: Filter project report results by person id. created_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_report/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/created_at" eq: "$ref": "#/components/schemas/resource_project_report/properties/created_at" contains: "$ref": "#/components/schemas/resource_project_report/properties/created_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project_report/properties/created_at" description: Filter by creation date range (created_at). project_number: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/project_number" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/project_number" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/project_number" eq: "$ref": "#/components/schemas/resource_project_report/properties/project_number" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/project_number" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the project's number identifier. formulas: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_project_report/properties/formulas" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/formulas" description: Filter operator object for formulas. - "$ref": "#/components/schemas/resource_project_report/properties/formulas" description: Filter project report results by formulas. fuzzy_dates: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/fuzzy_dates" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_project_report/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_project_report/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/fuzzy_dates" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/fuzzy_dates" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by fuzzy date range expressions (e.g. this_week, last_month). responsible_id: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/responsible_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project_report/properties/responsible_id" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_project_report/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_project_report/properties/responsible_id" description: Filter operator object for responsible id. description: Filter project report results by responsible id. profit_margin: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/profit_margin" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_project_report/properties/profit_margin" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/profit_margin" contains: "$ref": "#/components/schemas/resource_project_report/properties/profit_margin" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/profit_margin" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the project's profit margin across budgets. projected_revenue: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/projected_revenue" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project_report/properties/projected_revenue" not_eq: "$ref": "#/components/schemas/resource_project_report/properties/projected_revenue" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/projected_revenue" eq: "$ref": "#/components/schemas/resource_project_report/properties/projected_revenue" description: Filter operator object for projected revenue. description: Filter project report results by projected revenue. with_templates: oneOf: - "$ref": "#/components/schemas/resource_project_report/properties/with_templates" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_report/properties/with_templates" contains: "$ref": "#/components/schemas/resource_project_report/properties/with_templates" eq: "$ref": "#/components/schemas/resource_project_report/properties/with_templates" not_contain: "$ref": "#/components/schemas/resource_project_report/properties/with_templates" description: Operator object — supports eq, not_eq, contains, not_contain. description: When true, includes template projects in results (removes the default filter that excludes templates). patternProperties: "^deals..*$": title: Deals relationship "^budgets..*$": title: Budgets relationship "^company..*$": title: Company relationship "^project_manager..*$": title: Project manager relationship description: Available filter parameters for querying aggregated project report data. resource_payment_reminder_sequence: type: object title: Payment reminder sequence Resource properties: name: type: string title: Name description: The name of this payment reminder sequence. created_at: type: string title: Created At format: date-time description: Timestamp when this payment reminder sequence was created. updated_at: type: string title: Updated At format: date-time description: Timestamp when this payment reminder sequence was last updated. updater: title: Updater description: The person who last updated this payment reminder sequence. creator: title: Creator description: The person who created this payment reminder sequence. organization: title: Organization description: The organization this payment reminder sequence belongs to. payment_reminders: title: Payment Reminders description: Array of individual payment reminder steps in this sequence, each defining timing and message content. default_sequence: type: boolean title: Default Sequence description: When true, this sequence is used as the default reminder sequence for new invoices. description: The resource payment reminder sequence. _filter_root_deal_status: oneOf: - "$ref": "#/components/schemas/filter_deal_status" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_deal_status" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `deal_status` list endpoints — pass a single condition or a logical group. _filter_root_invoice_attribution: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_invoice_attribution" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_invoice_attribution" description: Filter schema for `invoice_attribution` list endpoints — pass a single condition or a logical group. _filter_root_subsidiary: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_subsidiary" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_subsidiary" description: Filter schema for `subsidiary` list endpoints — pass a single condition or a logical group. resource_entitlement: type: object title: Entitlement Resource properties: used: type: number title: Used description: Hours already used — approved absence bookings that have been taken within the entitlement period. approval_workflow: title: Approval Workflow description: Whether an approval workflow is required for absence requests under this entitlement. id: type: integer title: Id description: The unique identifier of this entitlement record. organization: title: Organization description: The organization this entitlement belongs to. note: type: string title: Note description: Optional note providing additional context for this entitlement allocation. person: title: Person description: The person this entitlement applies to. event_id: type: integer title: Event description: The ID of the absence category (event) this entitlement covers. start_date: type: string title: Start Date format: date description: The date when this entitlement period starts. pending: type: number title: Pending description: Hours pending approval — absence bookings submitted but not yet approved. allocated: type: number title: Allocated description: Total hours allocated to this person for the absence category in the entitlement period. date: type: string title: Date format: date description: The reference date for this entitlement record (typically the start of the accrual period). event: title: Event description: The absence category (event) this entitlement is for, such as vacation or sick leave. person_id: type: integer title: Person description: The ID of the person this entitlement applies to. end_date: type: string title: End Date format: date description: The date when this entitlement period ends. After this date, unused hours may expire. description: A time-off entitlement for a person showing allocated, used, and pending hours for an absence category. _filter_root_overhead: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_overhead" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_overhead" description: Filter schema for `overhead` list endpoints — pass a single condition or a logical group. filter_tag: type: object title: Filter tag properties: person_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_tag/properties/person_id" eq: "$ref": "#/components/schemas/resource_tag/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_tag/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_tag/properties/person_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_tag/properties/person_id" description: Filter to tags applied to the given person. company_id: oneOf: - "$ref": "#/components/schemas/resource_tag/properties/company_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_tag/properties/company_id" eq: "$ref": "#/components/schemas/resource_tag/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_tag/properties/company_id" contains: "$ref": "#/components/schemas/resource_tag/properties/company_id" description: Filter using explicit operator syntax. description: Filter to tags applied to the given company. name: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_tag/properties/name" contains: "$ref": "#/components/schemas/resource_tag/properties/name" not_eq: "$ref": "#/components/schemas/resource_tag/properties/name" not_contain: "$ref": "#/components/schemas/resource_tag/properties/name" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_tag/properties/name" description: Filter by tag name (text search). invoice_id: oneOf: - "$ref": "#/components/schemas/resource_tag/properties/invoice_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_tag/properties/invoice_id" eq: "$ref": "#/components/schemas/resource_tag/properties/invoice_id" not_contain: "$ref": "#/components/schemas/resource_tag/properties/invoice_id" not_eq: "$ref": "#/components/schemas/resource_tag/properties/invoice_id" description: Filter using explicit operator syntax. description: Filter to tags applied to the given invoice. taggable_type: oneOf: - "$ref": "#/components/schemas/resource_tag/properties/taggable_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_tag/properties/taggable_type" not_contain: "$ref": "#/components/schemas/resource_tag/properties/taggable_type" eq: "$ref": "#/components/schemas/resource_tag/properties/taggable_type" not_eq: "$ref": "#/components/schemas/resource_tag/properties/taggable_type" description: Filter using explicit operator syntax. description: Filter by the type of resource the tag is applied to (e.g. deal, task, person). task_id: oneOf: - "$ref": "#/components/schemas/resource_tag/properties/task_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_tag/properties/task_id" contains: "$ref": "#/components/schemas/resource_tag/properties/task_id" eq: "$ref": "#/components/schemas/resource_tag/properties/task_id" not_contain: "$ref": "#/components/schemas/resource_tag/properties/task_id" description: Filter using explicit operator syntax. description: Filter to tags applied to the given task. deal_id: oneOf: - "$ref": "#/components/schemas/resource_tag/properties/deal_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_tag/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_tag/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_tag/properties/deal_id" contains: "$ref": "#/components/schemas/resource_tag/properties/deal_id" description: Filter using explicit operator syntax. description: Filter to tags applied to the given deal. project_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_tag/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_tag/properties/project_id" contains: "$ref": "#/components/schemas/resource_tag/properties/project_id" eq: "$ref": "#/components/schemas/resource_tag/properties/project_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_tag/properties/project_id" description: Filter to tags applied to tasks within the given project. patternProperties: {} description: Filter parameters for tags. resource_kpd_code: type: object title: KPD Code Resource properties: id: type: integer title: Id description: Unique identifier of the KPD code record. example: '42' created_at: type: string title: Created At format: date-time description: Timestamp when the record was created. example: '2025-03-15T10:30:00.000Z' kpd_name: type: string title: Kpd Name description: Name of the activity in the KPD (agricultural activities) classification. example: Uzgoj žitarica (osim riže), mahunarki i uljanog sjemenja is_kpd: type: boolean title: Is Kpd description: Whether this code belongs to the KPD classification (true) or the NKD classification (false). example: true query: type: string title: Query description: Full-text search filter for KPD code names. example: žitarica nkd_name: type: string title: Nkd Name description: Name of the activity in the NKD (national activities) classification. example: Uzgoj žitarica (osim riže), mahunarki i uljanog sjemenja code: type: string title: Code description: The classification code value (e.g., 01.1, 10.12). example: '01.11' updated_at: type: string title: Updated At format: date-time description: Timestamp when the record was last updated. example: '2025-06-01T14:22:00.000Z' description: A reference entry from the Croatian KPD (Klasifikacija Poljoprivrednih Djelatnosti — agricultural activities) or NKD (Nacionalna Klasifikacija Djelatnosti — national activities) classification system. These codes are used to categorize invoice line items when sending Croatian e-invoices. The collection is read-only and globally shared across all organizations. example: id: '42' type: kpd_codes attributes: code: '01.11' kpd_name: Uzgoj žitarica (osim riže), mahunarki i uljanog sjemenja nkd_name: Uzgoj žitarica (osim riže), mahunarki i uljanog sjemenja is_kpd: true created_at: '2024-01-01T00:00:00.000Z' updated_at: '2024-01-01T00:00:00.000Z' resource_time_tracking_policy: type: object title: Time tracking policy Resource properties: name: type: string title: Name description: The display name of the time tracking policy. archived_at: type: string title: Archived At format: date-time description: Timestamp when this policy was archived, or null if it is still active. id: type: integer title: Id description: Unique identifier for the time tracking policy. creator: title: Creator description: The person who created this time tracking policy. working_day_limit: type: integer title: Working Day Limit description: Maximum hours that can be tracked on a standard working day. disabled_tracking_message: type: string title: Disabled Tracking Message description: Message shown to people when time tracking is fully disabled for them. half_day_absence_limit: type: integer title: Half Day Absence Limit description: Maximum hours that can be tracked on a half day of absence. limited_tracking_message: type: string title: Limited Tracking Message description: Message shown to people when time tracking is limited (not fully disabled) for them. person_id: type: integer title: Person description: The ID of the person this policy applies to, if person-specific. restrict_future_tracking: type: boolean title: Restrict Future Tracking description: When true, time entries cannot be logged for future dates. assigned_people_count: title: Assigned People Count description: The number of active people currently assigned to this time tracking policy. last_actor: title: Last Actor description: The person who last modified this time tracking policy. holiday_limit: type: integer title: Holiday Limit description: Maximum hours that can be tracked on a public holiday. full_day_absence_limit: type: integer title: Full Day Absence Limit description: Maximum hours that can be tracked on a full day of absence. status: enum: - 1 - 2 type: integer title: Status description: The status of this policy, indicating whether it is active or archived. updated_at: type: string title: Updated At format: date-time description: Timestamp when this time tracking policy was last updated. non_working_day_limit: type: integer title: Non Working Day Limit description: Maximum hours that can be tracked on a non-working day. restrict_time_entry_overlap: type: boolean title: Restrict Time Entry Overlap description: When true, overlapping time entry ranges are not allowed. task_mandatory: type: boolean title: Task Mandatory description: When true, a task must be selected when logging a time entry. restrict_tracking_over_budget: type: boolean title: Restrict Tracking Over Budget description: When true, time entries cannot be logged for services that have exceeded their budget. created_at: type: string title: Created At format: date-time description: Timestamp when the time tracking policy was created. time_range_mandatory: type: boolean title: Time Range Mandatory description: When true, a start and end time range must be provided for every time entry. organization: title: Organization description: The organization this time tracking policy belongs to. note_mandatory: type: boolean title: Note Mandatory description: When true, a note is required on every time entry submitted. description: A time tracking policy defines rules for how time entries can be logged, including limits and mandatory fields. _filter_root_service_type: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_service_type" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_service_type" description: Filter schema for `service_type` list endpoints — pass a single condition or a logical group. resource_todo: type: object title: Todo Resource properties: assignee_id: type: integer title: Assignee description: The ID of the person assigned to complete this checklist item. assignee: title: Assignee description: The person assigned to complete this checklist item. todoable_type: type: string title: Todoable Type description: The type of the parent resource this todo is attached to (task or deal). id: type: integer title: Id description: Unique identifier for the checklist item. task: title: Task description: The task this todo belongs to. organization: title: Organization description: The organization this checklist item belongs to. task_id: type: integer title: Task description: ID of the task this todo belongs to. status: enum: - 1 - 2 type: integer title: Status description: 'Filter by todo status: 1 = open, 2 = closed.' closed: title: Closed description: Indicates whether this checklist item has been completed. position: type: integer title: Position description: The display order of this todo within its parent list. closed_at: type: string title: Closed At format: date-time description: Timestamp when this checklist item was completed, or null if still open. created_at: type: string title: Created At format: date-time description: Timestamp when this checklist item was created. deal: title: Deal description: The deal this checklist item belongs to, if attached to a deal. due_time: type: string title: Due Time format: time description: The specific time of day the checklist item is due. due_date: type: string title: Due Date format: date description: The due date for completing this checklist item. deal_id: type: integer title: Deal description: The ID of the deal this checklist item belongs to, if applicable. description: Checklist item on a task or deal. Supports description, assignee, due date (with optional time), position ordering, and completion tracking via closed_at timestamp. resource_invoice_report: type: object title: Invoice report Resource properties: number: type: string title: Number description: The unique invoice number identifying this invoice. year: type: string title: Year description: Year grouping for this invoice report row. invoice_subject: title: Invoice Subject description: Invoice subject for this invoice report group. invoice_discount: title: Invoice Discount description: The discount applied to this invoice, surfaced as a report column. company_report: title: Company Report description: Related company report data for the client in this report group. creator_report: title: Creator Report description: Related person report data for the invoice creator in this report group. sent_on_period: title: Sent On Period description: Time period grouping for sent on (e.g. week, month, quarter). einvoice_status: type: integer title: Einvoice Status description: The current e-invoicing status of this invoice (e.g., pending, sent, accepted, rejected). example: delivered pay_on_period: title: Pay On Period description: Time period grouping for the invoice due date (e.g. week, month, quarter). total_amount_default: title: Total Amount Default description: Sum of amount in the organization's default currency across all records in this invoice report group. delivery_on: type: string title: Delivery On format: date description: Date when the goods or services on this invoice were delivered. total_amount_tax_default: title: Total Amount Tax Default description: Sum of amount tax in the organization's default currency across all records in this invoice report group. total_amount_credited_with_tax_default: title: Total Amount Credited With Tax Default description: Sum of amount credited with tax in the organization's default currency across all records in this invoice report group. id: type: integer title: Id description: Unique identifier for this invoice report row. invoice_last_activity_at: title: Invoice Last Activity At description: Timestamp of the most recent activity on the invoice associated with this report row. invoice_state: enum: - 1 - 2 type: integer title: Invoice State description: Invoice state for this invoice report group. custom_fields: type: string title: Custom Fields description: Custom field values for the invoice in this row, as a JSON hash keyed by custom field ID. export_status: enum: - 1 - 2 type: integer title: Export Status description: Export status of this invoice — whether it has been copied to an external accounting system (e.g. exported or unexported). total_amount_credited_default: title: Total Amount Credited Default description: Sum of amount credited in the organization's default currency across all records in this invoice report group. invoiced_on_period: title: Invoiced On Period description: Time period grouping for the invoice issued date (e.g. week, month, quarter). jump_query: type: string title: Jump Query description: A simplified query string for quick navigation or linking to this report's filtered view. invoice_number: title: Invoice Number description: The invoice's unique number identifier, surfaced as a report column. project: title: Project description: The project associated with this invoice row. total_amount_normalized: title: Total Amount Normalized description: Sum of amount in the normalized currency across all records in this invoice report group. total_amount_tax: title: Total Amount Tax description: Sum of amount tax across all records in this invoice report group. formula_fields: title: Formula Fields description: User-defined formula field values computed for this report row. invoice: title: Invoice description: The invoice associated with this report row (present when grouped by individual invoice). credited: type: boolean title: Credited description: Whether this invoice has been credited (a credit note has been issued against it). group: type: string title: Group description: The grouping dimension for this report row (e.g. company, subsidiary, invoice, time period). Determines how invoices are aggregated. parent_company_id: type: integer title: Parent Company description: ID of the parent company of the client linked to this invoice report entry, used for hierarchical company filtering. sent_on: type: string title: Sent On format: date description: Sent on for this invoice report group. invoice_paid_on: title: Invoice Paid On description: Date when this invoice was paid, surfaced as a report column. currency: type: string title: Currency description: Currency for this invoice report group. invoice_aging: enum: - 0 - 1 - 2 - 3 - 4 type: integer title: Invoice Aging description: 'Aging status of this invoice — categorizes overdue invoices into time brackets: current, 1-15 days overdue, 16-45 days overdue, or 45+ days overdue.' fuzzy_dates: type: string title: Fuzzy Dates format: date description: Fuzzy date range value used for flexible date filtering across multiple invoice date fields simultaneously. report: title: Report description: The saved report (filter view) this invoice report row belongs to. currency_default: title: Currency Default description: Currency code of the organization's default currency, for normalized financial comparisons. tags: type: string title: Tags description: The tags applied to the invoice in this report row, for filtering or grouping by label. total_amount_tax_normalized: title: Total Amount Tax Normalized description: Sum of amount tax in the normalized currency across all records in this invoice report group. amount_written_off: title: Amount Written Off description: Amount written off (marked as will never be paid) on this invoice, in the invoice's own currency. organization: title: Organization description: The organization that owns this invoice report. total_amount_paid: title: Total Amount Paid description: Sum of amount paid across all records in this invoice report group. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary this invoice is issued from. company: title: Company description: The client company this invoice is billed to. delivery_on_period: title: Delivery On Period description: Time period grouping for the delivery date (e.g. week, month, quarter). creator_id: type: integer title: Creator description: ID of the person who created this invoice. average_due_in: type: integer title: Average Due In description: Average number of days until the invoice is due (calculated from invoiced_on to pay_on) across invoices in this report group. total_amount_with_tax_normalized: title: Total Amount With Tax Normalized description: Sum of amount with tax in the normalized currency across all records in this invoice report group. parent_invoice_id: type: integer title: Parent Invoice description: ID of the parent invoice that this credit note credits against (present for credit notes only). pay_on: type: string title: Pay On format: date description: Due date by which this invoice must be paid. amount_tax: title: Amount Tax description: Tax amount on this invoice, in the invoice's own currency. invoice_invoiced_on: title: Invoice Invoiced On description: The date this invoice was issued, surfaced as a report column. total_amount_credited: title: Total Amount Credited description: Sum of all credited amounts (excluding tax) across invoices in this report group. invoice_status: enum: - 0 - 1 - 2 - 3 - 4 type: integer title: Invoice Status description: Invoice status for this invoice report group. total_amount_unpaid_default: title: Total Amount Unpaid Default description: Sum of amount unpaid in the organization's default currency across all records in this invoice report group. responsible_id: type: integer title: Responsible description: Responsible id for this invoice report group. total_amount_unpaid: title: Total Amount Unpaid description: Sum of amount unpaid across all records in this invoice report group. invoice_purchase_order_number: title: Invoice Purchase Order Number description: The client's purchase order number on this invoice, surfaced as a report column. example: PO-2024-017 month: type: string title: Month description: Month dimension for time-based report grouping (deprecated — use invoiced_on_period instead). amount_paid: title: Amount Paid description: Amount paid by the client on this invoice, in the invoice's own currency. currency_id: type: string title: Currency description: ID of the currency used on this invoice. total_amount_paid_normalized: title: Total Amount Paid Normalized description: Sum of amount paid in the normalized currency across all records in this invoice report group. created_at_period: title: Created At Period description: Time period grouping for the invoice creation date (e.g. week, month, quarter). invoice_created_at: title: Invoice Created At description: The invoice's creation timestamp, surfaced as a report column. total_amount_paid_default: title: Total Amount Paid Default description: Sum of amount paid in the organization's default currency across all records in this invoice report group. total_amount_credited_with_tax_normalized: title: Total Amount Credited With Tax Normalized description: Sum of amount credited with tax in the normalized currency across all records in this invoice report group. last_activity_at: type: string title: Last Activity At format: date description: Timestamp of the most recent activity on this invoice. total_amount_written_off_default: title: Total Amount Written Off Default description: Sum of amount written off in the organization's default currency across all records in this invoice report group. deal_id: type: integer title: Deal description: ID of the associated budget (deal) whose services are included in this invoice. amount_credited_with_tax: title: Amount Credited With Tax description: Amount credited including tax on this invoice, in the invoice's own currency. total_amount_credited_normalized: title: Total Amount Credited Normalized description: Sum of amount credited in the normalized currency across all records in this invoice report group. company_id: type: integer title: Company description: ID of the client company this invoice is billed to. query: type: string title: Query description: Text search query applied to this report — matches by invoice number or content depending on the operator used. subsidiary: title: Subsidiary description: The subsidiary (legal entity) this invoice payment is directed to. project_id: type: integer title: Project description: ID of the project associated with this invoice. invoice_custom_fields: title: Invoice Custom Fields description: The invoice's custom field values, surfaced as a report column. total_amount_unpaid_normalized: title: Total Amount Unpaid Normalized description: Sum of amount unpaid in the normalized currency across all records in this invoice report group. average_paid_in: type: integer title: Average Paid In description: Average number of days elapsed between the due date and the actual payment date across invoices in this report group. creator: title: Creator description: The person who created this invoice. currency_normalized: title: Currency Normalized description: Currency code of the organization's common normalized currency used for cross-currency reporting. total_amount: title: Total Amount description: Sum of all invoice amounts (excluding tax) across invoices in this report group, in each invoice's own currency. fuzzy_people: type: integer title: Fuzzy People description: People IDs used for fuzzy person-based filtering across multiple invoice person fields simultaneously. amount_unpaid: title: Amount Unpaid description: Amount still unpaid on this invoice, in the invoice's own currency. payment_status: enum: - 1 - 2 - 3 type: integer title: Payment Status description: Payment status of this invoice — indicates whether it is unpaid, partially paid, or fully paid. last_activity_at_period: title: Last Activity At Period description: Time period grouping for last activity date (e.g. week, month, quarter). amount: title: Amount description: Total invoice amount excluding tax, in the invoice's own currency. payment_terms: type: integer title: Payment Terms description: Payment terms in days — number of days from the invoice date until payment is due (calculated as pay_on minus invoiced_on). count: type: integer title: Count description: Number of invoices in this report group. full_query: type: string title: Full Query description: The full combined query string used to generate this report, including all filters and grouping dimensions. invoice_sent_on: title: Invoice Sent On description: Invoice sent on for this invoice report group. issuer_id: type: integer title: Issuer description: ID of the person who issued this invoice. formulas: type: integer title: Formulas description: Formula definitions used to compute custom calculated columns in this report. subscriber_id: type: integer title: Subscriber description: ID of the person subscribed to this invoice (receives notifications for recurring invoices). total_amount_written_off: title: Total Amount Written Off description: Sum of amount written off across all records in this invoice report group. total_amount_written_off_normalized: title: Total Amount Written Off Normalized description: Sum of amount written off in the normalized currency across all records in this invoice report group. issuer: title: Issuer description: The person (subsidiary contact) who issued this invoice on behalf of the organization. budget: title: Budget description: The associated budget (deal) for this invoice report row. tax_rates: type: string title: Tax Rates description: Tax rates applied to line items on this invoice. company_billing_name: title: Company Billing Name description: The billing name of the client company as it appears on this invoice. invoice_delivery_on: title: Invoice Delivery On description: The invoice's delivery date, surfaced as a report column. week: type: string title: Week description: Week grouping for this invoice report row. amount_credited: title: Amount Credited description: Amount credited (excluding tax) on this invoice, in the invoice's own currency. paid_on: type: string title: Paid On format: date description: Paid on for this invoice report group. invoice_pay_on: title: Invoice Pay On description: The invoice's due date, surfaced as a report column. status: enum: - 1 - 2 type: integer title: Status description: Sent status of this invoice (same as sent_status — whether the invoice has been sent to the client). overdue_status: enum: - 1 - 2 type: integer title: Overdue Status description: Overdue status for this invoice report group. issuer_report: title: Issuer Report description: Related person report data for the invoice issuer in this report group. invoice_type: enum: - 1 - 2 type: integer title: Invoice Type description: The type of this invoice document — invoice or credit note, surfaced as a report column. total_amount_with_tax_default: title: Total Amount With Tax Default description: Sum of amount with tax in the organization's default currency across all records in this invoice report group. total_amount_with_tax: title: Total Amount With Tax description: Sum of amount with tax across all records in this invoice report group. created_at: type: string title: Created At format: date description: The invoice's creation timestamp, for use as a report column. automatically_created: type: integer title: Automatically Created description: Whether this invoice was automatically created from a recurring contract budget, rather than manually by a user. quarter: type: string title: Quarter description: Quarter dimension for time-based report grouping (deprecated — use invoiced_on_period instead). invoiced_on: type: string title: Invoiced On format: date description: Date this invoice was issued (the official invoice date). invoicing_method: enum: - 1 - 2 - 3 type: integer title: Invoicing Method description: The method of invoicing used for this invoice (e.g. manual, automatic from services). sent_status: enum: - 1 - 2 type: integer title: Sent Status description: Whether this invoice has been sent to the client (sent or unsent). total_amount_credited_with_tax: title: Total Amount Credited With Tax description: Sum of amount credited with tax across all records in this invoice report group. paid_on_period: title: Paid On Period description: Time period grouping for paid on (e.g. week, month, quarter). amount_with_tax: title: Amount With Tax description: Total invoice amount including tax, in the invoice's own currency. purchase_order_number: type: string title: Purchase Order Number description: The client's purchase order number associated with this invoice. example: PO-2024-017 fiscalization_status: type: integer title: Fiscalization Status description: The fiscalization status of this invoice for tax compliance purposes. description: An aggregated invoice report row grouping invoices by configurable dimensions with payment totals, aging analysis, and billing metrics. Each row represents one group (e.g. by company, subsidiary, or time period) and exposes the invoice's financial fields — amount, tax, paid, unpaid, written off, and credited — along with period groupings and relationship pointers to company, issuer, and creator. resource_rate_card: type: object title: Rate card Resource properties: status: enum: - 1 - 2 type: integer title: Status description: The current status of this rate card (active or archived). company: title: Company description: The company this rate card is associated with. created_at: type: string title: Created At format: date-time description: Timestamp when this rate card was created. prices_count: title: Prices Count description: The number of prices defined on this rate card. company_id: type: integer title: Company description: ID of the company this rate card is associated with. organization: title: Organization description: The organization this rate card belongs to. updated_at: type: string title: Updated At format: date-time description: Timestamp when this rate card was last updated. archived_at: type: string title: Archived At format: date-time description: Timestamp when this rate card was archived, or null if it is still active. name: type: string title: Name description: The name of this rate card. creator: title: Creator description: The person who created this rate card. description: Price list for services. Contains a name, optional client company link (for client-specific rates), creation metadata, and a count of contained prices. Prices are managed separately via the prices endpoint. _meta: type: object title: Meta properties: organization_features: type: object description: Feature flags and capabilities enabled for the current organization, used for UI rendering. current_page: type: integer description: The current page number in this paginated response (1-based). total_count: type: integer description: Total number of records matching the current query across all pages. settings: type: object description: Organization or user settings relevant to this resource's display. total_pages: type: integer description: Total number of pages available for the current query and page size. max_page_size: type: integer description: Maximum number of records allowed per page for this endpoint. page_size: type: integer description: Number of records returned per page in this response. description: Pagination and response metadata returned with every collection endpoint. resource_approval_policy: type: object title: Approval policy Resource properties: default: type: boolean title: Default description: Indicates whether this is the default approval policy for its type. archived_at: type: string title: Archived At format: date-time description: Timestamp when the approval policy was archived, or null if active. type_id: enum: - 1 - 2 - 3 type: integer title: Type description: 'Numeric identifier for the approval policy type: 1 = absence, 2 = budget, 3 = deal.' organization: title: Organization description: The organization this approval policy belongs to. custom: type: boolean title: Custom description: Indicates whether this is a custom approval policy created for a specific assignment. name: type: string title: Name description: The display name of the approval policy. status: enum: - 1 - 2 type: integer title: Status description: The current status of the approval policy (e.g. active or archived). description: Approval policy defining who approves time entries, absences, or expenses. Configures the set of approvers and whether unanimous approval is required. Auto-creates approval_status records for each approver when a submission is made. _filter_root_project_report: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_project_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_project_report" description: Filter schema for `project_report` list endpoints — pass a single condition or a logical group. filter_board: type: object title: Filter board properties: project_id: oneOf: - "$ref": "#/components/schemas/resource_board/properties/project_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_board/properties/project_id" contains: "$ref": "#/components/schemas/resource_board/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_board/properties/project_id" eq: "$ref": "#/components/schemas/resource_board/properties/project_id" description: Filter using explicit operator syntax. description: Filter by the associated project. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_board/properties/id" not_eq: "$ref": "#/components/schemas/resource_board/properties/id" not_contain: "$ref": "#/components/schemas/resource_board/properties/id" contains: "$ref": "#/components/schemas/resource_board/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_board/properties/id" description: Filter by board ID. query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_board/properties/query" contains: "$ref": "#/components/schemas/resource_board/properties/query" eq: "$ref": "#/components/schemas/resource_board/properties/query" not_eq: "$ref": "#/components/schemas/resource_board/properties/query" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_board/properties/query" description: Search boards by name (text search). status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_board/properties/status" not_eq: "$ref": "#/components/schemas/resource_board/properties/status" not_contain: "$ref": "#/components/schemas/resource_board/properties/status" eq: "$ref": "#/components/schemas/resource_board/properties/status" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_board/properties/status" description: Filter by active/archived status. patternProperties: "^project..*$": title: Project relationship description: Filter parameters for listing boards (folders). Supports filtering by project, archived status, and position. Standard ID operators apply. resource_task_dependency: type: object title: Task dependency Resource properties: deleted_at: type: string title: Deleted At format: date description: Timestamp when this task dependency was deleted, or null if not deleted. task: title: Task description: The primary task object (the task that blocks or is linked to the dependent task). creator_id: type: integer title: Creator description: ID of the person who created this task dependency. dependent_task_id: type: integer title: Dependent Task description: ID of the dependent task (the task that depends on the primary task). type_id: enum: - 1 - 2 - 3 type: integer title: Type description: 'The dependency type: 1 = blocking, 2 = waiting on, 3 = linked.' id: type: integer title: Id description: The unique identifier of this task dependency. updated_at: type: string title: Updated At format: date description: Timestamp when this task dependency was last updated. task_id: type: integer title: Task description: ID of the primary task (the task that blocks or is linked to the dependent task). dependent_task: title: Dependent Task description: The dependent task object (the task that depends on the primary task). project_id: type: integer title: Project description: ID of the project this task dependency belongs to. reverse_dependency: title: Reverse Dependency description: The reverse dependency object linking the same two tasks from the opposite direction. created_at: type: string title: Created At format: date description: Timestamp when this task dependency was created. organization: title: Organization description: The organization this task dependency belongs to. updater_id: type: integer title: Updater description: ID of the person who last updated this task dependency. description: Task dependency relationship defining blocking, waiting_on, or linked connections between tasks. Each dependency has a type_id indicating the relationship direction. Creating a dependency may auto-create a reverse_dependency on the related task. resource_price_report: type: object title: Price report Resource properties: average_estimated_cost_normalized: title: Average Estimated Cost Normalized description: Average estimated cost in the normalized currency for this price report group. organization: title: Organization description: Organization for this price report group. rate_card_id: type: integer title: Rate Card description: Rate card id for this price report group. average_markup_amount_normalized: title: Average Markup Amount Normalized description: Average markup amount in the normalized currency for this price report group. average_discounted_rate_normalized: title: Average Discounted Rate Normalized description: Average discounted rate in the normalized currency for this price report group. average_markup: type: number title: Average Markup description: Average markup for this price report group. rate_card: title: Rate Card description: Rate card for this price report group. expense_tracking_enabled: type: integer title: Expense Tracking Enabled description: Expense tracking enabled for this price report group. average_discount: type: number title: Average Discount description: Average discount for this price report group. average_discounted_rate_default: title: Average Discounted Rate Default description: Average discounted rate in the organization's default currency for this price report group. service_type: title: Service Type description: Service type for this price report group. service_type_id: type: integer title: Service Type description: Service type id for this price report group. price: title: Price description: Price for this price report group. company_id: type: integer title: Company description: Company id for this price report group. company: title: Company description: Company for this price report group. average_discount_amount_normalized: title: Average Discount Amount Normalized description: Average discount amount in the normalized currency for this price report group. average_estimated_cost: title: Average Estimated Cost description: Average estimated cost for this price report group. billing_type_id: enum: - 1 - 2 - 3 - 4 type: integer title: Billing Type description: Billing type id for this price report group. currency_normalized: title: Currency Normalized description: Currency in the normalized currency for this price report group. price_description: title: Price Description description: Price description for this price report group. average_rate_default: title: Average Rate Default description: Average rate in the organization's default currency for this price report group. average_markup_amount: title: Average Markup Amount description: Average markup amount for this price report group. custom_fields: type: string title: Custom Fields description: Custom fields for this price report group. time_tracking_enabled: type: integer title: Time Tracking Enabled description: Time tracking enabled for this price report group. price_name: title: Price Name description: Price name for this price report group. average_estimated_cost_default: title: Average Estimated Cost Default description: Average estimated cost in the organization's default currency for this price report group. average_rate_normalized: title: Average Rate Normalized description: Average rate in the normalized currency for this price report group. report: title: Report description: Report for this price report group. average_markup_amount_default: title: Average Markup Amount Default description: Average markup amount in the organization's default currency for this price report group. currency: type: string title: Currency description: Currency for this price report group. price_quantity: title: Price Quantity description: Price quantity for this price report group. average_discount_amount_default: title: Average Discount Amount Default description: Average discount amount in the organization's default currency for this price report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this price report group. average_discounted_rate: title: Average Discounted Rate description: Average discounted rate for this price report group. rate_card_status: enum: - 1 - 2 type: integer title: Rate Card Status description: Rate card status for this price report group. company_report: title: Company Report description: Company report for this price report group. booking_tracking_enabled: type: integer title: Booking Tracking Enabled description: Booking tracking enabled for this price report group. average_rate: title: Average Rate description: Average rate for this price report group. formula_fields: title: Formula Fields description: Formula fields for this price report group. group: type: string title: Group description: The grouping dimension for this price report row. count: type: integer title: Count description: Number of prices in this report group. id: type: integer title: Id description: Unique identifier for this price report row. average_discount_amount: title: Average Discount Amount description: Average discount amount for this price report group. unit_id: enum: - 1 - 2 - 3 type: integer title: Unit description: Unit id for this price report group. description: An aggregated price report row grouping rate card prices by configurable dimensions. resource_event: type: object title: Event Resource properties: half_day_bookings: type: boolean title: Half Day Bookings description: When true, bookings for this event can be created in half-day increments. name: type: string title: Name description: The display name of this event. id: type: integer title: Id description: The unique identifier of this event. icon_id: type: string title: Icon description: The icon identifier used to visually represent this event in the UI. event_type_id: enum: - 1 - 2 type: integer title: Event Type description: ID of the event type indicating whether this absence is paid (1) or unpaid (2). description: type: string title: Description archived_at: type: string title: Archived At format: date-time description: Timestamp when this event was archived, or null if it is still active. color_id: type: integer title: Color description: ID of the color associated with this event for display purposes. sync_personal_integrations: type: boolean title: Sync Personal Integrations description: When true, bookings for this event are automatically synced to personal calendar integrations. limitation_type_id: enum: - 2 - 3 - 4 type: integer title: Limitation Type description: 'ID of the limitation type controlling how time-off for this event is tracked: limited by days (2), limited by hours (3), or unlimited by hours (4).' organization: title: Organization description: The organization this event belongs to. limited: type: boolean title: Limited description: When true, this event has a limit on the amount of time-off that can be booked. absence_type: enum: - time_off - remote_work type: string title: Absence Type description: The absence category of this event, either time_off (standard time-off) or remote_work. limitation_type: enum: - 2 - 3 - 4 type: integer title: Limitation Type description: The limitation type of this event used for filtering (limited by days, limited by hours, or unlimited by hours). status: enum: - 1 - 2 type: integer title: Status description: The archival status of this event, either active (1) or archived (2). description: An absence event type (e.g. vacation, sick leave) used to categorize time-off bookings in the resource planner. _filter_root_tax_rate: oneOf: - "$ref": "#/components/schemas/filter_tax_rate" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_tax_rate" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `tax_rate` list endpoints — pass a single condition or a logical group. filter_custom_field_section: type: object title: Filter custom field section properties: status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_custom_field_section/properties/status" eq: "$ref": "#/components/schemas/resource_custom_field_section/properties/status" contains: "$ref": "#/components/schemas/resource_custom_field_section/properties/status" not_eq: "$ref": "#/components/schemas/resource_custom_field_section/properties/status" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_custom_field_section/properties/status" description: Filter by active/archived status. patternProperties: {} description: Filter parameters for custom field sections. _filter_root_pipeline: oneOf: - "$ref": "#/components/schemas/filter_pipeline" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_pipeline" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `pipeline` list endpoints — pass a single condition or a logical group. filter_holiday: type: object title: Filter holiday properties: holiday_calendar_id: oneOf: - "$ref": "#/components/schemas/resource_holiday/properties/holiday_calendar_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_holiday/properties/holiday_calendar_id" contains: "$ref": "#/components/schemas/resource_holiday/properties/holiday_calendar_id" not_contain: "$ref": "#/components/schemas/resource_holiday/properties/holiday_calendar_id" eq: "$ref": "#/components/schemas/resource_holiday/properties/holiday_calendar_id" description: Filter using explicit operator syntax. description: Filter by the associated holiday calendar. before: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_holiday/properties/before" not_eq: "$ref": "#/components/schemas/resource_holiday/properties/before" eq: "$ref": "#/components/schemas/resource_holiday/properties/before" contains: "$ref": "#/components/schemas/resource_holiday/properties/before" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_holiday/properties/before" description: Filter by before. after: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_holiday/properties/after" not_contain: "$ref": "#/components/schemas/resource_holiday/properties/after" eq: "$ref": "#/components/schemas/resource_holiday/properties/after" contains: "$ref": "#/components/schemas/resource_holiday/properties/after" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_holiday/properties/after" description: Filter by after. patternProperties: {} description: Filter parameters for holidays. filter_new_salary_report: type: object title: Filter new salary report properties: people_custom_fields: oneOf: - "$ref": "#/components/schemas/resource_new_salary_report/properties/people_custom_fields" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/people_custom_fields" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/people_custom_fields" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/people_custom_fields" not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/people_custom_fields" description: Filter operator object for people custom fields. description: Filter new salary report results by people custom fields. started_on: oneOf: - "$ref": "#/components/schemas/resource_new_salary_report/properties/started_on" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/started_on" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/started_on" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/started_on" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/started_on" description: Filter operator object for started on. description: Filter new salary report results by started on. overhead: oneOf: - "$ref": "#/components/schemas/resource_new_salary_report/properties/overhead" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/overhead" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/overhead" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/overhead" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/overhead" description: Filter operator object for overhead. description: Filter new salary report results by overhead. ended_on: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/ended_on" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/ended_on" not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/ended_on" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/ended_on" description: Filter operator object for ended on. - "$ref": "#/components/schemas/resource_new_salary_report/properties/ended_on" description: Filter new salary report results by ended on. bi_weekly_cost: oneOf: - "$ref": "#/components/schemas/resource_new_salary_report/properties/bi_weekly_cost" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/bi_weekly_cost" not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/bi_weekly_cost" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/bi_weekly_cost" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/bi_weekly_cost" description: Filter operator object for bi weekly cost. description: Filter new salary report results by bi weekly cost. hourly_cost: oneOf: - "$ref": "#/components/schemas/resource_new_salary_report/properties/hourly_cost" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/hourly_cost" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/hourly_cost" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/hourly_cost" not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/hourly_cost" description: Filter operator object for hourly cost. description: Filter new salary report results by hourly cost. holiday_calendar_id: oneOf: - "$ref": "#/components/schemas/resource_new_salary_report/properties/holiday_calendar_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/holiday_calendar_id" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/holiday_calendar_id" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/holiday_calendar_id" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/holiday_calendar_id" description: Filter operator object for holiday calendar id. description: Filter new salary report results by holiday calendar id. date: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/date" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/date" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/date" not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/date" description: Filter operator object for date. - "$ref": "#/components/schemas/resource_new_salary_report/properties/date" description: Filter new salary report results by date. monthly_cost: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/monthly_cost" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/monthly_cost" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/monthly_cost" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/monthly_cost" description: Filter operator object for monthly cost. - "$ref": "#/components/schemas/resource_new_salary_report/properties/monthly_cost" description: Filter new salary report results by monthly cost. id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/id" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/id" description: Filter operator object for id. - "$ref": "#/components/schemas/resource_new_salary_report/properties/id" description: Filter new salary report results by id. salary_type_id: oneOf: - "$ref": "#/components/schemas/resource_new_salary_report/properties/salary_type_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/salary_type_id" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/salary_type_id" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/salary_type_id" not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/salary_type_id" description: Filter operator object for salary type id. description: Filter new salary report results by salary type id. estimated_weekly_hours: oneOf: - "$ref": "#/components/schemas/resource_new_salary_report/properties/estimated_weekly_hours" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/estimated_weekly_hours" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/estimated_weekly_hours" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/estimated_weekly_hours" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/estimated_weekly_hours" description: Filter operator object for estimated weekly hours. description: Filter new salary report results by estimated weekly hours. formulas: oneOf: - "$ref": "#/components/schemas/resource_new_salary_report/properties/formulas" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/formulas" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/formulas" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/formulas" description: Filter operator object for formulas. description: Filter new salary report results by formulas. weekly_cost: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/weekly_cost" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/weekly_cost" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/weekly_cost" not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/weekly_cost" description: Filter operator object for weekly cost. - "$ref": "#/components/schemas/resource_new_salary_report/properties/weekly_cost" description: Filter new salary report results by weekly cost. time: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/time" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/time" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/time" not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/time" description: Filter operator object for time. - "$ref": "#/components/schemas/resource_new_salary_report/properties/time" description: Filter new salary report results by time. salary_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/salary_id" not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/salary_id" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/salary_id" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/salary_id" description: Filter operator object for salary id. - "$ref": "#/components/schemas/resource_new_salary_report/properties/salary_id" description: Filter new salary report results by salary id. annuall_cost: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/annuall_cost" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/annuall_cost" contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/annuall_cost" not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/annuall_cost" description: Filter operator object for annuall cost. - "$ref": "#/components/schemas/resource_new_salary_report/properties/annuall_cost" description: Filter new salary report results by annuall cost. person_id: oneOf: - "$ref": "#/components/schemas/resource_new_salary_report/properties/person_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_new_salary_report/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_new_salary_report/properties/person_id" eq: "$ref": "#/components/schemas/resource_new_salary_report/properties/person_id" description: Filter operator object for person id. description: Filter new salary report results by person id. patternProperties: "^person..*$": title: Person relationship description: Available filter parameters for querying aggregated new salary report data. _filter_root_folder: oneOf: - "$ref": "#/components/schemas/filter_folder" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: The logical operator used to combine filter conditions. Accepted values are 'and' and 'or'. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_folder" description: A grouped filter object that combines multiple folder filter conditions using a logical operator. required: - "$op" description: A root filter object for folder list requests, supporting both a grouped filter with logical operators and a flat filter object. _filter_root_project: oneOf: - "$ref": "#/components/schemas/filter_project" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_project" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `project` list endpoints — pass a single condition or a logical group. _not_included: type: object title: Not included properties: meta: type: object properties: included: enum: - false type: boolean description: Whether the related resource was included in the sideloaded data. Always `false` for this variant. description: Metadata indicating the sideload status of this relationship. description: Placeholder for a relationship that was not sideloaded in this response. resource_pulse: type: object title: Pulse Resource properties: schedule_frame_id: enum: - 1 - 2 - 3 type: integer title: Schedule Frame description: The ID of the schedule frame (e.g. this week, last month) for the report period. export_params: type: object title: Export Params description: Export configuration parameters for the report attached to this pulse. test_pulse: type: boolean title: Test Pulse description: When true, this is a test pulse used for previewing output without sending to real recipients. document_format_id: enum: - 1 - 2 - 3 type: integer title: Document Format description: The ID of the document format used when exporting the report. subscriber_id: type: integer title: Subscriber description: ID of the person subscribed to receive this pulse. deactivated_at: type: string title: Deactivated At format: date-time description: Timestamp when the pulse was deactivated, or null if still active. teams_team: type: string title: Teams Team description: The Microsoft Teams team name where pulse notifications are delivered. repeat_schedule_id: enum: - 1 - 2 - 3 - 4 - 5 type: integer title: Repeat Schedule description: The ID of the repeat schedule setting (e.g. daily, weekly, monthly). filter: title: Filter description: The saved filter (report) delivered by this pulse. filter_id: type: integer title: Filter description: The ID of the saved filter (report) delivered by this pulse. creator: title: Creator description: The person who created this pulse. skip_if_empty: type: boolean title: Skip If Empty description: When true, the pulse is not sent if the report contains no data. slack_channel: type: string title: Slack Channel description: The Slack channel where this pulse is delivered, if configured. teams_channel: type: string title: Teams Channel description: The Microsoft Teams channel name within the team where pulse notifications are delivered. schedule_day_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 type: integer title: Schedule Day description: The ID of the day within the repeat schedule on which the pulse is sent. memberships: title: Memberships description: The memberships (recipients) that have access to this pulse. schedule_hour: type: integer title: Schedule Hour description: The hour of the day (0-23) when the pulse is sent. type_id: enum: - 1 - 2 - 3 type: integer title: Type description: ID of the pulse delivery type (email, Slack, or Microsoft Teams). version: type: integer title: Version description: The version number of this pulse configuration, incremented on each update. recipients: type: object title: Recipients description: Email addresses of recipients who receive this pulse delivery. creator_id: type: integer title: Creator description: The ID of the person who created this pulse. id: type: integer title: Id description: Unique identifier for the pulse. organization: title: Organization description: The organization this pulse belongs to. description: A pulse (scheduled report delivery) that sends a saved report to recipients via email or Slack on a recurring schedule. resource_tag: type: object title: Tag Resource properties: color_id: type: integer title: Color description: ID of the color used to visually distinguish this tag. project_id: type: integer title: Project description: ID of the project this tag is applied to, if tagged to a project. taggable_type: type: string title: Taggable Type description: The type of resource this tag is applied to (e.g. Company, Deal, Invoice, Person, Project, Task). deal_id: type: integer title: Deal description: ID of the deal this tag is applied to, if tagged to a deal. person_id: type: integer title: Person description: ID of the person this tag is applied to, if tagged to a person. company_id: type: integer title: Company description: ID of the company this tag is applied to, if tagged to a company. name: type: string title: Name description: The name of this tag. invoice_id: type: integer title: Invoice description: ID of the invoice this tag is applied to, if tagged to an invoice. task_id: type: integer title: Task description: ID of the task this tag is applied to, if tagged to a task. description: A label that can be applied to companies, deals, invoices, people, projects, or tasks for categorization and filtering. resource_survey_field: type: object title: Survey field Resource properties: archived_at: type: string title: Archived At format: date-time description: Timestamp when this survey field was archived, or null if not archived. id: title: Id description: The unique identifier of this survey field. project_id: type: integer title: Project description: ID of the project this survey field belongs to. survey: title: Survey description: The survey this field belongs to. organization: title: Organization description: The organization this survey field belongs to. name: type: string title: Name description: The name (label) of this survey field. origin_field_id: type: integer title: Origin Field description: ID of the original custom field this survey field was created from, if applicable. archived: title: Archived description: Whether this survey field has been archived. quick_add_enabled: type: boolean title: Quick Add Enabled description: When true, this field can be quickly added to a resource without opening the full edit form. updated_at: type: string title: Updated At format: date-time description: Timestamp when this survey field was last updated. survey_id: type: integer title: Survey description: ID of the survey this field belongs to. aggregation_type_id: type: integer title: Aggregation Type description: ID of the aggregation type used when summarizing responses to this field. custom_field_people: title: Custom Field People description: People associated with this survey field via custom field lookups. data_type_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 type: integer title: Data Type description: ID of the data type that determines what kind of value this field stores (text, number, date, etc.). required: type: boolean title: Required description: Whether a response to this field is required when submitting the survey. global: type: boolean title: Global description: When true, this field is shared across all projects in the organization. created_at: type: string title: Created At format: date-time description: Timestamp when this survey field was created. options: title: Options description: The answer options available for this survey field (for multiple-choice fields). formatting_type_id: type: integer title: Formatting Type description: ID of the formatting type that controls how this field's value is displayed. customizable_type: type: string title: Customizable Type description: The resource type this survey field can be attached to (e.g. tasks, deals, contacts). origin_field: title: Origin Field description: The original custom field this survey field was created from, if applicable. sensitive: type: boolean title: Sensitive description: When true, the value of this field is treated as sensitive and hidden from unauthorized users. show_in_add_edit_views: type: boolean title: Show In Add Edit Views description: The show in add edit views. position: type: integer title: Position description: The display order position of this field within the survey. description: Form field on a survey with a data type (text, number, date, dropdown, checkbox, file), label, required flag, position, and optional description. Dropdown fields have selectable options via survey_field_options. filter_team_membership: type: object title: Filter team membership properties: id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_team_membership/properties/id" not_eq: "$ref": "#/components/schemas/resource_team_membership/properties/id" eq: "$ref": "#/components/schemas/resource_team_membership/properties/id" not_contain: "$ref": "#/components/schemas/resource_team_membership/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_team_membership/properties/id" description: Filter by ID. team_id: oneOf: - "$ref": "#/components/schemas/resource_team_membership/properties/team_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_team_membership/properties/team_id" contains: "$ref": "#/components/schemas/resource_team_membership/properties/team_id" not_eq: "$ref": "#/components/schemas/resource_team_membership/properties/team_id" eq: "$ref": "#/components/schemas/resource_team_membership/properties/team_id" description: Filter using explicit operator syntax. description: Filter by the associated team. person_id: oneOf: - "$ref": "#/components/schemas/resource_team_membership/properties/person_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_team_membership/properties/person_id" eq: "$ref": "#/components/schemas/resource_team_membership/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_team_membership/properties/person_id" contains: "$ref": "#/components/schemas/resource_team_membership/properties/person_id" description: Filter using explicit operator syntax. description: Filter by the associated person. active: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_team_membership/properties/active" not_eq: "$ref": "#/components/schemas/resource_team_membership/properties/active" not_contain: "$ref": "#/components/schemas/resource_team_membership/properties/active" eq: "$ref": "#/components/schemas/resource_team_membership/properties/active" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_team_membership/properties/active" description: Filter to include only memberships with an active person (not deactivated). patternProperties: {} description: Filter parameters for listing team memberships. Supports filtering by team and person. Standard ID operators apply. resource_company_report: type: object title: Company report Resource properties: name: type: string title: Name description: Display name of the company. company: title: Company description: Company for this company report group. due_days: type: integer title: Due Days description: Payment due days — number of days after invoice date that payment is due. parent_company: title: Parent Company description: The parent company of this company in the hierarchy. exclude_company_and_children: type: integer title: Exclude Company And Children description: When true, excludes this company and all its subsidiaries from results when filtering by parent company. custom_fields: type: string title: Custom Fields description: Custom field values associated with this report row. group: type: string title: Group description: The grouping dimension for this company report row. company_name: title: Company Name description: Display name of the company. company_id: type: integer title: Company description: Unique identifier of the company. default_tax_rate_id: type: integer title: Default Tax Rate description: ID of the default tax rate applied to the company's invoices. archived_at: type: string title: Archived At format: date description: Archived at for this company report group. default_currency: type: string title: Default Currency description: Default currency code configured for the company. currency_default: title: Currency Default description: Default currency code of the company. company_created_at: title: Company Created At description: Date and time when the company was created. year: type: string title: Year description: Year grouping for this company report row. month: type: string title: Month description: Month number of the time dimension bucket for this report row. created_at_period: title: Created At Period description: Time period grouping for created at (e.g. week, month, quarter). company_custom_fields: title: Company Custom Fields description: Custom field values associated with the company. default_subsidiary_id: type: integer title: Default Subsidiary description: ID of the default subsidiary associated with this company. contact_city: title: Contact City description: City of the company's primary contact. parent_company_report: title: Parent Company Report description: Report object for the parent company of this company in the hierarchy. contact_country: title: Contact Country description: Country of the company's primary contact. status: enum: - 1 - 2 type: integer title: Status description: Status for this company report group. contact_zipcode: title: Contact Zipcode description: Contact zipcode for this company report group. fuzzy_people: type: string title: Fuzzy People description: Fuzzy people references used in the report query for flexible person matching. billing_name: type: string title: Billing Name description: Billing name for this company report group. last_activity_at: type: string title: Last Activity At format: date description: Timestamp of the most recent activity on this company. contact_email: title: Contact Email description: Email address of the company's primary contact. last_activity_at_period: title: Last Activity At Period description: Time period grouping for last activity date (e.g. week, month, quarter). count: type: integer title: Count description: Number of companys in this report group. subscriber_id: type: integer title: Subscriber description: Subscriber id for this company report group. contact_website: title: Contact Website description: Website URL of the company's primary contact. full_query: type: string title: Full Query description: Full query string used to generate this report row. vat: type: string title: Vat description: Vat for this company report group. currency_normalized: title: Currency Normalized description: Currency code after normalization to the organization's reporting currency. query: type: string title: Query description: Query parameters used to generate this report row. contact_state: title: Contact State description: State or province of the company's primary contact. jump_query: type: string title: Jump Query description: Jump query string for navigating directly to the underlying records of this report row. subsidiary_id: type: integer title: Subsidiary description: Subsidiary id for this company report group. parent_company_id: type: integer title: Parent Company description: ID of the parent company in the organizational hierarchy. company_code: type: string title: Company Code description: Unique identifier code assigned to the company. project_id: type: integer title: Project description: ID of the project associated with this report row. currency: title: Currency description: Currency code used for monetary values in this report row. has_parent_company: type: boolean title: Has Parent Company description: When true, this company has a parent company in the hierarchy. fuzzy_dates: type: string title: Fuzzy Dates description: Fuzzy date range values used in the report query for flexible date matching. contact_address: title: Contact Address description: Street address of the company's primary contact. formula_fields: title: Formula Fields description: Computed formula field values for this report row. report: title: Report description: Relationship link to the saved report filter this row is generated from. tags: type: string title: Tags description: List of tags applied to the company. company_billing_name: title: Company Billing Name description: Company billing name for this company report group. organization: title: Organization description: Relationship link to the organization this report belongs to. week: type: string title: Week description: Week grouping for this company report row. subsidiary: title: Subsidiary description: Subsidiary for this company report group. id: type: integer title: Id description: Unique identifier for this company report row. company_last_activity_at: title: Company Last Activity At description: Timestamp of the most recent activity on the company associated with this report row. quarter: type: string title: Quarter description: Quarter number (1–4) of the time dimension bucket for this report row. created_at: type: string title: Created At format: date description: Created at for this company report group. contact_phone: title: Contact Phone description: Phone number of the company's primary contact. payment_terms: type: integer title: Payment Terms description: Payment terms in days — number of days after invoice issue that payment is due. description: An aggregated company report row grouping client companies by configurable dimensions with revenue, invoicing, and relationship metrics. filter_company_report: type: object title: Filter company report properties: due_days: oneOf: - "$ref": "#/components/schemas/resource_company_report/properties/due_days" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company_report/properties/due_days" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/due_days" eq: "$ref": "#/components/schemas/resource_company_report/properties/due_days" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/due_days" description: Filter operator object for due days. description: Filter company report results by due days. company_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_company_report/properties/company_id" contains: "$ref": "#/components/schemas/resource_company_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/company_id" description: Filter operators for company_id using ID matching conditions. - "$ref": "#/components/schemas/resource_company_report/properties/company_id" description: Filter by client company. custom_fields: oneOf: - "$ref": "#/components/schemas/resource_company_report/properties/custom_fields" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_company_report/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_company_report/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/custom_fields" description: Filter operators for custom_fields using string matching conditions. description: Filter by custom field values. vat: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company_report/properties/vat" eq: "$ref": "#/components/schemas/resource_company_report/properties/vat" contains: "$ref": "#/components/schemas/resource_company_report/properties/vat" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/vat" description: Filter operator object for vat. - "$ref": "#/components/schemas/resource_company_report/properties/vat" description: Filter company report results by vat. fuzzy_people: oneOf: - "$ref": "#/components/schemas/resource_company_report/properties/fuzzy_people" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company_report/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_company_report/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_company_report/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/fuzzy_people" description: Filter operator object for fuzzy people. description: Filter company report results by fuzzy people. default_subsidiary_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company_report/properties/default_subsidiary_id" eq: "$ref": "#/components/schemas/resource_company_report/properties/default_subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/default_subsidiary_id" contains: "$ref": "#/components/schemas/resource_company_report/properties/default_subsidiary_id" description: Filter operator object for default subsidiary id. - "$ref": "#/components/schemas/resource_company_report/properties/default_subsidiary_id" description: Filter company report results by default subsidiary id. default_tax_rate_id: oneOf: - "$ref": "#/components/schemas/resource_company_report/properties/default_tax_rate_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_company_report/properties/default_tax_rate_id" contains: "$ref": "#/components/schemas/resource_company_report/properties/default_tax_rate_id" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/default_tax_rate_id" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/default_tax_rate_id" description: Filter operator object for default tax rate id. description: Filter company report results by default tax rate id. full_query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company_report/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/full_query" eq: "$ref": "#/components/schemas/resource_company_report/properties/full_query" description: Filter operator object for full query. - "$ref": "#/components/schemas/resource_company_report/properties/full_query" description: Filter company report results by full query. subsidiary_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company_report/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_company_report/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/subsidiary_id" description: Filter operator object for subsidiary id. - "$ref": "#/components/schemas/resource_company_report/properties/subsidiary_id" description: Filter company report results by subsidiary id. project_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/project_id" eq: "$ref": "#/components/schemas/resource_company_report/properties/project_id" description: Filter operator object for project id. - "$ref": "#/components/schemas/resource_company_report/properties/project_id" description: Filter company report results by project id. name: oneOf: - "$ref": "#/components/schemas/resource_company_report/properties/name" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company_report/properties/name" contains: "$ref": "#/components/schemas/resource_company_report/properties/name" eq: "$ref": "#/components/schemas/resource_company_report/properties/name" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/name" description: Filter operator object for name. description: Filter company report results by name. billing_name: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company_report/properties/billing_name" eq: "$ref": "#/components/schemas/resource_company_report/properties/billing_name" contains: "$ref": "#/components/schemas/resource_company_report/properties/billing_name" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/billing_name" description: Filter operators for billing_name using string matching conditions. - "$ref": "#/components/schemas/resource_company_report/properties/billing_name" description: Filter by the company's full billing name. last_activity_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company_report/properties/last_activity_at" eq: "$ref": "#/components/schemas/resource_company_report/properties/last_activity_at" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/last_activity_at" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company_report/properties/last_activity_at" description: Filter by last activity date range (`last_activity_at`). query: oneOf: - "$ref": "#/components/schemas/resource_company_report/properties/query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company_report/properties/query" eq: "$ref": "#/components/schemas/resource_company_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/query" contains: "$ref": "#/components/schemas/resource_company_report/properties/query" description: Filter operator object for query. description: Filter company report results by query. archived_at: oneOf: - "$ref": "#/components/schemas/resource_company_report/properties/archived_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company_report/properties/archived_at" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/archived_at" contains: "$ref": "#/components/schemas/resource_company_report/properties/archived_at" eq: "$ref": "#/components/schemas/resource_company_report/properties/archived_at" description: Filter operators for archived_at using date matching conditions. description: Filter by archive date range (`archived_at`). payment_terms: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company_report/properties/payment_terms" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/payment_terms" contains: "$ref": "#/components/schemas/resource_company_report/properties/payment_terms" eq: "$ref": "#/components/schemas/resource_company_report/properties/payment_terms" description: Filter operator object for payment terms. - "$ref": "#/components/schemas/resource_company_report/properties/payment_terms" description: Filter company report results by payment terms. subscriber_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_company_report/properties/subscriber_id" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/subscriber_id" contains: "$ref": "#/components/schemas/resource_company_report/properties/subscriber_id" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/subscriber_id" description: Filter operator object for subscriber id. - "$ref": "#/components/schemas/resource_company_report/properties/subscriber_id" description: Filter company report results by subscriber id. status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company_report/properties/status" eq: "$ref": "#/components/schemas/resource_company_report/properties/status" contains: "$ref": "#/components/schemas/resource_company_report/properties/status" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/status" description: Filter operator object for status. - "$ref": "#/components/schemas/resource_company_report/properties/status" description: Filter company report results by status. created_at: oneOf: - "$ref": "#/components/schemas/resource_company_report/properties/created_at" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_company_report/properties/created_at" contains: "$ref": "#/components/schemas/resource_company_report/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/created_at" description: Filter operators for created_at using date matching conditions. description: Filter by creation date range (`created_at`). tags: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company_report/properties/tags" contains: "$ref": "#/components/schemas/resource_company_report/properties/tags" eq: "$ref": "#/components/schemas/resource_company_report/properties/tags" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/tags" description: Filter operators for tags using string matching conditions. - "$ref": "#/components/schemas/resource_company_report/properties/tags" description: Filter by tag. id: oneOf: - "$ref": "#/components/schemas/resource_company_report/properties/id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/id" contains: "$ref": "#/components/schemas/resource_company_report/properties/id" eq: "$ref": "#/components/schemas/resource_company_report/properties/id" description: Filter operator object for id. description: Filter company report results by id. jump_query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company_report/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/jump_query" contains: "$ref": "#/components/schemas/resource_company_report/properties/jump_query" eq: "$ref": "#/components/schemas/resource_company_report/properties/jump_query" description: Filter operator object for jump query. - "$ref": "#/components/schemas/resource_company_report/properties/jump_query" description: Filter company report results by jump query. company_code: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company_report/properties/company_code" eq: "$ref": "#/components/schemas/resource_company_report/properties/company_code" contains: "$ref": "#/components/schemas/resource_company_report/properties/company_code" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/company_code" description: Filter operators for company_code using string matching conditions. - "$ref": "#/components/schemas/resource_company_report/properties/company_code" description: Filter by the company's unique company code. fuzzy_dates: oneOf: - "$ref": "#/components/schemas/resource_company_report/properties/fuzzy_dates" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company_report/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_company_report/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_company_report/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/fuzzy_dates" description: Filter operator object for fuzzy dates. description: Filter company report results by fuzzy dates. default_currency: oneOf: - "$ref": "#/components/schemas/resource_company_report/properties/default_currency" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company_report/properties/default_currency" eq: "$ref": "#/components/schemas/resource_company_report/properties/default_currency" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/default_currency" contains: "$ref": "#/components/schemas/resource_company_report/properties/default_currency" description: Filter operator object for default currency. description: Filter company report results by default currency. has_parent_company: oneOf: - "$ref": "#/components/schemas/resource_company_report/properties/has_parent_company" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company_report/properties/has_parent_company" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/has_parent_company" eq: "$ref": "#/components/schemas/resource_company_report/properties/has_parent_company" contains: "$ref": "#/components/schemas/resource_company_report/properties/has_parent_company" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the company has a parent company assigned. exclude_company_and_children: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company_report/properties/exclude_company_and_children" not_eq: "$ref": "#/components/schemas/resource_company_report/properties/exclude_company_and_children" eq: "$ref": "#/components/schemas/resource_company_report/properties/exclude_company_and_children" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/exclude_company_and_children" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company_report/properties/exclude_company_and_children" description: Filter by excluding a company and all its subsidiaries from results. parent_company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company_report/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_company_report/properties/parent_company_id" not_contain: "$ref": "#/components/schemas/resource_company_report/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_company_report/properties/parent_company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company_report/properties/parent_company_id" description: Filter by the parent company of the company. patternProperties: "^contact..*$": title: Contact relationship "^subsidiary..*$": title: Subsidiary relationship "^parent_company..*$": title: Parent company relationship "^default_subsidiary..*$": title: Default subsidiary relationship description: Available filter parameters for querying aggregated company report data. resource_subsidiary: type: object title: Subsidiary Resource properties: id: type: integer title: Id description: The unique identifier of this subsidiary. facility_costs_breakdown: type: object title: Facility Costs Breakdown description: Breakdown of facility costs into component categories. einvoice_identity: title: Einvoice Identity description: E-invoicing identity details for this subsidiary (PEPPOL endpoint, routing identifiers). example: data: type: einvoice_identities id: '568' einvoice_configuration: title: Einvoice Configuration description: E-invoicing configuration for this subsidiary (formats, routing, transmission settings). example: data: type: einvoice_configurations id: '1234' facility_costs_normalized: title: Facility Costs Normalized description: Facility costs normalized to a common currency for cross-subsidiary comparison. default_bank_account_id: type: integer title: Default Bank Account description: ID of the default bank account for this subsidiary. custom_domain_id: type: integer title: Custom Domain description: ID of the custom domain linked to this subsidiary for email sending. archived_at: type: string title: Archived At format: date-time description: Timestamp when the subsidiary was archived, or null if active. status: type: integer title: Status description: The status of this subsidiary, indicating whether it is active or archived. facility_costs_default: title: Facility Costs Default description: Facility costs in the organization's default currency. export_integration_type_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 type: integer title: Export Integration Type description: Integration type used for exporting documents from this subsidiary. facility_costs: title: Facility Costs description: Monthly facility/overhead costs allocated to this subsidiary. invoice_logo_url: type: string title: Invoice Logo Url description: The URL of the logo image used on invoices for this subsidiary. bill_from: title: Bill From description: Billing address details used on invoices issued by this subsidiary. show_delivery_date: type: boolean title: Show Delivery Date description: When true, the delivery date is shown on invoices generated for this subsidiary. custom_domain: title: Custom Domain description: Custom email domain linked to this subsidiary for outgoing communication. organization: title: Organization description: The organization this subsidiary belongs to. default_tax_rate_id: type: integer title: Default Tax Rate description: ID of the default tax rate for this subsidiary. name: type: string title: Name description: Display name of the subsidiary legal entity. invoice_number_scope: type: string title: Invoice Number Scope description: The scope that determines invoice number sequencing — whether numbers are shared across the organization or unique per subsidiary. default_document_type_id: type: integer title: Default Document Type description: Default document type (PDF template) applied to invoices from this subsidiary. integration: title: Integration description: Linked accounting or export integration for this subsidiary. default_bank_account: title: Default Bank Account description: Default bank account used for outgoing payments from this subsidiary. default_document_type: title: Default Document Type description: Default document type template applied to invoices from this subsidiary. default_tax_rate: title: Default Tax Rate description: Default tax rate applied to invoice line items for this subsidiary. invoice_number_format: type: string title: Invoice Number Format description: The format template for generating invoice numbers for this subsidiary (e.g. INV-{year}-{number}). description: A legal entity within the organization with its own billing identity, tax rates, bank accounts, and address. resource_time_entry_version: type: object title: Time entry version Resource properties: creator_id: type: integer title: Creator description: ID of the person who made the change that created this version. created_at: type: string title: Created At format: date-time description: Timestamp when this version record was created. creator: title: Creator description: The person who made the change that created this version. object_changes: type: object title: Object Changes description: The field-level changes recorded in this version as a map of field names to before and after values. time_entry_id: type: integer title: Time Entry description: The ID of the time entry this version record belongs to. changeset: title: Changeset description: A map of field names to before/after values representing changes made to the time entry in this version. item_name: title: Item Name description: The display name of the time entry at the time of this version (e.g., the service or task name). item_type: type: string title: Item Type description: The resource type of the versioned item, always TimeEntry. item_id: type: integer title: Item description: The ID of the time entry this version record belongs to. event: type: string title: Event description: The type of change event recorded by this version (e.g. create, update, destroy). service: title: Service description: The service the time entry was logged against at the time of this version. id: type: integer title: Id description: The unique identifier of this time entry version record. organization: title: Organization description: The organization this time entry version belongs to. description: The resource time entry version. resource_holiday: type: object title: Holiday Resource properties: after: type: string title: After format: date description: Filter to return holidays on or after this date. creator: title: Creator description: The person who created this holiday entry. organization: title: Organization description: The organization this holiday belongs to. before: type: string title: Before format: date description: Filter to return holidays on or before this date. holiday_calendar_id: type: integer title: Holiday Calendar description: ID of the holiday calendar this holiday belongs to. name: type: string title: Name description: The name of this holiday (e.g. Christmas Day). date: type: string title: Date format: date description: The date of this holiday. holiday_calendar: title: Holiday Calendar description: The holiday calendar this holiday belongs to. description: A non-working day within a holiday calendar that affects person availability calculations. _filter_root_document_style: oneOf: - "$ref": "#/components/schemas/filter_document_style" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_document_style" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `document_style` list endpoints — pass a single condition or a logical group. filter_time_entry_version: type: object title: Filter time entry version properties: event: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_version/properties/event" eq: "$ref": "#/components/schemas/resource_time_entry_version/properties/event" contains: "$ref": "#/components/schemas/resource_time_entry_version/properties/event" not_contain: "$ref": "#/components/schemas/resource_time_entry_version/properties/event" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_time_entry_version/properties/event" description: Filter by the type of change event (e.g. create, update, delete, approve, reject). creator_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_version/properties/creator_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_version/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_version/properties/creator_id" contains: "$ref": "#/components/schemas/resource_time_entry_version/properties/creator_id" eq: "$ref": "#/components/schemas/resource_time_entry_version/properties/creator_id" description: Filter using explicit operator syntax. description: Filter by the person who made the change. created_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_version/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_time_entry_version/properties/created_at" contains: "$ref": "#/components/schemas/resource_time_entry_version/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_time_entry_version/properties/created_at" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_time_entry_version/properties/created_at" description: Filter by the version creation date range. time_entry_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_version/properties/time_entry_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_version/properties/time_entry_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_version/properties/time_entry_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_version/properties/time_entry_id" eq: "$ref": "#/components/schemas/resource_time_entry_version/properties/time_entry_id" description: Filter using explicit operator syntax. description: Filter by the associated time entry. id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_version/properties/id" not_eq: "$ref": "#/components/schemas/resource_time_entry_version/properties/id" not_contain: "$ref": "#/components/schemas/resource_time_entry_version/properties/id" eq: "$ref": "#/components/schemas/resource_time_entry_version/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_time_entry_version/properties/id" description: Filter by time entry version ID. patternProperties: "^creator..*$": title: Creator relationship "^time_entry..*$": title: Time entry relationship description: Filter parameters for listing time entry version resources, which record the audit history of changes made to time entries. resource_line_item: type: object title: Line item Resource properties: service_type: title: Service Type description: The service type categorizing this line item. expense_id: type: integer title: Expense description: ID of the project expense linked to this line item, or null if not expense-based. amount: title: Amount description: The total line amount (unit price × quantity, minus discount) in the invoice's currency. amount_with_tax: title: Amount With Tax description: The total line amount including tax in the invoice's currency. invoice_id: type: integer title: Invoice description: ID of the invoice this line item belongs to. tax_value: type: number title: Tax Value description: The computed tax amount for this line item (amount × tax_value). amount_with_tax_normalized: title: Amount With Tax Normalized description: The amount with tax converted to the invoice currency. currency_default: title: Currency Default description: The organization's default currency for this line item. tax_rate_id: type: integer title: Tax Rate description: ID of the tax rate applied to this line item, or null if tax is not applied. tax_rate: title: Tax Rate description: The tax rate applied to this line item. id: type: integer title: Id description: Unique identifier of this line item. organization: title: Organization description: The organization this line item belongs to. unit_price: type: integer title: Unit Price description: The price per unit for this line item in the invoice's currency. amount_tax_default: title: Amount Tax Default description: The tax portion of this line item's amount converted to the organization's default currency. kpd_code: title: Kpd Code description: The KPD classification code assigned to this line item, used for e-invoicing compliance in Croatia. example: data: type: kpd_codes id: '42' unit_price_normalized: title: Unit Price Normalized description: "The price per unit for this line item in the invoice's currency.\n\n" invoice: title: Invoice description: The invoice this line item belongs to. quantity: type: number title: Quantity description: The quantity of units for this line item; for percentage billing types, expressed as a percentage value. unit_id: enum: - 1 - 2 - 3 type: integer title: Unit description: ID of the unit of measure for this line item (e.g. hour, day, piece). service_type_id: type: integer title: Service Type description: ID of the service type categorizing this line item. position: type: integer title: Position description: The display order of this line item within the invoice. amount_tax_normalized: title: Amount Tax Normalized description: The tax portion of this line item's amount converted to the invoice currency. unit_price_default: title: Unit Price Default description: The price per unit converted to the organization's default currency. currency: title: Currency description: The currency of this line item, inherited from the associated invoice. creator_id: type: integer title: Creator description: ID of the person who created this line item. amount_default: title: Amount Default description: The total line amount converted to the organization's default currency. service: title: Service description: The budget service linked to this line item, if this line item was generated from a service. kpd_code_id: type: integer title: Kpd Code description: ID of the KPD classification code assigned to this line item (used only in Croatia). example: '42' amount_tax: title: Amount Tax description: The tax portion of this line item's amount in the invoice's currency. discount: type: number title: Discount description: The discount applied to this line item, expressed as a percentage (0–100). company_id: type: integer title: Company description: ID of the company (client) on the invoice this line item belongs to. tax_name: type: string title: Tax Name description: The display name of the tax applied to this line item (e.g. VAT). updater_id: type: integer title: Updater description: ID of the person who last updated this line item. service_id: type: integer title: Service description: ID of the budget service linked to this line item, or null if not service-based. amount_normalized: title: Amount Normalized description: The total line amount converted to the invoice currency. expense: title: Expense description: The project expense linked to this line item, if this line item was generated from an expense. amount_with_tax_default: title: Amount With Tax Default description: The amount with tax converted to the organization's default currency. currency_normalized: title: Currency Normalized description: The invoice's currency for this line item. description: An invoice line item with quantity, unit price, description, and tax. Line items can link to budget services or expenses for automatic billing. resource_einvoice_configuration: type: object title: E-invoice Configuration Resource properties: subsidiary: title: Subsidiary description: The subsidiary this e-invoicing configuration belongs to. example: data: type: subsidiaries id: '42' include_timesheet_attachment: type: boolean title: Include Timesheet Attachment description: Whether to attach a timesheet report when sending e-invoices. example: false kpd_code_mapping: type: object title: Kpd Code Mapping description: JSON object mapping internal service/line-item categories to KPD classification codes for Croatian e-invoicing. example: '72105': '3806' '72106': '3459' '72110': '55' face_enabled: type: boolean title: Face Enabled description: Whether the Spanish FACe/FACeB2B e-invoicing format is enabled for this subsidiary. example: false updated_at: type: string title: Updated At format: date-time description: Timestamp when the record was last updated. example: '2025-06-01T14:22:00.000Z' subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary this e-invoicing configuration belongs to. example: '42' mer_enabled: type: boolean title: Mer Enabled description: Whether the Croatian MER (Modul za eRačune) e-invoicing format is enabled for this subsidiary. example: false include_pdf_attachment: type: boolean title: Include Pdf Attachment description: Whether to attach a PDF copy of the invoice when sending e-invoices. example: true mer_username: type: string title: Mer Username description: Username for authenticating with the Croatian MER e-invoicing service. example: mer_user@example.com payment_means_type_id: enum: - 1 - 2 type: integer title: Payment Means Type description: Identifier for the default payment method included in e-invoices (e.g., credit transfer or SEPA credit transfer). example: 1 xrechnung_enabled: type: boolean title: Xrechnung Enabled description: Whether the German XRechnung e-invoicing format is enabled for this subsidiary. example: true ksef_enabled: type: boolean title: Ksef Enabled description: Whether the Polish KSeF (Krajowy System e-Faktur) e-invoicing format is enabled for this subsidiary. example: false tax_rate_mapping: type: object title: Tax Rate Mapping description: JSON object mapping internal tax rate IDs to the corresponding e-invoicing tax category codes. example: '1042': tax_category_id: '4' exemption_reason: '' '1043': tax_category_id: '8' exemption_reason: Export outside the EU created_at: type: string title: Created At format: date-time description: Timestamp when the record was created. example: '2025-03-15T10:30:00.000Z' description: Stores e-invoicing settings for a subsidiary. Controls which e-invoicing formats are enabled — **FACe** (Spain), **KSeF** (Poland), **XRechnung** (Germany), **MER** (Croatia) — along with payment means, tax rate mappings, KPD code mappings, and whether to include PDF or timesheet attachments when sending e-invoices. Each subsidiary can have at most one configuration. example: id: '1234' type: einvoice_configurations attributes: face_enabled: false ksef_enabled: false xrechnung_enabled: false mer_enabled: true mer_username: mer_user@example.com payment_means_type_id: 1 tax_rate_mapping: '1042': tax_category_id: '4' exemption_reason: '' '1043': tax_category_id: '8' exemption_reason: Export outside the EU kpd_code_mapping: '72105': '3806' '72106': '3459' '72110': '55' include_pdf_attachment: true include_timesheet_attachment: false created_at: '2025-03-15T10:30:00.000Z' updated_at: '2025-06-01T14:22:00.000Z' relationships: subsidiary: data: type: subsidiaries id: '42' filter_line_item: type: object title: Filter line item properties: invoice_id: oneOf: - "$ref": "#/components/schemas/resource_line_item/properties/invoice_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_line_item/properties/invoice_id" not_eq: "$ref": "#/components/schemas/resource_line_item/properties/invoice_id" contains: "$ref": "#/components/schemas/resource_line_item/properties/invoice_id" not_contain: "$ref": "#/components/schemas/resource_line_item/properties/invoice_id" description: Filter operators for invoice_id. description: Filter by the associated invoice. expense_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_line_item/properties/expense_id" contains: "$ref": "#/components/schemas/resource_line_item/properties/expense_id" eq: "$ref": "#/components/schemas/resource_line_item/properties/expense_id" not_contain: "$ref": "#/components/schemas/resource_line_item/properties/expense_id" description: Filter operators for expense_id. - "$ref": "#/components/schemas/resource_line_item/properties/expense_id" description: Filter by the associated expense. company_id: oneOf: - "$ref": "#/components/schemas/resource_line_item/properties/company_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_line_item/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_line_item/properties/company_id" eq: "$ref": "#/components/schemas/resource_line_item/properties/company_id" contains: "$ref": "#/components/schemas/resource_line_item/properties/company_id" description: Filter operators for company_id. description: Filter by client company (via the associated invoice). service_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_line_item/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_line_item/properties/service_id" contains: "$ref": "#/components/schemas/resource_line_item/properties/service_id" eq: "$ref": "#/components/schemas/resource_line_item/properties/service_id" description: Filter operators for service_id. - "$ref": "#/components/schemas/resource_line_item/properties/service_id" description: Filter by the associated service. discount: oneOf: - "$ref": "#/components/schemas/resource_line_item/properties/discount" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_line_item/properties/discount" not_contain: "$ref": "#/components/schemas/resource_line_item/properties/discount" eq: "$ref": "#/components/schemas/resource_line_item/properties/discount" not_eq: "$ref": "#/components/schemas/resource_line_item/properties/discount" description: Filter operators for discount. description: Filter by discount percentage range. updater_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_line_item/properties/updater_id" contains: "$ref": "#/components/schemas/resource_line_item/properties/updater_id" not_eq: "$ref": "#/components/schemas/resource_line_item/properties/updater_id" eq: "$ref": "#/components/schemas/resource_line_item/properties/updater_id" description: Filter operators for updater_id. - "$ref": "#/components/schemas/resource_line_item/properties/updater_id" description: Filter by the person who last updated the line item. service_type_id: oneOf: - "$ref": "#/components/schemas/resource_line_item/properties/service_type_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_line_item/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_line_item/properties/service_type_id" contains: "$ref": "#/components/schemas/resource_line_item/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_line_item/properties/service_type_id" description: Filter operators for service_type_id. description: Filter by the service type of the associated service. id: oneOf: - "$ref": "#/components/schemas/resource_line_item/properties/id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_line_item/properties/id" not_eq: "$ref": "#/components/schemas/resource_line_item/properties/id" not_contain: "$ref": "#/components/schemas/resource_line_item/properties/id" contains: "$ref": "#/components/schemas/resource_line_item/properties/id" description: Filter operators for id. description: Filter by the line item's unique ID. tax_value: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_line_item/properties/tax_value" contains: "$ref": "#/components/schemas/resource_line_item/properties/tax_value" eq: "$ref": "#/components/schemas/resource_line_item/properties/tax_value" not_contain: "$ref": "#/components/schemas/resource_line_item/properties/tax_value" description: Filter operators for tax_value. - "$ref": "#/components/schemas/resource_line_item/properties/tax_value" description: Filter by tax rate percentage range. tax_name: oneOf: - "$ref": "#/components/schemas/resource_line_item/properties/tax_name" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_line_item/properties/tax_name" eq: "$ref": "#/components/schemas/resource_line_item/properties/tax_name" contains: "$ref": "#/components/schemas/resource_line_item/properties/tax_name" not_eq: "$ref": "#/components/schemas/resource_line_item/properties/tax_name" description: Filter using explicit operator syntax. description: Filter by tax name applied to the line item. unit_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_line_item/properties/unit_id" eq: "$ref": "#/components/schemas/resource_line_item/properties/unit_id" not_eq: "$ref": "#/components/schemas/resource_line_item/properties/unit_id" contains: "$ref": "#/components/schemas/resource_line_item/properties/unit_id" description: Filter operators for unit_id. - "$ref": "#/components/schemas/resource_line_item/properties/unit_id" description: Filter by the billing unit (e.g. hour, day, piece). creator_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_line_item/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_line_item/properties/creator_id" contains: "$ref": "#/components/schemas/resource_line_item/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_line_item/properties/creator_id" description: Filter operators for creator_id. - "$ref": "#/components/schemas/resource_line_item/properties/creator_id" description: Filter by the person who created the line item. patternProperties: "^creator..*$": title: Creator relationship "^expense..*$": title: Expense relationship "^invoice..*$": title: Invoice relationship "^service..*$": title: Service relationship "^updater..*$": title: Updater relationship "^kpd_code..*$": title: Kpd code relationship "^service_type..*$": title: Service type relationship description: Available filter parameters for querying invoice line items. filter_payment: type: object title: Filter payment properties: external_id: oneOf: - "$ref": "#/components/schemas/resource_payment/properties/external_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_payment/properties/external_id" not_eq: "$ref": "#/components/schemas/resource_payment/properties/external_id" eq: "$ref": "#/components/schemas/resource_payment/properties/external_id" contains: "$ref": "#/components/schemas/resource_payment/properties/external_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by external payment ID from an integrated system. paid_after: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payment/properties/paid_after" not_contain: "$ref": "#/components/schemas/resource_payment/properties/paid_after" contains: "$ref": "#/components/schemas/resource_payment/properties/paid_after" not_eq: "$ref": "#/components/schemas/resource_payment/properties/paid_after" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_payment/properties/paid_after" description: Filter payments made on or after this date (`paid_on`). written_off_on: oneOf: - "$ref": "#/components/schemas/resource_payment/properties/written_off_on" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payment/properties/written_off_on" not_contain: "$ref": "#/components/schemas/resource_payment/properties/written_off_on" not_eq: "$ref": "#/components/schemas/resource_payment/properties/written_off_on" eq: "$ref": "#/components/schemas/resource_payment/properties/written_off_on" description: Filter using explicit operator syntax. description: Filter by write-off date range (`written_off_on`). number: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payment/properties/number" not_eq: "$ref": "#/components/schemas/resource_payment/properties/number" contains: "$ref": "#/components/schemas/resource_payment/properties/number" not_contain: "$ref": "#/components/schemas/resource_payment/properties/number" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_payment/properties/number" description: Filter by the invoice number associated with the payment. paid_before: oneOf: - "$ref": "#/components/schemas/resource_payment/properties/paid_before" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payment/properties/paid_before" eq: "$ref": "#/components/schemas/resource_payment/properties/paid_before" not_eq: "$ref": "#/components/schemas/resource_payment/properties/paid_before" not_contain: "$ref": "#/components/schemas/resource_payment/properties/paid_before" description: Filter using explicit operator syntax. description: Filter payments made on or before this date (`paid_on`). budget_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payment/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_payment/properties/budget_id" contains: "$ref": "#/components/schemas/resource_payment/properties/budget_id" not_eq: "$ref": "#/components/schemas/resource_payment/properties/budget_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_payment/properties/budget_id" description: Filter by the associated budget or deal. query: oneOf: - "$ref": "#/components/schemas/resource_payment/properties/query" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payment/properties/query" contains: "$ref": "#/components/schemas/resource_payment/properties/query" not_contain: "$ref": "#/components/schemas/resource_payment/properties/query" not_eq: "$ref": "#/components/schemas/resource_payment/properties/query" description: Filter using explicit operator syntax. description: Search payments by invoice number or related text. paid_on: oneOf: - "$ref": "#/components/schemas/resource_payment/properties/paid_on" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_payment/properties/paid_on" not_contain: "$ref": "#/components/schemas/resource_payment/properties/paid_on" eq: "$ref": "#/components/schemas/resource_payment/properties/paid_on" contains: "$ref": "#/components/schemas/resource_payment/properties/paid_on" description: Filter using explicit operator syntax. description: Filter by payment date range (`paid_on`). invoice_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payment/properties/invoice_id" not_contain: "$ref": "#/components/schemas/resource_payment/properties/invoice_id" not_eq: "$ref": "#/components/schemas/resource_payment/properties/invoice_id" eq: "$ref": "#/components/schemas/resource_payment/properties/invoice_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_payment/properties/invoice_id" description: Filter by the associated invoice. project_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payment/properties/project_id" eq: "$ref": "#/components/schemas/resource_payment/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_payment/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_payment/properties/project_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_payment/properties/project_id" description: Filter by the associated project. amount: oneOf: - "$ref": "#/components/schemas/resource_payment/properties/amount" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payment/properties/amount" not_eq: "$ref": "#/components/schemas/resource_payment/properties/amount" not_contain: "$ref": "#/components/schemas/resource_payment/properties/amount" contains: "$ref": "#/components/schemas/resource_payment/properties/amount" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by payment amount range. subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_payment/properties/subsidiary_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payment/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_payment/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_payment/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_payment/properties/subsidiary_id" description: Filter using explicit operator syntax. description: Filter by the associated subsidiary (via the invoice). id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payment/properties/id" not_eq: "$ref": "#/components/schemas/resource_payment/properties/id" eq: "$ref": "#/components/schemas/resource_payment/properties/id" not_contain: "$ref": "#/components/schemas/resource_payment/properties/id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_payment/properties/id" description: Filter by payment ID. company_id: oneOf: - "$ref": "#/components/schemas/resource_payment/properties/company_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_payment/properties/company_id" eq: "$ref": "#/components/schemas/resource_payment/properties/company_id" contains: "$ref": "#/components/schemas/resource_payment/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_payment/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by client company (via the associated invoice). patternProperties: "^invoice..*$": title: Invoice relationship description: Available filter parameters for querying payments. _single_relationship: anyOf: - type: object title: Single data properties: data: "$ref": "#/components/schemas/_resource" description: Included variant — the related resource identifier is present in `data`. - "$ref": "#/components/schemas/_not_included" description: A JSON:API single relationship — links to one related resource or `null`. filter_event: type: object title: Filter event properties: id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_event/properties/id" not_eq: "$ref": "#/components/schemas/resource_event/properties/id" eq: "$ref": "#/components/schemas/resource_event/properties/id" contains: "$ref": "#/components/schemas/resource_event/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_event/properties/id" description: Filter by event type ID. limited: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_event/properties/limited" not_eq: "$ref": "#/components/schemas/resource_event/properties/limited" not_contain: "$ref": "#/components/schemas/resource_event/properties/limited" eq: "$ref": "#/components/schemas/resource_event/properties/limited" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_event/properties/limited" description: Filter by whether the event type has an entitlement limit (true) or is unlimited (false). absence_type: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_event/properties/absence_type" not_contain: "$ref": "#/components/schemas/resource_event/properties/absence_type" eq: "$ref": "#/components/schemas/resource_event/properties/absence_type" not_eq: "$ref": "#/components/schemas/resource_event/properties/absence_type" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_event/properties/absence_type" description: Filter by absence type (e.g. vacation, sick leave). name: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_event/properties/name" not_contain: "$ref": "#/components/schemas/resource_event/properties/name" eq: "$ref": "#/components/schemas/resource_event/properties/name" not_eq: "$ref": "#/components/schemas/resource_event/properties/name" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_event/properties/name" description: Filter by the name of the absence category (event). half_day_bookings: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_event/properties/half_day_bookings" contains: "$ref": "#/components/schemas/resource_event/properties/half_day_bookings" not_contain: "$ref": "#/components/schemas/resource_event/properties/half_day_bookings" not_eq: "$ref": "#/components/schemas/resource_event/properties/half_day_bookings" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_event/properties/half_day_bookings" description: Filter by whether the event type allows half-day bookings. status: oneOf: - "$ref": "#/components/schemas/resource_event/properties/status" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_event/properties/status" not_contain: "$ref": "#/components/schemas/resource_event/properties/status" eq: "$ref": "#/components/schemas/resource_event/properties/status" not_eq: "$ref": "#/components/schemas/resource_event/properties/status" description: Filter using explicit operator syntax. description: Filter by active/archived status. limitation_type: oneOf: - "$ref": "#/components/schemas/resource_event/properties/limitation_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_event/properties/limitation_type" not_eq: "$ref": "#/components/schemas/resource_event/properties/limitation_type" not_contain: "$ref": "#/components/schemas/resource_event/properties/limitation_type" eq: "$ref": "#/components/schemas/resource_event/properties/limitation_type" description: Filter using explicit operator syntax. description: Filter by the limitation type applied to entitlement accrual. sync_personal_integrations: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_event/properties/sync_personal_integrations" not_eq: "$ref": "#/components/schemas/resource_event/properties/sync_personal_integrations" not_contain: "$ref": "#/components/schemas/resource_event/properties/sync_personal_integrations" eq: "$ref": "#/components/schemas/resource_event/properties/sync_personal_integrations" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_event/properties/sync_personal_integrations" description: Filter by whether the event type syncs with personal calendar integrations. patternProperties: "^bookings..*$": title: Bookings relationship description: Filter parameters for absence event types (time-off categories). _filter_root_email: oneOf: - "$ref": "#/components/schemas/filter_email" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_email" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `email` list endpoints — pass a single condition or a logical group. _filter_root_einvoice_configuration: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. example: and patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_einvoice_configuration" description: Object form allowing multiple filter conditions combined with a logical operator. required: - "$op" example: '0': subsidiary_id: '42' "$op": and - "$ref": "#/components/schemas/filter_einvoice_configuration" description: Root filter object for e-invoice configuration resources. Supports combining multiple conditions with logical operators. example: subsidiary_id: '42' resource_dashboard: type: object title: Dashboard Resource properties: project_id: type: integer title: Project description: The ID of the project this dashboard is scoped to, if project-level. editable: type: boolean title: Editable description: Indicates whether the current user can edit this dashboard. subscriber_ids: type: array items: type: integer title: Subscriber Ids description: Array of IDs of people subscribed to this dashboard. project: title: Project description: The project this dashboard is scoped to, if project-level. query: type: string title: Query description: A saved filter query applied to this dashboard's data. person_id: type: integer title: Person description: The ID of the person who owns this dashboard. name: type: string title: Name description: The display name of the dashboard. creator: title: Creator description: The person who created this dashboard. updated_at: type: string title: Updated At format: date-time description: Timestamp when this dashboard was last updated. is_private: type: boolean title: Is Private description: When true, this dashboard is private and only visible to the creator. created_at: type: string title: Created At format: date-time description: Timestamp when the dashboard was created. organization: title: Organization description: The organization this dashboard belongs to. description: A configurable dashboard with widgets displaying KPIs, charts, and project summaries. filter_survey: type: object title: Filter survey properties: query: oneOf: - "$ref": "#/components/schemas/resource_survey/properties/query" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_survey/properties/query" not_contain: "$ref": "#/components/schemas/resource_survey/properties/query" eq: "$ref": "#/components/schemas/resource_survey/properties/query" not_eq: "$ref": "#/components/schemas/resource_survey/properties/query" description: Filter using explicit operator syntax. description: Filter by title (text search). editable: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_survey/properties/editable" eq: "$ref": "#/components/schemas/resource_survey/properties/editable" not_contain: "$ref": "#/components/schemas/resource_survey/properties/editable" not_eq: "$ref": "#/components/schemas/resource_survey/properties/editable" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_survey/properties/editable" description: Filter to include only surveys that the current user has full edit access to. title: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_survey/properties/title" contains: "$ref": "#/components/schemas/resource_survey/properties/title" not_eq: "$ref": "#/components/schemas/resource_survey/properties/title" not_contain: "$ref": "#/components/schemas/resource_survey/properties/title" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_survey/properties/title" description: Filter by survey title (text search). created_at: oneOf: - "$ref": "#/components/schemas/resource_survey/properties/created_at" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_survey/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_survey/properties/created_at" eq: "$ref": "#/components/schemas/resource_survey/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_survey/properties/created_at" description: Filter using explicit operator syntax. description: Filter by creation date range. id: oneOf: - "$ref": "#/components/schemas/resource_survey/properties/id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_survey/properties/id" contains: "$ref": "#/components/schemas/resource_survey/properties/id" not_contain: "$ref": "#/components/schemas/resource_survey/properties/id" eq: "$ref": "#/components/schemas/resource_survey/properties/id" description: Filter using explicit operator syntax. description: Filter by ID. creator_id: oneOf: - "$ref": "#/components/schemas/resource_survey/properties/creator_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_survey/properties/creator_id" eq: "$ref": "#/components/schemas/resource_survey/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_survey/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_survey/properties/creator_id" description: Filter using explicit operator syntax. description: Filter by the person who created the survey. project_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_survey/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_survey/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_survey/properties/project_id" eq: "$ref": "#/components/schemas/resource_survey/properties/project_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_survey/properties/project_id" description: Filter by the associated project. patternProperties: "^creator..*$": title: Creator relationship "^project..*$": title: Project relationship description: Filter parameters for listing surveys. Supports filtering by project, creator, and status. Standard ID operators apply. filter_deleted_item: type: object title: Filter deleted item properties: name: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deleted_item/properties/name" not_eq: "$ref": "#/components/schemas/resource_deleted_item/properties/name" contains: "$ref": "#/components/schemas/resource_deleted_item/properties/name" eq: "$ref": "#/components/schemas/resource_deleted_item/properties/name" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_deleted_item/properties/name" description: Filter by the deleted item's name (text search). deleter_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deleted_item/properties/deleter_id" eq: "$ref": "#/components/schemas/resource_deleted_item/properties/deleter_id" not_contain: "$ref": "#/components/schemas/resource_deleted_item/properties/deleter_id" not_eq: "$ref": "#/components/schemas/resource_deleted_item/properties/deleter_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_deleted_item/properties/deleter_id" description: Filter by the person who deleted the item. item_type: oneOf: - "$ref": "#/components/schemas/resource_deleted_item/properties/item_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deleted_item/properties/item_type" not_contain: "$ref": "#/components/schemas/resource_deleted_item/properties/item_type" not_eq: "$ref": "#/components/schemas/resource_deleted_item/properties/item_type" eq: "$ref": "#/components/schemas/resource_deleted_item/properties/item_type" description: Filter using explicit operator syntax. description: Filter by the resource type of the deleted item. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deleted_item/properties/id" not_eq: "$ref": "#/components/schemas/resource_deleted_item/properties/id" contains: "$ref": "#/components/schemas/resource_deleted_item/properties/id" not_contain: "$ref": "#/components/schemas/resource_deleted_item/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_deleted_item/properties/id" description: Filter by deleted item ID. location: oneOf: - "$ref": "#/components/schemas/resource_deleted_item/properties/location" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deleted_item/properties/location" not_contain: "$ref": "#/components/schemas/resource_deleted_item/properties/location" contains: "$ref": "#/components/schemas/resource_deleted_item/properties/location" eq: "$ref": "#/components/schemas/resource_deleted_item/properties/location" description: Filter using explicit operator syntax. description: Filter by the location path where the item was deleted from. created_at: oneOf: - "$ref": "#/components/schemas/resource_deleted_item/properties/created_at" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deleted_item/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_deleted_item/properties/created_at" eq: "$ref": "#/components/schemas/resource_deleted_item/properties/created_at" contains: "$ref": "#/components/schemas/resource_deleted_item/properties/created_at" description: Filter using explicit operator syntax. description: Filter by deletion date range (`created_at` on the deleted item record). query: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deleted_item/properties/query" not_contain: "$ref": "#/components/schemas/resource_deleted_item/properties/query" contains: "$ref": "#/components/schemas/resource_deleted_item/properties/query" eq: "$ref": "#/components/schemas/resource_deleted_item/properties/query" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_deleted_item/properties/query" description: Search deleted items by name (text search). patternProperties: {} description: Filter parameters for deleted items (trash). resource_custom_field: type: object title: Custom field Resource properties: section_id: type: integer title: Section description: ID of the custom field section this field belongs to. show_in_add_edit_views: type: boolean title: Show In Add Edit Views description: The show in add edit views. global: type: boolean title: Global description: Whether this custom field is available globally across all projects, rather than scoped to a specific project. aggregation_type_id: enum: - 1 - 2 type: integer title: Aggregation Type description: ID of the aggregation type defining how values of this custom field are aggregated in reports. archived: type: boolean title: Archived description: Whether this custom field has been archived. survey: title: Survey description: The survey this custom field is associated with, if it was created from a survey response field. quick_add_enabled: type: boolean title: Quick Add Enabled description: Whether this custom field appears in quick-add forms for faster data entry. archived_at: type: string title: Archived At format: date-time description: Timestamp when this custom field was archived, or null if not archived. project: title: Project description: The project this custom field is scoped to, or null if it is a global field. formatting_type_id: enum: - 1 - 2 type: integer title: Formatting Type description: ID of the formatting type that controls how this custom field's value is displayed. project_id: type: integer title: Project description: ID of the project this custom field is scoped to, or null if it is a global field. required: type: boolean title: Required description: Whether a value for this custom field is required when creating or editing the associated resource. survey_id: type: integer title: Survey description: ID of the survey this custom field is associated with. updated_at: type: string title: Updated At format: date-time description: Timestamp when this custom field was last updated. custom_field_people: title: Custom Field People description: People associated with this custom field via person-type values. section: title: Section description: The custom field section this field belongs to for grouping in the UI. position: type: integer title: Position description: The display order position of this custom field within its section. data_type_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 type: integer title: Data Type description: ID of the data type that determines what kind of value this custom field stores (e.g. text, number, date). customizable_type: type: string title: Customizable Type description: The type of resource this custom field is attached to (e.g. tasks, projects, people). name: type: string title: Name description: The display name of this custom field. created_at: type: string title: Created At format: date-time description: Timestamp when this custom field was created. options: title: Options description: The selectable options available for this custom field, applicable for dropdown and multi-select types. organization: title: Organization description: The organization this custom field belongs to. sensitive: type: boolean title: Sensitive description: Whether this custom field is sensitive and its values are restricted to authorized users. description: User-defined field on tasks, deals, people, pages, or other resources. Supports text, number, date, dropdown, multi-select, person, and file data types. Can be marked required, sensitive, global, or scoped to a project or section. Dropdown fields have selectable options via custom_field_options. resource_service_type: type: object title: Service type Resource properties: id: type: integer title: Id description: The unique identifier of this service type. organization: title: Organization description: The organization this service type belongs to. person_id: type: integer title: Person description: ID of the person used to filter service types by assignee. name: type: string title: Name description: The name of this service type. assignees: title: Assignees description: Array of people assigned to this service type. status: enum: - 1 - 2 type: integer title: Status description: 'The archival status of this service type: active or archived.' archived_at: type: string title: Archived At format: date-time description: Timestamp when this service type was archived, or null if active. query: type: string title: Query description: A search query string used to filter service types by name. description: Represents a category of work an organization delivers, used to classify services on deals and budgets. resource_email: type: object title: Email Resource properties: received_at: type: string title: Received At format: date-time description: Timestamp when this email was received from the external provider. company_id: type: integer title: Company description: Filter to return emails associated with a specific company, matched via recipients, deals, or invoices. before: type: string title: Before format: date description: Filter emails created before this date. bcc_recipients: title: Bcc Recipients description: The BCC recipients of this email. creator: title: Creator description: The person who created or sent this email. participants: title: Participants description: The people who participated in this email thread as senders or recipients. failed_at: type: string title: Failed At format: date-time description: Timestamp when delivery of this email failed, or null if no failure occurred. to_recipients: title: To Recipients description: The primary (To:) recipients of this email. created_at: type: string title: Created At format: date-time description: Timestamp when this email record was created in Productive. invoice: title: Invoice description: The invoice this email is linked to. linked_type: type: string title: Linked Type description: The type of resource this email is linked to (e.g. Quote, Invoice, Workspace). thread: title: Thread description: The email inbox thread this email belongs to. body_html: title: Body Html description: The raw HTML body of this email, available when the email inbox feature is enabled. id: type: integer title: Id description: The unique identifier of this email. from: type: string title: From description: The sender's email address. creator_id: type: integer title: Creator description: ID of the person who created or sent this email. payment_reminder: title: Payment Reminder description: The payment reminder this email is associated with. external_id: type: string title: External description: The external identifier of this email from the originating email provider. delivered_at: type: string title: Delivered At format: date-time description: Timestamp when this email was successfully delivered, or null if not yet delivered. outgoing: type: boolean title: Outgoing description: Whether this email was sent outgoing from Productive, as opposed to an incoming received email. recipients: title: Recipients description: A grouped map of recipients by type (to, cc, bcc), each with address, person ID, and delivery status. deal: title: Deal description: The deal or quote this email is linked to. integration: title: Integration description: The email integration (inbox connection) through which this email was synced. subject: type: string title: Subject description: The subject line of this email. linked_id: type: integer title: Linked description: The ID of the polymorphic resource this email is linked to (deal, invoice, workspace, etc.). dismissed_at: type: string title: Dismissed At format: date-time description: Timestamp when this email was dismissed from the inbox, or null if it has not been dismissed. status: enum: - 1 - 2 - 3 type: integer title: Status description: 'The inbox status of this email: unresolved (1), resolved/linked (2), or dismissed (3).' snippet: type: string title: Snippet description: A short preview snippet of the email content. sender_or_recipient_id: type: integer title: Sender Or Recipient description: The sender or recipient id. body: title: Body description: The plain text body of this email. organization: title: Organization description: The organization this email belongs to. auto_linked: type: boolean title: Auto Linked description: Whether this email was automatically linked to a deal or resource by the system. after: type: string title: After format: date description: Filter emails created after this date. unread: type: boolean title: Unread description: Whether this email has been marked as unread. cc_recipients: title: Cc Recipients description: The CC recipients of this email. body_truncated: title: Body Truncated description: A truncated version of the plain text body, used for preview purposes. attachments: title: Attachments description: The file attachments associated with this email. recipient_id: type: integer title: Recipient description: Filter to return emails where this person is a recipient. description: A synced email message linked to deals, invoices, companies, or other resources in Productive. _filter_root_rate_card: oneOf: - "$ref": "#/components/schemas/filter_rate_card" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_rate_card" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `rate_card` list endpoints — pass a single condition or a logical group. filter_time_entry: type: object title: Filter time entry properties: started_before: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/started_before" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/started_before" eq: "$ref": "#/components/schemas/resource_time_entry/properties/started_before" contains: "$ref": "#/components/schemas/resource_time_entry/properties/started_before" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/started_before" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by start timestamp — only entries started before this value. project_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/project_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/project_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/project_id" description: Filter by the project ID. autotracked: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/autotracked" contains: "$ref": "#/components/schemas/resource_time_entry/properties/autotracked" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/autotracked" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/autotracked" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/autotracked" description: Filter by whether the time entry was automatically tracked. query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/query" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/query" eq: "$ref": "#/components/schemas/resource_time_entry/properties/query" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/query" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/query" description: Full-text search across time entry fields. deal_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/deal_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/deal_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/deal_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the deal/budget ID. after: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/after" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/after" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/after" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/after" contains: "$ref": "#/components/schemas/resource_time_entry/properties/after" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by time entry end date — only entries with a date after this value are returned. created_before: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/created_before" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/created_before" eq: "$ref": "#/components/schemas/resource_time_entry/properties/created_before" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/created_before" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/created_before" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by creation timestamp — only entries created before this value. ended_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/ended_at" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/ended_at" eq: "$ref": "#/components/schemas/resource_time_entry/properties/ended_at" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/ended_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/ended_at" description: Filter by entry end timestamp (computed as started_at + time minutes). person_tags: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/person_tags" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/person_tags" eq: "$ref": "#/components/schemas/resource_time_entry/properties/person_tags" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/person_tags" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/person_tags" description: Filter by the tags of the person who tracked time. task_list_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/task_list_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/task_list_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/task_list_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/task_list_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/task_list_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the task list ID. company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/company_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/company_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/company_id" description: Filter by the client company ID. started_after: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/started_after" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/started_after" eq: "$ref": "#/components/schemas/resource_time_entry/properties/started_after" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/started_after" contains: "$ref": "#/components/schemas/resource_time_entry/properties/started_after" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by start timestamp — only entries started after this value. role_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/role_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/role_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/role_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/role_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/role_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the person's role ID. billing_type_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/billing_type_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/billing_type_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/billing_type_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/billing_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/billing_type_id" description: Filter by billing type ID of the associated service. created_after: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/created_after" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/created_after" eq: "$ref": "#/components/schemas/resource_time_entry/properties/created_after" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/created_after" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/created_after" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by creation timestamp — only entries created after this value. started_at: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/started_at" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/started_at" eq: "$ref": "#/components/schemas/resource_time_entry/properties/started_at" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/started_at" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/started_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the start date and time of the entry. billable_time: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/billable_time" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/billable_time" eq: "$ref": "#/components/schemas/resource_time_entry/properties/billable_time" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/billable_time" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/billable_time" description: Filter by billable minutes. time: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/time" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/time" eq: "$ref": "#/components/schemas/resource_time_entry/properties/time" contains: "$ref": "#/components/schemas/resource_time_entry/properties/time" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/time" description: Filter by duration in minutes. cost: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/cost" eq: "$ref": "#/components/schemas/resource_time_entry/properties/cost" contains: "$ref": "#/components/schemas/resource_time_entry/properties/cost" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/cost" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/cost" description: Filter by total cost amount. task_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/task_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/task_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/task_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/task_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/task_id" description: Filter by the task the time was tracked against. internal_overhead_cost: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost" eq: "$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost" contains: "$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost" description: Filter by internal overhead cost amount. invoice_attribution_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id" description: Filter by invoice attribution ID. before: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/before" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/before" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/before" eq: "$ref": "#/components/schemas/resource_time_entry/properties/before" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/before" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by time entry end date — only entries with a date before this value are returned. facility_overhead_cost: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/facility_overhead_cost" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/facility_overhead_cost" eq: "$ref": "#/components/schemas/resource_time_entry/properties/facility_overhead_cost" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/facility_overhead_cost" contains: "$ref": "#/components/schemas/resource_time_entry/properties/facility_overhead_cost" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by facility overhead cost amount. designated_approver_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/designated_approver_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/designated_approver_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/designated_approver_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/designated_approver_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/designated_approver_id" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the designated approver person ID set on the budget the time entry belongs to. date: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/date" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/date" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/date" contains: "$ref": "#/components/schemas/resource_time_entry/properties/date" eq: "$ref": "#/components/schemas/resource_time_entry/properties/date" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the date the time was tracked. created_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/created_at" eq: "$ref": "#/components/schemas/resource_time_entry/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/created_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/created_at" description: Filter by creation timestamp. budget_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/budget_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/budget_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/budget_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/budget_id" description: Filter by the budget (deal) ID this time was tracked on. unit_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/unit_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/unit_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/unit_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/unit_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/unit_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by unit id. overhead: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/overhead" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/overhead" eq: "$ref": "#/components/schemas/resource_time_entry/properties/overhead" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/overhead" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/overhead" description: Filter by whether the entry is counted as overhead. invoice_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/invoice_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/invoice_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/invoice_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/invoice_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/invoice_id" description: Filter by the associated invoice ID. track_method_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/track_method_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/track_method_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/track_method_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/track_method_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/track_method_id" description: Filter by how the time was recorded (manual, timer, mixed). note: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/note" eq: "$ref": "#/components/schemas/resource_time_entry/properties/note" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/note" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/note" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/note" description: Filter by the note text of the time entry. status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/status" contains: "$ref": "#/components/schemas/resource_time_entry/properties/status" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/status" eq: "$ref": "#/components/schemas/resource_time_entry/properties/status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/status" description: Filter by the approval status of the time entry. project_type_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/project_type_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/project_type_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/project_type_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/project_type_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/project_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by project type id. id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/id" description: Filter by time entry ID. stage_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/stage_type" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/stage_type" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/stage_type" contains: "$ref": "#/components/schemas/resource_time_entry/properties/stage_type" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/stage_type" description: Filter by stage type. last_actor_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/last_actor_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/last_actor_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/last_actor_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/last_actor_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/last_actor_id" description: Filter by last actor id. last_activity_at: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at" contains: "$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by last activity at. base_cost: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/base_cost" eq: "$ref": "#/components/schemas/resource_time_entry/properties/base_cost" contains: "$ref": "#/components/schemas/resource_time_entry/properties/base_cost" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/base_cost" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/base_cost" description: Filter by base labor cost amount. budget_type_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/budget_type_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/budget_type_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/budget_type_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/budget_type_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/budget_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the budget type ID. jira_issue_status: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status" contains: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the status of the linked Jira issue. jira_issue_summary: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary" eq: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary" description: Filter by the summary text of the linked Jira issue. overhead_cost: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost" contains: "$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total overhead cost amount. billable: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/billable" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/billable" contains: "$ref": "#/components/schemas/resource_time_entry/properties/billable" eq: "$ref": "#/components/schemas/resource_time_entry/properties/billable" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/billable" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the time entry is billable. people_custom_fields: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/people_custom_fields" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/people_custom_fields" eq: "$ref": "#/components/schemas/resource_time_entry/properties/people_custom_fields" contains: "$ref": "#/components/schemas/resource_time_entry/properties/people_custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/people_custom_fields" description: Filter by people custom fields. person_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/person_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/person_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/person_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/person_id" description: Filter by the person who tracked the time. deal_subsidiary_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/deal_subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/deal_subsidiary_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/deal_subsidiary_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/deal_subsidiary_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/deal_subsidiary_id" description: Filter by the subsidiary of the deal. awaiting_approval_from_approver_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/awaiting_approval_from_approver_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/awaiting_approval_from_approver_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/awaiting_approval_from_approver_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/awaiting_approval_from_approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/awaiting_approval_from_approver_id" description: Filter by the ID of the approver whose decision is pending. creator_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/creator_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/creator_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/creator_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the ID of the person who created the time entry. service_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/service_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/service_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/service_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/service_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the service ID the time was tracked against. parent_company_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/parent_company_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/parent_company_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/parent_company_id" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by parent company ID, returning time entries linked to budgets of companies that are children of the specified parent. updated_at: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/updated_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/updated_at" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/updated_at" contains: "$ref": "#/components/schemas/resource_time_entry/properties/updated_at" eq: "$ref": "#/components/schemas/resource_time_entry/properties/updated_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by last modification timestamp. invoicing_status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/invoicing_status" eq: "$ref": "#/components/schemas/resource_time_entry/properties/invoicing_status" contains: "$ref": "#/components/schemas/resource_time_entry/properties/invoicing_status" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/invoicing_status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/invoicing_status" description: Filter by the invoicing status of the time entry. jira_issue_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by linked Jira issue ID. section_name: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/section_name" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/section_name" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/section_name" eq: "$ref": "#/components/schemas/resource_time_entry/properties/section_name" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/section_name" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by section name. intercompany_hours: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/intercompany_hours" eq: "$ref": "#/components/schemas/resource_time_entry/properties/intercompany_hours" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/intercompany_hours" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/intercompany_hours" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/intercompany_hours" description: Filter by whether the entry is intercompany (person subsidiary differs from deal subsidiary). booking_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/booking_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/booking_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/booking_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/booking_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/booking_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the booking this time entry was created from. jira_worklog_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id" description: Filter by Jira worklog ID. responsible_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/responsible_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/responsible_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/responsible_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by responsible person ID. assigned_approver_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/assigned_approver_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/assigned_approver_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/assigned_approver_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/assigned_approver_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/assigned_approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the ID of the person assigned to approve the time entry. approval_policy_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/approval_policy_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry/properties/approval_policy_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/approval_policy_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/approval_policy_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/approval_policy_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by approval policy ID. project_manager_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/project_manager_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/project_manager_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/project_manager_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/project_manager_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/project_manager_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the project manager ID. invoiced: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/invoiced" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/invoiced" contains: "$ref": "#/components/schemas/resource_time_entry/properties/invoiced" eq: "$ref": "#/components/schemas/resource_time_entry/properties/invoiced" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/invoiced" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the time entry has been invoiced. approver_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/approver_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/approver_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/approver_id" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/approver_id" description: Filter by the ID of the person who approved the time entry. service_type_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/service_type_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/service_type_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/service_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by service type ID. approved_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry/properties/approved_at" not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/approved_at" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/approved_at" contains: "$ref": "#/components/schemas/resource_time_entry/properties/approved_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry/properties/approved_at" description: Filter by approval timestamp. person_subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry/properties/person_subsidiary_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry/properties/person_subsidiary_id" contains: "$ref": "#/components/schemas/resource_time_entry/properties/person_subsidiary_id" eq: "$ref": "#/components/schemas/resource_time_entry/properties/person_subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_time_entry/properties/person_subsidiary_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the subsidiary of the person who tracked time. patternProperties: "^task..*$": title: Task relationship "^person..*$": title: Person relationship "^creator..*$": title: Creator relationship "^service..*$": title: Service relationship "^approver..*$": title: Approver relationship "^last_actor..*$": title: Last actor relationship description: Available filter parameters for querying time entries. filter_overhead: type: object title: Filter overhead properties: subsidiary_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_overhead/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_overhead/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_overhead/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_overhead/properties/subsidiary_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_overhead/properties/subsidiary_id" description: Filter by the associated subsidiary. patternProperties: {} description: Filter parameters for overhead projects. resource_tax_rate: type: object title: Tax rate Resource properties: name: type: string title: Name description: The display name of this tax rate. primary_component_value: type: number title: Primary Component Value description: The percentage value of the primary tax component. id: type: integer title: Id description: The unique identifier of this tax rate. secondary_component_value: type: number title: Secondary Component Value description: The percentage value of the optional secondary tax component. subsidiary: title: Subsidiary description: The subsidiary this tax rate is associated with. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary this tax rate is associated with. secondary_component_name: type: string title: Secondary Component Name description: The label for the optional secondary tax component (e.g. PST in Canada). archived_at: type: string title: Archived At format: date-time description: Timestamp when this tax rate was archived, or null if active. subsidiary_name: title: Subsidiary Name description: The name of the subsidiary this tax rate is associated with. status: enum: - 1 - 2 type: integer title: Status description: The status of this tax rate, used for filtering (active or archived). organization: title: Organization description: The organization this tax rate belongs to. primary_component_name: type: string title: Primary Component Name description: The label for the primary tax component (e.g. VAT or GST). description: A tax rate with optional primary and secondary components, associated with a subsidiary and applied to invoices and line items. filter_page_report: type: object title: Filter page report properties: person_type: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/person_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_page_report/properties/person_type" eq: "$ref": "#/components/schemas/resource_page_report/properties/person_type" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/person_type" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/person_type" description: Filter operator object for person type. description: Filter page report results by person type. custom_fields: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/custom_fields" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page_report/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_page_report/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_page_report/properties/custom_fields" description: Filter operator object for custom fields. description: Filter page report results by custom fields. subscriber_id: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/subscriber_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_page_report/properties/subscriber_id" contains: "$ref": "#/components/schemas/resource_page_report/properties/subscriber_id" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/subscriber_id" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/subscriber_id" description: Filter operator object for subscriber id. description: Filter page report results by subscriber id. project_status: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/project_status" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_page_report/properties/project_status" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/project_status" eq: "$ref": "#/components/schemas/resource_page_report/properties/project_status" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/project_status" description: Filter operator object for project status. description: Filter page report results by project status. id: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_page_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/id" eq: "$ref": "#/components/schemas/resource_page_report/properties/id" description: Filter operator object for id. description: Filter page report results by id. last_activity_at: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/last_activity_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page_report/properties/last_activity_at" contains: "$ref": "#/components/schemas/resource_page_report/properties/last_activity_at" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/last_activity_at" eq: "$ref": "#/components/schemas/resource_page_report/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by last activity date range. status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_page_report/properties/status" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/status" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/status" eq: "$ref": "#/components/schemas/resource_page_report/properties/status" description: Filter operator object for status. - "$ref": "#/components/schemas/resource_page_report/properties/status" description: Filter page report results by status. created_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page_report/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/created_at" eq: "$ref": "#/components/schemas/resource_page_report/properties/created_at" contains: "$ref": "#/components/schemas/resource_page_report/properties/created_at" description: Filter operator object for created at. - "$ref": "#/components/schemas/resource_page_report/properties/created_at" description: Filter page report results by created at. project_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page_report/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/project_id" eq: "$ref": "#/components/schemas/resource_page_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_page_report/properties/project_id" description: Filter operator object for project id. - "$ref": "#/components/schemas/resource_page_report/properties/project_id" description: Filter page report results by project id. full_query: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_page_report/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/full_query" contains: "$ref": "#/components/schemas/resource_page_report/properties/full_query" eq: "$ref": "#/components/schemas/resource_page_report/properties/full_query" description: Filter operator object for full query. - "$ref": "#/components/schemas/resource_page_report/properties/full_query" description: Filter page report results by full query. jump_query: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/jump_query" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_page_report/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/jump_query" eq: "$ref": "#/components/schemas/resource_page_report/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/jump_query" description: Filter operator object for jump query. description: Filter page report results by jump query. creator_id: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/creator_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_page_report/properties/creator_id" contains: "$ref": "#/components/schemas/resource_page_report/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/creator_id" eq: "$ref": "#/components/schemas/resource_page_report/properties/creator_id" description: Filter operator object for creator id. description: Filter page report results by creator id. edited_at: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/edited_at" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_page_report/properties/edited_at" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/edited_at" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/edited_at" contains: "$ref": "#/components/schemas/resource_page_report/properties/edited_at" description: Filter operator object for edited at. description: Filter page report results by edited at. template: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/template" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_page_report/properties/template" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/template" contains: "$ref": "#/components/schemas/resource_page_report/properties/template" eq: "$ref": "#/components/schemas/resource_page_report/properties/template" description: Filter operator object for template. description: Filter page report results by template. fuzzy_dates: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/fuzzy_dates" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_page_report/properties/fuzzy_dates" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_page_report/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/fuzzy_dates" description: Filter operator object for fuzzy dates. description: Filter page report results by fuzzy dates. fuzzy_people: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/fuzzy_people" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_page_report/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_page_report/properties/fuzzy_people" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/fuzzy_people" description: Filter operator object for fuzzy people. description: Filter page report results by fuzzy people. parent_page_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page_report/properties/parent_page_id" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/parent_page_id" eq: "$ref": "#/components/schemas/resource_page_report/properties/parent_page_id" contains: "$ref": "#/components/schemas/resource_page_report/properties/parent_page_id" description: Filter operator object for parent page id. - "$ref": "#/components/schemas/resource_page_report/properties/parent_page_id" description: Filter page report results by parent page id. root_page_id: oneOf: - "$ref": "#/components/schemas/resource_page_report/properties/root_page_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page_report/properties/root_page_id" contains: "$ref": "#/components/schemas/resource_page_report/properties/root_page_id" eq: "$ref": "#/components/schemas/resource_page_report/properties/root_page_id" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/root_page_id" description: Filter operator object for root page id. description: Filter page report results by root page id. query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_page_report/properties/query" not_eq: "$ref": "#/components/schemas/resource_page_report/properties/query" eq: "$ref": "#/components/schemas/resource_page_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_page_report/properties/query" description: Filter operator object for query. - "$ref": "#/components/schemas/resource_page_report/properties/query" description: Filter page report results by query. patternProperties: {} description: Available filter parameters for querying aggregated page report data. filter_section: type: object title: Filter section properties: name: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_section/properties/name" not_eq: "$ref": "#/components/schemas/resource_section/properties/name" eq: "$ref": "#/components/schemas/resource_section/properties/name" contains: "$ref": "#/components/schemas/resource_section/properties/name" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_section/properties/name" description: Filter by section name (text search). id: oneOf: - "$ref": "#/components/schemas/resource_section/properties/id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_section/properties/id" contains: "$ref": "#/components/schemas/resource_section/properties/id" not_eq: "$ref": "#/components/schemas/resource_section/properties/id" eq: "$ref": "#/components/schemas/resource_section/properties/id" description: Filter using explicit operator syntax. description: Filter by ID. deal_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_section/properties/deal_id" contains: "$ref": "#/components/schemas/resource_section/properties/deal_id" eq: "$ref": "#/components/schemas/resource_section/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_section/properties/deal_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_section/properties/deal_id" description: Filter by the associated deal. budget_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_section/properties/budget_id" not_eq: "$ref": "#/components/schemas/resource_section/properties/budget_id" contains: "$ref": "#/components/schemas/resource_section/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_section/properties/budget_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_section/properties/budget_id" description: Filter by the associated budget. patternProperties: "^deal..*$": title: Deal relationship description: Filter parameters for deal sections. _collection_relationship: anyOf: - "$ref": "#/components/schemas/_not_included" - type: object title: Collection data properties: data: type: array items: "$ref": "#/components/schemas/_resource" description: Array of resource identifier objects for the related resources. description: Included variant — related resource identifiers are present in `data`. description: A JSON:API collection relationship — links to zero or more related resources. resource_page_version: type: object title: Page version Resource properties: organization: title: Organization description: The organization this page version belongs to. created_at: type: string title: Created At format: date-time description: Timestamp when this page version was created. body_snapshot: title: Body Snapshot description: A snapshot of the page body in ProseMirror JSON format at the time this version was saved. page_id: type: integer title: Page description: ID of the page this version belongs to. page: title: Page description: The page this version belongs to. updated_at: type: string title: Updated At format: date-time description: Timestamp when this page version was last updated. name: type: string title: Name description: An optional user-defined name for this version (e.g. a milestone label). restored_from_version_id: type: integer title: Restored From Version description: The restored from version id. prosemirror_steps: type: object title: Prosemirror Steps description: The ordered list of ProseMirror operations that transform the previous version into this one. person: title: Person description: The person who saved this version. id: type: integer title: Id description: The unique identifier of this page version. title_snapshot: type: string title: Title Snapshot description: A snapshot of the page title at the time this version was saved. person_id: type: integer title: Person description: ID of the person who saved this version. description: A historical snapshot of a page's content created whenever the page is saved. _filter_root_page_report: oneOf: - "$ref": "#/components/schemas/filter_page_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_page_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `page_report` list endpoints — pass a single condition or a logical group. resource_team_membership: type: object title: Team membership Resource properties: active: type: boolean title: Active description: Whether this team membership is currently active. id: type: integer title: Id description: The unique identifier of this team membership. person_id: type: integer title: Person description: ID of the person who is a member of the team. person: title: Person description: The person who is a member of the team. person_name: title: Person Name description: The full name of the person who is a member of the team. team_id: type: integer title: Team description: ID of the team this membership belongs to. organization: title: Organization description: The organization this team membership belongs to. team: title: Team description: The team this membership belongs to. description: Person-team link record. Associates a person with a team for access control and reporting purposes. filter_dashboard: type: object title: Filter dashboard properties: editable: oneOf: - "$ref": "#/components/schemas/resource_dashboard/properties/editable" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_dashboard/properties/editable" not_eq: "$ref": "#/components/schemas/resource_dashboard/properties/editable" eq: "$ref": "#/components/schemas/resource_dashboard/properties/editable" not_contain: "$ref": "#/components/schemas/resource_dashboard/properties/editable" description: Filter using explicit operator syntax. description: Filter to include only dashboards the current user can edit. project_id: oneOf: - "$ref": "#/components/schemas/resource_dashboard/properties/project_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_dashboard/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_dashboard/properties/project_id" eq: "$ref": "#/components/schemas/resource_dashboard/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_dashboard/properties/project_id" description: Filter using explicit operator syntax. description: Filter by the associated project. query: oneOf: - "$ref": "#/components/schemas/resource_dashboard/properties/query" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_dashboard/properties/query" contains: "$ref": "#/components/schemas/resource_dashboard/properties/query" eq: "$ref": "#/components/schemas/resource_dashboard/properties/query" not_eq: "$ref": "#/components/schemas/resource_dashboard/properties/query" description: Filter using explicit operator syntax. description: Search dashboards by name (text search). patternProperties: {} description: Filter parameters for dashboards. resource_custom_field_section: type: object title: Custom field section Resource properties: status: enum: - 1 - 2 type: integer title: Status description: The current status of the custom field section (e.g. active). organization: title: Organization description: The organization this custom field section belongs to. name: type: string title: Name description: The display name of this custom field section. customizable_type: title: Customizable Type description: The type of resource whose custom fields this section groups (e.g. tasks, projects, people). position: type: integer title: Position description: The display order position of this section among custom field sections. description: The resource custom field section. filter_resource_request: type: object title: Filter resource request properties: resolver_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_resource_request/properties/resolver_id" contains: "$ref": "#/components/schemas/resource_resource_request/properties/resolver_id" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/resolver_id" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/resolver_id" description: Filter by resolver_id using specific operators. - "$ref": "#/components/schemas/resource_resource_request/properties/resolver_id" description: Filter by the ID of the person who resolved the resource request. id: oneOf: - "$ref": "#/components/schemas/resource_resource_request/properties/id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/id" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/id" eq: "$ref": "#/components/schemas/resource_resource_request/properties/id" contains: "$ref": "#/components/schemas/resource_resource_request/properties/id" description: Filter by id using specific operators. description: Filter by resource request ID. query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_resource_request/properties/query" eq: "$ref": "#/components/schemas/resource_resource_request/properties/query" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/query" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/query" description: Filter by query using specific operators. - "$ref": "#/components/schemas/resource_resource_request/properties/query" description: Full-text search filter across resource request titles. title: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/title" contains: "$ref": "#/components/schemas/resource_resource_request/properties/title" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/title" eq: "$ref": "#/components/schemas/resource_resource_request/properties/title" description: Filter by title using specific operators. - "$ref": "#/components/schemas/resource_resource_request/properties/title" description: Filter by the title of the resource request. subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_resource_request/properties/subsidiary_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_resource_request/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_resource_request/properties/subsidiary_id" description: Filter by subsidiary_id using specific operators. description: Filter by subsidiary ID stored in the resource request fields. resolved_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/resolved_at" eq: "$ref": "#/components/schemas/resource_resource_request/properties/resolved_at" contains: "$ref": "#/components/schemas/resource_resource_request/properties/resolved_at" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/resolved_at" description: Filter by resolved_at using specific operators. - "$ref": "#/components/schemas/resource_resource_request/properties/resolved_at" description: Filter by resolved_at date range. tags: oneOf: - "$ref": "#/components/schemas/resource_resource_request/properties/tags" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/tags" contains: "$ref": "#/components/schemas/resource_resource_request/properties/tags" eq: "$ref": "#/components/schemas/resource_resource_request/properties/tags" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/tags" description: Filter by tags using specific operators. description: Filter by tag values stored in the resource request fields. status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/status" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/status" contains: "$ref": "#/components/schemas/resource_resource_request/properties/status" eq: "$ref": "#/components/schemas/resource_resource_request/properties/status" description: Filter by status using specific operators. - "$ref": "#/components/schemas/resource_resource_request/properties/status" description: Filter by the status of the resource request. ended_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_resource_request/properties/ended_on" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/ended_on" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/ended_on" contains: "$ref": "#/components/schemas/resource_resource_request/properties/ended_on" description: Filter by ended_on using specific operators. - "$ref": "#/components/schemas/resource_resource_request/properties/ended_on" description: Filter by end date range. job_title: oneOf: - "$ref": "#/components/schemas/resource_resource_request/properties/job_title" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/job_title" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/job_title" eq: "$ref": "#/components/schemas/resource_resource_request/properties/job_title" contains: "$ref": "#/components/schemas/resource_resource_request/properties/job_title" description: Filter by job_title using specific operators. description: Filter by the requested job title stored in the resource request fields. time: oneOf: - "$ref": "#/components/schemas/resource_resource_request/properties/time" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_resource_request/properties/time" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/time" eq: "$ref": "#/components/schemas/resource_resource_request/properties/time" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/time" description: Filter by time using specific operators. description: Filter by the requested time in minutes per day of the resource request. workplace_id: oneOf: - "$ref": "#/components/schemas/resource_resource_request/properties/workplace_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_resource_request/properties/workplace_id" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/workplace_id" contains: "$ref": "#/components/schemas/resource_resource_request/properties/workplace_id" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/workplace_id" description: Filter by workplace_id using specific operators. description: Filter by workplace ID stored in the resource request fields. created_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_resource_request/properties/created_at" contains: "$ref": "#/components/schemas/resource_resource_request/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/created_at" description: Filter by created_at using specific operators. - "$ref": "#/components/schemas/resource_resource_request/properties/created_at" description: Filter by created_at date range. service_type_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/service_type_id" contains: "$ref": "#/components/schemas/resource_resource_request/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_resource_request/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/service_type_id" description: Filter by service_type_id using specific operators. - "$ref": "#/components/schemas/resource_resource_request/properties/service_type_id" description: Filter by service type IDs stored in the resource request fields. deleted_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_resource_request/properties/deleted_at" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/deleted_at" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/deleted_at" eq: "$ref": "#/components/schemas/resource_resource_request/properties/deleted_at" description: Filter by deleted_at using specific operators. - "$ref": "#/components/schemas/resource_resource_request/properties/deleted_at" description: Filter by deleted_at date range. started_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_resource_request/properties/started_on" contains: "$ref": "#/components/schemas/resource_resource_request/properties/started_on" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/started_on" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/started_on" description: Filter by started_on using specific operators. - "$ref": "#/components/schemas/resource_resource_request/properties/started_on" description: Filter by start date range. team_id: oneOf: - "$ref": "#/components/schemas/resource_resource_request/properties/team_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/team_id" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/team_id" contains: "$ref": "#/components/schemas/resource_resource_request/properties/team_id" eq: "$ref": "#/components/schemas/resource_resource_request/properties/team_id" description: Filter by team_id using specific operators. description: Filter by team IDs stored in the resource request fields. custom_fields: oneOf: - "$ref": "#/components/schemas/resource_resource_request/properties/custom_fields" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_resource_request/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_resource_request/properties/custom_fields" description: Filter by custom_fields using specific operators. description: Filter by custom field values on the resource request. creator_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_resource_request/properties/creator_id" eq: "$ref": "#/components/schemas/resource_resource_request/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/creator_id" description: Filter by creator_id using specific operators. - "$ref": "#/components/schemas/resource_resource_request/properties/creator_id" description: Filter by the ID of the person who created the resource request. time_to_close: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/time_to_close" not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/time_to_close" eq: "$ref": "#/components/schemas/resource_resource_request/properties/time_to_close" contains: "$ref": "#/components/schemas/resource_resource_request/properties/time_to_close" description: Filter by time_to_close using specific operators. - "$ref": "#/components/schemas/resource_resource_request/properties/time_to_close" description: Filter by the time to close in minutes from creation to resolution. service_id: oneOf: - "$ref": "#/components/schemas/resource_resource_request/properties/service_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_resource_request/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_resource_request/properties/service_id" contains: "$ref": "#/components/schemas/resource_resource_request/properties/service_id" eq: "$ref": "#/components/schemas/resource_resource_request/properties/service_id" description: Filter by service_id using specific operators. description: Filter by the ID of the service (billing point) the resource request belongs to. patternProperties: "^creator..*$": title: Creator relationship "^service..*$": title: Service relationship "^resolver..*$": title: Resolver relationship description: Filter parameters for listing resource requests. resource_document_type: type: object title: Document type Resource properties: name: type: string title: Name description: The display name of this document type. exportable_type_id: enum: - 1 - 2 - 3 - 4 type: integer title: Exportable Type description: ID of the exportable type indicating what kind of document this type generates (e.g. invoice, proposal). id: type: integer title: Id description: The unique identifier of this document type. tax2_name: type: string title: Tax2 Name description: The label displayed for the second tax line on documents of this type. locale: type: string title: Locale description: The locale (language/region) used for formatting numbers, dates, and translations in documents of this type. attachment_ids: title: Attachment Ids description: IDs of attachments (e.g. header images) associated with this document type. status: enum: - 1 - 2 type: integer title: Status description: The current status of this document type (e.g. active or archived). exporter_options: type: string title: Exporter Options description: A hash of additional options passed to the document exporter to control rendering behavior. email_subject: type: string title: Email Subject description: The default subject line used when emailing documents of this type. tax2_value: type: number title: Tax2 Value description: The default rate (as a percentage) for the second tax applied to documents of this type. email_data: type: object title: Email Data description: A JSON object containing additional data passed to the email template when sending documents of this type. scss_template: type: string title: Scss Template description: The SCSS stylesheet template used to style documents of this type when rendered to PDF. filename_schema: type: string title: Filename Schema description: A template string defining the naming pattern for exported document files. attachments: title: Attachments description: Attachments associated with this document type, such as images used in templates. tax1_value: type: number title: Tax1 Value description: The default rate (as a percentage) for the first tax applied to documents of this type. organization: title: Organization description: The organization this document type belongs to. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary this document type is associated with. body_template: type: string title: Body Template description: The Liquid template used to render the body content of documents of this type. archived_at: type: string title: Archived At format: date-time description: Timestamp when this document type was archived, or null if still active. document_style_id: type: integer title: Document Style description: ID of the document style applied to documents of this type. dual_currency: type: boolean title: Dual Currency description: Whether documents of this type display amounts in dual currencies. footer: type: string title: Footer description: Legacy footer text included at the bottom of documents of this type. template_options: type: string title: Template Options description: A hash of configuration options specific to the document template used by this type. note: type: string title: Note description: An internal note or description for this document type, visible only to administrators. document_style: title: Document Style description: The document style applied to documents of this type for visual formatting. email_template: type: string title: Email Template description: The Liquid template used to render the email body when sending documents of this type. document_template_id: enum: - 1 type: integer title: Document Template description: ID of the built-in document template this type is based on. subsidiary: title: Subsidiary description: The subsidiary this document type is associated with for billing and legal entity purposes. tax1_name: type: string title: Tax1 Name description: The label displayed for the first tax line on documents of this type. header_template: type: string title: Header Template description: The Liquid template used to render the header section of documents of this type. footer_template: type: string title: Footer Template description: The Liquid template used to render the footer section of documents of this type. description: A template for PDF generation of invoices and financial documents, defining content layout, branding, and field configuration. filter_page: type: object title: Filter page properties: last_activity_at: oneOf: - "$ref": "#/components/schemas/resource_page/properties/last_activity_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page/properties/last_activity_at" not_eq: "$ref": "#/components/schemas/resource_page/properties/last_activity_at" eq: "$ref": "#/components/schemas/resource_page/properties/last_activity_at" contains: "$ref": "#/components/schemas/resource_page/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by last activity date range. project_id: oneOf: - "$ref": "#/components/schemas/resource_page/properties/project_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_page/properties/project_id" eq: "$ref": "#/components/schemas/resource_page/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_page/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_page/properties/project_id" description: Filter using explicit operator syntax. description: Filter by the associated project. fuzzy_people: oneOf: - "$ref": "#/components/schemas/resource_page/properties/fuzzy_people" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_page/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_page/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_page/properties/fuzzy_people" description: Filter using explicit operator syntax. description: Filter pages by people mentioned in the page content. custom_fields: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_page/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_page/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_page/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_page/properties/custom_fields" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page/properties/custom_fields" description: Filter by custom field values. full_query: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_page/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_page/properties/full_query" eq: "$ref": "#/components/schemas/resource_page/properties/full_query" contains: "$ref": "#/components/schemas/resource_page/properties/full_query" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page/properties/full_query" description: Full-text search across all fields of a page, including title and body content. parent_page_id: oneOf: - "$ref": "#/components/schemas/resource_page/properties/parent_page_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_page/properties/parent_page_id" not_contain: "$ref": "#/components/schemas/resource_page/properties/parent_page_id" not_eq: "$ref": "#/components/schemas/resource_page/properties/parent_page_id" eq: "$ref": "#/components/schemas/resource_page/properties/parent_page_id" description: Filter using explicit operator syntax. description: Filter by the direct parent page. person_type: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page/properties/person_type" contains: "$ref": "#/components/schemas/resource_page/properties/person_type" eq: "$ref": "#/components/schemas/resource_page/properties/person_type" not_eq: "$ref": "#/components/schemas/resource_page/properties/person_type" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page/properties/person_type" description: Filter by the person type (used in search context, e.g. assignee or subscriber). template: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_page/properties/template" not_eq: "$ref": "#/components/schemas/resource_page/properties/template" not_contain: "$ref": "#/components/schemas/resource_page/properties/template" contains: "$ref": "#/components/schemas/resource_page/properties/template" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page/properties/template" description: Filter to include only pages that are based on a template. project_status: oneOf: - "$ref": "#/components/schemas/resource_page/properties/project_status" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_page/properties/project_status" contains: "$ref": "#/components/schemas/resource_page/properties/project_status" not_contain: "$ref": "#/components/schemas/resource_page/properties/project_status" eq: "$ref": "#/components/schemas/resource_page/properties/project_status" description: Filter using explicit operator syntax. description: Filter by the status of the parent project (active or archived). root_page_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_page/properties/root_page_id" contains: "$ref": "#/components/schemas/resource_page/properties/root_page_id" not_contain: "$ref": "#/components/schemas/resource_page/properties/root_page_id" eq: "$ref": "#/components/schemas/resource_page/properties/root_page_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page/properties/root_page_id" description: Filter by the top-level ancestor page. creator_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_page/properties/creator_id" eq: "$ref": "#/components/schemas/resource_page/properties/creator_id" contains: "$ref": "#/components/schemas/resource_page/properties/creator_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page/properties/creator_id" description: Filter by the person who created the page. query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page/properties/query" eq: "$ref": "#/components/schemas/resource_page/properties/query" not_eq: "$ref": "#/components/schemas/resource_page/properties/query" contains: "$ref": "#/components/schemas/resource_page/properties/query" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page/properties/query" description: Filter by title or content (text search). edited_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_page/properties/edited_at" not_contain: "$ref": "#/components/schemas/resource_page/properties/edited_at" contains: "$ref": "#/components/schemas/resource_page/properties/edited_at" eq: "$ref": "#/components/schemas/resource_page/properties/edited_at" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page/properties/edited_at" description: Filter by last edited date range. subscriber_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_page/properties/subscriber_id" eq: "$ref": "#/components/schemas/resource_page/properties/subscriber_id" not_contain: "$ref": "#/components/schemas/resource_page/properties/subscriber_id" contains: "$ref": "#/components/schemas/resource_page/properties/subscriber_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page/properties/subscriber_id" description: Filter by the person subscribed to the page. status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_page/properties/status" not_contain: "$ref": "#/components/schemas/resource_page/properties/status" eq: "$ref": "#/components/schemas/resource_page/properties/status" contains: "$ref": "#/components/schemas/resource_page/properties/status" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page/properties/status" description: Filter by page status (used in search context). jump_query: oneOf: - "$ref": "#/components/schemas/resource_page/properties/jump_query" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_page/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_page/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_page/properties/jump_query" contains: "$ref": "#/components/schemas/resource_page/properties/jump_query" description: Filter using explicit operator syntax. description: Filter pages by a quick search query used in jump navigation. id: oneOf: - "$ref": "#/components/schemas/resource_page/properties/id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_page/properties/id" eq: "$ref": "#/components/schemas/resource_page/properties/id" not_contain: "$ref": "#/components/schemas/resource_page/properties/id" not_eq: "$ref": "#/components/schemas/resource_page/properties/id" description: Filter using explicit operator syntax. description: Filter by ID. fuzzy_dates: oneOf: - "$ref": "#/components/schemas/resource_page/properties/fuzzy_dates" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_page/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_page/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_page/properties/fuzzy_dates" description: Filter using explicit operator syntax. description: Filter pages by fuzzy date expressions mentioned in the page content. created_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_page/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_page/properties/created_at" eq: "$ref": "#/components/schemas/resource_page/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_page/properties/created_at" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page/properties/created_at" description: Filter by creation date range. patternProperties: {} description: Filter parameters for listing pages. Supports filtering by creator, creation and edit timestamps, parent page, project, custom fields, and full-text search. Standard string and date operators apply. filter_task: type: object title: Filter task properties: fuzzy_dates: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_task/properties/fuzzy_dates" not_contain: "$ref": "#/components/schemas/resource_task/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_task/properties/fuzzy_dates" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/fuzzy_dates" description: Fuzzy date matching across task date fields. service_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/service_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/service_id" eq: "$ref": "#/components/schemas/resource_task/properties/service_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/service_id" description: Filter by associated service ID. after: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/after" eq: "$ref": "#/components/schemas/resource_task/properties/after" not_contain: "$ref": "#/components/schemas/resource_task/properties/after" not_eq: "$ref": "#/components/schemas/resource_task/properties/after" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/after" description: Return tasks created on or after this date. closed_after: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/closed_after" not_eq: "$ref": "#/components/schemas/resource_task/properties/closed_after" not_contain: "$ref": "#/components/schemas/resource_task/properties/closed_after" eq: "$ref": "#/components/schemas/resource_task/properties/closed_after" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/closed_after" description: Return tasks closed on or after this date. fuzzy_people: oneOf: - "$ref": "#/components/schemas/resource_task/properties/fuzzy_people" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_task/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_task/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_task/properties/fuzzy_people" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Fuzzy match by people related to the task. last_activity_before: oneOf: - "$ref": "#/components/schemas/resource_task/properties/last_activity_before" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/last_activity_before" not_contain: "$ref": "#/components/schemas/resource_task/properties/last_activity_before" contains: "$ref": "#/components/schemas/resource_task/properties/last_activity_before" not_eq: "$ref": "#/components/schemas/resource_task/properties/last_activity_before" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Return tasks with activity on or before this date. created_at: oneOf: - "$ref": "#/components/schemas/resource_task/properties/created_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_task/properties/created_at" contains: "$ref": "#/components/schemas/resource_task/properties/created_at" eq: "$ref": "#/components/schemas/resource_task/properties/created_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by creation date range (created_at). public_access: oneOf: - "$ref": "#/components/schemas/resource_task/properties/public_access" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/public_access" contains: "$ref": "#/components/schemas/resource_task/properties/public_access" not_eq: "$ref": "#/components/schemas/resource_task/properties/public_access" not_contain: "$ref": "#/components/schemas/resource_task/properties/public_access" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by task privacy (deprecated — use `private` filter instead). task_type: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/task_type" eq: "$ref": "#/components/schemas/resource_task/properties/task_type" contains: "$ref": "#/components/schemas/resource_task/properties/task_type" not_contain: "$ref": "#/components/schemas/resource_task/properties/task_type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/task_type" description: Filter by task type (task, subtask, or milestone). task_list_status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/task_list_status" eq: "$ref": "#/components/schemas/resource_task/properties/task_list_status" contains: "$ref": "#/components/schemas/resource_task/properties/task_list_status" not_contain: "$ref": "#/components/schemas/resource_task/properties/task_list_status" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/task_list_status" description: Filter by task list open/archived status. last_actor_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/last_actor_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/last_actor_id" contains: "$ref": "#/components/schemas/resource_task/properties/last_actor_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/last_actor_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/last_actor_id" description: Filter by the person who last acted on the task. task_list_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/task_list_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/task_list_id" eq: "$ref": "#/components/schemas/resource_task/properties/task_list_id" contains: "$ref": "#/components/schemas/resource_task/properties/task_list_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/task_list_id" description: Filter by task list (milestone) ID. last_activity: oneOf: - "$ref": "#/components/schemas/resource_task/properties/last_activity" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/last_activity" not_eq: "$ref": "#/components/schemas/resource_task/properties/last_activity" not_contain: "$ref": "#/components/schemas/resource_task/properties/last_activity" eq: "$ref": "#/components/schemas/resource_task/properties/last_activity" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by last activity date range (last_activity_at). workflow_id: oneOf: - "$ref": "#/components/schemas/resource_task/properties/workflow_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/workflow_id" eq: "$ref": "#/components/schemas/resource_task/properties/workflow_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/workflow_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/workflow_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by workflow ID (via the task's workflow status). start_date_before: oneOf: - "$ref": "#/components/schemas/resource_task/properties/start_date_before" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/start_date_before" eq: "$ref": "#/components/schemas/resource_task/properties/start_date_before" not_contain: "$ref": "#/components/schemas/resource_task/properties/start_date_before" contains: "$ref": "#/components/schemas/resource_task/properties/start_date_before" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Return tasks starting on or before this date. type_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/type_id" contains: "$ref": "#/components/schemas/resource_task/properties/type_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/type_id" eq: "$ref": "#/components/schemas/resource_task/properties/type_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/type_id" description: Filter by task type (task, subtask, or milestone). jump_query: oneOf: - "$ref": "#/components/schemas/resource_task/properties/jump_query" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_task/properties/jump_query" eq: "$ref": "#/components/schemas/resource_task/properties/jump_query" contains: "$ref": "#/components/schemas/resource_task/properties/jump_query" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Quick jump search by task name or number. parent_task_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/parent_task_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/parent_task_id" eq: "$ref": "#/components/schemas/resource_task/properties/parent_task_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/parent_task_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/parent_task_id" description: Filter by parent task (to find subtasks of a specific task). folder_status: oneOf: - "$ref": "#/components/schemas/resource_task/properties/folder_status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/folder_status" not_eq: "$ref": "#/components/schemas/resource_task/properties/folder_status" eq: "$ref": "#/components/schemas/resource_task/properties/folder_status" contains: "$ref": "#/components/schemas/resource_task/properties/folder_status" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by whether the folder is active or archived (alias for board_status). initial_estimate: oneOf: - "$ref": "#/components/schemas/resource_task/properties/initial_estimate" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/initial_estimate" not_eq: "$ref": "#/components/schemas/resource_task/properties/initial_estimate" eq: "$ref": "#/components/schemas/resource_task/properties/initial_estimate" contains: "$ref": "#/components/schemas/resource_task/properties/initial_estimate" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by initial time estimate (in seconds). bookable_before: oneOf: - "$ref": "#/components/schemas/resource_task/properties/bookable_before" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/bookable_before" eq: "$ref": "#/components/schemas/resource_task/properties/bookable_before" not_contain: "$ref": "#/components/schemas/resource_task/properties/bookable_before" not_eq: "$ref": "#/components/schemas/resource_task/properties/bookable_before" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter tasks whose linked service is bookable before this date. closed_at: oneOf: - "$ref": "#/components/schemas/resource_task/properties/closed_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/closed_at" eq: "$ref": "#/components/schemas/resource_task/properties/closed_at" contains: "$ref": "#/components/schemas/resource_task/properties/closed_at" not_eq: "$ref": "#/components/schemas/resource_task/properties/closed_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by close date range (closed_at). updated_at: oneOf: - "$ref": "#/components/schemas/resource_task/properties/updated_at" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/updated_at" not_contain: "$ref": "#/components/schemas/resource_task/properties/updated_at" not_eq: "$ref": "#/components/schemas/resource_task/properties/updated_at" contains: "$ref": "#/components/schemas/resource_task/properties/updated_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by last update date range (updated_at). date_range: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/date_range" contains: "$ref": "#/components/schemas/resource_task/properties/date_range" not_eq: "$ref": "#/components/schemas/resource_task/properties/date_range" eq: "$ref": "#/components/schemas/resource_task/properties/date_range" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/date_range" description: Filter tasks overlapping a date range (for timeline/Gantt views). full_query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_task/properties/full_query" eq: "$ref": "#/components/schemas/resource_task/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_task/properties/full_query" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/full_query" description: Full-text search across task fields. company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/company_id" contains: "$ref": "#/components/schemas/resource_task/properties/company_id" eq: "$ref": "#/components/schemas/resource_task/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/company_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/company_id" description: Filter by client company (via the task's project). query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/query" contains: "$ref": "#/components/schemas/resource_task/properties/query" eq: "$ref": "#/components/schemas/resource_task/properties/query" not_eq: "$ref": "#/components/schemas/resource_task/properties/query" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/query" description: Quick search matching task title and number. billable_time: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/billable_time" eq: "$ref": "#/components/schemas/resource_task/properties/billable_time" not_contain: "$ref": "#/components/schemas/resource_task/properties/billable_time" not_eq: "$ref": "#/components/schemas/resource_task/properties/billable_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/billable_time" description: Filter by billable time (in seconds). board_id: oneOf: - "$ref": "#/components/schemas/resource_task/properties/board_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/board_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/board_id" contains: "$ref": "#/components/schemas/resource_task/properties/board_id" eq: "$ref": "#/components/schemas/resource_task/properties/board_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by folder (board) ID. folder_name: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/folder_name" eq: "$ref": "#/components/schemas/resource_task/properties/folder_name" not_eq: "$ref": "#/components/schemas/resource_task/properties/folder_name" not_contain: "$ref": "#/components/schemas/resource_task/properties/folder_name" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/folder_name" description: Filter by folder name (alias for board_name). person_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/person_type" contains: "$ref": "#/components/schemas/resource_task/properties/person_type" not_eq: "$ref": "#/components/schemas/resource_task/properties/person_type" not_contain: "$ref": "#/components/schemas/resource_task/properties/person_type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/person_type" description: Filter by parent/subtask distinction. dependency_type: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/dependency_type" not_contain: "$ref": "#/components/schemas/resource_task/properties/dependency_type" contains: "$ref": "#/components/schemas/resource_task/properties/dependency_type" eq: "$ref": "#/components/schemas/resource_task/properties/dependency_type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/dependency_type" description: 'Filter by dependency type: blocking, waiting on, or linked.' board_status: oneOf: - "$ref": "#/components/schemas/resource_task/properties/board_status" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/board_status" contains: "$ref": "#/components/schemas/resource_task/properties/board_status" not_eq: "$ref": "#/components/schemas/resource_task/properties/board_status" not_contain: "$ref": "#/components/schemas/resource_task/properties/board_status" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by folder (board) open/archived status. assignee_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/assignee_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/assignee_id" eq: "$ref": "#/components/schemas/resource_task/properties/assignee_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/assignee_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/assignee_id" description: Filter by assigned person (also matches open to-do assignees). due_date_new: oneOf: - "$ref": "#/components/schemas/resource_task/properties/due_date_new" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/due_date_new" eq: "$ref": "#/components/schemas/resource_task/properties/due_date_new" not_contain: "$ref": "#/components/schemas/resource_task/properties/due_date_new" contains: "$ref": "#/components/schemas/resource_task/properties/due_date_new" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Return tasks due on this exact date. project_type: oneOf: - "$ref": "#/components/schemas/resource_task/properties/project_type" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/project_type" eq: "$ref": "#/components/schemas/resource_task/properties/project_type" not_contain: "$ref": "#/components/schemas/resource_task/properties/project_type" contains: "$ref": "#/components/schemas/resource_task/properties/project_type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: 'Filter by project type: internal (overhead) or client (billable).' start_date: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/start_date" eq: "$ref": "#/components/schemas/resource_task/properties/start_date" contains: "$ref": "#/components/schemas/resource_task/properties/start_date" not_contain: "$ref": "#/components/schemas/resource_task/properties/start_date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/start_date" description: Filter by start date range (start_date). due_date_after: oneOf: - "$ref": "#/components/schemas/resource_task/properties/due_date_after" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/due_date_after" eq: "$ref": "#/components/schemas/resource_task/properties/due_date_after" not_eq: "$ref": "#/components/schemas/resource_task/properties/due_date_after" contains: "$ref": "#/components/schemas/resource_task/properties/due_date_after" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Return tasks due on or after this date. subscriber_id: oneOf: - "$ref": "#/components/schemas/resource_task/properties/subscriber_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/subscriber_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/subscriber_id" contains: "$ref": "#/components/schemas/resource_task/properties/subscriber_id" eq: "$ref": "#/components/schemas/resource_task/properties/subscriber_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by subscriber (person subscribed to the task). closed_before: oneOf: - "$ref": "#/components/schemas/resource_task/properties/closed_before" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/closed_before" not_eq: "$ref": "#/components/schemas/resource_task/properties/closed_before" not_contain: "$ref": "#/components/schemas/resource_task/properties/closed_before" contains: "$ref": "#/components/schemas/resource_task/properties/closed_before" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Return tasks closed on or before this date. due_date_before: oneOf: - "$ref": "#/components/schemas/resource_task/properties/due_date_before" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/due_date_before" not_contain: "$ref": "#/components/schemas/resource_task/properties/due_date_before" contains: "$ref": "#/components/schemas/resource_task/properties/due_date_before" eq: "$ref": "#/components/schemas/resource_task/properties/due_date_before" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Return tasks due on or before this date. last_activity_after: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/last_activity_after" not_contain: "$ref": "#/components/schemas/resource_task/properties/last_activity_after" not_eq: "$ref": "#/components/schemas/resource_task/properties/last_activity_after" contains: "$ref": "#/components/schemas/resource_task/properties/last_activity_after" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/last_activity_after" description: Return tasks with activity on or after this date. remaining_time: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/remaining_time" contains: "$ref": "#/components/schemas/resource_task/properties/remaining_time" not_contain: "$ref": "#/components/schemas/resource_task/properties/remaining_time" eq: "$ref": "#/components/schemas/resource_task/properties/remaining_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/remaining_time" description: Filter by remaining time (in seconds). custom_fields: oneOf: - "$ref": "#/components/schemas/resource_task/properties/custom_fields" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_task/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_task/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_task/properties/custom_fields" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by custom field values. worked_time: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/worked_time" not_contain: "$ref": "#/components/schemas/resource_task/properties/worked_time" not_eq: "$ref": "#/components/schemas/resource_task/properties/worked_time" contains: "$ref": "#/components/schemas/resource_task/properties/worked_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/worked_time" description: Filter by worked time (in seconds). overdue_status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/overdue_status" contains: "$ref": "#/components/schemas/resource_task/properties/overdue_status" eq: "$ref": "#/components/schemas/resource_task/properties/overdue_status" not_eq: "$ref": "#/components/schemas/resource_task/properties/overdue_status" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/overdue_status" description: Filter by whether the task is overdue (past due date). tags: oneOf: - "$ref": "#/components/schemas/resource_task/properties/tags" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/tags" contains: "$ref": "#/components/schemas/resource_task/properties/tags" not_contain: "$ref": "#/components/schemas/resource_task/properties/tags" not_eq: "$ref": "#/components/schemas/resource_task/properties/tags" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by tag name(s); use null to match tasks with no tags. repeating: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/repeating" eq: "$ref": "#/components/schemas/resource_task/properties/repeating" contains: "$ref": "#/components/schemas/resource_task/properties/repeating" not_contain: "$ref": "#/components/schemas/resource_task/properties/repeating" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/repeating" description: Filter to include only repeating tasks (those with a repeat schedule). before: oneOf: - "$ref": "#/components/schemas/resource_task/properties/before" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/before" eq: "$ref": "#/components/schemas/resource_task/properties/before" not_eq: "$ref": "#/components/schemas/resource_task/properties/before" not_contain: "$ref": "#/components/schemas/resource_task/properties/before" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Return tasks created on or before this date. due_date: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/due_date" contains: "$ref": "#/components/schemas/resource_task/properties/due_date" not_contain: "$ref": "#/components/schemas/resource_task/properties/due_date" not_eq: "$ref": "#/components/schemas/resource_task/properties/due_date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/due_date" description: Filter by due date range (due_date). project_id: oneOf: - "$ref": "#/components/schemas/resource_task/properties/project_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/project_id" eq: "$ref": "#/components/schemas/resource_task/properties/project_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by project ID. status: oneOf: - "$ref": "#/components/schemas/resource_task/properties/status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/status" eq: "$ref": "#/components/schemas/resource_task/properties/status" not_eq: "$ref": "#/components/schemas/resource_task/properties/status" contains: "$ref": "#/components/schemas/resource_task/properties/status" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by open (1) or closed (2) status. id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/id" not_eq: "$ref": "#/components/schemas/resource_task/properties/id" eq: "$ref": "#/components/schemas/resource_task/properties/id" not_contain: "$ref": "#/components/schemas/resource_task/properties/id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/id" description: Filter by task ID. folder_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/folder_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/folder_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/folder_id" contains: "$ref": "#/components/schemas/resource_task/properties/folder_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/folder_id" description: Filter by folder ID (alias for board_id). start_date_after: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/start_date_after" not_eq: "$ref": "#/components/schemas/resource_task/properties/start_date_after" eq: "$ref": "#/components/schemas/resource_task/properties/start_date_after" contains: "$ref": "#/components/schemas/resource_task/properties/start_date_after" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/start_date_after" description: Return tasks starting on or after this date. template: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/template" contains: "$ref": "#/components/schemas/resource_task/properties/template" not_eq: "$ref": "#/components/schemas/resource_task/properties/template" not_contain: "$ref": "#/components/schemas/resource_task/properties/template" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/template" description: Return only template tasks. due_date_on: oneOf: - "$ref": "#/components/schemas/resource_task/properties/due_date_on" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/due_date_on" not_eq: "$ref": "#/components/schemas/resource_task/properties/due_date_on" contains: "$ref": "#/components/schemas/resource_task/properties/due_date_on" eq: "$ref": "#/components/schemas/resource_task/properties/due_date_on" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Return tasks due on this exact date. template_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/template_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/template_id" eq: "$ref": "#/components/schemas/resource_task/properties/template_id" contains: "$ref": "#/components/schemas/resource_task/properties/template_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_task/properties/template_id" description: Filter tasks by the template they were created from. query_extended: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/query_extended" contains: "$ref": "#/components/schemas/resource_task/properties/query_extended" not_eq: "$ref": "#/components/schemas/resource_task/properties/query_extended" eq: "$ref": "#/components/schemas/resource_task/properties/query_extended" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/query_extended" description: Extended search matching title, number, and description. creator_id: oneOf: - "$ref": "#/components/schemas/resource_task/properties/creator_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task/properties/creator_id" contains: "$ref": "#/components/schemas/resource_task/properties/creator_id" eq: "$ref": "#/components/schemas/resource_task/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/creator_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the person who created the task. bookable_after: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/bookable_after" eq: "$ref": "#/components/schemas/resource_task/properties/bookable_after" not_contain: "$ref": "#/components/schemas/resource_task/properties/bookable_after" not_eq: "$ref": "#/components/schemas/resource_task/properties/bookable_after" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_task/properties/bookable_after" description: Filter tasks whose linked service becomes bookable on or after this date. task_number: oneOf: - "$ref": "#/components/schemas/resource_task/properties/task_number" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/task_number" not_contain: "$ref": "#/components/schemas/resource_task/properties/task_number" not_eq: "$ref": "#/components/schemas/resource_task/properties/task_number" contains: "$ref": "#/components/schemas/resource_task/properties/task_number" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by task number (text search). task_list_name: oneOf: - "$ref": "#/components/schemas/resource_task/properties/task_list_name" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/task_list_name" not_eq: "$ref": "#/components/schemas/resource_task/properties/task_list_name" eq: "$ref": "#/components/schemas/resource_task/properties/task_list_name" not_contain: "$ref": "#/components/schemas/resource_task/properties/task_list_name" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by task list name (text search). project_manager_id: oneOf: - "$ref": "#/components/schemas/resource_task/properties/project_manager_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/project_manager_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/project_manager_id" eq: "$ref": "#/components/schemas/resource_task/properties/project_manager_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/project_manager_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the project's responsible person. board_name: oneOf: - "$ref": "#/components/schemas/resource_task/properties/board_name" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/board_name" eq: "$ref": "#/components/schemas/resource_task/properties/board_name" not_contain: "$ref": "#/components/schemas/resource_task/properties/board_name" not_eq: "$ref": "#/components/schemas/resource_task/properties/board_name" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by folder name (text search). trackable_by_person_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/trackable_by_person_id" eq: "$ref": "#/components/schemas/resource_task/properties/trackable_by_person_id" contains: "$ref": "#/components/schemas/resource_task/properties/trackable_by_person_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/trackable_by_person_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_task/properties/trackable_by_person_id" description: Filter tasks that the specified person is permitted to track time on. workflow_status_category_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task/properties/workflow_status_category_id" contains: "$ref": "#/components/schemas/resource_task/properties/workflow_status_category_id" eq: "$ref": "#/components/schemas/resource_task/properties/workflow_status_category_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/workflow_status_category_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/workflow_status_category_id" description: 'Filter by status category: not started (1), started (2), or closed (3).' title: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/title" contains: "$ref": "#/components/schemas/resource_task/properties/title" not_eq: "$ref": "#/components/schemas/resource_task/properties/title" not_contain: "$ref": "#/components/schemas/resource_task/properties/title" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/title" description: Filter by task title (text search). workflow_status_id: oneOf: - "$ref": "#/components/schemas/resource_task/properties/workflow_status_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task/properties/workflow_status_id" not_contain: "$ref": "#/components/schemas/resource_task/properties/workflow_status_id" not_eq: "$ref": "#/components/schemas/resource_task/properties/workflow_status_id" contains: "$ref": "#/components/schemas/resource_task/properties/workflow_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by workflow status ID. subtask: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task/properties/subtask" eq: "$ref": "#/components/schemas/resource_task/properties/subtask" not_eq: "$ref": "#/components/schemas/resource_task/properties/subtask" not_contain: "$ref": "#/components/schemas/resource_task/properties/subtask" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_task/properties/subtask" description: Filter to include only subtasks (tasks with a parent task). patternProperties: "^creator..*$": title: Creator relationship "^project..*$": title: Project relationship "^service..*$": title: Service relationship "^assignee..*$": title: Assignee relationship "^task_list..*$": title: Task list relationship "^last_actor..*$": title: Last actor relationship description: Available filter parameters for querying tasks. resource_page_report: type: object title: Page report Resource properties: parent_page_id: type: integer title: Parent Page description: Parent page id for this page report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this page report group. full_query: type: string title: Full Query description: Full query for this page report group. root_page_id: type: integer title: Root Page description: Root page id for this page report group. jump_query: type: string title: Jump Query description: Jump query for this page report group. group: type: string title: Group description: The grouping dimension for this page report row. status: type: integer title: Status description: Status for this page report group. currency: title: Currency description: Currency for this page report group. page_last_activity_at: title: Page Last Activity At description: Timestamp of the most recent activity on the page associated with this report row. template: type: string title: Template description: Template for this page report group. id: type: integer title: Id description: Unique identifier for this page report row. fuzzy_dates: type: string title: Fuzzy Dates format: date description: Fuzzy dates for this page report group. report: title: Report description: Report for this page report group. creator_id: type: integer title: Creator description: Creator id for this page report group. query: type: string title: Query description: Query for this page report group. last_activity_at: type: string title: Last Activity At format: date description: Timestamp of the most recent activity on this page. subscriber_id: type: integer title: Subscriber description: Subscriber id for this page report group. project_status: enum: - 1 - 2 type: integer title: Project Status description: Project status for this page report group. organization: title: Organization description: Organization for this page report group. fuzzy_people: type: integer title: Fuzzy People description: Fuzzy people for this page report group. custom_fields: type: string title: Custom Fields description: Custom fields for this page report group. edited_at: type: string title: Edited At format: date description: Edited at for this page report group. count: type: integer title: Count description: Number of pages in this report group. creator: title: Creator description: Creator for this page report group. title: type: string title: Title description: Title for this page report group. currency_normalized: title: Currency Normalized description: Currency in the normalized currency for this page report group. person_type: type: integer title: Person Type description: Person type for this page report group. page: title: Page description: Page for this page report group. formula_fields: title: Formula Fields description: Formula fields for this page report group. page_id: title: Page description: Page id for this page report group. updater: title: Updater description: Updater for this page report group. project_id: type: integer title: Project description: Project id for this page report group. project: title: Project description: Project for this page report group. created_at: type: string title: Created At format: date description: Created at for this page report group. description: An aggregated page report row grouping documentation pages by configurable dimensions with activity metrics. resource_workflow_status: type: object title: Workflow status Resource properties: name: type: string title: Name description: The display name of this workflow status. position: type: integer title: Position description: The display order of this status within its workflow. organization: title: Organization description: The organization this workflow status belongs to. workflow: title: Workflow description: The workflow this status belongs to. workflow_id: type: integer title: Workflow description: ID of the workflow this status belongs to. id: type: integer title: Id description: The unique identifier of this workflow status. color_id: type: integer title: Color description: The color identifier used to visually distinguish this status. category_id: enum: - 1 - 2 - 3 type: integer title: Category description: 'The lifecycle category of this status: 1=Not started, 2=Started, 3=Closed.' query: type: string title: Query description: Text search query to filter workflow statuses by name. description: Task lifecycle status within a workflow. Belongs to a workflow and has a category_id (not_started, started, or closed) that determines how tasks in this status are counted and reported. Supports color coding and ordered positioning. _filter_root_workflow: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_workflow" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_workflow" description: Filter schema for `workflow` list endpoints — pass a single condition or a logical group. filter_time_tracking_policy: type: object title: Filter time tracking policy properties: name: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/name" not_eq: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/name" not_contain: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/name" contains: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/name" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_time_tracking_policy/properties/name" description: Filter by policy name. status: oneOf: - "$ref": "#/components/schemas/resource_time_tracking_policy/properties/status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/status" not_eq: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/status" contains: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/status" eq: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/status" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter time tracking policies by archival status; active (1) or archived (2). person_id: oneOf: - "$ref": "#/components/schemas/resource_time_tracking_policy/properties/person_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/person_id" contains: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/person_id" eq: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/person_id" description: Filter using explicit operator syntax. description: Filter by the people assigned to the policy. id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/id" contains: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/id" not_eq: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/id" eq: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_time_tracking_policy/properties/id" description: Filter by time tracking policy ID. patternProperties: {} description: Filter parameters for listing time tracking policy resources, which define rules governing how time entries are tracked for people. filter_time_entry_report: type: object title: Filter time entry report properties: project_manager_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/project_manager_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_manager_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_manager_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_manager_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_manager_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the project manager of the associated project. billing_type_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/billing_type_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/billing_type_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/billing_type_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/billing_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/billing_type_id" description: Filter by the billing type of the service. updated_at: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/updated_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/updated_at" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/updated_at" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/updated_at" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/updated_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by last update date range (`updated_at`). stage_type: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/stage_type" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/stage_type" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/stage_type" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/stage_type" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/stage_type" description: Filter by stage type — whether the time entry belongs to a deal or a budget. budget_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/budget_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/budget_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/budget_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/budget_id" description: Filter by the budget (deal) the time was tracked on. ended_at: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/ended_at" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/ended_at" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/ended_at" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/ended_at" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/ended_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by timer end datetime range (`ended_at`). facility_overhead_cost: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/facility_overhead_cost" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/facility_overhead_cost" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/facility_overhead_cost" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/facility_overhead_cost" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/facility_overhead_cost" description: Filter by facility overhead cost amount range. person_subsidiary_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/person_subsidiary_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/person_subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/person_subsidiary_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/person_subsidiary_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/person_subsidiary_id" description: Filter by the subsidiary associated with the person. after: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/after" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/after" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/after" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/after" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/after" description: Filter by entries tracked after this date (inclusive). Shorthand for a date range start. approval_policy_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/approval_policy_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/approval_policy_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/approval_policy_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/approval_policy_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/approval_policy_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the approval policy assigned to the time entry's budget. base_cost: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/base_cost" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/base_cost" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/base_cost" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/base_cost" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/base_cost" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by base cost amount range (cost before overhead). project_type_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_type_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_type_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_type_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/project_type_id" description: Filter by the project type (internal or client project). created_at: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/created_at" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_at" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by creation date range (`created_at`). track_method_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/track_method_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/track_method_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/track_method_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/track_method_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/track_method_id" description: Filter by the method used to track time (manual, timer, or mixed). task_list_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/task_list_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/task_list_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/task_list_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/task_list_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/task_list_id" description: Filter by the task list of the associated task. creator_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/creator_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/creator_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/creator_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/creator_id" description: Filter by the person who created the time entry. unit_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/unit_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/unit_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/unit_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/unit_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/unit_id" description: Filter by the unit of measure (hours, days, or pieces) of the service. intercompany_hours: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/intercompany_hours" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/intercompany_hours" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/intercompany_hours" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/intercompany_hours" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/intercompany_hours" description: Filter by whether the time was tracked on a budget owned by another subsidiary (intercompany). deal_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/deal_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/deal_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/deal_id" description: Filter by the associated budget or deal. people_custom_fields: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/people_custom_fields" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/people_custom_fields" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/people_custom_fields" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/people_custom_fields" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/people_custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by custom field values assigned to people. section_name: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/section_name" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/section_name" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/section_name" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/section_name" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/section_name" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the name of the service section. jira_issue_status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_status" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_status" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_status" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_status" description: Filter by Jira issue status. approver_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/approver_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/approver_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/approver_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/approver_id" description: Filter by the person who approved the time entry. jira_issue_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_id" description: Filter by Jira issue ID. started_after: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_after" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_after" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_after" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_after" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/started_after" description: Return time entries with a start timestamp after this datetime. project_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/project_id" description: Filter by the associated project. company_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/company_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/company_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by client company. person_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/person_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/person_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/person_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated person. task_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/task_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/task_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/task_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/task_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/task_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated task. overhead: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/overhead" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/overhead" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/overhead" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/overhead" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/overhead" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by overhead status; when true, includes only overhead time entries. query: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/query" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/query" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/query" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/query" description: Full-text search across time entry fields such as note, person, project, and service. service_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/service_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/service_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/service_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/service_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated service. budget_type_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/budget_type_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/budget_type_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/budget_type_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/budget_type_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/budget_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the type of budget the time was tracked on (e.g. fixed price, time and materials). overhead_cost: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/overhead_cost" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/overhead_cost" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/overhead_cost" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/overhead_cost" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/overhead_cost" description: Filter by total overhead cost amount range (internal plus facility). before: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/before" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/before" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/before" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/before" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/before" description: Filter by entries tracked before this date (inclusive). Shorthand for a date range end. status: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/status" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/status" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/status" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/status" description: Filter by the approval status of the time entry (approved, unapproved, or change requested). formulas: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/formulas" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/formulas" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/formulas" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/formulas" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by calculated formula field values. note: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/note" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/note" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/note" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/note" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/note" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the note text on the time entry. approved_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/approved_at" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/approved_at" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/approved_at" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/approved_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/approved_at" description: Filter by approval date range (`approved_at`). deal_subsidiary_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/deal_subsidiary_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/deal_subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/deal_subsidiary_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/deal_subsidiary_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/deal_subsidiary_id" description: Filter by the subsidiary associated with the time entry's budget. last_activity_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/last_activity_at" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/last_activity_at" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/last_activity_at" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/last_activity_at" description: Filter by last activity date range (`last_activity_at`). internal_overhead_cost: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/internal_overhead_cost" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/internal_overhead_cost" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/internal_overhead_cost" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/internal_overhead_cost" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/internal_overhead_cost" description: Filter by internal overhead cost amount range. date: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/date" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/date" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/date" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/date" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/date" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by time entry date range (`date`). jira_worklog_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_worklog_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_worklog_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_worklog_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_worklog_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_worklog_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by Jira worklog ID. created_before: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/created_before" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_before" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_before" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_before" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_before" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter to include entries created before this timestamp. invoiced: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoiced" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoiced" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoiced" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoiced" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/invoiced" description: Filter by invoiced status; when true, includes only invoiced time entries. role_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/role_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/role_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/role_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/role_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/role_id" description: Filter by the role of the associated person. invoice_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/invoice_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoice_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoice_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoice_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoice_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated invoice. invoice_attribution_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoice_attribution_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoice_attribution_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoice_attribution_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoice_attribution_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/invoice_attribution_id" description: Filter by the associated invoice attribution. cost: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/cost" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/cost" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/cost" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/cost" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/cost" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the total cost of the time entry (work cost plus overhead). time: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/time" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/time" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/time" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/time" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/time" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total time worked (in seconds). designated_approver_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/designated_approver_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/designated_approver_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/designated_approver_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/designated_approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/designated_approver_id" description: Filter time entries by the person designated as the approver. person_tags: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/person_tags" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/person_tags" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/person_tags" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/person_tags" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/person_tags" description: Filter by tags assigned to the associated person. billable: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/billable" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/billable" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/billable" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/billable" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/billable" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by billable status; when true, includes only time entries on billable services. service_type_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/service_type_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/service_type_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/service_type_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/service_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the service type of the associated service. invoicing_status: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/invoicing_status" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoicing_status" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoicing_status" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoicing_status" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoicing_status" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by invoicing status (not invoiced, drafted, or finalized). started_before: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_before" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_before" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_before" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_before" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/started_before" description: Return time entries with a start timestamp before this datetime. billable_time: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/billable_time" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/billable_time" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/billable_time" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/billable_time" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/billable_time" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by billable time range (in minutes). assigned_approver_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/assigned_approver_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/assigned_approver_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/assigned_approver_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/assigned_approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/assigned_approver_id" description: Filter by a person assigned as an approver on the time entry. responsible_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/responsible_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/responsible_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/responsible_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the ID of the budget owner (person responsible for approving time entries). autotracked: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/autotracked" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/autotracked" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/autotracked" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/autotracked" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/autotracked" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the time entry was captured automatically (e.g. via timer or integration). last_actor_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/last_actor_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/last_actor_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/last_actor_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/last_actor_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/last_actor_id" description: Filter by the last person who acted on the time entry. awaiting_approval_from_approver_id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/awaiting_approval_from_approver_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/awaiting_approval_from_approver_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/awaiting_approval_from_approver_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/awaiting_approval_from_approver_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/awaiting_approval_from_approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by a person from whom approval is currently awaited. parent_company_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/parent_company_id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/parent_company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/parent_company_id" description: Filter time entries by the parent company of the associated client. jira_issue_summary: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_summary" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_summary" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_summary" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_summary" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_summary" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by Jira issue summary text. booking_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/booking_id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/booking_id" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/booking_id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/booking_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/booking_id" description: Filter by the associated booking. started_at: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/started_at" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_at" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_at" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_at" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by timer start datetime range (`started_at`). created_after: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_after" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_after" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_after" not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_after" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_time_entry_report/properties/created_after" description: Filter to include entries created after this timestamp. id: oneOf: - "$ref": "#/components/schemas/resource_time_entry_report/properties/id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_time_entry_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/id" contains: "$ref": "#/components/schemas/resource_time_entry_report/properties/id" eq: "$ref": "#/components/schemas/resource_time_entry_report/properties/id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by time entry ID. patternProperties: "^task..*$": title: Task relationship "^person..*$": title: Person relationship "^creator..*$": title: Creator relationship "^service..*$": title: Service relationship "^approver..*$": title: Approver relationship "^last_actor..*$": title: Last actor relationship description: Available filter parameters for querying aggregated time entry report data. filter_entitlement: type: object title: Filter entitlement properties: used: oneOf: - "$ref": "#/components/schemas/resource_entitlement/properties/used" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_entitlement/properties/used" not_contain: "$ref": "#/components/schemas/resource_entitlement/properties/used" eq: "$ref": "#/components/schemas/resource_entitlement/properties/used" contains: "$ref": "#/components/schemas/resource_entitlement/properties/used" description: Filter using explicit operator syntax. description: Filter by the number of days used from the entitlement. person_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_entitlement/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_entitlement/properties/person_id" contains: "$ref": "#/components/schemas/resource_entitlement/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_entitlement/properties/person_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_entitlement/properties/person_id" description: Filter by the associated person. date: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_entitlement/properties/date" contains: "$ref": "#/components/schemas/resource_entitlement/properties/date" eq: "$ref": "#/components/schemas/resource_entitlement/properties/date" not_eq: "$ref": "#/components/schemas/resource_entitlement/properties/date" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_entitlement/properties/date" description: Filter entitlements active on a specific date (where start_date <= date <= end_date). allocated: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_entitlement/properties/allocated" contains: "$ref": "#/components/schemas/resource_entitlement/properties/allocated" not_eq: "$ref": "#/components/schemas/resource_entitlement/properties/allocated" eq: "$ref": "#/components/schemas/resource_entitlement/properties/allocated" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_entitlement/properties/allocated" description: Filter by the number of days allocated in the entitlement. id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_entitlement/properties/id" not_contain: "$ref": "#/components/schemas/resource_entitlement/properties/id" not_eq: "$ref": "#/components/schemas/resource_entitlement/properties/id" eq: "$ref": "#/components/schemas/resource_entitlement/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_entitlement/properties/id" description: Filter by entitlement ID. event_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_entitlement/properties/event_id" contains: "$ref": "#/components/schemas/resource_entitlement/properties/event_id" not_contain: "$ref": "#/components/schemas/resource_entitlement/properties/event_id" not_eq: "$ref": "#/components/schemas/resource_entitlement/properties/event_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_entitlement/properties/event_id" description: Filter by the associated absence event type. end_date: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_entitlement/properties/end_date" not_contain: "$ref": "#/components/schemas/resource_entitlement/properties/end_date" eq: "$ref": "#/components/schemas/resource_entitlement/properties/end_date" contains: "$ref": "#/components/schemas/resource_entitlement/properties/end_date" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_entitlement/properties/end_date" description: Filter by entitlement end date range (`end_date`). start_date: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_entitlement/properties/start_date" not_eq: "$ref": "#/components/schemas/resource_entitlement/properties/start_date" not_contain: "$ref": "#/components/schemas/resource_entitlement/properties/start_date" eq: "$ref": "#/components/schemas/resource_entitlement/properties/start_date" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_entitlement/properties/start_date" description: Filter by entitlement start date range (`start_date`). patternProperties: "^event..*$": title: Event relationship "^person..*$": title: Person relationship description: Filter parameters for listing entitlements (time-off balances). Supports filtering by person, event (absence category), date range, and approval workflow. Standard ID and date operators apply. resource_attachment: type: object title: Attachment Resource properties: deal: title: Deal description: The deal this attachment is associated with. document_style_id: type: integer title: Document Style description: ID of the document style this attachment is associated with. invoice: title: Invoice description: The invoice this attachment is associated with. full_query: type: string title: Full Query description: Full-text search query context for this attachment. fuzzy_people: type: integer title: Fuzzy People description: Fuzzy person references extracted from this attachment for search purposes. type: type: integer title: Type description: The attachment type identifier (e.g. file vs embedded image). jump_query: type: string title: Jump Query description: Jump-to search query context for navigating to this attachment. bill: title: Bill description: The bill this attachment is associated with. temp_url: title: Temp Url description: A temporary pre-signed URL for accessing the file, valid for a limited time. comment_id: type: integer title: Comment description: The ID of the comment this attachment belongs to. creator: title: Creator description: The person who uploaded this attachment. name: title: Name description: The filename of the uploaded file. invoice_id: type: integer title: Invoice description: ID of the invoice this attachment is associated with. task: title: Task description: The task this attachment is associated with. project_id: type: integer title: Project description: The ID of the project this attachment is scoped to. email: title: Email description: The email this attachment was received from or sent with. deleted_at: type: string title: Deleted At format: date-time description: Timestamp when this attachment was soft-deleted. Null if not deleted. company_id: type: integer title: Company description: The ID of the company this attachment is associated with. aws_policy: title: Aws Policy description: The AWS S3 presigned upload policy used for direct file uploads to object storage. page: title: Page description: The doc page this attachment is associated with. organization: title: Organization description: The organization this attachment belongs to. message_id: type: integer title: Message description: The email thread message ID this attachment belongs to. booking_id: type: integer title: Booking description: ID of the booking this attachment is associated with. document_style: title: Document Style description: The document layout style applied when rendering this attachment as a PDF. file_updated_at: title: File Updated At description: Timestamp when the file content was last updated in storage. purchase_order_id: type: integer title: Purchase Order description: ID of the purchase order this attachment is associated with. example: 1234567 fuzzy_dates: type: string title: Fuzzy Dates format: date description: Fuzzy date tokens extracted from this attachment for search purposes. url: title: Url description: The download URL for this attachment. expense: title: Expense description: The expense this attachment is associated with (e.g. receipt or supporting document). thumb: title: Thumb description: URL of a thumbnail image for previewing this attachment (for image files). id: type: integer title: Id description: The unique identifier of this attachment. page_id: type: integer title: Page description: The ID of the doc page this attachment is associated with. purchase_order: title: Purchase Order description: The purchase order this attachment is associated with. example: data: type: purchase_orders id: '1234567' resized: type: boolean title: Resized description: Whether resized image variants are available for this attachment. bill_id: type: integer title: Bill description: ID of the bill (vendor invoice) this attachment is associated with. widget_id: type: integer title: Widget description: ID of the widget this attachment is associated with. task_id: type: integer title: Task description: The ID of the task this attachment is associated with. attachable_type: type: string title: Attachable Type description: The type of the parent entity this file is attached to (e.g. comment, expense, task). comment: title: Comment description: The comment this attachment belongs to. expense_id: type: integer title: Expense description: ID of the expense this attachment is associated with. external_id: type: integer title: External description: The external system ID for this attachment, used when synced from an integration. creator_id: type: integer title: Creator description: The ID of the person who uploaded this attachment. content_type: title: Content Type description: The MIME content type of this file (e.g. image/png, application/pdf). created_at: type: string title: Created At format: date-time description: Timestamp when this attachment was uploaded. document_type: title: Document Type description: The document type template used for generating structured PDF documents from this attachment. size: title: Size description: The file size in bytes. document_type_id: type: integer title: Document Type description: ID of the document type this attachment is associated with. notes_attachment: type: boolean title: Notes Attachment description: Whether this attachment is embedded in a notes or rich text field. attachment_type: enum: - attachment - inline type: string title: Attachment Type description: The attachment category type (e.g. file, image, document). description: An uploaded file attached to a task, comment, expense, or other entity. _filter_root_time_entry_report: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_time_entry_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_time_entry_report" description: Filter schema for `time_entry_report` list endpoints — pass a single condition or a logical group. filter_custom_field_option: type: object title: Filter custom field option properties: custom_field_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_custom_field_option/properties/custom_field_id" not_eq: "$ref": "#/components/schemas/resource_custom_field_option/properties/custom_field_id" eq: "$ref": "#/components/schemas/resource_custom_field_option/properties/custom_field_id" not_contain: "$ref": "#/components/schemas/resource_custom_field_option/properties/custom_field_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_custom_field_option/properties/custom_field_id" description: Filter by the associated custom field. archived: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_custom_field_option/properties/archived" eq: "$ref": "#/components/schemas/resource_custom_field_option/properties/archived" not_contain: "$ref": "#/components/schemas/resource_custom_field_option/properties/archived" contains: "$ref": "#/components/schemas/resource_custom_field_option/properties/archived" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_custom_field_option/properties/archived" description: Filter by whether the custom field option is archived. patternProperties: {} description: Filter parameters for listing custom field options. Supports filtering by custom field and archived status. Standard ID operators apply. resource_purchase_order: type: object title: Purchase order Resource properties: attachment: title: Attachment description: The file attachment associated with this purchase order. example: data: type: attachments id: '89012' creator_id: type: integer title: Creator description: ID of the person who created this purchase order. example: 345678 query: type: string title: Query description: A full-text search query to filter purchase orders by number, subject, or vendor name. example: PO-2024 created_at: type: string title: Created At format: date-time description: Timestamp when this purchase order was created. example: '2026-04-01T09:00:00.000Z' project_id: type: integer title: Project description: ID of the project associated with the deal this purchase order is linked to. example: 567890 exchange_rate: type: number title: Exchange Rate description: The exchange rate applied to convert this purchase order's currency to the organization's default currency. example: '1.00000000000000000000' id: type: integer title: Id description: Unique identifier of this purchase order. example: 1234567 total_cost_default: title: Total Cost Default description: The total cost converted to the organization's default currency. example: '150000.000000' currency: type: string title: Currency description: The currency of this purchase order. example: USD export_url: type: string title: Export Url description: The URL of the exported purchase order in the external accounting system. example: https://go.xero.com/PurchaseOrders/Edit/abc123 deal_name: title: Deal Name description: The name of the deal (budget) this purchase order is linked to. example: Q2 Marketing Campaign export_id: type: string title: Export description: The external identifier assigned when this purchase order was exported to an accounting system. example: xero-abc123 note_interpolated: title: Note Interpolated description: The note text with template placeholders replaced by actual values from the purchase order. example: Please confirm delivery date for PO-2024-017. sent_status: enum: - 1 - 2 type: integer title: Sent Status description: The sent status of this purchase order, indicating whether it has been sent (1=sent, 2=not sent). example: 1 document_type: title: Document Type description: The document type associated with this purchase order. example: data: type: document_types id: '12' total_received_default: title: Total Received Default description: The total amount received converted to the organization's default currency. example: '150000.000000' payment_status_id: enum: - 1 - 2 - 3 type: integer title: Payment Status description: The payment status ID indicating how much of this purchase order has been received (1=not received, 2=partially received, 3=fully received). example: 1 note: title: Note description: The note or description body of this purchase order. example: Please confirm delivery date for the attached items. delivery_on: type: string title: Delivery On format: date description: Date when the goods or services covered by this purchase order are expected to be delivered. example: '2026-04-17' total_received: title: Total Received description: The total amount received against this purchase order in the purchase order's currency. example: '150000.000000' attachment_id: type: integer title: Attachment description: ID of the file attachment associated with this purchase order. example: 89012 number: type: string title: Number description: The auto-generated reference number of this purchase order. example: PO-2024-017 issued_on: type: string title: Issued On format: date description: Date when this purchase order was issued. example: '2026-04-10' email_key: type: string title: Email Key description: A unique key used to identify this purchase order when receiving it via email. example: po-7f3c9b2a exported: title: Exported description: Whether this purchase order has been exported to an accounting system. example: true total_cost_with_tax: title: Total Cost With Tax description: The total cost with tax. example: '187500.000000' status_id: enum: - 1 - 2 type: integer title: Status description: The ID of the approval status of this purchase order (e.g. draft, pending, finalized). example: 1 currency_default: title: Currency Default description: The purchase order amount converted to the organization's default currency. example: USD received_on: type: string title: Received On format: date-time description: Timestamp when this purchase order was received by the vendor, or null if not yet received. example: '2026-04-15T10:30:00.000Z' vendor_id: type: integer title: Vendor description: ID of the vendor (client/company) this purchase order was sent to. example: 234567 document_type_id: type: integer title: Document Type description: ID of the document type associated with this purchase order. example: 12 currency_normalized: title: Currency Normalized description: The purchase order amount converted to the normalized (reporting) currency. example: USD exported_at: type: string title: Exported At format: date-time description: Timestamp when this purchase order was exported to an accounting system, or null if not yet exported. example: '2026-04-12T14:22:00.000Z' sent_on: type: string title: Sent On format: date description: Date when this purchase order was sent to the vendor. example: '2026-04-10' total_cost_with_tax_default: title: Total Cost With Tax Default description: The total cost with tax default. example: '187500.000000' subscriber_ids: title: Subscriber Ids description: Array of IDs of users subscribed to receive notifications about this purchase order. example: - 345678 - 456789 bill_from: title: Bill From description: The billing address of the sender (bill from contact data) on this purchase order. example: data: type: contact_entries id: '79' footer: title: Footer description: The footer text template for this purchase order, sourced from the associated document type. example: 'Payment terms: net 30.' subject: type: string title: Subject description: The subject line of this purchase order. example: Purchase Order PO-2024-017 bill_to: title: Bill To description: The billing address of the recipient (bill to contact data) on this purchase order. example: data: type: contact_entries id: '78' exchange_date: type: string title: Exchange Date format: date description: The date used for applying the exchange rate when converting this purchase order's currency. example: '2026-04-10' deal: title: Deal description: The deal (budget) this purchase order is linked to. example: data: type: deals id: '456789' total_cost_normalized: title: Total Cost Normalized description: The total cost converted to the normalized (reporting) currency. example: '150000.000000' footer_interpolated: title: Footer Interpolated description: The footer text with template placeholders replaced by actual values from the purchase order. example: 'Payment terms: net 30.' creator: title: Creator description: The person who created this purchase order. example: data: type: people id: '345678' total_cost: title: Total Cost description: The total cost of this purchase order (excluding tax) in the purchase order's currency. example: '150000.000000' total_received_normalized: title: Total Received Normalized description: The total amount received converted to the normalized (reporting) currency. example: '150000.000000' export_integration_type_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 type: integer title: Export Integration Type description: The export integration type id. example: 3 vendor: title: Vendor description: The vendor (client/company) this purchase order was sent to. example: data: type: companies id: '234567' total_cost_with_tax_normalized: title: Total Cost With Tax Normalized description: The total cost with tax normalized. example: '187500.000000' deal_id: type: integer title: Deal description: ID of the deal (budget) this purchase order is linked to. example: 456789 organization: title: Organization description: The organization this purchase order belongs to. example: data: type: organizations id: '109' description: Vendor procurement document on a budget. Tracks subject, status, issued/delivery/received dates, vendor, amounts, and export status for accounting integration. Line items (expenses) are created from the PO and billed via bills. example: type: purchase_orders id: '1234567' attributes: subject: Purchase Order PO-2024-017 status_id: 1 issued_on: '2026-04-10' delivery_on: '2026-04-17' sent_on: '2026-04-10' received_on: '2026-04-15T10:30:00.000Z' created_at: '2026-04-01T09:00:00.000Z' number: PO-2024-017 note: Please confirm delivery date for the attached items. footer: 'Payment terms: net 30.' note_interpolated: Please confirm delivery date for PO-2024-017. footer_interpolated: 'Payment terms: net 30.' email_key: po-7f3c9b2a payment_status_id: 1 exchange_rate: '1.00000000000000000000' exchange_date: '2026-04-10' exported: true exported_at: '2026-04-12T14:22:00.000Z' export_integration_type_id: 3 export_id: xero-abc123 export_url: https://go.xero.com/PurchaseOrders/Edit/abc123 currency: USD currency_default: USD currency_normalized: USD total_cost: '150000.000000' total_cost_default: '150000.000000' total_cost_normalized: '150000.000000' total_cost_with_tax: '187500.000000' total_cost_with_tax_default: '187500.000000' total_cost_with_tax_normalized: '187500.000000' total_received: '150000.000000' total_received_default: '150000.000000' total_received_normalized: '150000.000000' relationships: organization: data: type: organizations id: '109' vendor: data: type: companies id: '234567' deal: data: type: deals id: '456789' creator: data: type: people id: '345678' document_type: data: type: document_types id: '12' attachment: data: type: attachments id: '89012' bill_to: data: type: contact_entries id: '78' bill_from: data: type: contact_entries id: '79' resource_workflow: type: object title: Workflow Resource properties: name: type: string title: Name description: The display name of this workflow. organization: title: Organization description: The organization this workflow belongs to. archived: type: boolean title: Archived description: When true, filter to include only archived workflows. archived_at: type: string title: Archived At format: date-time description: Timestamp when this workflow was archived, or null if still active. query: type: string title: Query description: Text search query to filter workflows by name. workflow_statuses: title: Workflow Statuses description: The list of statuses defined in this workflow. description: Named group of workflow statuses assigned to a project. Workflows define the task lifecycle for a project. Each workflow contains ordered statuses in Not Started, Started, or Closed categories. resource_pipeline: type: object title: Pipeline Resource properties: organization: title: Organization description: The organization this pipeline belongs to. pipeline_type_id: enum: - 1 - 2 type: integer title: Pipeline Type description: 'Pipeline type: 1 = sales (opportunities), 2 = production (budgets).' icon_id: type: string title: Icon description: Icon ID used to visually identify this pipeline. name: type: string title: Name description: Display name of the pipeline. updater: title: Updater description: Person who last updated this pipeline. position: type: integer title: Position description: Display order of this pipeline relative to other pipelines. creator: title: Creator description: Person who created this pipeline. created_at: type: string title: Created At format: date-time description: Timestamp when the pipeline was created. updated_at: type: string title: Updated At format: date-time description: Timestamp of the last modification to this pipeline. description: A sales or production pipeline defining the stages that deals progress through. filter_discussion: type: object title: Filter discussion properties: status: oneOf: - "$ref": "#/components/schemas/resource_discussion/properties/status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_discussion/properties/status" not_eq: "$ref": "#/components/schemas/resource_discussion/properties/status" contains: "$ref": "#/components/schemas/resource_discussion/properties/status" eq: "$ref": "#/components/schemas/resource_discussion/properties/status" description: Filter using explicit operator syntax. description: Filter by discussion status (active or resolved). page_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_discussion/properties/page_id" not_eq: "$ref": "#/components/schemas/resource_discussion/properties/page_id" contains: "$ref": "#/components/schemas/resource_discussion/properties/page_id" not_contain: "$ref": "#/components/schemas/resource_discussion/properties/page_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_discussion/properties/page_id" description: Filter by the associated document page. id: oneOf: - "$ref": "#/components/schemas/resource_discussion/properties/id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_discussion/properties/id" not_eq: "$ref": "#/components/schemas/resource_discussion/properties/id" eq: "$ref": "#/components/schemas/resource_discussion/properties/id" contains: "$ref": "#/components/schemas/resource_discussion/properties/id" description: Filter using explicit operator syntax. description: Filter by discussion ID. patternProperties: {} description: Filter parameters for discussions. filter_person: type: object title: Filter person properties: agent: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person/properties/agent" contains: "$ref": "#/components/schemas/resource_person/properties/agent" not_contain: "$ref": "#/components/schemas/resource_person/properties/agent" eq: "$ref": "#/components/schemas/resource_person/properties/agent" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person/properties/agent" description: Filter by whether the person is an AI agent. joined_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/joined_at" contains: "$ref": "#/components/schemas/resource_person/properties/joined_at" not_eq: "$ref": "#/components/schemas/resource_person/properties/joined_at" not_contain: "$ref": "#/components/schemas/resource_person/properties/joined_at" description: Operator object for filtering by joined_at. - "$ref": "#/components/schemas/resource_person/properties/joined_at" description: Filter by the date the person joined the organization (joined_at). title: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/title" not_contain: "$ref": "#/components/schemas/resource_person/properties/title" eq: "$ref": "#/components/schemas/resource_person/properties/title" not_eq: "$ref": "#/components/schemas/resource_person/properties/title" description: Operator object for filtering by title. - "$ref": "#/components/schemas/resource_person/properties/title" description: Filter by job title (text search). autotracking: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/autotracking" not_eq: "$ref": "#/components/schemas/resource_person/properties/autotracking" contains: "$ref": "#/components/schemas/resource_person/properties/autotracking" eq: "$ref": "#/components/schemas/resource_person/properties/autotracking" description: Operator object for filtering by autotracking. - "$ref": "#/components/schemas/resource_person/properties/autotracking" description: Filter by autotracking (automatic time tracking) status. fuzzy_dates: oneOf: - "$ref": "#/components/schemas/resource_person/properties/fuzzy_dates" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_person/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_person/properties/fuzzy_dates" not_contain: "$ref": "#/components/schemas/resource_person/properties/fuzzy_dates" description: Operator object for filtering by fuzzy_dates. description: Fuzzy date filter for approximate date matching. offboarding_status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/offboarding_status" not_eq: "$ref": "#/components/schemas/resource_person/properties/offboarding_status" eq: "$ref": "#/components/schemas/resource_person/properties/offboarding_status" not_contain: "$ref": "#/components/schemas/resource_person/properties/offboarding_status" description: Operator object for filtering by offboarding_status. - "$ref": "#/components/schemas/resource_person/properties/offboarding_status" description: Filter by offboarding status (e.g. active, in-progress). person_type: oneOf: - "$ref": "#/components/schemas/resource_person/properties/person_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/person_type" eq: "$ref": "#/components/schemas/resource_person/properties/person_type" not_eq: "$ref": "#/components/schemas/resource_person/properties/person_type" contains: "$ref": "#/components/schemas/resource_person/properties/person_type" description: Operator object for filtering by person_type. description: 'Filter by person type: user (can log in), contact (external), placeholder (resource planning).' accessible_filter_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/accessible_filter_id" contains: "$ref": "#/components/schemas/resource_person/properties/accessible_filter_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/accessible_filter_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/accessible_filter_id" description: Operator object for filtering by accessible_filter_id. - "$ref": "#/components/schemas/resource_person/properties/accessible_filter_id" description: Filter by accessible filter ID — returns people who are members of the specified saved filter. bookings_after: oneOf: - "$ref": "#/components/schemas/resource_person/properties/bookings_after" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/bookings_after" contains: "$ref": "#/components/schemas/resource_person/properties/bookings_after" eq: "$ref": "#/components/schemas/resource_person/properties/bookings_after" not_eq: "$ref": "#/components/schemas/resource_person/properties/bookings_after" description: Operator object for filtering by bookings_after. description: Filter by bookings_after date — returns people with bookings ending on or after this date. first_name: oneOf: - "$ref": "#/components/schemas/resource_person/properties/first_name" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person/properties/first_name" contains: "$ref": "#/components/schemas/resource_person/properties/first_name" not_contain: "$ref": "#/components/schemas/resource_person/properties/first_name" eq: "$ref": "#/components/schemas/resource_person/properties/first_name" description: Operator object for filtering by first_name. description: Filter by first name (text search). eligible_replacement_managers: oneOf: - "$ref": "#/components/schemas/resource_person/properties/eligible_replacement_managers" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/eligible_replacement_managers" contains: "$ref": "#/components/schemas/resource_person/properties/eligible_replacement_managers" not_contain: "$ref": "#/components/schemas/resource_person/properties/eligible_replacement_managers" not_eq: "$ref": "#/components/schemas/resource_person/properties/eligible_replacement_managers" description: Operator object for filtering by eligible_replacement_managers. description: Filter for eligible replacement managers — returns people who could replace the specified person as a manager. last_activity_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/last_activity_at" not_eq: "$ref": "#/components/schemas/resource_person/properties/last_activity_at" contains: "$ref": "#/components/schemas/resource_person/properties/last_activity_at" eq: "$ref": "#/components/schemas/resource_person/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person/properties/last_activity_at" description: Filter by the date of the person's last activity (last_activity_at). two_factor_auth: oneOf: - "$ref": "#/components/schemas/resource_person/properties/two_factor_auth" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/two_factor_auth" not_contain: "$ref": "#/components/schemas/resource_person/properties/two_factor_auth" not_eq: "$ref": "#/components/schemas/resource_person/properties/two_factor_auth" eq: "$ref": "#/components/schemas/resource_person/properties/two_factor_auth" description: Operator object for filtering by two_factor_auth. description: Filter by two-factor authentication status. manager_id: oneOf: - "$ref": "#/components/schemas/resource_person/properties/manager_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person/properties/manager_id" eq: "$ref": "#/components/schemas/resource_person/properties/manager_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/manager_id" contains: "$ref": "#/components/schemas/resource_person/properties/manager_id" description: Operator object for filtering by manager_id. description: Filter by the person's manager. last_name: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/last_name" contains: "$ref": "#/components/schemas/resource_person/properties/last_name" eq: "$ref": "#/components/schemas/resource_person/properties/last_name" not_eq: "$ref": "#/components/schemas/resource_person/properties/last_name" description: Operator object for filtering by last_name. - "$ref": "#/components/schemas/resource_person/properties/last_name" description: Filter by last name (text search). accessible_project_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/accessible_project_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/accessible_project_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/accessible_project_id" eq: "$ref": "#/components/schemas/resource_person/properties/accessible_project_id" description: Operator object for filtering by accessible_project_id. - "$ref": "#/components/schemas/resource_person/properties/accessible_project_id" description: Filter by accessible project ID — returns people who have access to the specified project. jump_query: oneOf: - "$ref": "#/components/schemas/resource_person/properties/jump_query" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_person/properties/jump_query" eq: "$ref": "#/components/schemas/resource_person/properties/jump_query" contains: "$ref": "#/components/schemas/resource_person/properties/jump_query" description: Operator object for filtering by jump_query. description: Quick jump search filter — matches against name for navigation shortcuts. deactivated_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/deactivated_at" contains: "$ref": "#/components/schemas/resource_person/properties/deactivated_at" not_eq: "$ref": "#/components/schemas/resource_person/properties/deactivated_at" eq: "$ref": "#/components/schemas/resource_person/properties/deactivated_at" description: Operator object for filtering by deactivated_at. - "$ref": "#/components/schemas/resource_person/properties/deactivated_at" description: Filter by deactivation date range (deactivated_at). time_tracking_policy_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/time_tracking_policy_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/time_tracking_policy_id" contains: "$ref": "#/components/schemas/resource_person/properties/time_tracking_policy_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/time_tracking_policy_id" description: Operator object for filtering by time_tracking_policy_id. - "$ref": "#/components/schemas/resource_person/properties/time_tracking_policy_id" description: Filter by the person's assigned time tracking policy. hrm_type_id: oneOf: - "$ref": "#/components/schemas/resource_person/properties/hrm_type_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/hrm_type_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/hrm_type_id" eq: "$ref": "#/components/schemas/resource_person/properties/hrm_type_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/hrm_type_id" description: Operator object for filtering by hrm_type_id. description: 'Filter by HRM type: 1 for employee (time tracker), 2 for contact.' custom_fields: oneOf: - "$ref": "#/components/schemas/resource_person/properties/custom_fields" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_person/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_person/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_person/properties/custom_fields" description: Operator object for filtering by custom_fields. description: Filter by custom field values. accessible_doc_id: oneOf: - "$ref": "#/components/schemas/resource_person/properties/accessible_doc_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/accessible_doc_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/accessible_doc_id" contains: "$ref": "#/components/schemas/resource_person/properties/accessible_doc_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/accessible_doc_id" description: Operator object for filtering by accessible_doc_id. description: Filter by accessible doc ID — returns people who have access to the specified document. archived_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/archived_at" eq: "$ref": "#/components/schemas/resource_person/properties/archived_at" not_eq: "$ref": "#/components/schemas/resource_person/properties/archived_at" not_contain: "$ref": "#/components/schemas/resource_person/properties/archived_at" description: Operator object for filtering by archived_at. - "$ref": "#/components/schemas/resource_person/properties/archived_at" description: Filter by archival date range (archived_at). bookings_before: oneOf: - "$ref": "#/components/schemas/resource_person/properties/bookings_before" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/bookings_before" not_contain: "$ref": "#/components/schemas/resource_person/properties/bookings_before" eq: "$ref": "#/components/schemas/resource_person/properties/bookings_before" not_eq: "$ref": "#/components/schemas/resource_person/properties/bookings_before" description: Operator object for filtering by bookings_before. description: Filter by bookings_before date — returns people with bookings starting on or before this date. last_seen_at: oneOf: - "$ref": "#/components/schemas/resource_person/properties/last_seen_at" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person/properties/last_seen_at" eq: "$ref": "#/components/schemas/resource_person/properties/last_seen_at" not_contain: "$ref": "#/components/schemas/resource_person/properties/last_seen_at" contains: "$ref": "#/components/schemas/resource_person/properties/last_seen_at" description: Operator object for filtering by last_seen_at. description: Filter by the date the person was last seen (last_seen_at). status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/status" not_contain: "$ref": "#/components/schemas/resource_person/properties/status" eq: "$ref": "#/components/schemas/resource_person/properties/status" not_eq: "$ref": "#/components/schemas/resource_person/properties/status" description: Operator object for filtering by status. - "$ref": "#/components/schemas/resource_person/properties/status" description: 'Filter by person status: 1 (active) or 2 (deactivated).' virtual: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/virtual" contains: "$ref": "#/components/schemas/resource_person/properties/virtual" not_eq: "$ref": "#/components/schemas/resource_person/properties/virtual" not_contain: "$ref": "#/components/schemas/resource_person/properties/virtual" description: Operator object for filtering by virtual. - "$ref": "#/components/schemas/resource_person/properties/virtual" description: Filter by virtual status — whether this is a virtual person record. service_type_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_person/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/service_type_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/service_type_id" description: Operator object for filtering by service_type_id. - "$ref": "#/components/schemas/resource_person/properties/service_type_id" description: Filter by service type ID — returns people assigned to the specified service types. created_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person/properties/created_at" eq: "$ref": "#/components/schemas/resource_person/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_person/properties/created_at" contains: "$ref": "#/components/schemas/resource_person/properties/created_at" description: Operator object for filtering by created_at. - "$ref": "#/components/schemas/resource_person/properties/created_at" description: Filter by creation date range (created_at). email: oneOf: - "$ref": "#/components/schemas/resource_person/properties/email" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/email" not_eq: "$ref": "#/components/schemas/resource_person/properties/email" contains: "$ref": "#/components/schemas/resource_person/properties/email" eq: "$ref": "#/components/schemas/resource_person/properties/email" description: Operator object for filtering by email. description: Filter by email address (text search). query: oneOf: - "$ref": "#/components/schemas/resource_person/properties/query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person/properties/query" not_contain: "$ref": "#/components/schemas/resource_person/properties/query" eq: "$ref": "#/components/schemas/resource_person/properties/query" contains: "$ref": "#/components/schemas/resource_person/properties/query" description: Operator object for filtering by query. description: Text search filter — matches by full name (exact) or contains partial name. full_query: oneOf: - "$ref": "#/components/schemas/resource_person/properties/full_query" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/full_query" eq: "$ref": "#/components/schemas/resource_person/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_person/properties/full_query" contains: "$ref": "#/components/schemas/resource_person/properties/full_query" description: Operator object for filtering by full_query. description: Full text search filter — matches against name and other indexed fields. fuzzy_people: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_person/properties/fuzzy_people" not_contain: "$ref": "#/components/schemas/resource_person/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_person/properties/fuzzy_people" description: Operator object for filtering by fuzzy_people. - "$ref": "#/components/schemas/resource_person/properties/fuzzy_people" description: Fuzzy people filter for approximate person name matching. timesheet_submission_disabled: oneOf: - "$ref": "#/components/schemas/resource_person/properties/timesheet_submission_disabled" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/timesheet_submission_disabled" not_eq: "$ref": "#/components/schemas/resource_person/properties/timesheet_submission_disabled" not_contain: "$ref": "#/components/schemas/resource_person/properties/timesheet_submission_disabled" eq: "$ref": "#/components/schemas/resource_person/properties/timesheet_submission_disabled" description: Operator object for filtering by timesheet_submission_disabled. description: Filter by whether timesheet submission is disabled for the person. id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/id" not_eq: "$ref": "#/components/schemas/resource_person/properties/id" eq: "$ref": "#/components/schemas/resource_person/properties/id" contains: "$ref": "#/components/schemas/resource_person/properties/id" description: Operator object for filtering by id. - "$ref": "#/components/schemas/resource_person/properties/id" description: Filter by person ID. subscribable_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/subscribable_id" contains: "$ref": "#/components/schemas/resource_person/properties/subscribable_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/subscribable_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/subscribable_id" description: Operator object for filtering by subscribable_id. - "$ref": "#/components/schemas/resource_person/properties/subscribable_id" description: Filter by subscribable ID — used with subscribable_type to return subscribers of a resource. approval_policy_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/approval_policy_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/approval_policy_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/approval_policy_id" contains: "$ref": "#/components/schemas/resource_person/properties/approval_policy_id" description: Operator object for filtering by approval_policy_id. - "$ref": "#/components/schemas/resource_person/properties/approval_policy_id" description: Filter by the person's assigned approval policy. schedulable: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/schedulable" not_eq: "$ref": "#/components/schemas/resource_person/properties/schedulable" not_contain: "$ref": "#/components/schemas/resource_person/properties/schedulable" contains: "$ref": "#/components/schemas/resource_person/properties/schedulable" description: Operator object for filtering by schedulable. - "$ref": "#/components/schemas/resource_person/properties/schedulable" description: Filter for schedulable people — returns employees, contractors, and placeholders who can be booked. company_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/company_id" eq: "$ref": "#/components/schemas/resource_person/properties/company_id" contains: "$ref": "#/components/schemas/resource_person/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/company_id" description: Operator object for filtering by company_id. - "$ref": "#/components/schemas/resource_person/properties/company_id" description: Filter by company (client) ID. project_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/project_id" eq: "$ref": "#/components/schemas/resource_person/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/project_id" description: Operator object for filtering by project_id. - "$ref": "#/components/schemas/resource_person/properties/project_id" description: Filter by project ID — returns people who are members of the specified project. tags: oneOf: - "$ref": "#/components/schemas/resource_person/properties/tags" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/tags" eq: "$ref": "#/components/schemas/resource_person/properties/tags" contains: "$ref": "#/components/schemas/resource_person/properties/tags" not_eq: "$ref": "#/components/schemas/resource_person/properties/tags" description: Operator object for filtering by tags. description: Filter by tag. service_id: oneOf: - "$ref": "#/components/schemas/resource_person/properties/service_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/service_id" eq: "$ref": "#/components/schemas/resource_person/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/service_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/service_id" description: Operator object for filtering by service_id. description: Filter by service ID — returns people who can track time on the specified service. team: oneOf: - "$ref": "#/components/schemas/resource_person/properties/team" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/team" eq: "$ref": "#/components/schemas/resource_person/properties/team" not_eq: "$ref": "#/components/schemas/resource_person/properties/team" contains: "$ref": "#/components/schemas/resource_person/properties/team" description: Operator object for filtering by team. description: Filter by team ID — returns people who belong to the specified team(s). subsidiary_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_person/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/subsidiary_id" description: Operator object for filtering by subsidiary_id. - "$ref": "#/components/schemas/resource_person/properties/subsidiary_id" description: Filter by the person's subsidiary. subscribable_type: oneOf: - "$ref": "#/components/schemas/resource_person/properties/subscribable_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/subscribable_type" contains: "$ref": "#/components/schemas/resource_person/properties/subscribable_type" not_eq: "$ref": "#/components/schemas/resource_person/properties/subscribable_type" eq: "$ref": "#/components/schemas/resource_person/properties/subscribable_type" description: Operator object for filtering by subscribable_type. description: Filter by subscribable type — the resource type to match subscribers against. holiday_calendar_id: oneOf: - "$ref": "#/components/schemas/resource_person/properties/holiday_calendar_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/holiday_calendar_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/holiday_calendar_id" eq: "$ref": "#/components/schemas/resource_person/properties/holiday_calendar_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/holiday_calendar_id" description: Operator object for filtering by holiday_calendar_id. description: Filter by the person's assigned holiday calendar. accessible_deal_id: oneOf: - "$ref": "#/components/schemas/resource_person/properties/accessible_deal_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/accessible_deal_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/accessible_deal_id" contains: "$ref": "#/components/schemas/resource_person/properties/accessible_deal_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/accessible_deal_id" description: Operator object for filtering by accessible_deal_id. description: Filter by accessible deal ID — returns people who have access to the specified deal. permissions: oneOf: - "$ref": "#/components/schemas/resource_person/properties/permissions" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person/properties/permissions" not_contain: "$ref": "#/components/schemas/resource_person/properties/permissions" eq: "$ref": "#/components/schemas/resource_person/properties/permissions" not_eq: "$ref": "#/components/schemas/resource_person/properties/permissions" description: Operator object for filtering by permissions. description: Filter by permission set — returns people with the specified permission slugs. project_watching: oneOf: - "$ref": "#/components/schemas/resource_person/properties/project_watching" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/project_watching" eq: "$ref": "#/components/schemas/resource_person/properties/project_watching" contains: "$ref": "#/components/schemas/resource_person/properties/project_watching" not_eq: "$ref": "#/components/schemas/resource_person/properties/project_watching" description: Operator object for filtering by project_watching. description: Filter by project_watching — returns people who are auto-subscribed to the specified project. role_id: oneOf: - "$ref": "#/components/schemas/resource_person/properties/role_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person/properties/role_id" eq: "$ref": "#/components/schemas/resource_person/properties/role_id" contains: "$ref": "#/components/schemas/resource_person/properties/role_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/role_id" description: Operator object for filtering by role_id. description: Filter by built-in role type ID. approval_workflow_id: oneOf: - "$ref": "#/components/schemas/resource_person/properties/approval_workflow_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person/properties/approval_workflow_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/approval_workflow_id" not_eq: "$ref": "#/components/schemas/resource_person/properties/approval_workflow_id" contains: "$ref": "#/components/schemas/resource_person/properties/approval_workflow_id" description: Operator object for filtering by approval_workflow_id. description: Filter by approval workflow ID — returns people who have approvals in the specified workflow. custom_role_id: oneOf: - "$ref": "#/components/schemas/resource_person/properties/custom_role_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person/properties/custom_role_id" contains: "$ref": "#/components/schemas/resource_person/properties/custom_role_id" eq: "$ref": "#/components/schemas/resource_person/properties/custom_role_id" not_contain: "$ref": "#/components/schemas/resource_person/properties/custom_role_id" description: Operator object for filtering by custom_role_id. description: Filter by custom role (permission set) ID. patternProperties: "^company..*$": title: Company relationship "^contact..*$": title: Contact relationship "^bookings..*$": title: Bookings relationship "^subsidiary..*$": title: Subsidiary relationship "^custom_role..*$": title: Custom role relationship description: Filters people by various criteria such as name, email, role, team, tags, status, and date fields. resource_deal_funnel_report: type: object title: Deal funnel report Resource properties: created_at: type: string title: Created At format: date description: Timestamp when this report row was created. total_projected_revenue_normalized: title: Total Projected Revenue Normalized description: Sum of projected revenue for all deals in this funnel stage, in the normalized common currency. currency_default: title: Currency Default description: Currency code for totals expressed in the organization's default currency. lost_count: type: integer title: Lost Count description: Number of deals in this funnel stage that were marked as lost. total_projected_revenue_default: title: Total Projected Revenue Default description: Sum of projected revenue for all deals in this funnel stage, in the organization's default currency. projected_revenue: title: Projected Revenue description: Projected revenue for deals in this funnel stage, based on budget forecasting. formulas: type: integer title: Formulas description: Custom formula results for this report row, keyed by formula identifier. report: title: Report description: The parent report row for this funnel row, used in hierarchical grouping. total_budget_total_default: title: Total Budget Total Default description: Sum of total budget value for all deals in this funnel stage, in the organization's default currency. currency_normalized: title: Currency Normalized description: Currency code for totals expressed in the organization's normalized (common) currency. deal_funnel: title: Deal Funnel description: Related deal funnel data combining pipeline, deal status, and this report row — used by the UI to compute conversion metrics. total_budget_total: title: Total Budget Total description: Sum of total budget value for all deals in this funnel stage, in the budget currency. formula_fields: title: Formula Fields description: Formula fields — key-value hash of custom formula results for this report row. pipeline: title: Pipeline description: The pipeline this report row belongs to. count: type: integer title: Count description: Number of deals grouped into this report row. organization: title: Organization description: The organization this report row belongs to. group: type: string title: Group description: Dimension value used to group this report row (e.g. pipeline stage name or deal status label). date: type: string title: Date format: date description: Date dimension for time-based filtering of the funnel report. pipeline_id: type: integer title: Pipeline description: ID of the pipeline this funnel row is grouped by. currency: type: string title: Currency description: Currency code for this report row, reflecting the budget currency. budget_total: title: Budget Total description: Total contracted budget value for deals in this funnel stage. total_budget_total_normalized: title: Total Budget Total Normalized description: Sum of total budget value for all deals in this funnel stage, in the normalized common currency. deal_status: title: Deal Status description: The deal status (pipeline stage) this funnel row is grouped by. total_projected_revenue: title: Total Projected Revenue description: Sum of projected revenue for all deals in this funnel stage, in the budget currency. description: An aggregated deal funnel report showing pipeline conversion rates, stage progression, and win/loss analysis. Each row represents deals grouped by pipeline stage (deal status), with counts of active and lost deals and total financial values. Used to visualize funnel drop-off and conversion across the sales pipeline. resource_survey_report: type: object title: Survey report Resource properties: project_id: type: integer title: Project description: Project id for this survey report group. report: title: Report description: Report for this survey report group. title: type: string title: Title description: Title for this survey report group. query: type: string title: Query description: Query for this survey report group. editable: type: boolean title: Editable description: Editable for this survey report group. created_at: type: string title: Created At format: date description: Created at for this survey report group. survey_id: title: Survey description: Survey id for this survey report group. id: type: integer title: Id description: Unique identifier for this survey report row. currency: title: Currency description: Currency for this survey report group. count: type: integer title: Count description: Number of surveys in this report group. currency_normalized: title: Currency Normalized description: Currency in the normalized currency for this survey report group. group: type: string title: Group description: The grouping dimension for this survey report row. organization: title: Organization description: Organization for this survey report group. project: title: Project description: Project for this survey report group. creator: title: Creator description: Creator for this survey report group. updater: title: Updater description: Updater for this survey report group. creator_id: type: integer title: Creator description: Creator id for this survey report group. formula_fields: title: Formula Fields description: Formula fields for this survey report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this survey report group. survey: title: Survey description: Survey for this survey report group. description: An aggregated survey report row grouping survey submissions by configurable dimensions. filter_activity: type: object title: Filter activity properties: participant_id: oneOf: - "$ref": "#/components/schemas/resource_activity/properties/participant_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_activity/properties/participant_id" not_eq: "$ref": "#/components/schemas/resource_activity/properties/participant_id" not_contain: "$ref": "#/components/schemas/resource_activity/properties/participant_id" contains: "$ref": "#/components/schemas/resource_activity/properties/participant_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter activities where this person participated (as creator, email recipient, or subject). parent_type: oneOf: - "$ref": "#/components/schemas/resource_activity/properties/parent_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_activity/properties/parent_type" not_eq: "$ref": "#/components/schemas/resource_activity/properties/parent_type" eq: "$ref": "#/components/schemas/resource_activity/properties/parent_type" contains: "$ref": "#/components/schemas/resource_activity/properties/parent_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the resource type of the activity's immediate parent (e.g. task, project). proposal_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_activity/properties/proposal_id" not_contain: "$ref": "#/components/schemas/resource_activity/properties/proposal_id" contains: "$ref": "#/components/schemas/resource_activity/properties/proposal_id" not_eq: "$ref": "#/components/schemas/resource_activity/properties/proposal_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/proposal_id" description: Filter activities related to a specific proposal (includes both direct and parent-linked activities). expense_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_activity/properties/expense_id" contains: "$ref": "#/components/schemas/resource_activity/properties/expense_id" eq: "$ref": "#/components/schemas/resource_activity/properties/expense_id" not_contain: "$ref": "#/components/schemas/resource_activity/properties/expense_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/expense_id" description: Filter activities related to a specific expense. after: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_activity/properties/after" not_eq: "$ref": "#/components/schemas/resource_activity/properties/after" contains: "$ref": "#/components/schemas/resource_activity/properties/after" not_contain: "$ref": "#/components/schemas/resource_activity/properties/after" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/after" description: Return activities created after this timestamp. event: oneOf: - "$ref": "#/components/schemas/resource_activity/properties/event" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_activity/properties/event" eq: "$ref": "#/components/schemas/resource_activity/properties/event" contains: "$ref": "#/components/schemas/resource_activity/properties/event" not_eq: "$ref": "#/components/schemas/resource_activity/properties/event" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by event type (e.g. create, update, destroy). discussion_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_activity/properties/discussion_id" not_eq: "$ref": "#/components/schemas/resource_activity/properties/discussion_id" eq: "$ref": "#/components/schemas/resource_activity/properties/discussion_id" not_contain: "$ref": "#/components/schemas/resource_activity/properties/discussion_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/discussion_id" description: Filter activities related to a specific doc discussion. booking_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_activity/properties/booking_id" not_eq: "$ref": "#/components/schemas/resource_activity/properties/booking_id" contains: "$ref": "#/components/schemas/resource_activity/properties/booking_id" eq: "$ref": "#/components/schemas/resource_activity/properties/booking_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/booking_id" description: Filter activities related to a specific booking. id: oneOf: - "$ref": "#/components/schemas/resource_activity/properties/id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_activity/properties/id" contains: "$ref": "#/components/schemas/resource_activity/properties/id" eq: "$ref": "#/components/schemas/resource_activity/properties/id" not_contain: "$ref": "#/components/schemas/resource_activity/properties/id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by activity ID. before: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_activity/properties/before" not_contain: "$ref": "#/components/schemas/resource_activity/properties/before" not_eq: "$ref": "#/components/schemas/resource_activity/properties/before" contains: "$ref": "#/components/schemas/resource_activity/properties/before" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/before" description: Return activities created before this timestamp. person_id: oneOf: - "$ref": "#/components/schemas/resource_activity/properties/person_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_activity/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_activity/properties/person_id" eq: "$ref": "#/components/schemas/resource_activity/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_activity/properties/person_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter activities related to a specific person. item_type: oneOf: - "$ref": "#/components/schemas/resource_activity/properties/item_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_activity/properties/item_type" not_eq: "$ref": "#/components/schemas/resource_activity/properties/item_type" not_contain: "$ref": "#/components/schemas/resource_activity/properties/item_type" eq: "$ref": "#/components/schemas/resource_activity/properties/item_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the resource type of the changed entity (e.g. "task", "deal"). purchase_order_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_activity/properties/purchase_order_id" contains: "$ref": "#/components/schemas/resource_activity/properties/purchase_order_id" eq: "$ref": "#/components/schemas/resource_activity/properties/purchase_order_id" not_eq: "$ref": "#/components/schemas/resource_activity/properties/purchase_order_id" description: Operator object — supports eq, not_eq, contains, not_contain. example: eq: - 1234567 - "$ref": "#/components/schemas/resource_activity/properties/purchase_order_id" description: Filter activities on a specific purchase order. example: eq: - 1234567 task_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_activity/properties/task_id" not_contain: "$ref": "#/components/schemas/resource_activity/properties/task_id" not_eq: "$ref": "#/components/schemas/resource_activity/properties/task_id" contains: "$ref": "#/components/schemas/resource_activity/properties/task_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/task_id" description: Filter activities related to a specific task. resource_request_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_activity/properties/resource_request_id" not_contain: "$ref": "#/components/schemas/resource_activity/properties/resource_request_id" contains: "$ref": "#/components/schemas/resource_activity/properties/resource_request_id" not_eq: "$ref": "#/components/schemas/resource_activity/properties/resource_request_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/resource_request_id" description: Filter activities on a specific resource request. pinned: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_activity/properties/pinned" not_contain: "$ref": "#/components/schemas/resource_activity/properties/pinned" eq: "$ref": "#/components/schemas/resource_activity/properties/pinned" not_eq: "$ref": "#/components/schemas/resource_activity/properties/pinned" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/pinned" description: Return only activities with pinned comments. created_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_activity/properties/created_at" contains: "$ref": "#/components/schemas/resource_activity/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_activity/properties/created_at" eq: "$ref": "#/components/schemas/resource_activity/properties/created_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/created_at" description: Filter by creation date range (`created_at`). company_id: oneOf: - "$ref": "#/components/schemas/resource_activity/properties/company_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_activity/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_activity/properties/company_id" eq: "$ref": "#/components/schemas/resource_activity/properties/company_id" contains: "$ref": "#/components/schemas/resource_activity/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter activities related to a specific company. deal_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_activity/properties/deal_id" eq: "$ref": "#/components/schemas/resource_activity/properties/deal_id" contains: "$ref": "#/components/schemas/resource_activity/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_activity/properties/deal_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/deal_id" description: Filter activities related to a specific deal or budget. creator_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_activity/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_activity/properties/creator_id" contains: "$ref": "#/components/schemas/resource_activity/properties/creator_id" eq: "$ref": "#/components/schemas/resource_activity/properties/creator_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/creator_id" description: Filter by the person who created the activity. root_type: oneOf: - "$ref": "#/components/schemas/resource_activity/properties/root_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_activity/properties/root_type" eq: "$ref": "#/components/schemas/resource_activity/properties/root_type" not_eq: "$ref": "#/components/schemas/resource_activity/properties/root_type" contains: "$ref": "#/components/schemas/resource_activity/properties/root_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the top-level resource type the activity is nested under (e.g. project, deal). normalized_item_type: oneOf: - "$ref": "#/components/schemas/resource_activity/properties/normalized_item_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_activity/properties/normalized_item_type" eq: "$ref": "#/components/schemas/resource_activity/properties/normalized_item_type" not_eq: "$ref": "#/components/schemas/resource_activity/properties/normalized_item_type" not_contain: "$ref": "#/components/schemas/resource_activity/properties/normalized_item_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by normalized resource type, distinguishing between deals and budgets. type: oneOf: - "$ref": "#/components/schemas/resource_activity/properties/type" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_activity/properties/type" not_eq: "$ref": "#/components/schemas/resource_activity/properties/type" not_contain: "$ref": "#/components/schemas/resource_activity/properties/type" contains: "$ref": "#/components/schemas/resource_activity/properties/type" description: Operator object — supports eq, not_eq, contains, not_contain. description: 'Filter by activity type: 1=Comment, 2=Changeset (field change), 3=Email.' project_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_activity/properties/project_id" contains: "$ref": "#/components/schemas/resource_activity/properties/project_id" eq: "$ref": "#/components/schemas/resource_activity/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_activity/properties/project_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/project_id" description: Filter activities related to a specific project. has_attachments: oneOf: - "$ref": "#/components/schemas/resource_activity/properties/has_attachments" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_activity/properties/has_attachments" not_contain: "$ref": "#/components/schemas/resource_activity/properties/has_attachments" eq: "$ref": "#/components/schemas/resource_activity/properties/has_attachments" not_eq: "$ref": "#/components/schemas/resource_activity/properties/has_attachments" description: Operator object — supports eq, not_eq, contains, not_contain. description: Return only activities that have file attachments. invoice_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_activity/properties/invoice_id" not_eq: "$ref": "#/components/schemas/resource_activity/properties/invoice_id" not_contain: "$ref": "#/components/schemas/resource_activity/properties/invoice_id" eq: "$ref": "#/components/schemas/resource_activity/properties/invoice_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_activity/properties/invoice_id" description: Filter activities related to a specific invoice. patternProperties: {} description: Available filter parameters for querying activity feed records. _filter_root_time_entry: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_time_entry" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_time_entry" description: Filter schema for `time_entry` list endpoints — pass a single condition or a logical group. resource_timer: type: object title: Timer Resource properties: started_at: type: string title: Started At format: date-time description: Timestamp when the timer was started. service_id: type: integer title: Service description: The ID of the service this timer is tracking time for. total_time: type: integer title: Total Time description: The total elapsed time of the timer in minutes. stopped_at: type: string title: Stopped At format: date-time description: Timestamp when the timer was stopped, or null if still running. time_entry_id: type: integer title: Time Entry description: The ID of the time entry created when this timer was stopped. time_entry: title: Time Entry description: The time entry created when this timer was stopped. person_id: type: integer title: Person description: The ID of the person who owns this timer. organization: title: Organization description: The organization this timer belongs to. description: An active stopwatch session linked to a time entry. The timer duration is saved to the time entry when stopped. resource_section: type: object title: Section Resource properties: position: type: integer title: Position description: The sort position of this section within the deal. organization: title: Organization description: The organization this section belongs to. deal_id: type: integer title: Deal description: ID of the deal this section belongs to. deal: title: Deal description: The deal this section belongs to. preferences: type: object title: Preferences description: User-specific display preferences for this section, stored as key-value settings. editor_config: type: object title: Editor Config description: Rich text editor configuration and content for this section's description. name: type: string title: Name description: The name of this section. id: type: integer title: Id description: The unique identifier of this section. budget_id: type: integer title: Budget description: ID of the budget this section belongs to. description: Represents a named grouping of services within a deal or budget, used to organize line items into logical sections. filter_service: type: object title: Filter service properties: service_type_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/service_type_id" contains: "$ref": "#/components/schemas/resource_service/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_service/properties/service_type_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/service_type_id" description: Filter by the associated service type. stage_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/stage_type" contains: "$ref": "#/components/schemas/resource_service/properties/stage_type" not_contain: "$ref": "#/components/schemas/resource_service/properties/stage_type" not_eq: "$ref": "#/components/schemas/resource_service/properties/stage_type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/stage_type" description: Filter by deal stage type (e.g. open, won, lost). template: oneOf: - "$ref": "#/components/schemas/resource_service/properties/template" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/template" contains: "$ref": "#/components/schemas/resource_service/properties/template" not_eq: "$ref": "#/components/schemas/resource_service/properties/template" eq: "$ref": "#/components/schemas/resource_service/properties/template" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter template services. markup_amount: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/markup_amount" contains: "$ref": "#/components/schemas/resource_service/properties/markup_amount" not_contain: "$ref": "#/components/schemas/resource_service/properties/markup_amount" eq: "$ref": "#/components/schemas/resource_service/properties/markup_amount" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/markup_amount" description: Filter by markup amount (monetary). projectless_budgets: oneOf: - "$ref": "#/components/schemas/resource_service/properties/projectless_budgets" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/projectless_budgets" contains: "$ref": "#/components/schemas/resource_service/properties/projectless_budgets" not_eq: "$ref": "#/components/schemas/resource_service/properties/projectless_budgets" eq: "$ref": "#/components/schemas/resource_service/properties/projectless_budgets" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: When true, includes services from budgets not linked to any project. origin_service_id: oneOf: - "$ref": "#/components/schemas/resource_service/properties/origin_service_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/origin_service_id" eq: "$ref": "#/components/schemas/resource_service/properties/origin_service_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/origin_service_id" contains: "$ref": "#/components/schemas/resource_service/properties/origin_service_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the service this service was copied or derived from. price: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/price" eq: "$ref": "#/components/schemas/resource_service/properties/price" contains: "$ref": "#/components/schemas/resource_service/properties/price" not_eq: "$ref": "#/components/schemas/resource_service/properties/price" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/price" description: Filter by service price range. section_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/section_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/section_id" eq: "$ref": "#/components/schemas/resource_service/properties/section_id" contains: "$ref": "#/components/schemas/resource_service/properties/section_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/section_id" description: Filter by the section (group of services) within the deal or budget. with_memberships: oneOf: - "$ref": "#/components/schemas/resource_service/properties/with_memberships" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/with_memberships" contains: "$ref": "#/components/schemas/resource_service/properties/with_memberships" not_contain: "$ref": "#/components/schemas/resource_service/properties/with_memberships" not_eq: "$ref": "#/components/schemas/resource_service/properties/with_memberships" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: When true, includes membership data with the service results (internal use). person_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/person_id" contains: "$ref": "#/components/schemas/resource_service/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/person_id" eq: "$ref": "#/components/schemas/resource_service/properties/person_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/person_id" description: Filter to services accessible to the specified person for time tracking. after: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/after" not_contain: "$ref": "#/components/schemas/resource_service/properties/after" eq: "$ref": "#/components/schemas/resource_service/properties/after" not_eq: "$ref": "#/components/schemas/resource_service/properties/after" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/after" description: 'Filter by a date range: return services bookable after this date.' budgets_and_deals: oneOf: - "$ref": "#/components/schemas/resource_service/properties/budgets_and_deals" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/budgets_and_deals" not_contain: "$ref": "#/components/schemas/resource_service/properties/budgets_and_deals" not_eq: "$ref": "#/components/schemas/resource_service/properties/budgets_and_deals" contains: "$ref": "#/components/schemas/resource_service/properties/budgets_and_deals" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter services linked to a specific set of budgets and deals. booked_time: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/booked_time" contains: "$ref": "#/components/schemas/resource_service/properties/booked_time" eq: "$ref": "#/components/schemas/resource_service/properties/booked_time" not_contain: "$ref": "#/components/schemas/resource_service/properties/booked_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/booked_time" description: Filter by total booked time scheduled against the service (in minutes). origin_deal_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/origin_deal_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/origin_deal_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/origin_deal_id" contains: "$ref": "#/components/schemas/resource_service/properties/origin_deal_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/origin_deal_id" description: Filter by the deal this service's budget originated from. budget_date: oneOf: - "$ref": "#/components/schemas/resource_service/properties/budget_date" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/budget_date" not_eq: "$ref": "#/components/schemas/resource_service/properties/budget_date" contains: "$ref": "#/components/schemas/resource_service/properties/budget_date" eq: "$ref": "#/components/schemas/resource_service/properties/budget_date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the start date of the associated budget (quotes.date). remaining_scheduled_time: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/remaining_scheduled_time" eq: "$ref": "#/components/schemas/resource_service/properties/remaining_scheduled_time" not_contain: "$ref": "#/components/schemas/resource_service/properties/remaining_scheduled_time" contains: "$ref": "#/components/schemas/resource_service/properties/remaining_scheduled_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/remaining_scheduled_time" description: Filter by remaining scheduled time (budgeted minus worked minus future booked) in minutes. revamped_unit: oneOf: - "$ref": "#/components/schemas/resource_service/properties/revamped_unit" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/revamped_unit" eq: "$ref": "#/components/schemas/resource_service/properties/revamped_unit" contains: "$ref": "#/components/schemas/resource_service/properties/revamped_unit" not_contain: "$ref": "#/components/schemas/resource_service/properties/revamped_unit" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by unit type (revamped unit dimension) for the service. id: oneOf: - "$ref": "#/components/schemas/resource_service/properties/id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/id" not_contain: "$ref": "#/components/schemas/resource_service/properties/id" eq: "$ref": "#/components/schemas/resource_service/properties/id" contains: "$ref": "#/components/schemas/resource_service/properties/id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by service ID. custom_fields: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_service/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_service/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_service/properties/custom_fields" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/custom_fields" description: Filter by custom field values. before: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/before" not_contain: "$ref": "#/components/schemas/resource_service/properties/before" not_eq: "$ref": "#/components/schemas/resource_service/properties/before" contains: "$ref": "#/components/schemas/resource_service/properties/before" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/before" description: 'Filter by a date range: return services bookable before this date.' name: oneOf: - "$ref": "#/components/schemas/resource_service/properties/name" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/name" contains: "$ref": "#/components/schemas/resource_service/properties/name" eq: "$ref": "#/components/schemas/resource_service/properties/name" not_contain: "$ref": "#/components/schemas/resource_service/properties/name" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by service name (text search). quantity: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/quantity" eq: "$ref": "#/components/schemas/resource_service/properties/quantity" contains: "$ref": "#/components/schemas/resource_service/properties/quantity" not_contain: "$ref": "#/components/schemas/resource_service/properties/quantity" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/quantity" description: Filter by service quantity range. initial_service_id: oneOf: - "$ref": "#/components/schemas/resource_service/properties/initial_service_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/initial_service_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/initial_service_id" eq: "$ref": "#/components/schemas/resource_service/properties/initial_service_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/initial_service_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the original service this service was derived from (across contract periods). type: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/type" not_contain: "$ref": "#/components/schemas/resource_service/properties/type" contains: "$ref": "#/components/schemas/resource_service/properties/type" eq: "$ref": "#/components/schemas/resource_service/properties/type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/type" description: Filter by service parent type (deal or budget). bookable_before: oneOf: - "$ref": "#/components/schemas/resource_service/properties/bookable_before" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/bookable_before" contains: "$ref": "#/components/schemas/resource_service/properties/bookable_before" eq: "$ref": "#/components/schemas/resource_service/properties/bookable_before" not_contain: "$ref": "#/components/schemas/resource_service/properties/bookable_before" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter services with a bookable end date before this value. discount: oneOf: - "$ref": "#/components/schemas/resource_service/properties/discount" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/discount" eq: "$ref": "#/components/schemas/resource_service/properties/discount" not_contain: "$ref": "#/components/schemas/resource_service/properties/discount" contains: "$ref": "#/components/schemas/resource_service/properties/discount" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the service's discount percentage range. worked_time: oneOf: - "$ref": "#/components/schemas/resource_service/properties/worked_time" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/worked_time" contains: "$ref": "#/components/schemas/resource_service/properties/worked_time" not_eq: "$ref": "#/components/schemas/resource_service/properties/worked_time" not_contain: "$ref": "#/components/schemas/resource_service/properties/worked_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total worked time logged against the service (in minutes). unit: oneOf: - "$ref": "#/components/schemas/resource_service/properties/unit" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/unit" eq: "$ref": "#/components/schemas/resource_service/properties/unit" contains: "$ref": "#/components/schemas/resource_service/properties/unit" not_eq: "$ref": "#/components/schemas/resource_service/properties/unit" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by service unit type (e.g. hours, days, items). profit: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/profit" not_contain: "$ref": "#/components/schemas/resource_service/properties/profit" contains: "$ref": "#/components/schemas/resource_service/properties/profit" eq: "$ref": "#/components/schemas/resource_service/properties/profit" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/profit" description: Filter by profit (revenue minus cost) range. markup: oneOf: - "$ref": "#/components/schemas/resource_service/properties/markup" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/markup" eq: "$ref": "#/components/schemas/resource_service/properties/markup" not_eq: "$ref": "#/components/schemas/resource_service/properties/markup" contains: "$ref": "#/components/schemas/resource_service/properties/markup" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the service's markup percentage range. for_tracking: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/for_tracking" contains: "$ref": "#/components/schemas/resource_service/properties/for_tracking" not_contain: "$ref": "#/components/schemas/resource_service/properties/for_tracking" not_eq: "$ref": "#/components/schemas/resource_service/properties/for_tracking" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/for_tracking" description: Filter to services that the current person is allowed to track time against. deal_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/deal_id" contains: "$ref": "#/components/schemas/resource_service/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/deal_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/deal_id" description: Filter by the associated deal or budget. pipeline_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/pipeline_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/pipeline_id" eq: "$ref": "#/components/schemas/resource_service/properties/pipeline_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/pipeline_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/pipeline_id" description: Filter by the associated pipeline. expense_cost: oneOf: - "$ref": "#/components/schemas/resource_service/properties/expense_cost" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/expense_cost" eq: "$ref": "#/components/schemas/resource_service/properties/expense_cost" contains: "$ref": "#/components/schemas/resource_service/properties/expense_cost" not_contain: "$ref": "#/components/schemas/resource_service/properties/expense_cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total expense cost range. expense_tracking_enabled: oneOf: - "$ref": "#/components/schemas/resource_service/properties/expense_tracking_enabled" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/expense_tracking_enabled" eq: "$ref": "#/components/schemas/resource_service/properties/expense_tracking_enabled" contains: "$ref": "#/components/schemas/resource_service/properties/expense_tracking_enabled" not_eq: "$ref": "#/components/schemas/resource_service/properties/expense_tracking_enabled" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by whether expense tracking is enabled on the service. deal_stage_id: oneOf: - "$ref": "#/components/schemas/resource_service/properties/deal_stage_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/deal_stage_id" eq: "$ref": "#/components/schemas/resource_service/properties/deal_stage_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/deal_stage_id" contains: "$ref": "#/components/schemas/resource_service/properties/deal_stage_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by deal stage (deprecated; use deal_status_id instead). deal_status_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/deal_status_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/deal_status_id" contains: "$ref": "#/components/schemas/resource_service/properties/deal_status_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/deal_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/deal_status_id" description: Filter by the associated deal status (pipeline stage). unapproved_time: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/unapproved_time" not_contain: "$ref": "#/components/schemas/resource_service/properties/unapproved_time" eq: "$ref": "#/components/schemas/resource_service/properties/unapproved_time" contains: "$ref": "#/components/schemas/resource_service/properties/unapproved_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/unapproved_time" description: Filter by total unapproved time (in minutes) logged against the service. company_id: oneOf: - "$ref": "#/components/schemas/resource_service/properties/company_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/company_id" contains: "$ref": "#/components/schemas/resource_service/properties/company_id" eq: "$ref": "#/components/schemas/resource_service/properties/company_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by client company. discount_amount: oneOf: - "$ref": "#/components/schemas/resource_service/properties/discount_amount" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/discount_amount" contains: "$ref": "#/components/schemas/resource_service/properties/discount_amount" not_contain: "$ref": "#/components/schemas/resource_service/properties/discount_amount" not_eq: "$ref": "#/components/schemas/resource_service/properties/discount_amount" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by discount amount (monetary). budget_used: oneOf: - "$ref": "#/components/schemas/resource_service/properties/budget_used" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/budget_used" not_contain: "$ref": "#/components/schemas/resource_service/properties/budget_used" contains: "$ref": "#/components/schemas/resource_service/properties/budget_used" eq: "$ref": "#/components/schemas/resource_service/properties/budget_used" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by amount of budget already used. budget_id: oneOf: - "$ref": "#/components/schemas/resource_service/properties/budget_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/budget_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/budget_id" contains: "$ref": "#/components/schemas/resource_service/properties/budget_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the associated budget ID. worked_cost: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/worked_cost" contains: "$ref": "#/components/schemas/resource_service/properties/worked_cost" not_contain: "$ref": "#/components/schemas/resource_service/properties/worked_cost" eq: "$ref": "#/components/schemas/resource_service/properties/worked_cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/worked_cost" description: Filter by worked cost (cost of time already logged) range. cost: oneOf: - "$ref": "#/components/schemas/resource_service/properties/cost" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/cost" eq: "$ref": "#/components/schemas/resource_service/properties/cost" contains: "$ref": "#/components/schemas/resource_service/properties/cost" not_eq: "$ref": "#/components/schemas/resource_service/properties/cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by work cost (labor cost) range. updated_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/updated_at" eq: "$ref": "#/components/schemas/resource_service/properties/updated_at" not_eq: "$ref": "#/components/schemas/resource_service/properties/updated_at" not_contain: "$ref": "#/components/schemas/resource_service/properties/updated_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/updated_at" description: Filter by service last-updated date range. budget_total: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/budget_total" not_contain: "$ref": "#/components/schemas/resource_service/properties/budget_total" contains: "$ref": "#/components/schemas/resource_service/properties/budget_total" not_eq: "$ref": "#/components/schemas/resource_service/properties/budget_total" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/budget_total" description: Filter by total budget amount range. budget_status: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/budget_status" not_contain: "$ref": "#/components/schemas/resource_service/properties/budget_status" contains: "$ref": "#/components/schemas/resource_service/properties/budget_status" not_eq: "$ref": "#/components/schemas/resource_service/properties/budget_status" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/budget_status" description: Filter by budget status (open or delivered). billing_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/billing_type" not_contain: "$ref": "#/components/schemas/resource_service/properties/billing_type" contains: "$ref": "#/components/schemas/resource_service/properties/billing_type" not_eq: "$ref": "#/components/schemas/resource_service/properties/billing_type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/billing_type" description: Filter by billing type (hourly, fixed, non-billable, etc.). billable_time: oneOf: - "$ref": "#/components/schemas/resource_service/properties/billable_time" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/billable_time" contains: "$ref": "#/components/schemas/resource_service/properties/billable_time" not_contain: "$ref": "#/components/schemas/resource_service/properties/billable_time" not_eq: "$ref": "#/components/schemas/resource_service/properties/billable_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total billable time logged against the service (in minutes). project_id: oneOf: - "$ref": "#/components/schemas/resource_service/properties/project_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/project_id" contains: "$ref": "#/components/schemas/resource_service/properties/project_id" eq: "$ref": "#/components/schemas/resource_service/properties/project_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the associated project. revenue: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/revenue" contains: "$ref": "#/components/schemas/resource_service/properties/revenue" not_contain: "$ref": "#/components/schemas/resource_service/properties/revenue" not_eq: "$ref": "#/components/schemas/resource_service/properties/revenue" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/revenue" description: Filter by recognized revenue range. subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_service/properties/subsidiary_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_service/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_service/properties/subsidiary_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the associated subsidiary. contract_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/contract_id" eq: "$ref": "#/components/schemas/resource_service/properties/contract_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/contract_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/contract_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/contract_id" description: Filter by the associated contract ID. budget_remaining: oneOf: - "$ref": "#/components/schemas/resource_service/properties/budget_remaining" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/budget_remaining" contains: "$ref": "#/components/schemas/resource_service/properties/budget_remaining" not_eq: "$ref": "#/components/schemas/resource_service/properties/budget_remaining" not_contain: "$ref": "#/components/schemas/resource_service/properties/budget_remaining" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by remaining budget amount (budget total minus budget used) in the deal currency. bookable_date: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/bookable_date" not_eq: "$ref": "#/components/schemas/resource_service/properties/bookable_date" contains: "$ref": "#/components/schemas/resource_service/properties/bookable_date" eq: "$ref": "#/components/schemas/resource_service/properties/bookable_date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/bookable_date" description: Filter services by a specific bookable date. probability: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/probability" contains: "$ref": "#/components/schemas/resource_service/properties/probability" not_contain: "$ref": "#/components/schemas/resource_service/properties/probability" eq: "$ref": "#/components/schemas/resource_service/properties/probability" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/probability" description: Filter by the associated deal's probability of closing (as a percentage). estimated_cost: oneOf: - "$ref": "#/components/schemas/resource_service/properties/estimated_cost" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/estimated_cost" not_eq: "$ref": "#/components/schemas/resource_service/properties/estimated_cost" not_contain: "$ref": "#/components/schemas/resource_service/properties/estimated_cost" eq: "$ref": "#/components/schemas/resource_service/properties/estimated_cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by estimated cost range. projected_revenue: oneOf: - "$ref": "#/components/schemas/resource_service/properties/projected_revenue" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/projected_revenue" eq: "$ref": "#/components/schemas/resource_service/properties/projected_revenue" contains: "$ref": "#/components/schemas/resource_service/properties/projected_revenue" not_contain: "$ref": "#/components/schemas/resource_service/properties/projected_revenue" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by projected revenue range. billable: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/billable" contains: "$ref": "#/components/schemas/resource_service/properties/billable" not_eq: "$ref": "#/components/schemas/resource_service/properties/billable" not_contain: "$ref": "#/components/schemas/resource_service/properties/billable" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/billable" description: Filter by whether the service is billable (true) or non-billable (false). responsible_id: oneOf: - "$ref": "#/components/schemas/resource_service/properties/responsible_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_service/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/responsible_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/responsible_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the responsible person on the associated deal or budget. explicit_access: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/explicit_access" contains: "$ref": "#/components/schemas/resource_service/properties/explicit_access" not_eq: "$ref": "#/components/schemas/resource_service/properties/explicit_access" not_contain: "$ref": "#/components/schemas/resource_service/properties/explicit_access" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service/properties/explicit_access" description: Filter services to only those the current user has explicit (non-implicit) access permissions on. time_tracking_enabled: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/time_tracking_enabled" not_eq: "$ref": "#/components/schemas/resource_service/properties/time_tracking_enabled" not_contain: "$ref": "#/components/schemas/resource_service/properties/time_tracking_enabled" eq: "$ref": "#/components/schemas/resource_service/properties/time_tracking_enabled" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/time_tracking_enabled" description: Filter by whether time tracking is enabled on the service. project_type: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/project_type" not_contain: "$ref": "#/components/schemas/resource_service/properties/project_type" eq: "$ref": "#/components/schemas/resource_service/properties/project_type" not_eq: "$ref": "#/components/schemas/resource_service/properties/project_type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/project_type" description: Filter by project type (deal or budget). profit_margin: oneOf: - "$ref": "#/components/schemas/resource_service/properties/profit_margin" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/profit_margin" not_contain: "$ref": "#/components/schemas/resource_service/properties/profit_margin" contains: "$ref": "#/components/schemas/resource_service/properties/profit_margin" not_eq: "$ref": "#/components/schemas/resource_service/properties/profit_margin" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by profit margin percentage range. stage_status_id: oneOf: - "$ref": "#/components/schemas/resource_service/properties/stage_status_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/stage_status_id" eq: "$ref": "#/components/schemas/resource_service/properties/stage_status_id" contains: "$ref": "#/components/schemas/resource_service/properties/stage_status_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/stage_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by budget pipeline stage status. task_id: oneOf: - "$ref": "#/components/schemas/resource_service/properties/task_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/task_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/task_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/task_id" eq: "$ref": "#/components/schemas/resource_service/properties/task_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the associated task. left_to_schedule_time: oneOf: - "$ref": "#/components/schemas/resource_service/properties/left_to_schedule_time" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/left_to_schedule_time" not_eq: "$ref": "#/components/schemas/resource_service/properties/left_to_schedule_time" contains: "$ref": "#/components/schemas/resource_service/properties/left_to_schedule_time" eq: "$ref": "#/components/schemas/resource_service/properties/left_to_schedule_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by time remaining to schedule (estimated time minus booked time) in minutes. booking_tracking_enabled: oneOf: - "$ref": "#/components/schemas/resource_service/properties/booking_tracking_enabled" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/booking_tracking_enabled" contains: "$ref": "#/components/schemas/resource_service/properties/booking_tracking_enabled" not_contain: "$ref": "#/components/schemas/resource_service/properties/booking_tracking_enabled" not_eq: "$ref": "#/components/schemas/resource_service/properties/booking_tracking_enabled" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by whether booking tracking is enabled on the service. trackable_by_person_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/trackable_by_person_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/trackable_by_person_id" contains: "$ref": "#/components/schemas/resource_service/properties/trackable_by_person_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/trackable_by_person_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/trackable_by_person_id" description: Filter to services that the specified person has permission to track time on. future_booked_time: oneOf: - "$ref": "#/components/schemas/resource_service/properties/future_booked_time" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/future_booked_time" eq: "$ref": "#/components/schemas/resource_service/properties/future_booked_time" not_contain: "$ref": "#/components/schemas/resource_service/properties/future_booked_time" contains: "$ref": "#/components/schemas/resource_service/properties/future_booked_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total future booked time (upcoming bookings) in minutes. future_budget_used: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service/properties/future_budget_used" contains: "$ref": "#/components/schemas/resource_service/properties/future_budget_used" eq: "$ref": "#/components/schemas/resource_service/properties/future_budget_used" not_contain: "$ref": "#/components/schemas/resource_service/properties/future_budget_used" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/future_budget_used" description: Filter by the amount of budget that will be consumed by future bookings. budgeted_time: oneOf: - "$ref": "#/components/schemas/resource_service/properties/budgeted_time" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/budgeted_time" not_contain: "$ref": "#/components/schemas/resource_service/properties/budgeted_time" eq: "$ref": "#/components/schemas/resource_service/properties/budgeted_time" not_eq: "$ref": "#/components/schemas/resource_service/properties/budgeted_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the service's budgeted time (in minutes). limitation_type: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/limitation_type" contains: "$ref": "#/components/schemas/resource_service/properties/limitation_type" eq: "$ref": "#/components/schemas/resource_service/properties/limitation_type" not_eq: "$ref": "#/components/schemas/resource_service/properties/limitation_type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/limitation_type" description: Filter by limitation type (none, time, budget, etc.) applied to the service. estimated_time: oneOf: - "$ref": "#/components/schemas/resource_service/properties/estimated_time" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/estimated_time" not_eq: "$ref": "#/components/schemas/resource_service/properties/estimated_time" contains: "$ref": "#/components/schemas/resource_service/properties/estimated_time" not_contain: "$ref": "#/components/schemas/resource_service/properties/estimated_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by estimated time range (in minutes). rolled_over_time: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/rolled_over_time" not_eq: "$ref": "#/components/schemas/resource_service/properties/rolled_over_time" not_contain: "$ref": "#/components/schemas/resource_service/properties/rolled_over_time" eq: "$ref": "#/components/schemas/resource_service/properties/rolled_over_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/rolled_over_time" description: Filter by rolled-over time (time carried over from previous periods) in minutes. bookable_after: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/bookable_after" contains: "$ref": "#/components/schemas/resource_service/properties/bookable_after" eq: "$ref": "#/components/schemas/resource_service/properties/bookable_after" not_eq: "$ref": "#/components/schemas/resource_service/properties/bookable_after" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/bookable_after" description: Filter services with a bookable start date after this value. query: oneOf: - "$ref": "#/components/schemas/resource_service/properties/query" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service/properties/query" contains: "$ref": "#/components/schemas/resource_service/properties/query" not_eq: "$ref": "#/components/schemas/resource_service/properties/query" eq: "$ref": "#/components/schemas/resource_service/properties/query" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Full-text search across service names and descriptions. bookable_date_for_period: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service/properties/bookable_date_for_period" not_eq: "$ref": "#/components/schemas/resource_service/properties/bookable_date_for_period" not_contain: "$ref": "#/components/schemas/resource_service/properties/bookable_date_for_period" contains: "$ref": "#/components/schemas/resource_service/properties/bookable_date_for_period" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service/properties/bookable_date_for_period" description: Filter services that are bookable on the given date (falls within the service's bookable period). budget_cap_enabled: oneOf: - "$ref": "#/components/schemas/resource_service/properties/budget_cap_enabled" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/budget_cap_enabled" not_contain: "$ref": "#/components/schemas/resource_service/properties/budget_cap_enabled" eq: "$ref": "#/components/schemas/resource_service/properties/budget_cap_enabled" not_eq: "$ref": "#/components/schemas/resource_service/properties/budget_cap_enabled" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by whether a budget cap is enabled on the service. sales_status_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service/properties/sales_status_id" eq: "$ref": "#/components/schemas/resource_service/properties/sales_status_id" not_contain: "$ref": "#/components/schemas/resource_service/properties/sales_status_id" not_eq: "$ref": "#/components/schemas/resource_service/properties/sales_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_service/properties/sales_status_id" description: Filter by sales pipeline stage status. patternProperties: "^deal..*$": title: Deal relationship "^budget..*$": title: Budget relationship "^section..*$": title: Section relationship "^bookings..*$": title: Bookings relationship "^service_type..*$": title: Service type relationship description: Available filter parameters for querying services. resource_contract: type: object title: Contract Resource properties: copy_expenses: type: boolean title: Copy Expenses description: Whether to copy expenses from the template. use_rollover_hours: type: boolean title: Use Rollover Hours description: Whether to roll over unused hours. starts_on: type: string title: Starts On format: date description: Date when this contract starts. copy_purchase_order_number: type: boolean title: Copy Purchase Order Number description: Whether to copy the purchase order number. example: PO-2024-017 interval_id: type: integer title: Interval description: ID of the recurrence interval of this contract (alias for contract_interval_id). next_occurrence_on: type: string title: Next Occurrence On format: date description: The date of the next occurrence. contract_interval_id: type: integer title: Contract Interval description: ID of the recurrence interval (e.g. monthly, quarterly, annually) for this contract. id: type: integer title: Id description: The unique identifier of this contract. organization: title: Organization description: The organization this contract belongs to. template: title: Template description: The budget used as the template for generating new budgets from this contract. template_id: title: Template description: ID of the budget used as the template for generating new budgets from this contract. ends_on: type: string title: Ends On format: date description: Date when this contract ends, or null if it has no end date. description: A recurring retainer contract that auto-generates budgets at set intervals with optional rollover of unused amounts. _filter_root_bank_account: oneOf: - "$ref": "#/components/schemas/filter_bank_account" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_bank_account" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `bank_account` list endpoints — pass a single condition or a logical group. _filter_root_company: oneOf: - "$ref": "#/components/schemas/filter_company" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_company" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `company` list endpoints — pass a single condition or a logical group. resource_team: type: object title: Team Resource properties: color_id: type: integer title: Color description: The identifier of the color associated with this team. query: type: string title: Query description: A search query used to filter teams by name. id: type: integer title: Id description: The unique identifier of this team. icon_id: type: string title: Icon description: The identifier of the icon associated with this team. name: type: string title: Name description: The name of this team. members: title: Members description: The people who are members of this team. organization: title: Organization description: The organization this team belongs to. description: Named group of people. Includes the team name and a list of member people (via has_many members). Teams are used for access control (memberships) and reporting groupings. _filter_root_attachment: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_attachment" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_attachment" description: Filter schema for `attachment` list endpoints — pass a single condition or a logical group. _filter_root_proposal_report: oneOf: - "$ref": "#/components/schemas/filter_proposal_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining multiple filter conditions (e.g. `AND`, `OR`). patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_proposal_report" description: A single filter condition object for proposal report queries, using named operators. required: - "$op" description: Filter parameters for listing proposal report entries. resource_time_entry_report: type: object title: Time entry report Resource properties: query: type: string title: Query description: Full-text search query used to filter the time entry report. created_after: type: string title: Created After format: date description: Return time entries created after this datetime. invoice: title: Invoice description: The invoice this time entry has been billed on. unit_id: enum: - 1 - 2 - 3 type: integer title: Unit description: Unit id for this time entry report group. started_before: type: string title: Started Before format: date description: Started before for this time entry report group. approver: title: Approver description: The person who approved this time entry. service_report: title: Service Report description: Report data for the service this time entry is tracked against. id: type: integer title: Id description: Unique identifier of the time entry report record. total_overhead_cost_default: title: Total Overhead Cost Default description: Sum of overhead cost in the organization's default currency across all records in this time entry report group. time_entry_ended_at: title: Time Entry Ended At description: Time entry ended at for this time entry report group. total_recognized_profit_normalized: title: Total Recognized Profit Normalized description: Sum of recognized profit in the normalized currency across all records in this time entry report group. billable: type: boolean title: Billable description: Indicates whether the time entry is billable to the client. last_actor_id: type: integer title: Last Actor description: The ID of the last person who modified this time entry. total_overhead_cost: title: Total Overhead Cost description: Sum of overhead cost across all records in this time entry report group. project_id: type: integer title: Project description: The ID of the project this time entry is tracked on. average_blended_rate_default: title: Average Blended Rate Default description: The average blended rate in the default display currency. responsible_id: type: integer title: Responsible description: The ID of the budget owner responsible for approving this time entry. status: enum: - 1 - 2 - 3 - 4 - 5 - 6 type: integer title: Status description: Status for this time entry report group. task: title: Task description: Task for this time entry report group. group: type: string title: Group description: The grouping dimension applied to aggregate time entry results. total_billable_revenue: title: Total Billable Revenue description: Sum of billable revenue across all records in this time entry report group. service: title: Service description: The service this time entry is tracked against. invoicing_status: enum: - 1 - 2 - 3 type: integer title: Invoicing Status description: The invoicing status of this time entry. last_activity_at_period: title: Last Activity At Period description: Time period grouping for last activity date (e.g. week, month, quarter). total_internal_overhead_cost_default: title: Total Internal Overhead Cost Default description: Sum of internal overhead cost in the organization's default currency across all records in this time entry report group. total_recognized_revenue_default: title: Total Recognized Revenue Default description: Sum of recognized revenue in the organization's default currency across all records in this time entry report group. average_blended_rate_normalized: title: Average Blended Rate Normalized description: The average blended rate normalized to the organization base currency. approver_report: title: Approver Report description: The report data for the approver of this time entry. started_after: type: string title: Started After format: date description: Started after for this time entry report group. budget: title: Budget description: The budget this time entry is tracked against. total_cost_default: title: Total Cost Default description: Sum of cost in the organization's default currency across all records in this time entry report group. task_list: title: Task List description: Task list for this time entry report group. task_report: title: Task Report description: Task report for this time entry report group. total_billable_revenue_default: title: Total Billable Revenue Default description: Sum of billable revenue in the organization's default currency across all records in this time entry report group. currency: type: string title: Currency description: The currency code in the organization currency. track_method_id: type: integer title: Track Method description: Track method id for this time entry report group. total_recognized_revenue_normalized: title: Total Recognized Revenue Normalized description: Sum of recognized revenue in the normalized currency across all records in this time entry report group. project_manager_id: type: integer title: Project Manager description: The ID of the project manager for this time entry's project. designated_approver_id: type: integer title: Designated Approver description: ID of the person designated as the approver for the budget linked to this time entry. approval_policy: title: Approval Policy description: The approval policy governing this time entry. responsible: title: Responsible description: The budget owner responsible for approving this time entry. jira_issue_summary: type: string title: Jira Issue Summary description: The Jira issue summary linked to this time entry. service_type: title: Service Type description: The type of service this time entry is tracked against. total_internal_overhead_cost: title: Total Internal Overhead Cost description: Sum of internal overhead cost across all records in this time entry report group. person: title: Person description: The person who tracked this time entry. total_recognized_time: type: number title: Total Recognized Time description: Sum of recognized time across all records in this time entry report group. invoice_id: type: integer title: Invoice description: The ID of the invoice this time entry has been billed on. total_billable_revenue_normalized: title: Total Billable Revenue Normalized description: Sum of billable revenue in the normalized currency across all records in this time entry report group. total_recognized_profit_default: title: Total Recognized Profit Default description: Sum of recognized profit in the organization's default currency across all records in this time entry report group. assigned_approver_id: type: integer title: Assigned Approver description: The ID of the approver currently assigned to this time entry. approval_policy_id: type: integer title: Approval Policy description: The ID of the approval policy governing this time entry. company_id: type: integer title: Company description: The ID of the client company this time entry is tracked for. stage_type: enum: - 1 - 2 type: integer title: Stage Type description: Stage type for this time entry report group. date: type: string title: Date format: date description: The date the time was tracked (YYYY-MM-DD). overhead: type: integer title: Overhead description: Indicates whether this time entry is classified as overhead. currency_normalized: type: string title: Currency Normalized description: The currency code normalized to the organization base currency. total_work_cost: title: Total Work Cost description: Sum of work cost across all records in this time entry report group. day: type: string title: Day description: The specific day for which time was tracked. booking_id: type: integer title: Booking description: The ID of the booking this time entry is associated with. person_report: title: Person Report description: Report data for the person who tracked this time entry. autotracked: type: integer title: Autotracked description: Indicates whether this time entry was recorded automatically via autotracking. created_at_period: title: Created At Period description: The time period (day, week, month) for the created_at grouping. report: title: Report description: The report identifier for this time entry aggregation. service_id: type: integer title: Service description: The ID of the service this time entry is tracked against. total_time: type: number title: Total Time description: Sum of time across all records in this time entry report group. total_internal_overhead_cost_normalized: title: Total Internal Overhead Cost Normalized description: Sum of internal overhead cost in the normalized currency across all records in this time entry report group. currency_default: title: Currency Default description: The currency code in the default display currency. after: type: string title: After format: date description: Return time entries created after this datetime. base_cost: title: Base Cost description: Base cost of the time entry before overhead is applied. average_recognized_margin: type: number title: Average Recognized Margin description: Average profit margin calculated from recognized revenue and costs. ended_at: type: string title: Ended At format: date description: Timestamp when the time entry ended. billing_type: type: integer title: Billing Type description: The billing type of the service (hourly, fixed price, etc.). total_work_cost_default: title: Total Work Cost Default description: Sum of work cost in the organization's default currency across all records in this time entry report group. total_facility_overhead_cost_normalized: title: Total Facility Overhead Cost Normalized description: Sum of facility overhead cost in the normalized currency across all records in this time entry report group. deal_subsidiary_id: type: integer title: Deal Subsidiary description: The ID of the subsidiary of the deal this time entry is tracked against. time_entry_date: title: Time Entry Date description: Time entry date for this time entry report group. note: type: string title: Note description: The description or note on what was worked on. updated_at: type: string title: Updated At format: date description: Updated at for this time entry report group. person_subsidiary: title: Person Subsidiary description: The subsidiary of the person who tracked this time entry. total_facility_overhead_cost_default: title: Total Facility Overhead Cost Default description: Sum of facility overhead cost in the organization's default currency across all records in this time entry report group. person_subsidiary_id: type: integer title: Person Subsidiary description: The ID of the subsidiary of the person who tracked this time entry. company_report: title: Company Report description: Report data for the associated company. company: title: Company description: The client company this time entry is tracked for. jira_issue_id: type: string title: Jira Issue description: The Jira issue ID linked to this time entry. responsible_report: title: Responsible Report description: Report data for the budget owner of this time entry. custom_fields: title: Custom Fields description: Custom field values associated with this time entry. month: type: string title: Month description: The month in which the time entry was tracked. last_actor_report: title: Last Actor Report description: Report data for the last actor who modified this time entry. deal_subsidiary: title: Deal Subsidiary description: The subsidiary of the deal this time entry is tracked against. parent_company_id: type: integer title: Parent Company description: ID of the parent company of the client linked to this time entry's budget, used for hierarchical company filtering. creator_id: type: integer title: Creator description: The ID of the person who created this time entry. total_billable_time: type: number title: Total Billable Time description: Sum of billable time across all records in this time entry report group. project_type_id: type: integer title: Project Type description: The ID of the project type (internal or client). billing_type_id: enum: - 1 - 2 - 3 - 4 type: integer title: Billing Type description: The ID of the billing type of the service. designated_approver: title: Designated Approver description: The person designated as the approver for the budget linked to this time entry. deal_id: type: integer title: Deal description: The ID of the deal associated with this time entry. project: title: Project description: The project this time entry is tracked on. person_tags: type: string title: Person Tags description: Tags applied to the person who tracked this time entry. facility_overhead_cost: title: Facility Overhead Cost description: Total facility overhead cost allocated to this time entry. week: type: string title: Week description: Week grouping for this time entry report row. total_recognized_profit: title: Total Recognized Profit description: Sum of recognized profit across all records in this time entry report group. invoiced: type: integer title: Invoiced description: Indicates whether this time entry has been invoiced to the client. total_work_cost_normalized: title: Total Work Cost Normalized description: Sum of work cost in the normalized currency across all records in this time entry report group. year: type: string title: Year description: Year grouping for this time entry report row. time_entry: title: Time Entry description: Time entry for this time entry report group. time_entry_started_at: title: Time Entry Started At description: Time entry started at for this time entry report group. creator_report: title: Creator Report description: Report data for the creator of this time entry. creator: title: Creator description: The person who created this time entry. task_id: type: integer title: Task description: Task id for this time entry report group. quarter: type: string title: Quarter description: The quarter in which the time entry was tracked. overhead_cost: title: Overhead Cost description: Total overhead cost of this time entry. started_at: type: string title: Started At format: date description: Started at for this time entry report group. role_id: type: integer title: Role description: The ID of the role of the person who tracked time. approved_at: type: string title: Approved At format: date description: Timestamp when the time entry was approved. total_facility_overhead_cost: title: Total Facility Overhead Cost description: Sum of facility overhead cost across all records in this time entry report group. project_report: title: Project Report description: Report data for the project this time entry is tracked on. time_entry_created_at: title: Time Entry Created At description: Time entry created at for this time entry report group. date_period: title: Date Period description: The time period (day, week, month) for the date grouping. total_cost_normalized: title: Total Cost Normalized description: Sum of cost in the normalized currency across all records in this time entry report group. person_id: type: integer title: Person description: The ID of the person who tracked this time entry. intercompany_hours: type: integer title: Intercompany Hours description: Indicates whether hours were tracked on a budget owned by another subsidiary. time: type: integer title: Time description: Time for this time entry report group. section_name: type: string title: Section Name description: The name of the budget section the service belongs to. before: type: string title: Before format: date description: Return time entries created before this datetime. formulas: type: integer title: Formulas description: Custom formulas applied to this time entry report. total_overhead_cost_normalized: title: Total Overhead Cost Normalized description: Sum of overhead cost in the normalized currency across all records in this time entry report group. count: type: integer title: Count description: The number of time entries in this grouped result. deal_or_budget_report: title: Deal Or Budget Report description: Report object for the deal or budget associated with this time entry. formula_fields: title: Formula Fields description: Custom formula field values calculated for this time entry. approver_id: type: integer title: Approver description: The ID of the person who approved this time entry. billable_time: type: integer title: Billable Time description: Hours billable to the client for this time entry. last_activity_at: type: string title: Last Activity At format: date description: Timestamp of the most recent activity on this time entry. jira_issue_status: type: string title: Jira Issue Status description: The Jira issue status linked to this time entry. time_entry_last_activity_at: title: Time Entry Last Activity At description: Timestamp of the most recent activity on the time entry associated with this report row. service_type_id: type: integer title: Service Type description: Service type id for this time entry report group. task_list_id: type: integer title: Task List description: Task list id for this time entry report group. created_at: type: string title: Created At format: date description: Timestamp when the time entry was created. total_cost: title: Total Cost description: Sum of cost across all records in this time entry report group. average_blended_rate: title: Average Blended Rate description: The average blended rate in the organization currency. budget_type_id: type: integer title: Budget Type description: The ID of the budget type (deal or budget). people_custom_fields: type: string title: People Custom Fields description: Custom field values associated with the person who tracked time. total_recognized_revenue: title: Total Recognized Revenue description: Sum of recognized revenue across all records in this time entry report group. budget_id: type: integer title: Budget description: The ID of the budget this time entry is tracked against. jira_worklog_id: type: integer title: Jira Worklog description: The Jira worklog ID linked to this time entry. last_actor: title: Last Actor description: The last person who modified this time entry. invoice_attribution_id: type: integer title: Invoice Attribution description: The ID of the invoice attribution linking this time entry to an invoice. organization: title: Organization description: The organization this time entry belongs to. cost: title: Cost description: Total cost of the time entry including work cost and overhead costs. awaiting_approval_from_approver_id: type: integer title: Awaiting Approval From Approver description: The ID of the approver currently awaiting approval for this time entry. created_before: type: string title: Created Before format: date description: Return time entries created before this datetime. internal_overhead_cost: title: Internal Overhead Cost description: Total internal overhead cost allocated to this time entry. description: Time entry report record — aggregates tracked time with financial metrics including cost, revenue, and approval status. resource_new_salary_report: type: object title: New salary report Resource properties: capacity: type: number title: Capacity description: Capacity for this new salary report group. people_custom_fields: type: string title: People Custom Fields description: People custom fields for this new salary report group. total_monthly_cost: title: Total Monthly Cost description: Sum of monthly cost across all records in this new salary report group. person: title: Person description: Person for this new salary report group. formulas: type: integer title: Formulas description: Formulas for this new salary report group. salary_type_id: type: integer title: Salary Type description: Salary type id for this new salary report group. total_overhead_cost_per_hour_normalized: title: Total Overhead Cost Per Hour Normalized description: Sum of overhead cost per hour in the normalized currency across all records in this new salary report group. total_bi_weekly_cost_default: title: Total Bi Weekly Cost Default description: Sum of bi weekly cost in the organization's default currency across all records in this new salary report group. salary_id: type: integer title: Salary description: Salary id for this new salary report group. total_weekly_cost_normalized: title: Total Weekly Cost Normalized description: Sum of weekly cost in the normalized currency across all records in this new salary report group. hourly_cost: title: Hourly Cost description: Hourly cost for this new salary report group. total_weekly_cost: title: Total Weekly Cost description: Sum of weekly cost across all records in this new salary report group. person_id: type: integer title: Person description: Person id for this new salary report group. work_days: type: number title: Work Days description: Work days for this new salary report group. started_on: type: string title: Started On format: date description: Started on for this new salary report group. engagement_ended_on: title: Engagement Ended On description: Engagement ended on for this new salary report group. total_period_cost: title: Total Period Cost description: Sum of period cost across all records in this new salary report group. total_period_cost_default: title: Total Period Cost Default description: Sum of period cost in the organization's default currency across all records in this new salary report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this new salary report group. weekly_cost: title: Weekly Cost description: Weekly cost for this new salary report group. report: title: Report description: Report for this new salary report group. total_monthly_cost_default: title: Total Monthly Cost Default description: Sum of monthly cost in the organization's default currency across all records in this new salary report group. total_annually_cost: title: Total Annually Cost description: Sum of annually cost across all records in this new salary report group. person_report: title: Person Report description: The person associated with this salary report row. currency_normalized: title: Currency Normalized description: Currency in the normalized currency for this new salary report group. total_period_cost_normalized: title: Total Period Cost Normalized description: Sum of period cost in the normalized currency across all records in this new salary report group. salary: title: Salary description: Salary for this new salary report group. start_date_period: title: Start Date Period description: Time period grouping for start date (e.g. week, month, quarter). bi_weekly_cost: title: Bi Weekly Cost description: Bi weekly cost for this new salary report group. total_annually_cost_default: title: Total Annually Cost Default description: Sum of annually cost in the organization's default currency across all records in this new salary report group. total_monthly_cost_normalized: title: Total Monthly Cost Normalized description: Sum of monthly cost in the normalized currency across all records in this new salary report group. total_overhead_cost_per_hour_default: title: Total Overhead Cost Per Hour Default description: Sum of overhead cost per hour in the organization's default currency across all records in this new salary report group. total_bi_weekly_cost_normalized: title: Total Bi Weekly Cost Normalized description: Sum of bi weekly cost in the normalized currency across all records in this new salary report group. ended_on: type: string title: Ended On format: date description: Ended on for this new salary report group. count: type: integer title: Count description: Number of new salarys in this report group. total_estimated_weekly_hours: type: number title: Total Estimated Weekly Hours description: Sum of estimated weekly hours across all records in this new salary report group. time: type: number title: Time description: Time for this new salary report group. total_hourly_cost: title: Total Hourly Cost description: Sum of hourly cost across all records in this new salary report group. group: type: string title: Group description: The grouping dimension for this new salary report row. date_period: title: Date Period description: Time period grouping for date (e.g. week, month, quarter). organization: title: Organization description: Organization for this new salary report group. currency: type: string title: Currency description: Currency for this new salary report group. total_weekly_cost_default: title: Total Weekly Cost Default description: Sum of weekly cost in the organization's default currency across all records in this new salary report group. total_hourly_cost_normalized: title: Total Hourly Cost Normalized description: Sum of hourly cost in the normalized currency across all records in this new salary report group. total_hourly_cost_default: title: Total Hourly Cost Default description: Sum of hourly cost in the organization's default currency across all records in this new salary report group. engagement: title: Engagement description: Engagement for this new salary report group. total_overhead_cost_per_hour: title: Total Overhead Cost Per Hour description: Sum of overhead cost per hour across all records in this new salary report group. total_bi_weekly_cost: title: Total Bi Weekly Cost description: Sum of bi weekly cost across all records in this new salary report group. annuall_cost: title: Annuall Cost description: Annuall cost for this new salary report group. holiday_calendar_id: type: integer title: Holiday Calendar description: Holiday calendar id for this new salary report group. overhead: type: integer title: Overhead description: Overhead for this new salary report group. id: type: integer title: Id description: Unique identifier for this new salary report row. total_annually_cost_normalized: title: Total Annually Cost Normalized description: Sum of annually cost in the normalized currency across all records in this new salary report group. monthly_cost: title: Monthly Cost description: Monthly cost for this new salary report group. formula_fields: title: Formula Fields description: Formula fields for this new salary report group. estimated_weekly_hours: type: integer title: Estimated Weekly Hours description: Estimated weekly hours for this new salary report group. end_date_period: title: End Date Period description: Time period grouping for end date (e.g. week, month, quarter). engagement_started_on: title: Engagement Started On description: Engagement started on for this new salary report group. date: type: string title: Date format: date description: Date for this new salary report group. description: An aggregated salary report row grouping people by configurable dimensions with salary cost metrics. filter_deal: type: object title: Filter deal properties: deal_type_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/deal_type_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/deal_type_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/deal_type_id" eq: "$ref": "#/components/schemas/resource_deal/properties/deal_type_id" contains: "$ref": "#/components/schemas/resource_deal/properties/deal_type_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by deal type (one-off or retainer). actual_rate: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/actual_rate" contains: "$ref": "#/components/schemas/resource_deal/properties/actual_rate" eq: "$ref": "#/components/schemas/resource_deal/properties/actual_rate" not_eq: "$ref": "#/components/schemas/resource_deal/properties/actual_rate" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/actual_rate" description: Filter by actual hourly rate (revenue per hour worked). type: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/type" not_contain: "$ref": "#/components/schemas/resource_deal/properties/type" eq: "$ref": "#/components/schemas/resource_deal/properties/type" not_eq: "$ref": "#/components/schemas/resource_deal/properties/type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by deal type (sales deal or production budget). lost_reason_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/lost_reason_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/lost_reason_id" eq: "$ref": "#/components/schemas/resource_deal/properties/lost_reason_id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/lost_reason_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/lost_reason_id" description: Filter by associated lost reason. designated_approver_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/designated_approver_id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/designated_approver_id" eq: "$ref": "#/components/schemas/resource_deal/properties/designated_approver_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/designated_approver_id" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_deal/properties/designated_approver_id" description: Filter by the designated approver person ID set on the deal (`designated_approver_id`). full_query: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/full_query" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/full_query" eq: "$ref": "#/components/schemas/resource_deal/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_deal/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_deal/properties/full_query" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by full-text search query. stage_updated_at: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/stage_updated_at" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/stage_updated_at" not_contain: "$ref": "#/components/schemas/resource_deal/properties/stage_updated_at" not_eq: "$ref": "#/components/schemas/resource_deal/properties/stage_updated_at" eq: "$ref": "#/components/schemas/resource_deal/properties/stage_updated_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by date the deal stage was last updated (`sales_status_updated_at`). recurring_ends_on: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/recurring_ends_on" not_contain: "$ref": "#/components/schemas/resource_deal/properties/recurring_ends_on" eq: "$ref": "#/components/schemas/resource_deal/properties/recurring_ends_on" contains: "$ref": "#/components/schemas/resource_deal/properties/recurring_ends_on" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/recurring_ends_on" description: Filter by recurring contract end date range. recurring: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/recurring" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/recurring" contains: "$ref": "#/components/schemas/resource_deal/properties/recurring" not_eq: "$ref": "#/components/schemas/resource_deal/properties/recurring" eq: "$ref": "#/components/schemas/resource_deal/properties/recurring" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by recurring/retainer status. draft_invoiced: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/draft_invoiced" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/draft_invoiced" not_eq: "$ref": "#/components/schemas/resource_deal/properties/draft_invoiced" not_contain: "$ref": "#/components/schemas/resource_deal/properties/draft_invoiced" eq: "$ref": "#/components/schemas/resource_deal/properties/draft_invoiced" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by draft invoiced amount range. fuzzy_dates: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/fuzzy_dates" not_contain: "$ref": "#/components/schemas/resource_deal/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_deal/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_deal/properties/fuzzy_dates" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/fuzzy_dates" description: Filter by fuzzy date range (matches across multiple date fields). deal_status_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/deal_status_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/deal_status_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/deal_status_id" contains: "$ref": "#/components/schemas/resource_deal/properties/deal_status_id" eq: "$ref": "#/components/schemas/resource_deal/properties/deal_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by pipeline stage (deal status). custom_fields: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_deal/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_deal/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_deal/properties/custom_fields" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/custom_fields" description: Filter by custom field values. time_approval: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/time_approval" eq: "$ref": "#/components/schemas/resource_deal/properties/time_approval" contains: "$ref": "#/components/schemas/resource_deal/properties/time_approval" not_eq: "$ref": "#/components/schemas/resource_deal/properties/time_approval" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/time_approval" description: Filter by whether time approval is required. delivered_on: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/delivered_on" eq: "$ref": "#/components/schemas/resource_deal/properties/delivered_on" contains: "$ref": "#/components/schemas/resource_deal/properties/delivered_on" not_contain: "$ref": "#/components/schemas/resource_deal/properties/delivered_on" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/delivered_on" description: Filter by delivery date range (`delivered_on`). previous_or_current_deal_status_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/previous_or_current_deal_status_id" contains: "$ref": "#/components/schemas/resource_deal/properties/previous_or_current_deal_status_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/previous_or_current_deal_status_id" eq: "$ref": "#/components/schemas/resource_deal/properties/previous_or_current_deal_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/previous_or_current_deal_status_id" description: Filter by pipeline stage matching either the current or previous deal status. revenue_distribution_type: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/revenue_distribution_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/revenue_distribution_type" eq: "$ref": "#/components/schemas/resource_deal/properties/revenue_distribution_type" not_contain: "$ref": "#/components/schemas/resource_deal/properties/revenue_distribution_type" not_eq: "$ref": "#/components/schemas/resource_deal/properties/revenue_distribution_type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by revenue distribution type. purchase_order_number: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/purchase_order_number" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/purchase_order_number" eq: "$ref": "#/components/schemas/resource_deal/properties/purchase_order_number" not_eq: "$ref": "#/components/schemas/resource_deal/properties/purchase_order_number" not_contain: "$ref": "#/components/schemas/resource_deal/properties/purchase_order_number" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. example: eq: PO-2024-017 description: Filter by purchase order number (text search). example: eq: PO-2024-017 lost_at: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/lost_at" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/lost_at" eq: "$ref": "#/components/schemas/resource_deal/properties/lost_at" contains: "$ref": "#/components/schemas/resource_deal/properties/lost_at" not_contain: "$ref": "#/components/schemas/resource_deal/properties/lost_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by lost date range (`lost_at`). query: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/query" contains: "$ref": "#/components/schemas/resource_deal/properties/query" not_contain: "$ref": "#/components/schemas/resource_deal/properties/query" eq: "$ref": "#/components/schemas/resource_deal/properties/query" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/query" description: Filter by deal name or reference (full-text search across name and number). forecasted_cost: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/forecasted_cost" not_eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_cost" eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_cost" not_contain: "$ref": "#/components/schemas/resource_deal/properties/forecasted_cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/forecasted_cost" description: Filter by forecasted total cost amount range. future_revenue: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/future_revenue" eq: "$ref": "#/components/schemas/resource_deal/properties/future_revenue" not_contain: "$ref": "#/components/schemas/resource_deal/properties/future_revenue" not_eq: "$ref": "#/components/schemas/resource_deal/properties/future_revenue" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/future_revenue" description: Filter by future revenue amount range. creator_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/creator_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/creator_id" eq: "$ref": "#/components/schemas/resource_deal/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/creator_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the person who created the deal. estimated_time: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/estimated_time" not_eq: "$ref": "#/components/schemas/resource_deal/properties/estimated_time" contains: "$ref": "#/components/schemas/resource_deal/properties/estimated_time" eq: "$ref": "#/components/schemas/resource_deal/properties/estimated_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/estimated_time" description: Filter by total estimated time amount range. budget_remaining: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/budget_remaining" contains: "$ref": "#/components/schemas/resource_deal/properties/budget_remaining" not_contain: "$ref": "#/components/schemas/resource_deal/properties/budget_remaining" not_eq: "$ref": "#/components/schemas/resource_deal/properties/budget_remaining" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/budget_remaining" description: Filter by remaining budget amount range. forecasted_billable_time: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/forecasted_billable_time" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/forecasted_billable_time" contains: "$ref": "#/components/schemas/resource_deal/properties/forecasted_billable_time" not_eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_billable_time" eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_billable_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by forecasted remaining billable time range. profit_margin: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/profit_margin" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/profit_margin" not_eq: "$ref": "#/components/schemas/resource_deal/properties/profit_margin" eq: "$ref": "#/components/schemas/resource_deal/properties/profit_margin" contains: "$ref": "#/components/schemas/resource_deal/properties/profit_margin" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by profit margin percentage range. template: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/template" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/template" not_contain: "$ref": "#/components/schemas/resource_deal/properties/template" eq: "$ref": "#/components/schemas/resource_deal/properties/template" not_eq: "$ref": "#/components/schemas/resource_deal/properties/template" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter to show deal templates only. subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/subsidiary_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_deal/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_deal/properties/subsidiary_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by subsidiary company. project_type: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/project_type" not_contain: "$ref": "#/components/schemas/resource_deal/properties/project_type" not_eq: "$ref": "#/components/schemas/resource_deal/properties/project_type" eq: "$ref": "#/components/schemas/resource_deal/properties/project_type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/project_type" description: Filter by project type. future_budget_used: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/future_budget_used" not_contain: "$ref": "#/components/schemas/resource_deal/properties/future_budget_used" not_eq: "$ref": "#/components/schemas/resource_deal/properties/future_budget_used" eq: "$ref": "#/components/schemas/resource_deal/properties/future_budget_used" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/future_budget_used" description: Filter by future budget used amount range. expense: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/expense" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/expense" not_contain: "$ref": "#/components/schemas/resource_deal/properties/expense" contains: "$ref": "#/components/schemas/resource_deal/properties/expense" eq: "$ref": "#/components/schemas/resource_deal/properties/expense" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total expenses amount range. discount: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/discount" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/discount" contains: "$ref": "#/components/schemas/resource_deal/properties/discount" not_contain: "$ref": "#/components/schemas/resource_deal/properties/discount" eq: "$ref": "#/components/schemas/resource_deal/properties/discount" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by discount percentage range. pending_invoicing: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/pending_invoicing" contains: "$ref": "#/components/schemas/resource_deal/properties/pending_invoicing" not_contain: "$ref": "#/components/schemas/resource_deal/properties/pending_invoicing" not_eq: "$ref": "#/components/schemas/resource_deal/properties/pending_invoicing" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/pending_invoicing" description: Filter by pending invoicing amount range. created_at: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/created_at" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/created_at" eq: "$ref": "#/components/schemas/resource_deal/properties/created_at" contains: "$ref": "#/components/schemas/resource_deal/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_deal/properties/created_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by creation date range (`created_at`). budget_usage: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/budget_usage" contains: "$ref": "#/components/schemas/resource_deal/properties/budget_usage" not_contain: "$ref": "#/components/schemas/resource_deal/properties/budget_usage" not_eq: "$ref": "#/components/schemas/resource_deal/properties/budget_usage" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/budget_usage" description: Filter by budget usage percentage range. recurring_starts_on: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/recurring_starts_on" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/recurring_starts_on" not_eq: "$ref": "#/components/schemas/resource_deal/properties/recurring_starts_on" not_contain: "$ref": "#/components/schemas/resource_deal/properties/recurring_starts_on" contains: "$ref": "#/components/schemas/resource_deal/properties/recurring_starts_on" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by recurring contract start date range. forecasted_budget_usage: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/forecasted_budget_usage" eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_budget_usage" not_contain: "$ref": "#/components/schemas/resource_deal/properties/forecasted_budget_usage" not_eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_budget_usage" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/forecasted_budget_usage" description: Filter by forecasted budget usage percentage range. forecasted_time_usage: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/forecasted_time_usage" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/forecasted_time_usage" eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_time_usage" not_eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_time_usage" not_contain: "$ref": "#/components/schemas/resource_deal/properties/forecasted_time_usage" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by forecasted time usage percentage range. unapproved_time: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/unapproved_time" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/unapproved_time" not_eq: "$ref": "#/components/schemas/resource_deal/properties/unapproved_time" not_contain: "$ref": "#/components/schemas/resource_deal/properties/unapproved_time" contains: "$ref": "#/components/schemas/resource_deal/properties/unapproved_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by unapproved time amount range. status: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/status" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/status" not_contain: "$ref": "#/components/schemas/resource_deal/properties/status" contains: "$ref": "#/components/schemas/resource_deal/properties/status" not_eq: "$ref": "#/components/schemas/resource_deal/properties/status" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by deal lifecycle status (open/won/lost/delivered). contact_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/contact_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/contact_id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/contact_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/contact_id" eq: "$ref": "#/components/schemas/resource_deal/properties/contact_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by associated contact person. currency: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/currency" eq: "$ref": "#/components/schemas/resource_deal/properties/currency" not_contain: "$ref": "#/components/schemas/resource_deal/properties/currency" not_eq: "$ref": "#/components/schemas/resource_deal/properties/currency" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/currency" description: Filter by deal currency. budget_used: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/budget_used" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/budget_used" not_contain: "$ref": "#/components/schemas/resource_deal/properties/budget_used" contains: "$ref": "#/components/schemas/resource_deal/properties/budget_used" eq: "$ref": "#/components/schemas/resource_deal/properties/budget_used" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by amount of budget used. manual_invoicing_status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/manual_invoicing_status" eq: "$ref": "#/components/schemas/resource_deal/properties/manual_invoicing_status" not_eq: "$ref": "#/components/schemas/resource_deal/properties/manual_invoicing_status" not_contain: "$ref": "#/components/schemas/resource_deal/properties/manual_invoicing_status" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/manual_invoicing_status" description: Filter by manual invoicing status (manually invoiced or not). approval_policy_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/approval_policy_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/approval_policy_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/approval_policy_id" eq: "$ref": "#/components/schemas/resource_deal/properties/approval_policy_id" contains: "$ref": "#/components/schemas/resource_deal/properties/approval_policy_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by assigned approval policy. tracking_type_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/tracking_type_id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/tracking_type_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/tracking_type_id" contains: "$ref": "#/components/schemas/resource_deal/properties/tracking_type_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/tracking_type_id" description: Filter by tracking type. needs_invoicing: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/needs_invoicing" eq: "$ref": "#/components/schemas/resource_deal/properties/needs_invoicing" not_contain: "$ref": "#/components/schemas/resource_deal/properties/needs_invoicing" not_eq: "$ref": "#/components/schemas/resource_deal/properties/needs_invoicing" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/needs_invoicing" description: Filter to include deals that are closed but have uninvoiced revenue. projected_revenue: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/projected_revenue" not_eq: "$ref": "#/components/schemas/resource_deal/properties/projected_revenue" contains: "$ref": "#/components/schemas/resource_deal/properties/projected_revenue" not_contain: "$ref": "#/components/schemas/resource_deal/properties/projected_revenue" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/projected_revenue" description: Filter by projected revenue amount range. todo_due_date: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/todo_due_date" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/todo_due_date" not_contain: "$ref": "#/components/schemas/resource_deal/properties/todo_due_date" eq: "$ref": "#/components/schemas/resource_deal/properties/todo_due_date" not_eq: "$ref": "#/components/schemas/resource_deal/properties/todo_due_date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by next to-do due date. future_booked_time: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/future_booked_time" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/future_booked_time" contains: "$ref": "#/components/schemas/resource_deal/properties/future_booked_time" eq: "$ref": "#/components/schemas/resource_deal/properties/future_booked_time" not_eq: "$ref": "#/components/schemas/resource_deal/properties/future_booked_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by future booked time amount range. work_cost: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/work_cost" not_eq: "$ref": "#/components/schemas/resource_deal/properties/work_cost" eq: "$ref": "#/components/schemas/resource_deal/properties/work_cost" not_contain: "$ref": "#/components/schemas/resource_deal/properties/work_cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/work_cost" description: Filter by work cost amount range. days_since_last_activity: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/days_since_last_activity" not_contain: "$ref": "#/components/schemas/resource_deal/properties/days_since_last_activity" not_eq: "$ref": "#/components/schemas/resource_deal/properties/days_since_last_activity" eq: "$ref": "#/components/schemas/resource_deal/properties/days_since_last_activity" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_deal/properties/days_since_last_activity" description: Filter by the number of days since the last activity was recorded on the deal (`last_activity_at`). billable_time: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/billable_time" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/billable_time" eq: "$ref": "#/components/schemas/resource_deal/properties/billable_time" contains: "$ref": "#/components/schemas/resource_deal/properties/billable_time" not_contain: "$ref": "#/components/schemas/resource_deal/properties/billable_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total billable time amount range. invoiced_percentage: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/invoiced_percentage" not_contain: "$ref": "#/components/schemas/resource_deal/properties/invoiced_percentage" contains: "$ref": "#/components/schemas/resource_deal/properties/invoiced_percentage" eq: "$ref": "#/components/schemas/resource_deal/properties/invoiced_percentage" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/invoiced_percentage" description: Filter by invoiced percentage range. invoiced_rate: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/invoiced_rate" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/invoiced_rate" not_eq: "$ref": "#/components/schemas/resource_deal/properties/invoiced_rate" not_contain: "$ref": "#/components/schemas/resource_deal/properties/invoiced_rate" contains: "$ref": "#/components/schemas/resource_deal/properties/invoiced_rate" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by invoiced rate (invoiced amount per hour) range. contract_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/contract_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/contract_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/contract_id" eq: "$ref": "#/components/schemas/resource_deal/properties/contract_id" contains: "$ref": "#/components/schemas/resource_deal/properties/contract_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by associated contract. company_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/company_id" eq: "$ref": "#/components/schemas/resource_deal/properties/company_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/company_id" description: Filter by client company. parent_company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_deal/properties/parent_company_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_deal/properties/parent_company_id" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_deal/properties/parent_company_id" description: Filter by parent company ID, returning deals linked to companies that are children of the specified parent. name: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/name" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/name" not_eq: "$ref": "#/components/schemas/resource_deal/properties/name" contains: "$ref": "#/components/schemas/resource_deal/properties/name" not_contain: "$ref": "#/components/schemas/resource_deal/properties/name" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by deal name (text search). profit: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/profit" eq: "$ref": "#/components/schemas/resource_deal/properties/profit" not_contain: "$ref": "#/components/schemas/resource_deal/properties/profit" contains: "$ref": "#/components/schemas/resource_deal/properties/profit" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/profit" description: Filter by profit amount range. status_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/status_id" eq: "$ref": "#/components/schemas/resource_deal/properties/status_id" contains: "$ref": "#/components/schemas/resource_deal/properties/status_id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/status_id" description: Filter by pipeline stage. retainer_interval: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/retainer_interval" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/retainer_interval" contains: "$ref": "#/components/schemas/resource_deal/properties/retainer_interval" eq: "$ref": "#/components/schemas/resource_deal/properties/retainer_interval" not_eq: "$ref": "#/components/schemas/resource_deal/properties/retainer_interval" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the deal retainer billing interval (week, two_weeks, month, quarter, half_year, or year). invoiced: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/invoiced" contains: "$ref": "#/components/schemas/resource_deal/properties/invoiced" not_eq: "$ref": "#/components/schemas/resource_deal/properties/invoiced" not_contain: "$ref": "#/components/schemas/resource_deal/properties/invoiced" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/invoiced" description: Filter by invoiced amount range. project_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/project_id" contains: "$ref": "#/components/schemas/resource_deal/properties/project_id" eq: "$ref": "#/components/schemas/resource_deal/properties/project_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/project_id" description: Filter by associated project. estimated_remaining_time: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/estimated_remaining_time" eq: "$ref": "#/components/schemas/resource_deal/properties/estimated_remaining_time" contains: "$ref": "#/components/schemas/resource_deal/properties/estimated_remaining_time" not_contain: "$ref": "#/components/schemas/resource_deal/properties/estimated_remaining_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/estimated_remaining_time" description: Filter by estimated remaining time amount range. id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/id" eq: "$ref": "#/components/schemas/resource_deal/properties/id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/id" description: Filter by deal ID. needs_closing: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/needs_closing" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/needs_closing" contains: "$ref": "#/components/schemas/resource_deal/properties/needs_closing" not_eq: "$ref": "#/components/schemas/resource_deal/properties/needs_closing" not_contain: "$ref": "#/components/schemas/resource_deal/properties/needs_closing" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter to include deals that are past their end date and not yet closed. won_date: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/won_date" not_eq: "$ref": "#/components/schemas/resource_deal/properties/won_date" contains: "$ref": "#/components/schemas/resource_deal/properties/won_date" eq: "$ref": "#/components/schemas/resource_deal/properties/won_date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/won_date" description: Filter deals won on a specific date range (`sales_closed_on` where stage is won). stage_status_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/stage_status_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/stage_status_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/stage_status_id" contains: "$ref": "#/components/schemas/resource_deal/properties/stage_status_id" eq: "$ref": "#/components/schemas/resource_deal/properties/stage_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by pipeline stage outcome status. budget_total: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/budget_total" not_eq: "$ref": "#/components/schemas/resource_deal/properties/budget_total" not_contain: "$ref": "#/components/schemas/resource_deal/properties/budget_total" contains: "$ref": "#/components/schemas/resource_deal/properties/budget_total" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/budget_total" description: Filter by total budget amount range. jump_query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_deal/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_deal/properties/jump_query" eq: "$ref": "#/components/schemas/resource_deal/properties/jump_query" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/jump_query" description: Filter by deal name or number (quick jump search). color_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/color_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/color_id" contains: "$ref": "#/components/schemas/resource_deal/properties/color_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/color_id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/color_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by color label. forecasted_profit: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/forecasted_profit" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_profit" contains: "$ref": "#/components/schemas/resource_deal/properties/forecasted_profit" not_eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_profit" not_contain: "$ref": "#/components/schemas/resource_deal/properties/forecasted_profit" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by forecasted profit amount range. date: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/date" not_eq: "$ref": "#/components/schemas/resource_deal/properties/date" eq: "$ref": "#/components/schemas/resource_deal/properties/date" contains: "$ref": "#/components/schemas/resource_deal/properties/date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/date" description: Filter by deal start date range (`date`). last_activity_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/last_activity_at" eq: "$ref": "#/components/schemas/resource_deal/properties/last_activity_at" not_eq: "$ref": "#/components/schemas/resource_deal/properties/last_activity_at" contains: "$ref": "#/components/schemas/resource_deal/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal/properties/last_activity_at" description: Filter by last activity date range (`last_activity_at`). end_date: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/end_date" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/end_date" not_eq: "$ref": "#/components/schemas/resource_deal/properties/end_date" not_contain: "$ref": "#/components/schemas/resource_deal/properties/end_date" contains: "$ref": "#/components/schemas/resource_deal/properties/end_date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by end date range (`end_date`). forecasted_budget_used: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/forecasted_budget_used" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_budget_used" not_contain: "$ref": "#/components/schemas/resource_deal/properties/forecasted_budget_used" not_eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_budget_used" contains: "$ref": "#/components/schemas/resource_deal/properties/forecasted_budget_used" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by forecasted total budget used amount range. probability: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/probability" contains: "$ref": "#/components/schemas/resource_deal/properties/probability" eq: "$ref": "#/components/schemas/resource_deal/properties/probability" not_contain: "$ref": "#/components/schemas/resource_deal/properties/probability" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/probability" description: Filter by win probability percentage range. number: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/number" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/number" contains: "$ref": "#/components/schemas/resource_deal/properties/number" not_eq: "$ref": "#/components/schemas/resource_deal/properties/number" eq: "$ref": "#/components/schemas/resource_deal/properties/number" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by deal/quote number (text search). next_occurrence_on: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/next_occurrence_on" not_eq: "$ref": "#/components/schemas/resource_deal/properties/next_occurrence_on" eq: "$ref": "#/components/schemas/resource_deal/properties/next_occurrence_on" not_contain: "$ref": "#/components/schemas/resource_deal/properties/next_occurrence_on" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/next_occurrence_on" description: Filter by next contract occurrence date range. previous_probability: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/previous_probability" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/previous_probability" not_eq: "$ref": "#/components/schemas/resource_deal/properties/previous_probability" contains: "$ref": "#/components/schemas/resource_deal/properties/previous_probability" not_contain: "$ref": "#/components/schemas/resource_deal/properties/previous_probability" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the previous win probability percentage range. budget_warning: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/budget_warning" not_eq: "$ref": "#/components/schemas/resource_deal/properties/budget_warning" not_contain: "$ref": "#/components/schemas/resource_deal/properties/budget_warning" contains: "$ref": "#/components/schemas/resource_deal/properties/budget_warning" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/budget_warning" description: Filter by budget warning percentage threshold. forecasted_margin: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/forecasted_margin" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/forecasted_margin" eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_margin" contains: "$ref": "#/components/schemas/resource_deal/properties/forecasted_margin" not_eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_margin" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by forecasted profit margin percentage range. tags: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/tags" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/tags" not_contain: "$ref": "#/components/schemas/resource_deal/properties/tags" not_eq: "$ref": "#/components/schemas/resource_deal/properties/tags" eq: "$ref": "#/components/schemas/resource_deal/properties/tags" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by tag. credited: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/credited" contains: "$ref": "#/components/schemas/resource_deal/properties/credited" not_eq: "$ref": "#/components/schemas/resource_deal/properties/credited" not_contain: "$ref": "#/components/schemas/resource_deal/properties/credited" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/credited" description: Filter by credited amount range. subscriber_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/subscriber_id" eq: "$ref": "#/components/schemas/resource_deal/properties/subscriber_id" contains: "$ref": "#/components/schemas/resource_deal/properties/subscriber_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/subscriber_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/subscriber_id" description: Filter by subscriber (person following the deal). previous_deal_status_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/previous_deal_status_id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/previous_deal_status_id" eq: "$ref": "#/components/schemas/resource_deal/properties/previous_deal_status_id" contains: "$ref": "#/components/schemas/resource_deal/properties/previous_deal_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/previous_deal_status_id" description: Filter by the previous pipeline stage the deal was in. expenses_billable: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/expenses_billable" contains: "$ref": "#/components/schemas/resource_deal/properties/expenses_billable" eq: "$ref": "#/components/schemas/resource_deal/properties/expenses_billable" not_contain: "$ref": "#/components/schemas/resource_deal/properties/expenses_billable" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/expenses_billable" description: Filter by billable expenses amount range. won_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/won_at" not_eq: "$ref": "#/components/schemas/resource_deal/properties/won_at" not_contain: "$ref": "#/components/schemas/resource_deal/properties/won_at" eq: "$ref": "#/components/schemas/resource_deal/properties/won_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/won_at" description: Filter by won date range (`won_at`). sales_status_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/sales_status_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/sales_status_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/sales_status_id" contains: "$ref": "#/components/schemas/resource_deal/properties/sales_status_id" eq: "$ref": "#/components/schemas/resource_deal/properties/sales_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by sales outcome status (won, lost, open). worked_time: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/worked_time" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/worked_time" contains: "$ref": "#/components/schemas/resource_deal/properties/worked_time" not_eq: "$ref": "#/components/schemas/resource_deal/properties/worked_time" eq: "$ref": "#/components/schemas/resource_deal/properties/worked_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total worked time amount range. budget_status: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/budget_status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/budget_status" contains: "$ref": "#/components/schemas/resource_deal/properties/budget_status" eq: "$ref": "#/components/schemas/resource_deal/properties/budget_status" not_eq: "$ref": "#/components/schemas/resource_deal/properties/budget_status" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by budget open/closed status. pipeline_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/pipeline_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/pipeline_id" eq: "$ref": "#/components/schemas/resource_deal/properties/pipeline_id" contains: "$ref": "#/components/schemas/resource_deal/properties/pipeline_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/pipeline_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by associated pipeline. fuzzy_people: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_deal/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_deal/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_deal/properties/fuzzy_people" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/fuzzy_people" description: Filter by associated people using fuzzy matching. origin_deal_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/origin_deal_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/origin_deal_id" eq: "$ref": "#/components/schemas/resource_deal/properties/origin_deal_id" contains: "$ref": "#/components/schemas/resource_deal/properties/origin_deal_id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/origin_deal_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the originating deal this budget was created from. forecasted_revenue: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/forecasted_revenue" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_revenue" eq: "$ref": "#/components/schemas/resource_deal/properties/forecasted_revenue" not_contain: "$ref": "#/components/schemas/resource_deal/properties/forecasted_revenue" contains: "$ref": "#/components/schemas/resource_deal/properties/forecasted_revenue" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by forecasted total revenue amount range. sales_closed_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_at" contains: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_at" not_eq: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_at" not_contain: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/sales_closed_at" description: Filter by win/loss timestamp. manually_invoiced: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/manually_invoiced" contains: "$ref": "#/components/schemas/resource_deal/properties/manually_invoiced" eq: "$ref": "#/components/schemas/resource_deal/properties/manually_invoiced" not_eq: "$ref": "#/components/schemas/resource_deal/properties/manually_invoiced" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/manually_invoiced" description: Filter by manually invoiced amount range. cost: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/cost" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/cost" not_eq: "$ref": "#/components/schemas/resource_deal/properties/cost" eq: "$ref": "#/components/schemas/resource_deal/properties/cost" not_contain: "$ref": "#/components/schemas/resource_deal/properties/cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total cost (work cost plus expenses) amount range. days_in_current_stage: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/days_in_current_stage" contains: "$ref": "#/components/schemas/resource_deal/properties/days_in_current_stage" eq: "$ref": "#/components/schemas/resource_deal/properties/days_in_current_stage" not_eq: "$ref": "#/components/schemas/resource_deal/properties/days_in_current_stage" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_deal/properties/days_in_current_stage" description: Filter by the number of days the deal has been in its current pipeline stage. recurring_interval_id: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/recurring_interval_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/recurring_interval_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/recurring_interval_id" not_eq: "$ref": "#/components/schemas/resource_deal/properties/recurring_interval_id" contains: "$ref": "#/components/schemas/resource_deal/properties/recurring_interval_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by recurring contract billing interval. revenue: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/revenue" contains: "$ref": "#/components/schemas/resource_deal/properties/revenue" not_eq: "$ref": "#/components/schemas/resource_deal/properties/revenue" eq: "$ref": "#/components/schemas/resource_deal/properties/revenue" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/revenue" description: Filter by total revenue amount range. accessible_by_person: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/accessible_by_person" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/accessible_by_person" contains: "$ref": "#/components/schemas/resource_deal/properties/accessible_by_person" eq: "$ref": "#/components/schemas/resource_deal/properties/accessible_by_person" not_eq: "$ref": "#/components/schemas/resource_deal/properties/accessible_by_person" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter deals accessible by a specific person. responsible_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_deal/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_deal/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_deal/properties/responsible_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/responsible_id" description: Filter by responsible person. closed_at: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/closed_at" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/closed_at" eq: "$ref": "#/components/schemas/resource_deal/properties/closed_at" not_contain: "$ref": "#/components/schemas/resource_deal/properties/closed_at" not_eq: "$ref": "#/components/schemas/resource_deal/properties/closed_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by closure date range (`closed_at`). services_revenue: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/services_revenue" not_contain: "$ref": "#/components/schemas/resource_deal/properties/services_revenue" eq: "$ref": "#/components/schemas/resource_deal/properties/services_revenue" contains: "$ref": "#/components/schemas/resource_deal/properties/services_revenue" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/services_revenue" description: Filter by services revenue amount range. estimated_cost: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/estimated_cost" eq: "$ref": "#/components/schemas/resource_deal/properties/estimated_cost" not_eq: "$ref": "#/components/schemas/resource_deal/properties/estimated_cost" contains: "$ref": "#/components/schemas/resource_deal/properties/estimated_cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/estimated_cost" description: Filter by estimated cost amount range. lost_date: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/lost_date" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/lost_date" contains: "$ref": "#/components/schemas/resource_deal/properties/lost_date" eq: "$ref": "#/components/schemas/resource_deal/properties/lost_date" not_contain: "$ref": "#/components/schemas/resource_deal/properties/lost_date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter deals lost on a specific date range (`sales_closed_on` where stage is lost). sales_closed_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_on" contains: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_on" not_eq: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_on" not_contain: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_on" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_deal/properties/sales_closed_on" description: Filter by win/loss date. budgeted_time: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/budgeted_time" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal/properties/budgeted_time" eq: "$ref": "#/components/schemas/resource_deal/properties/budgeted_time" not_eq: "$ref": "#/components/schemas/resource_deal/properties/budgeted_time" not_contain: "$ref": "#/components/schemas/resource_deal/properties/budgeted_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total budgeted time amount range. future_cost: oneOf: - "$ref": "#/components/schemas/resource_deal/properties/future_cost" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal/properties/future_cost" eq: "$ref": "#/components/schemas/resource_deal/properties/future_cost" contains: "$ref": "#/components/schemas/resource_deal/properties/future_cost" not_contain: "$ref": "#/components/schemas/resource_deal/properties/future_cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by future cost amount range. days_since_created: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal/properties/days_since_created" not_eq: "$ref": "#/components/schemas/resource_deal/properties/days_since_created" eq: "$ref": "#/components/schemas/resource_deal/properties/days_since_created" contains: "$ref": "#/components/schemas/resource_deal/properties/days_since_created" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_deal/properties/days_since_created" description: Filter by the number of days elapsed since the deal was created (`created_at`). patternProperties: "^company..*$": title: Company relationship "^contact..*$": title: Contact relationship "^creator..*$": title: Creator relationship "^project..*$": title: Project relationship "^contract..*$": title: Contract relationship "^services..*$": title: Services relationship "^deal_status..*$": title: Deal status relationship "^lost_reason..*$": title: Lost reason relationship "^origin_deal..*$": title: Origin deal relationship "^responsible..*$": title: Responsible relationship "^document_type..*$": title: Document type relationship "^designated_approver..*$": title: Designated approver relationship "^previous_deal_status..*$": title: Previous deal status relationship description: Filter parameters for querying deals (sales pipeline opportunities). _filter_root_payroll_item_report: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_payroll_item_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_payroll_item_report" description: Filter schema for `payroll_item_report` list endpoints — pass a single condition or a logical group. _filter_root_page: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_page" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_page" description: Filter schema for `page` list endpoints — pass a single condition or a logical group. resource_session: type: object title: Session Resource properties: cordova_device_model: title: Cordova Device Model description: The model of the Cordova (mobile) device used to create this session. platform: type: string title: Platform description: The operating system platform detected from the device used to create this session. single_sign_on: type: boolean title: Single Sign On description: Whether this session was authenticated via Single Sign-On. read_only: type: boolean title: Read Only description: When true, this session has read-only access and cannot make changes. agent_last_name: title: Agent Last Name description: The last name of the agent (admin) who created this session on behalf of the user, or null if the user created it themselves. firebase_token: title: Firebase Token description: The Firebase push notification token for this session, used for mobile push notifications. id: title: Id description: The unique identifier of this session. token: title: Token description: The API access token for authenticating requests in this session. location: type: string title: Location description: The geographic location associated with the last IP address used in this session. device: type: string title: Device description: The type of device used to create this session, such as desktop or mobile. token_expires_at: type: string title: Token Expires At format: date-time description: Timestamp when this session's token expires, or null if the session does not expire. browser: type: string title: Browser description: The browser used to create this session, as detected from the user agent string. app_version: title: App Version description: The version of the Productive app used when this session was created. agent_first_name: title: Agent First Name description: The first name of the agent (admin) who created this session on behalf of the user, or null if the user created it themselves. two_factor_auth: type: boolean title: Two Factor Auth description: When true, two-factor authentication has been verified for this session. agent_avatar: title: Agent Avatar description: The avatar URL of the agent (admin) who created this session on behalf of the user, if applicable. cordova_device_uid: title: Cordova Device Uid description: The unique device identifier of the Cordova (mobile) device used to create this session. user: title: User description: The user this session belongs to. note: type: string title: Note description: An optional note describing the purpose of this session or API token. cordova_device_version: title: Cordova Device Version description: The OS version of the Cordova (mobile) device used to create this session. user_id: type: integer title: User description: ID of the user this session belongs to. machine: type: boolean title: Machine description: When true, this session belongs to a machine (API token) rather than an interactive user session. last_activity_at: type: string title: Last Activity At format: date-time description: Timestamp of the last request made in this session. cordova_device_platform: title: Cordova Device Platform description: The platform of the Cordova (mobile) device (e.g. iOS or Android) used to create this session. last_ip: type: string title: Last Ip description: The IP address from which this session was last used. name: type: string title: Name description: A user-assigned label for this session, used to identify API tokens or machine sessions. creator_id: type: integer title: Creator description: ID of the user who created this session (typically the same as user_id, unless created by an agent). description: An API access token session for a user, tracking device, browser, and IP information. _filter_root_webhook_log: oneOf: - "$ref": "#/components/schemas/filter_webhook_log" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_webhook_log" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `webhook_log` list endpoints — pass a single condition or a logical group. resource_placeholder_usage: type: object title: Placeholder usage Resource properties: target_type: type: string title: Target Type description: The type of the target record this placeholder usage applies to (task or todo). placeholder_id: type: integer title: Placeholder description: ID of the placeholder associated with this usage. task: title: Task description: The task this placeholder usage is linked to, if the target is a task. target_id: type: integer title: Target description: The ID of the target record (task or todo) this placeholder usage applies to. interval_value: type: integer title: Interval Value description: The numeric value of the date offset applied to the target field when using interval mode. created_at: type: string title: Created At format: date-time description: Timestamp when this placeholder usage was created. skip_weekends: type: boolean title: Skip Weekends description: When true, weekends are excluded when calculating date offsets for this placeholder. updated_at: type: string title: Updated At format: date-time description: Timestamp when this placeholder usage was last updated. interval_unit: enum: - day - week - month - year type: string title: Interval Unit description: The unit of the date offset interval (day, week, month, or year). todo_id: type: integer title: Todo description: ID of the todo this placeholder usage is linked to, if the target is a todo. id: type: integer title: Id description: The unique identifier of this placeholder usage. field: enum: - assignee - subscriber - due_date - start_date type: string title: Field description: The task or todo field this placeholder is mapped to (e.g. assignee, due_date, start_date). task_id: type: integer title: Task description: ID of the task this placeholder usage is linked to, if the target is a task. interval_enabled: type: boolean title: Interval Enabled description: Whether the date offset interval is enabled for this placeholder usage. placeholder: title: Placeholder description: The placeholder associated with this usage. interval_direction: enum: - before - after type: string title: Interval Direction description: The direction of the date offset relative to the reference date, either before or after. todo: title: Todo description: The todo this placeholder usage is linked to, if the target is a todo. project_id: type: integer title: Project description: ID of the project this placeholder usage is associated with. description: A record linking a placeholder to a specific task or todo field, optionally with a date offset interval. filter_revenue_distribution: type: object title: Filter revenue distribution properties: id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_revenue_distribution/properties/id" not_contain: "$ref": "#/components/schemas/resource_revenue_distribution/properties/id" not_eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/id" eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_revenue_distribution/properties/id" description: Filter by ID. start_on: oneOf: - "$ref": "#/components/schemas/resource_revenue_distribution/properties/start_on" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_revenue_distribution/properties/start_on" contains: "$ref": "#/components/schemas/resource_revenue_distribution/properties/start_on" eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/start_on" not_eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/start_on" description: Filter using explicit operator syntax. description: Filter by the start date of the distribution period. creator_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_revenue_distribution/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/creator_id" eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_revenue_distribution/properties/creator_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_revenue_distribution/properties/creator_id" description: Filter by the person who created the revenue distribution. amount: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount" contains: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount" not_contain: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount" not_eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount" description: Filter by the monetary amount of the revenue distribution. end_on: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/end_on" eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/end_on" not_contain: "$ref": "#/components/schemas/resource_revenue_distribution/properties/end_on" contains: "$ref": "#/components/schemas/resource_revenue_distribution/properties/end_on" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_revenue_distribution/properties/end_on" description: Filter by the end date of the distribution period. created_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_revenue_distribution/properties/created_at" contains: "$ref": "#/components/schemas/resource_revenue_distribution/properties/created_at" eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/created_at" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_revenue_distribution/properties/created_at" description: Filter by creation date range. deal_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_revenue_distribution/properties/deal_id" eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_revenue_distribution/properties/deal_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_revenue_distribution/properties/deal_id" description: Filter by the associated deal. amount_percent: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount_percent" contains: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount_percent" not_eq: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount_percent" not_contain: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount_percent" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount_percent" description: Filter by percentage amount of the revenue distribution. patternProperties: "^deal..*$": title: Deal relationship description: Filter parameters for revenue distribution records. _filter_root_budget_report: oneOf: - "$ref": "#/components/schemas/filter_budget_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_budget_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `budget_report` list endpoints — pass a single condition or a logical group. filter_line_item_report: type: object title: Filter line item report properties: id: oneOf: - "$ref": "#/components/schemas/resource_line_item_report/properties/id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_line_item_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/id" contains: "$ref": "#/components/schemas/resource_line_item_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/id" description: Filter operator object for id. description: Filter line item report results by id. invoice_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_line_item_report/properties/invoice_id" not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/invoice_id" contains: "$ref": "#/components/schemas/resource_line_item_report/properties/invoice_id" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/invoice_id" description: Filter operator object for invoice id. - "$ref": "#/components/schemas/resource_line_item_report/properties/invoice_id" description: Filter line item report results by invoice id. discount: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_line_item_report/properties/discount" contains: "$ref": "#/components/schemas/resource_line_item_report/properties/discount" not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/discount" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/discount" description: Filter operator object for discount. - "$ref": "#/components/schemas/resource_line_item_report/properties/discount" description: Filter line item report results by discount. tax_rate: oneOf: - "$ref": "#/components/schemas/resource_line_item_report/properties/tax_rate" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_rate" eq: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_rate" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_rate" contains: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_rate" description: Filter operator object for tax rate. description: Filter line item report results by tax rate. company_id: oneOf: - "$ref": "#/components/schemas/resource_line_item_report/properties/company_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_line_item_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/company_id" eq: "$ref": "#/components/schemas/resource_line_item_report/properties/company_id" description: Filter operator object for company id. description: Filter line item report results by company id. service_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/service_id" eq: "$ref": "#/components/schemas/resource_line_item_report/properties/service_id" contains: "$ref": "#/components/schemas/resource_line_item_report/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/service_id" description: Filter operator object for service id. - "$ref": "#/components/schemas/resource_line_item_report/properties/service_id" description: Filter line item report results by service id. tax_name: oneOf: - "$ref": "#/components/schemas/resource_line_item_report/properties/tax_name" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_name" contains: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_name" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_name" not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_name" description: Filter operator object for tax name. description: Filter line item report results by tax name. creator_id: oneOf: - "$ref": "#/components/schemas/resource_line_item_report/properties/creator_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_line_item_report/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/creator_id" eq: "$ref": "#/components/schemas/resource_line_item_report/properties/creator_id" description: Filter operator object for creator id. description: Filter line item report results by creator id. unit_id: oneOf: - "$ref": "#/components/schemas/resource_line_item_report/properties/unit_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_line_item_report/properties/unit_id" eq: "$ref": "#/components/schemas/resource_line_item_report/properties/unit_id" not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/unit_id" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/unit_id" description: Filter operator object for unit id. description: Filter line item report results by unit id. expense_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/expense_id" eq: "$ref": "#/components/schemas/resource_line_item_report/properties/expense_id" contains: "$ref": "#/components/schemas/resource_line_item_report/properties/expense_id" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/expense_id" description: Filter operator object for expense id. - "$ref": "#/components/schemas/resource_line_item_report/properties/expense_id" description: Filter line item report results by expense id. tax_value: oneOf: - "$ref": "#/components/schemas/resource_line_item_report/properties/tax_value" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_value" eq: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_value" not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_value" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_value" description: Filter operator object for tax value. description: Filter line item report results by tax value. service_type_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_line_item_report/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/service_type_id" not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_line_item_report/properties/service_type_id" description: Filter operator object for service type id. - "$ref": "#/components/schemas/resource_line_item_report/properties/service_type_id" description: Filter line item report results by service type id. updater_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_line_item_report/properties/updater_id" contains: "$ref": "#/components/schemas/resource_line_item_report/properties/updater_id" not_contain: "$ref": "#/components/schemas/resource_line_item_report/properties/updater_id" eq: "$ref": "#/components/schemas/resource_line_item_report/properties/updater_id" description: Filter operator object for updater id. - "$ref": "#/components/schemas/resource_line_item_report/properties/updater_id" description: Filter line item report results by updater id. patternProperties: "^creator..*$": title: Creator relationship "^expense..*$": title: Expense relationship "^invoice..*$": title: Invoice relationship "^service..*$": title: Service relationship "^updater..*$": title: Updater relationship "^kpd_code..*$": title: Kpd code relationship "^service_type..*$": title: Service type relationship description: Available filter parameters for querying aggregated line item report data. _filter_root_survey_report: oneOf: - "$ref": "#/components/schemas/filter_survey_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_survey_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `survey_report` list endpoints — pass a single condition or a logical group. resource_payroll_item_report: type: object title: Payroll item report Resource properties: person_type: enum: - 1 - 2 - 3 - 4 type: integer title: Person Type description: Person type for this payroll item report group. total_time_off_cost: title: Total Time Off Cost description: Sum of time off cost across all records in this payroll item report group. parent_company_id: type: integer title: Parent Company description: ID of the parent company of the client linked to this payroll item, used for hierarchical company filtering. total_cost: title: Total Cost description: Sum of cost across all records in this payroll item report group. booking_id: type: integer title: Booking description: Booking id for this payroll item report group. formulas: type: integer title: Formulas description: Formulas for this payroll item report group. subsidiary_id: type: integer title: Subsidiary description: Subsidiary id for this payroll item report group. total_capacity: type: number title: Total Capacity description: Sum of capacity across all records in this payroll item report group. total_time: type: number title: Total Time description: Sum of time across all records in this payroll item report group. payroll_item_id: type: integer title: Payroll Item description: Payroll item id for this payroll item report group. formula_fields: title: Formula Fields description: Formula fields for this payroll item report group. salary_type: title: Salary Type description: Salary type for this payroll item report group. subsidiary: title: Subsidiary description: Subsidiary for this payroll item report group. company: title: Company description: Company for this payroll item report group. role_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 type: integer title: Role description: Role id for this payroll item report group. booking: title: Booking description: Booking for this payroll item report group. total_scheduled_time: type: number title: Total Scheduled Time description: Sum of scheduled time across all records in this payroll item report group. person_id: type: integer title: Person description: Person id for this payroll item report group. currency_normalized: title: Currency Normalized description: Currency in the normalized currency for this payroll item report group. payroll_item: title: Payroll Item description: Payroll item for this payroll item report group. person_report: title: Person Report description: The person associated with this payroll item report row. person: title: Person description: Person for this payroll item report group. company_id: type: integer title: Company description: Company id for this payroll item report group. count: type: integer title: Count description: Number of payroll items in this report group. currency: type: string title: Currency description: Currency for this payroll item report group. time_entry_id: type: integer title: Time Entry description: Time entry id for this payroll item report group. group: type: string title: Group description: The grouping dimension for this payroll item report row. total_cost_default: title: Total Cost Default description: Sum of cost in the organization's default currency across all records in this payroll item report group. total_time_off_cost_normalized: title: Total Time Off Cost Normalized description: Sum of time off cost in the normalized currency across all records in this payroll item report group. organization: title: Organization description: Organization for this payroll item report group. start_date: type: string title: Start Date format: date description: Start date for this payroll item report group. role: title: Role description: Role for this payroll item report group. salary_id: type: integer title: Salary description: Salary id for this payroll item report group. salary_type_id: enum: - 1 - 2 - 3 - 4 - 5 type: integer title: Salary Type description: Salary type id for this payroll item report group. person_status: enum: - 1 - 2 type: integer title: Person Status description: Person status for this payroll item report group. end_date: type: string title: End Date format: date description: End date for this payroll item report group. time_entry: title: Time Entry description: Time entry for this payroll item report group. total_availability: type: number title: Total Availability description: Sum of availability across all records in this payroll item report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this payroll item report group. total_time_off_time: type: number title: Total Time Off Time description: Sum of time off time across all records in this payroll item report group. custom_fields: type: string title: Custom Fields description: Custom fields for this payroll item report group. report: title: Report description: Report for this payroll item report group. total_time_off_cost_default: title: Total Time Off Cost Default description: Sum of time off cost in the organization's default currency across all records in this payroll item report group. total_cost_normalized: title: Total Cost Normalized description: Sum of cost in the normalized currency across all records in this payroll item report group. salary: title: Salary description: Salary for this payroll item report group. payroll_item_type: type: string title: Payroll Item Type description: Payroll item type for this payroll item report group. date: type: string title: Date format: date description: Date for this payroll item report group. description: An aggregated payroll item report row grouping payroll entries by configurable dimensions with cost metrics. filter_proposal: type: object title: Filter proposal properties: created_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_proposal/properties/created_at" contains: "$ref": "#/components/schemas/resource_proposal/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_proposal/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_proposal/properties/created_at" description: Named-operator filter for the proposal creation date. - "$ref": "#/components/schemas/resource_proposal/properties/created_at" description: Filters proposals by their creation date. deal_id: oneOf: - "$ref": "#/components/schemas/resource_proposal/properties/deal_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_proposal/properties/deal_id" eq: "$ref": "#/components/schemas/resource_proposal/properties/deal_id" contains: "$ref": "#/components/schemas/resource_proposal/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_proposal/properties/deal_id" description: Filter using explicit operator syntax. description: Filter by the associated deal. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_proposal/properties/id" not_eq: "$ref": "#/components/schemas/resource_proposal/properties/id" contains: "$ref": "#/components/schemas/resource_proposal/properties/id" not_contain: "$ref": "#/components/schemas/resource_proposal/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_proposal/properties/id" description: Filter by ID. responsible_id: oneOf: - "$ref": "#/components/schemas/resource_proposal/properties/responsible_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_proposal/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_proposal/properties/responsible_id" not_eq: "$ref": "#/components/schemas/resource_proposal/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_proposal/properties/responsible_id" description: Named-operator filter for the proposal responsible person ID. description: Filters proposals by the ID of their responsible person. sent_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_proposal/properties/sent_at" contains: "$ref": "#/components/schemas/resource_proposal/properties/sent_at" not_contain: "$ref": "#/components/schemas/resource_proposal/properties/sent_at" eq: "$ref": "#/components/schemas/resource_proposal/properties/sent_at" description: Named-operator filter for the proposal sent date. - "$ref": "#/components/schemas/resource_proposal/properties/sent_at" description: Filters proposals by the date they were sent to the client. creator_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_proposal/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_proposal/properties/creator_id" eq: "$ref": "#/components/schemas/resource_proposal/properties/creator_id" contains: "$ref": "#/components/schemas/resource_proposal/properties/creator_id" description: Named-operator filter for the proposal creator ID. - "$ref": "#/components/schemas/resource_proposal/properties/creator_id" description: Filters proposals by the ID of the person who created them. budget_total: oneOf: - "$ref": "#/components/schemas/resource_proposal/properties/budget_total" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_proposal/properties/budget_total" not_contain: "$ref": "#/components/schemas/resource_proposal/properties/budget_total" eq: "$ref": "#/components/schemas/resource_proposal/properties/budget_total" contains: "$ref": "#/components/schemas/resource_proposal/properties/budget_total" description: Named-operator filter for the proposal budget total amount. description: Filters proposals by their total budget amount. status: oneOf: - "$ref": "#/components/schemas/resource_proposal/properties/status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_proposal/properties/status" eq: "$ref": "#/components/schemas/resource_proposal/properties/status" contains: "$ref": "#/components/schemas/resource_proposal/properties/status" not_eq: "$ref": "#/components/schemas/resource_proposal/properties/status" description: Filter using explicit operator syntax. description: Filter by proposal status. company_id: oneOf: - "$ref": "#/components/schemas/resource_proposal/properties/company_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_proposal/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_proposal/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_proposal/properties/company_id" eq: "$ref": "#/components/schemas/resource_proposal/properties/company_id" description: Named-operator filter for the proposal company ID. description: Filters proposals by the ID of their associated company (client). updated_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_proposal/properties/updated_at" contains: "$ref": "#/components/schemas/resource_proposal/properties/updated_at" eq: "$ref": "#/components/schemas/resource_proposal/properties/updated_at" not_eq: "$ref": "#/components/schemas/resource_proposal/properties/updated_at" description: Named-operator filter for the proposal last updated date. - "$ref": "#/components/schemas/resource_proposal/properties/updated_at" description: Filters proposals by their last update date. link_status: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_proposal/properties/link_status" contains: "$ref": "#/components/schemas/resource_proposal/properties/link_status" not_contain: "$ref": "#/components/schemas/resource_proposal/properties/link_status" not_eq: "$ref": "#/components/schemas/resource_proposal/properties/link_status" description: Named-operator filter for the proposal link status. - "$ref": "#/components/schemas/resource_proposal/properties/link_status" description: Filters proposals by their public link sharing status. status_changed_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_proposal/properties/status_changed_at" not_contain: "$ref": "#/components/schemas/resource_proposal/properties/status_changed_at" eq: "$ref": "#/components/schemas/resource_proposal/properties/status_changed_at" not_eq: "$ref": "#/components/schemas/resource_proposal/properties/status_changed_at" description: Named-operator filter for the proposal status change date. - "$ref": "#/components/schemas/resource_proposal/properties/status_changed_at" description: Filters proposals by the date their status last changed. patternProperties: "^deal..*$": title: Deal relationship "^company..*$": title: Company relationship "^creator..*$": title: Creator relationship "^responsible..*$": title: Responsible relationship description: Filter parameters for proposals. filter_page_version: type: object title: Filter page version properties: person_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page_version/properties/person_id" contains: "$ref": "#/components/schemas/resource_page_version/properties/person_id" eq: "$ref": "#/components/schemas/resource_page_version/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_page_version/properties/person_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page_version/properties/person_id" description: Filter by the person who created this version. restored_from_version_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page_version/properties/restored_from_version_id" eq: "$ref": "#/components/schemas/resource_page_version/properties/restored_from_version_id" contains: "$ref": "#/components/schemas/resource_page_version/properties/restored_from_version_id" not_eq: "$ref": "#/components/schemas/resource_page_version/properties/restored_from_version_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page_version/properties/restored_from_version_id" description: Filter by the version this version was restored from. id: oneOf: - "$ref": "#/components/schemas/resource_page_version/properties/id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_page_version/properties/id" not_contain: "$ref": "#/components/schemas/resource_page_version/properties/id" contains: "$ref": "#/components/schemas/resource_page_version/properties/id" eq: "$ref": "#/components/schemas/resource_page_version/properties/id" description: Filter using explicit operator syntax. description: Filter by ID. page_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_page_version/properties/page_id" contains: "$ref": "#/components/schemas/resource_page_version/properties/page_id" not_eq: "$ref": "#/components/schemas/resource_page_version/properties/page_id" eq: "$ref": "#/components/schemas/resource_page_version/properties/page_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_page_version/properties/page_id" description: Filter by the associated page. patternProperties: {} description: Filter parameters for page versions. filter_widget: type: object title: Filter widget properties: report_layout_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_widget/properties/report_layout_id" eq: "$ref": "#/components/schemas/resource_widget/properties/report_layout_id" not_eq: "$ref": "#/components/schemas/resource_widget/properties/report_layout_id" contains: "$ref": "#/components/schemas/resource_widget/properties/report_layout_id" description: Filter operator object for report layout ID. - "$ref": "#/components/schemas/resource_widget/properties/report_layout_id" description: Filter widgets by report layout ID. dashboard_id: oneOf: - "$ref": "#/components/schemas/resource_widget/properties/dashboard_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_widget/properties/dashboard_id" contains: "$ref": "#/components/schemas/resource_widget/properties/dashboard_id" not_eq: "$ref": "#/components/schemas/resource_widget/properties/dashboard_id" not_contain: "$ref": "#/components/schemas/resource_widget/properties/dashboard_id" description: Filter using explicit operator syntax. description: Filter by the associated dashboard. patternProperties: {} description: Filter parameters for listing widget resources, which are configurable data panels displayed on dashboards. resource_payment: type: object title: Payment Resource properties: date: title: Date description: Date when the payment was recorded. project_id: type: integer title: Project description: ID of the project associated with the invoice this payment was applied to. note: type: string title: Note description: An optional note or memo about this payment. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary associated with the invoice this payment was applied to. invoice: title: Invoice description: The invoice this payment was applied to. query: type: string title: Query description: A full-text search query to filter payments by invoice number or note. budget_id: type: integer title: Budget description: ID of the budget (deal) associated with the invoice this payment was applied to. amount: type: integer title: Amount description: The payment amount in the invoice's currency. paid_after: type: string title: Paid After format: date description: Filter for payments made after this date (used as a filter parameter). invoice_number: title: Invoice Number description: The invoice number of the associated invoice at the time this payment was recorded. organization: title: Organization description: The organization this payment belongs to. invoice_id: type: integer title: Invoice description: ID of the invoice this payment was applied to. paid_before: type: string title: Paid Before format: date description: Filter for payments made before this date (used as a filter parameter). number: type: string title: Number description: The auto-generated sequence number for this payment. currency_default: title: Currency Default description: The organization's default currency for this payment. amount_normalized: title: Amount Normalized description: The payment amount converted to the normalized (reporting) currency. paid_on: type: string title: Paid On format: date description: Date when the payment was received (paid). id: type: integer title: Id description: Unique identifier of this payment. amount_default: title: Amount Default description: The payment amount converted to the organization's default currency. currency: title: Currency description: The currency of this payment, inherited from the associated invoice. company_id: type: integer title: Company description: ID of the company (client) on the invoice this payment was applied to. currency_normalized: title: Currency Normalized description: The normalized (reporting) currency for this payment. external_id: type: string title: External description: An external identifier for this payment, used when syncing with third-party accounting systems. written_off_on: type: string title: Written Off On format: date description: Date when this payment was written off as uncollectable, or null if the payment is not written off. description: A payment record representing an amount received against an invoice, internally referred to as an InvoicePayment. resource_service_assignment: type: object title: Service assignment Resource properties: service_id: type: integer title: Service description: ID of the service this assignment belongs to. organization: title: Organization description: The organization this service assignment belongs to. id: type: integer title: Id description: The unique identifier of this service assignment. person_id: type: integer title: Person description: ID of the person assigned to this service. person: title: Person description: The person assigned to this service. service: title: Service description: The service this assignment belongs to. description: Represents an assignment of a person to a service (line item) on a deal or budget. filter_booking_report: type: object title: Filter booking report properties: canceled_at: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/canceled_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/canceled_at" contains: "$ref": "#/components/schemas/resource_booking_report/properties/canceled_at" eq: "$ref": "#/components/schemas/resource_booking_report/properties/canceled_at" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/canceled_at" description: Filter operator object for canceled at. description: Filter booking report results by canceled at. approved_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/approved_at" contains: "$ref": "#/components/schemas/resource_booking_report/properties/approved_at" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/approved_at" eq: "$ref": "#/components/schemas/resource_booking_report/properties/approved_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking_report/properties/approved_at" description: Filter by approval date range (approved_at). parent_company_id: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/parent_company_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/parent_company_id" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_booking_report/properties/parent_company_id" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/parent_company_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the parent company of the booking's company. stage_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/stage_type" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/stage_type" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/stage_type" contains: "$ref": "#/components/schemas/resource_booking_report/properties/stage_type" description: Filter operator object for stage type. - "$ref": "#/components/schemas/resource_booking_report/properties/stage_type" description: Filter booking report results by stage type. project_id: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/project_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_booking_report/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/project_id" description: Filter operator object for project id. description: Filter booking report results by project id. custom_fields: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_booking_report/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking_report/properties/custom_fields" description: Filter by custom field values. after: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking_report/properties/after" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/after" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/after" eq: "$ref": "#/components/schemas/resource_booking_report/properties/after" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking_report/properties/after" description: Filter by bookings starting after this date (inclusive). Shorthand for a date range start. tags: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/tags" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/tags" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/tags" contains: "$ref": "#/components/schemas/resource_booking_report/properties/tags" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/tags" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by tag. ended_on_after: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/ended_on_after" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking_report/properties/ended_on_after" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/ended_on_after" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/ended_on_after" eq: "$ref": "#/components/schemas/resource_booking_report/properties/ended_on_after" description: Filter operator object for ended on after. description: Filter booking report results by ended on after. with_draft: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/with_draft" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/with_draft" eq: "$ref": "#/components/schemas/resource_booking_report/properties/with_draft" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/with_draft" contains: "$ref": "#/components/schemas/resource_booking_report/properties/with_draft" description: Filter operator object for with draft. description: Filter booking report results by with draft. date: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/date" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking_report/properties/date" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/date" eq: "$ref": "#/components/schemas/resource_booking_report/properties/date" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/date" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the booking item date. started_on: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/started_on" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/started_on" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/started_on" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/started_on" contains: "$ref": "#/components/schemas/resource_booking_report/properties/started_on" description: Filter operator object for started on. description: Filter booking report results by started on. before: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/before" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/before" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/before" contains: "$ref": "#/components/schemas/resource_booking_report/properties/before" description: Filter operator object for before. - "$ref": "#/components/schemas/resource_booking_report/properties/before" description: Filter booking report results by before. project_type: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking_report/properties/project_type" eq: "$ref": "#/components/schemas/resource_booking_report/properties/project_type" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/project_type" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/project_type" description: Filter operator object for project type. - "$ref": "#/components/schemas/resource_booking_report/properties/project_type" description: Filter booking report results by project type. people_custom_fields: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/people_custom_fields" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/people_custom_fields" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/people_custom_fields" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/people_custom_fields" contains: "$ref": "#/components/schemas/resource_booking_report/properties/people_custom_fields" description: Filter operator object for people custom fields. description: Filter booking report results by people custom fields. ended_on: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/ended_on" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/ended_on" contains: "$ref": "#/components/schemas/resource_booking_report/properties/ended_on" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/ended_on" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/ended_on" description: Filter operator object for ended on. description: Filter booking report results by ended on. date_before: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/date_before" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking_report/properties/date_before" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/date_before" eq: "$ref": "#/components/schemas/resource_booking_report/properties/date_before" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/date_before" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter to include only booking items on or before this date. date_after: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/date_after" contains: "$ref": "#/components/schemas/resource_booking_report/properties/date_after" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/date_after" eq: "$ref": "#/components/schemas/resource_booking_report/properties/date_after" description: Filter operator object for date after. - "$ref": "#/components/schemas/resource_booking_report/properties/date_after" description: Filter booking report results by date after. started_on_before: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/started_on_before" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/started_on_before" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/started_on_before" contains: "$ref": "#/components/schemas/resource_booking_report/properties/started_on_before" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/started_on_before" description: Filter operator object for started on before. description: Filter booking report results by started on before. autotracking: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/autotracking" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/autotracking" eq: "$ref": "#/components/schemas/resource_booking_report/properties/autotracking" contains: "$ref": "#/components/schemas/resource_booking_report/properties/autotracking" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/autotracking" description: Filter operator object for autotracking. description: Filter booking report results by autotracking. created_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/created_at" eq: "$ref": "#/components/schemas/resource_booking_report/properties/created_at" contains: "$ref": "#/components/schemas/resource_booking_report/properties/created_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking_report/properties/created_at" description: Filter by booking creation date range (created_at). approver_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/approver_id" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/approver_id" contains: "$ref": "#/components/schemas/resource_booking_report/properties/approver_id" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking_report/properties/approver_id" description: Filter by the person who approved the booking. rejected_at: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/rejected_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/rejected_at" eq: "$ref": "#/components/schemas/resource_booking_report/properties/rejected_at" contains: "$ref": "#/components/schemas/resource_booking_report/properties/rejected_at" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/rejected_at" description: Filter operator object for rejected at. description: Filter booking report results by rejected at. event_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/event_id" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/event_id" contains: "$ref": "#/components/schemas/resource_booking_report/properties/event_id" eq: "$ref": "#/components/schemas/resource_booking_report/properties/event_id" description: Filter operator object for event id. - "$ref": "#/components/schemas/resource_booking_report/properties/event_id" description: Filter booking report results by event id. draft: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking_report/properties/draft" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/draft" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/draft" eq: "$ref": "#/components/schemas/resource_booking_report/properties/draft" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking_report/properties/draft" description: Filter by booking status (confirmed or tentative/draft). formulas: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking_report/properties/formulas" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_booking_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/formulas" description: Filter operator object for formulas. - "$ref": "#/components/schemas/resource_booking_report/properties/formulas" description: Filter booking report results by formulas. person_id: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/person_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking_report/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/person_id" eq: "$ref": "#/components/schemas/resource_booking_report/properties/person_id" description: Filter operator object for person id. description: Filter booking report results by person id. time: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/time" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking_report/properties/time" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/time" eq: "$ref": "#/components/schemas/resource_booking_report/properties/time" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/time" description: Filter operator object for time. description: Filter booking report results by time. absence_type: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/absence_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/absence_type" eq: "$ref": "#/components/schemas/resource_booking_report/properties/absence_type" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/absence_type" contains: "$ref": "#/components/schemas/resource_booking_report/properties/absence_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by absence type (time off or remote work). company_id: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/company_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/company_id" contains: "$ref": "#/components/schemas/resource_booking_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the client company associated with the booking's project. person_subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/person_subsidiary_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/person_subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/person_subsidiary_id" eq: "$ref": "#/components/schemas/resource_booking_report/properties/person_subsidiary_id" contains: "$ref": "#/components/schemas/resource_booking_report/properties/person_subsidiary_id" description: Filter operator object for person subsidiary id. description: Filter booking report results by person subsidiary id. service_type_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/service_type_id" contains: "$ref": "#/components/schemas/resource_booking_report/properties/service_type_id" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/service_type_id" description: Filter operator object for service type id. - "$ref": "#/components/schemas/resource_booking_report/properties/service_type_id" description: Filter booking report results by service type id. booking_type: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking_report/properties/booking_type" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/booking_type" eq: "$ref": "#/components/schemas/resource_booking_report/properties/booking_type" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/booking_type" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking_report/properties/booking_type" description: Filter by booking type (budget/deal or absence). billing_type_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/billing_type_id" contains: "$ref": "#/components/schemas/resource_booking_report/properties/billing_type_id" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/billing_type_id" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/billing_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking_report/properties/billing_type_id" description: Filter by billing type. approval_status: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/approval_status" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/approval_status" contains: "$ref": "#/components/schemas/resource_booking_report/properties/approval_status" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/approval_status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking_report/properties/approval_status" description: Filter by booking approval status (approved or unapproved). ended_on_before: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking_report/properties/ended_on_before" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/ended_on_before" eq: "$ref": "#/components/schemas/resource_booking_report/properties/ended_on_before" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/ended_on_before" description: Filter operator object for ended on before. - "$ref": "#/components/schemas/resource_booking_report/properties/ended_on_before" description: Filter booking report results by ended on before. started_on_after: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/started_on_after" contains: "$ref": "#/components/schemas/resource_booking_report/properties/started_on_after" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/started_on_after" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/started_on_after" description: Filter operator object for started on after. - "$ref": "#/components/schemas/resource_booking_report/properties/started_on_after" description: Filter booking report results by started on after. note: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/note" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking_report/properties/note" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/note" contains: "$ref": "#/components/schemas/resource_booking_report/properties/note" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/note" description: Filter operator object for note. description: Filter booking report results by note. service_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/service_id" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/service_id" contains: "$ref": "#/components/schemas/resource_booking_report/properties/service_id" eq: "$ref": "#/components/schemas/resource_booking_report/properties/service_id" description: Filter operator object for service id. - "$ref": "#/components/schemas/resource_booking_report/properties/service_id" description: Filter booking report results by service id. task_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/task_id" contains: "$ref": "#/components/schemas/resource_booking_report/properties/task_id" not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/task_id" eq: "$ref": "#/components/schemas/resource_booking_report/properties/task_id" description: Filter operator object for task id. - "$ref": "#/components/schemas/resource_booking_report/properties/task_id" description: Filter booking report results by task id. budget_id: oneOf: - "$ref": "#/components/schemas/resource_booking_report/properties/budget_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking_report/properties/budget_id" not_eq: "$ref": "#/components/schemas/resource_booking_report/properties/budget_id" eq: "$ref": "#/components/schemas/resource_booking_report/properties/budget_id" contains: "$ref": "#/components/schemas/resource_booking_report/properties/budget_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated budget. patternProperties: "^task..*$": title: Task relationship "^event..*$": title: Event relationship "^person..*$": title: Person relationship "^booking..*$": title: Booking relationship "^service..*$": title: Service relationship description: Available filter parameters for querying aggregated booking report data. filter_pipeline: type: object title: Filter pipeline properties: pipeline_type_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_pipeline/properties/pipeline_type_id" not_contain: "$ref": "#/components/schemas/resource_pipeline/properties/pipeline_type_id" contains: "$ref": "#/components/schemas/resource_pipeline/properties/pipeline_type_id" eq: "$ref": "#/components/schemas/resource_pipeline/properties/pipeline_type_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_pipeline/properties/pipeline_type_id" description: Filter by pipeline type ID. patternProperties: {} description: Filter parameters for listing pipelines. Supports filtering by name, type (sales or production), and position. Standard string and ID operators apply. resource_deal_status: type: object title: Deal status Resource properties: probability: type: integer title: Probability description: The default win probability percentage for deals in this stage. archived_at: type: string title: Archived At format: date-time description: Timestamp when the pipeline stage was archived, or null if active. query: type: string title: Query description: A saved filter query string applied to this pipeline stage view. booking_tracking_enabled: type: boolean title: Booking Tracking Enabled description: When true, bookings can be tracked for deals in this pipeline stage. pipeline_type_id: enum: - 1 - 2 type: integer title: Pipeline Type description: Numeric identifier for the pipeline type (1 = sales, 2 = production). time_tracking_enabled: type: boolean title: Time Tracking Enabled description: When true, time entries can be logged for deals in this pipeline stage. color_id: type: integer title: Color description: The color ID used to visually distinguish this pipeline stage. name: type: string title: Name description: The display name of the pipeline stage. pipeline: title: Pipeline description: The pipeline this stage belongs to. probability_enabled: type: boolean title: Probability Enabled description: When true, win probability is tracked for deals in this pipeline stage. created_at: title: Created At description: Timestamp when this pipeline stage was created. position: type: integer title: Position description: The display order position of this stage within the pipeline. status_id: enum: - 1 - 2 - 3 - 4 type: integer title: Status description: Numeric identifier for the outcome status of this stage (e.g. open, won, lost, delivered). lost_reason_enabled: type: boolean title: Lost Reason Enabled description: When true, a lost reason must be provided when a deal is moved to this stage. id: type: integer title: Id description: Unique identifier for the pipeline stage. expense_tracking_enabled: type: boolean title: Expense Tracking Enabled description: When true, expenses can be tracked for deals in this pipeline stage. used: type: boolean title: Used description: Indicates whether any deals are currently in this pipeline stage. organization: title: Organization description: The organization this pipeline stage belongs to. pipeline_id: type: integer title: Pipeline description: The ID of the pipeline this stage belongs to. description: Pipeline stage defining the outcome and tracking capabilities for deals in that stage. The status_id determines outcome category (open/won/lost/delivered). Optional flags enable time, expense, and booking tracking, probability estimation, and lost reason capture. filter_integration: type: object title: Filter integration properties: jira_organization: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_integration/properties/jira_organization" not_eq: "$ref": "#/components/schemas/resource_integration/properties/jira_organization" not_contain: "$ref": "#/components/schemas/resource_integration/properties/jira_organization" contains: "$ref": "#/components/schemas/resource_integration/properties/jira_organization" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_integration/properties/jira_organization" description: Filter by Jira organization name or key (Jira integrations only). subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_integration/properties/subsidiary_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_integration/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_integration/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_integration/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_integration/properties/subsidiary_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated subsidiary. project_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_integration/properties/project_id" contains: "$ref": "#/components/schemas/resource_integration/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_integration/properties/project_id" eq: "$ref": "#/components/schemas/resource_integration/properties/project_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_integration/properties/project_id" description: Filter by the associated project. integration_type_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_integration/properties/integration_type_id" not_contain: "$ref": "#/components/schemas/resource_integration/properties/integration_type_id" contains: "$ref": "#/components/schemas/resource_integration/properties/integration_type_id" eq: "$ref": "#/components/schemas/resource_integration/properties/integration_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_integration/properties/integration_type_id" description: Filter by integration type ID (e.g. Jira, Slack, QuickBooks). deal_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_integration/properties/deal_id" contains: "$ref": "#/components/schemas/resource_integration/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_integration/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_integration/properties/deal_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_integration/properties/deal_id" description: Filter by the associated deal. jira_project: oneOf: - "$ref": "#/components/schemas/resource_integration/properties/jira_project" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_integration/properties/jira_project" contains: "$ref": "#/components/schemas/resource_integration/properties/jira_project" not_contain: "$ref": "#/components/schemas/resource_integration/properties/jira_project" eq: "$ref": "#/components/schemas/resource_integration/properties/jira_project" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by Jira project key (Jira integrations only). project_status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_integration/properties/project_status" eq: "$ref": "#/components/schemas/resource_integration/properties/project_status" not_eq: "$ref": "#/components/schemas/resource_integration/properties/project_status" contains: "$ref": "#/components/schemas/resource_integration/properties/project_status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_integration/properties/project_status" description: Filter by project status (e.g. active, archived). patternProperties: {} description: Available filter parameters for querying integration records. resource_custom_field_option: type: object title: Custom field option Resource properties: position: type: integer title: Position description: The sort order of this option within the custom field's option list. archived_at: type: string title: Archived At format: date-time description: Timestamp when this option was archived, or null if not archived. custom_field: title: Custom Field description: The custom field this option belongs to. archived: type: boolean title: Archived description: Whether this custom field option has been archived and is no longer available for selection. color_id: type: integer title: Color description: ID of the color associated with this option for visual identification. custom_field_id: type: integer title: Custom Field description: ID of the custom field this option belongs to. organization: title: Organization description: The organization this custom field option belongs to. name: type: string title: Name description: The display label for this custom field option. description: Selectable option for a dropdown or multi-select custom field. Supports a name, position ordering, color, and archiving. Archived options remain on existing records but are hidden from new selections. resource_integration_exporter_configuration: type: object title: Integration exporter configuration Resource properties: company_type: enum: - client - vendor - both type: string title: Company Type description: The type of company record used in the accounting integration, such as customer or vendor. datev_client_account_code: title: Datev Client Account Code description: The datev client account code. company_id: type: integer title: Company description: ID of the company (client) this exporter configuration applies to. company: title: Company description: The company (client) this exporter configuration applies to. client_id: title: Client description: ID of the company (client) this exporter configuration applies to. datev_vendor_account_code: title: Datev Vendor Account Code description: The datev vendor account code. organization: title: Organization description: The organization this exporter configuration belongs to. description: The resource integration exporter configuration. resource_user: type: object title: User Resource properties: newsletter_consent_at: type: string title: Newsletter Consent At format: date-time description: Timestamp when the user gave newsletter consent, or null if not consented. email: type: string title: Email description: The email address used to log in to Productive. default_organization_slug: title: Default Organization Slug description: URL slug of the user's default organization. flags: type: object title: Flags description: Feature flag overrides applied to this user's account. avatar_url: type: string title: Avatar Url description: URL of the user's profile avatar image. ical_token: type: string title: Ical Token description: Authentication token used to access this user's iCal calendar feed. newsletter_consent: title: Newsletter Consent description: When true, the user has consented to receive marketing newsletters. last_name: type: string title: Last Name description: The last name of the user. updated_at: type: string title: Updated At format: date-time description: Timestamp when this user was last updated. intercom_hash: title: Intercom Hash description: HMAC hash used to verify this user's identity with Intercom. default_organization_id: type: integer title: Default Organization description: ID of the organization this user logs into by default. sysadmin: type: boolean title: Sysadmin description: When true, this user has system administrator privileges. account_access_expires_at: type: string title: Account Access Expires At format: date-time description: The account access expires at. preferences: type: string title: Preferences description: User interface preferences and settings stored as key-value pairs. locale: enum: - en_US - de_DE - fr_FR - es_ES - it_IT type: string title: Locale description: The preferred language locale for this user's interface. two_factor_auth: type: boolean title: Two Factor Auth description: When true, two-factor authentication is enabled for this user. sso_provision: type: boolean title: Sso Provision description: When true, this user account was provisioned via single sign-on. time_zone: type: string title: Time Zone description: The IANA time zone identifier for this user's preferred time zone. first_name: type: string title: First Name description: The first name of the user. sysadmin_permissions: type: object title: Sysadmin Permissions description: The specific system administrator permissions granted to this user. description: A user represents a login account in Productive, holding authentication credentials and preferences. It is distinct from a person, which represents the employee profile linked to an organization. filter_timesheet: type: object title: Filter timesheet properties: person_id: oneOf: - "$ref": "#/components/schemas/resource_timesheet/properties/person_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_timesheet/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_timesheet/properties/person_id" eq: "$ref": "#/components/schemas/resource_timesheet/properties/person_id" contains: "$ref": "#/components/schemas/resource_timesheet/properties/person_id" description: Filter using explicit operator syntax. description: Filter by the associated person. creator_id: oneOf: - "$ref": "#/components/schemas/resource_timesheet/properties/creator_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_timesheet/properties/creator_id" contains: "$ref": "#/components/schemas/resource_timesheet/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_timesheet/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_timesheet/properties/creator_id" description: Filter using explicit operator syntax. description: Filter by the person who created the timesheet. date: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_timesheet/properties/date" contains: "$ref": "#/components/schemas/resource_timesheet/properties/date" eq: "$ref": "#/components/schemas/resource_timesheet/properties/date" not_contain: "$ref": "#/components/schemas/resource_timesheet/properties/date" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_timesheet/properties/date" description: Filter by the timesheet date. patternProperties: "^person..*$": title: Person relationship "^creator..*$": title: Creator relationship description: Filter parameters for listing timesheet resources, which group a person's time entries for a given week for approval. resource_automatic_invoicing_rule: type: object title: Automatic invoicing rule Resource properties: created_at: title: Created At description: Timestamp when the automatic invoicing rule was created. creator_id: type: integer title: Creator description: The ID of the person who created this automatic invoicing rule. budget_id: type: integer title: Budget description: The ID of the budget this automatic invoicing rule applies to. next_invoice_date: type: string title: Next Invoice Date format: date description: The next scheduled date on which an invoice draft will be automatically created. creator: title: Creator description: The person who created this automatic invoicing rule. reference_date: enum: - start_date - end_date type: string title: Reference Date description: The reference date used to calculate when invoices are created (e.g. period_start, period_end). creation_offset_unit: enum: - day - week - month type: string title: Creation Offset Unit description: The time unit for the creation offset (e.g. days, weeks, months). id: type: integer title: Id description: Unique identifier for the automatic invoicing rule. organization: title: Organization description: The organization this automatic invoicing rule belongs to. creation_offset: type: integer title: Creation Offset description: Number of time units to offset invoice creation from the reference date. budget: title: Budget description: The budget this automatic invoicing rule applies to. skip_weekends: type: boolean title: Skip Weekends description: When true, invoice creation is shifted to the next working day if the scheduled date falls on a weekend. description: An automatic invoicing rule defines when invoice drafts are automatically created for a budget. _filter_root_webhook: oneOf: - "$ref": "#/components/schemas/filter_webhook" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_webhook" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `webhook` list endpoints — pass a single condition or a logical group. _filter_root_expense_report: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_expense_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_expense_report" description: Filter schema for `expense_report` list endpoints — pass a single condition or a logical group. filter_approval_policy_assignment: type: object title: Filter approval policy assignment properties: target_id: oneOf: - "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_id" not_eq: "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_id" not_contain: "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_id" contains: "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_id" description: Filter using explicit operator syntax. description: Filter by the ID of the assigned target (person or deal/budget). target_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_type" not_contain: "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_type" contains: "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_type" not_eq: "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_type" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_type" description: Filter by the type of the assigned target (person, deal, or budget). patternProperties: {} description: Filter schema for approval_policy_assignment resources. resource_filter: type: object title: Filter Resource properties: id: type: string title: Id description: The unique identifier of this filter, expressed as a slug combining the numeric ID, filterable type, and collection. memberships: title: Memberships description: People or teams who have been granted access to this shared filter. sort_by: type: string title: Sort By description: The field identifier used to sort results in this filter's view. exchange_date: type: object title: Exchange Date description: A JSON object defining the date or date range used for currency exchange rate lookups in this filter. filterable_type: type: string title: Filterable Type description: The type of resource this filter is scoped to (e.g. projects), or null for organization-wide filters. filterable_id: type: integer title: Filterable description: ID of the specific resource (e.g. a project) this filter is scoped to, or null for organization-wide filters. public: type: boolean title: Public description: Whether this filter is visible to all members of the organization. last_pulse_sent_at: type: string title: Last Pulse Sent At format: date-time description: Timestamp when the last pulse notification was sent for this filter. original_id: type: integer title: Original description: The internal numeric ID of this filter, as opposed to the slug-based id field. report_category: title: Report Category description: The report category this filter belongs to. export_params: type: object title: Export Params description: A JSON object containing additional parameters used when exporting data from this filter. type_id: enum: - 1 - 2 - 3 type: integer title: Type description: ID of the filter type, indicating whether this is a saved view, a report, or a widget. pulse: type: boolean title: Pulse description: The pulse notification associated with this filter, if any. group_by: type: string title: Group By description: The field identifier used to group results in this filter's view. filterable_collection: type: string title: Filterable Collection description: The collection of resources (e.g. tasks, bookings) that this filter applies to. columns: type: string title: Columns description: An ordered list of column identifiers defining which columns are visible in this filter's list view. creator_id: type: integer title: Creator description: ID of the person who created this filter. created_at: type: string title: Created At format: date-time description: Timestamp when this filter was created. last_accessed_at: type: string title: Last Accessed At format: date description: Timestamp when this filter was last accessed by any user. column_settings: type: string title: Column Settings description: A JSON object containing per-column display settings such as width and visibility. creator: title: Creator description: The person who created this filter. settings: type: string title: Settings description: A JSON object containing miscellaneous UI settings for this filter, such as collapsed state or display preferences. updated_at: type: string title: Updated At format: date-time description: Timestamp when this filter was last updated. pulse_count: title: Pulse Count description: The number of unread pulse notifications for the current user on this report filter. formulas: type: string title: Formulas description: Custom formula definitions used to compute derived values in report-type filters. exchange_currency: type: string title: Exchange Currency description: The currency used for exchange rate conversions when this filter displays monetary values. hidden: type: boolean title: Hidden description: Whether this filter is hidden from the navigation sidebar. report: type: boolean title: Report description: Indicates whether this saved filter is of report type. organization: title: Organization description: The organization this filter belongs to. default: title: Default description: Whether this filter is the default view loaded when navigating to the associated resource list. transpose_by: type: string title: Transpose By description: The field identifier used to pivot or transpose data in report-type filters. project_id: type: integer title: Project description: ID of the project this filter is scoped to, when filterable_type is projects. predefined_id: type: string title: Predefined description: The identifier of the predefined system filter this was created from, if applicable. report_layout_id: type: integer title: Report Layout description: ID of the report layout used by this filter. report_category_id: type: integer title: Report Category description: ID of the report category this filter belongs to. chart_type_id: type: integer title: Chart Type description: ID of the chart visualization type used when displaying this filter as a report chart. last_viewed_at: type: string title: Last Viewed At format: date-time description: Timestamp when this filter was last viewed by the current user. shared: type: boolean title: Shared description: Whether this filter has been shared with specific people or teams via memberships. layout_id: type: integer title: Layout description: ID of the layout mode used to display this filter (e.g. list, board, timeline). name: type: string title: Name description: The display name of this filter. query: type: string title: Query description: A text search query applied as an additional keyword filter when loading results. params: type: string title: Params description: A hash of filter criteria (field/value pairs) that define what records this filter matches. description: A saved view configuration containing filters, sorters, column layout, and optional report aggregation settings. _filter_root_revenue_distribution: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_revenue_distribution" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_revenue_distribution" description: Filter schema for `revenue_distribution` list endpoints — pass a single condition or a logical group. _filter_root_project_assignment: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_project_assignment" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_project_assignment" description: Filter schema for `project_assignment` list endpoints — pass a single condition or a logical group. _filter_root_service_assignment: oneOf: - "$ref": "#/components/schemas/filter_service_assignment" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_service_assignment" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `service_assignment` list endpoints — pass a single condition or a logical group. resource_webhook: type: object title: Webhook Resource properties: name: type: string title: Name description: The display name of this webhook. event_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 - 32 - 33 - 34 - 35 type: integer title: Event description: The event type that triggers this webhook. organization: title: Organization description: The organization this webhook belongs to. test: type: boolean title: Test description: When true, this webhook is in test mode and will not fire on real events. id: type: integer title: Id description: The unique identifier of this webhook. target_url: type: string title: Target Url description: The URL where webhook event payloads are delivered. custom_headers: type: object title: Custom Headers description: Custom HTTP headers to include in each webhook delivery request. type_id: enum: - 1 - 2 type: integer title: Type description: 'The integration type of this webhook: 1=Webhook, 2=Zapier.' deactivated_at: type: string title: Deactivated At format: date-time description: Timestamp when this webhook was deactivated, or null if still active. retry_attempts: type: integer title: Retry Attempts description: The number of retry attempts made after a failed delivery. signature_token: type: string title: Signature Token description: Secret token used to sign webhook payloads for verification by the recipient. state_id: enum: - 1 - 2 - 3 type: integer title: State description: 'The current delivery state of this webhook: 1=Working, 2=Issues, 3=Waiting.' creator: title: Creator description: The person who created this webhook. description: A webhook is an HTTP callback configured to fire when specific events occur in Productive, delivering real-time event notifications to an external target URL. filter_exchange_rate: type: object title: Filter exchange rate properties: date: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_exchange_rate/properties/date" not_contain: "$ref": "#/components/schemas/resource_exchange_rate/properties/date" eq: "$ref": "#/components/schemas/resource_exchange_rate/properties/date" contains: "$ref": "#/components/schemas/resource_exchange_rate/properties/date" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_exchange_rate/properties/date" description: Filter by exchange rate date. out_of_date: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_exchange_rate/properties/out_of_date" contains: "$ref": "#/components/schemas/resource_exchange_rate/properties/out_of_date" not_eq: "$ref": "#/components/schemas/resource_exchange_rate/properties/out_of_date" not_contain: "$ref": "#/components/schemas/resource_exchange_rate/properties/out_of_date" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_exchange_rate/properties/out_of_date" description: Filter to include only exchange rates that are out of date (i.e. not reflecting the latest rates). patternProperties: {} description: Filter parameters for exchange rates. _filter_root_expense: oneOf: - "$ref": "#/components/schemas/filter_expense" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_expense" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `expense` list endpoints — pass a single condition or a logical group. filter_service_report: type: object title: Filter service report properties: budget_total: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/budget_total" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/budget_total" eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_total" contains: "$ref": "#/components/schemas/resource_service_report/properties/budget_total" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_total" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total budget amount range. unit: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/unit" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/unit" contains: "$ref": "#/components/schemas/resource_service_report/properties/unit" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/unit" description: Filter operator object for unit. - "$ref": "#/components/schemas/resource_service_report/properties/unit" description: Filter service report results by unit. discount_amount: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/discount_amount" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/discount_amount" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/discount_amount" contains: "$ref": "#/components/schemas/resource_service_report/properties/discount_amount" eq: "$ref": "#/components/schemas/resource_service_report/properties/discount_amount" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by discount amount range. future_booked_time: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/future_booked_time" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/future_booked_time" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/future_booked_time" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/future_booked_time" eq: "$ref": "#/components/schemas/resource_service_report/properties/future_booked_time" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total future booked time (upcoming bookings) in minutes. section_id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/section_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/section_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/section_id" eq: "$ref": "#/components/schemas/resource_service_report/properties/section_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/section_id" description: Filter operator object for section id. description: Filter service report results by section id. billable: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/billable" contains: "$ref": "#/components/schemas/resource_service_report/properties/billable" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/billable" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/billable" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/billable" description: Filter by whether the service is billable (true) or non-billable (false). bookable_after: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/bookable_after" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/bookable_after" eq: "$ref": "#/components/schemas/resource_service_report/properties/bookable_after" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/bookable_after" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/bookable_after" description: Filter to services bookable after the given date within the associated budget period. subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/subsidiary_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/subsidiary_id" description: Filter operator object for subsidiary id. description: Filter service report results by subsidiary id. worked_time: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/worked_time" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/worked_time" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/worked_time" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/worked_time" contains: "$ref": "#/components/schemas/resource_service_report/properties/worked_time" description: Filter operator object for worked time. description: Filter service report results by worked time. sales_status_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/sales_status_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/sales_status_id" eq: "$ref": "#/components/schemas/resource_service_report/properties/sales_status_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/sales_status_id" description: Filter operator object for sales status id. - "$ref": "#/components/schemas/resource_service_report/properties/sales_status_id" description: Filter service report results by sales status id. price: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/price" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/price" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/price" eq: "$ref": "#/components/schemas/resource_service_report/properties/price" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/price" description: Filter by service price range. expense_tracking_enabled: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/expense_tracking_enabled" contains: "$ref": "#/components/schemas/resource_service_report/properties/expense_tracking_enabled" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/expense_tracking_enabled" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/expense_tracking_enabled" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/expense_tracking_enabled" description: Filter by whether expense tracking is enabled on the service. probability: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/probability" contains: "$ref": "#/components/schemas/resource_service_report/properties/probability" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/probability" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/probability" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/probability" description: Filter by the associated deal's probability of closing (as a percentage). worked_cost: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/worked_cost" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/worked_cost" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/worked_cost" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/worked_cost" eq: "$ref": "#/components/schemas/resource_service_report/properties/worked_cost" description: Filter operator object for worked cost. description: Filter service report results by worked cost. trackable_by_person_id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/trackable_by_person_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/trackable_by_person_id" eq: "$ref": "#/components/schemas/resource_service_report/properties/trackable_by_person_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/trackable_by_person_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/trackable_by_person_id" description: Filter operator object for trackable by person id. description: Filter service report results by trackable by person id. deal_status_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/deal_status_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/deal_status_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/deal_status_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/deal_status_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/deal_status_id" description: Filter by the associated deal status (pipeline stage). for_tracking: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/for_tracking" contains: "$ref": "#/components/schemas/resource_service_report/properties/for_tracking" eq: "$ref": "#/components/schemas/resource_service_report/properties/for_tracking" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/for_tracking" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/for_tracking" description: Filter to services that the current person is allowed to track time against. expense_cost: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/expense_cost" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/expense_cost" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/expense_cost" eq: "$ref": "#/components/schemas/resource_service_report/properties/expense_cost" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/expense_cost" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total expense cost range. remaining_scheduled_time: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/remaining_scheduled_time" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/remaining_scheduled_time" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/remaining_scheduled_time" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/remaining_scheduled_time" eq: "$ref": "#/components/schemas/resource_service_report/properties/remaining_scheduled_time" description: Filter operator object for remaining scheduled time. description: Filter service report results by remaining scheduled time. company_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/company_id" eq: "$ref": "#/components/schemas/resource_service_report/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/company_id" description: Filter by client company. with_memberships: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/with_memberships" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/with_memberships" contains: "$ref": "#/components/schemas/resource_service_report/properties/with_memberships" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/with_memberships" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/with_memberships" description: Filter operator object for with memberships. description: Filter service report results by with memberships. stage_status_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/stage_status_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/stage_status_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/stage_status_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/stage_status_id" description: Filter operator object for stage status id. - "$ref": "#/components/schemas/resource_service_report/properties/stage_status_id" description: Filter service report results by stage status id. initial_service_id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/initial_service_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/initial_service_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/initial_service_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/initial_service_id" eq: "$ref": "#/components/schemas/resource_service_report/properties/initial_service_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the ID of the original service this one was created from (retainer rollover). bookable_before: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/bookable_before" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/bookable_before" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/bookable_before" contains: "$ref": "#/components/schemas/resource_service_report/properties/bookable_before" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/bookable_before" description: Filter to services whose budget period ends before the given date. profit: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/profit" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/profit" eq: "$ref": "#/components/schemas/resource_service_report/properties/profit" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/profit" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/profit" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the profit of the service — revenue minus cost. name: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/name" eq: "$ref": "#/components/schemas/resource_service_report/properties/name" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/name" contains: "$ref": "#/components/schemas/resource_service_report/properties/name" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/name" description: Filter by service name (text search). template: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/template" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/template" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/template" eq: "$ref": "#/components/schemas/resource_service_report/properties/template" contains: "$ref": "#/components/schemas/resource_service_report/properties/template" description: Filter operator object for template. description: Filter service report results by template. explicit_access: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/explicit_access" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/explicit_access" contains: "$ref": "#/components/schemas/resource_service_report/properties/explicit_access" eq: "$ref": "#/components/schemas/resource_service_report/properties/explicit_access" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/explicit_access" description: Filter services to only those the current user has explicit (non-implicit) access permissions on. budget_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/budget_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/budget_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/budget_id" description: Filter by the associated budget ID. task_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/task_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/task_id" eq: "$ref": "#/components/schemas/resource_service_report/properties/task_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/task_id" description: Filter operator object for task id. - "$ref": "#/components/schemas/resource_service_report/properties/task_id" description: Filter service report results by task id. bookable_date: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/bookable_date" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/bookable_date" contains: "$ref": "#/components/schemas/resource_service_report/properties/bookable_date" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/bookable_date" eq: "$ref": "#/components/schemas/resource_service_report/properties/bookable_date" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter to services whose budget period includes the given date. discount: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/discount" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/discount" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/discount" contains: "$ref": "#/components/schemas/resource_service_report/properties/discount" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/discount" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the service's discount percentage range. budgets_and_deals: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/budgets_and_deals" eq: "$ref": "#/components/schemas/resource_service_report/properties/budgets_and_deals" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/budgets_and_deals" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/budgets_and_deals" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/budgets_and_deals" description: When true, includes services from both deals and budgets. profit_margin: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/profit_margin" contains: "$ref": "#/components/schemas/resource_service_report/properties/profit_margin" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/profit_margin" eq: "$ref": "#/components/schemas/resource_service_report/properties/profit_margin" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/profit_margin" description: Filter by the profit margin of the service — profit divided by revenue. project_type: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/project_type" eq: "$ref": "#/components/schemas/resource_service_report/properties/project_type" contains: "$ref": "#/components/schemas/resource_service_report/properties/project_type" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/project_type" description: Filter operator object for project type. - "$ref": "#/components/schemas/resource_service_report/properties/project_type" description: Filter service report results by project type. revenue: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/revenue" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/revenue" contains: "$ref": "#/components/schemas/resource_service_report/properties/revenue" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/revenue" description: Filter operator object for revenue. - "$ref": "#/components/schemas/resource_service_report/properties/revenue" description: Filter service report results by revenue. projected_revenue: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/projected_revenue" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/projected_revenue" contains: "$ref": "#/components/schemas/resource_service_report/properties/projected_revenue" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/projected_revenue" description: Filter operator object for projected revenue. - "$ref": "#/components/schemas/resource_service_report/properties/projected_revenue" description: Filter service report results by projected revenue. formulas: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/formulas" contains: "$ref": "#/components/schemas/resource_service_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_service_report/properties/formulas" description: Operator object — supports contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/formulas" description: Filter by custom formula values defined for the report. unapproved_time: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/unapproved_time" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/unapproved_time" eq: "$ref": "#/components/schemas/resource_service_report/properties/unapproved_time" contains: "$ref": "#/components/schemas/resource_service_report/properties/unapproved_time" description: Filter operator object for unapproved time. - "$ref": "#/components/schemas/resource_service_report/properties/unapproved_time" description: Filter service report results by unapproved time. origin_deal_id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/origin_deal_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/origin_deal_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/origin_deal_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/origin_deal_id" eq: "$ref": "#/components/schemas/resource_service_report/properties/origin_deal_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the deal this service's budget originated from. estimated_time: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/estimated_time" eq: "$ref": "#/components/schemas/resource_service_report/properties/estimated_time" contains: "$ref": "#/components/schemas/resource_service_report/properties/estimated_time" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/estimated_time" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/estimated_time" description: Filter by estimated time range (in minutes). custom_fields: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/custom_fields" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_service_report/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by service-level custom field values. quantity: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/quantity" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/quantity" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/quantity" contains: "$ref": "#/components/schemas/resource_service_report/properties/quantity" description: Filter operator object for quantity. - "$ref": "#/components/schemas/resource_service_report/properties/quantity" description: Filter service report results by quantity. future_budget_used: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/future_budget_used" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/future_budget_used" contains: "$ref": "#/components/schemas/resource_service_report/properties/future_budget_used" eq: "$ref": "#/components/schemas/resource_service_report/properties/future_budget_used" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/future_budget_used" description: Filter by the total future budget spent on the service, calculated from resourcing. type: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/type" eq: "$ref": "#/components/schemas/resource_service_report/properties/type" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/type" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/type" description: Filter operator object for type. - "$ref": "#/components/schemas/resource_service_report/properties/type" description: Filter service report results by type. deal_stage_id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/deal_stage_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/deal_stage_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/deal_stage_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/deal_stage_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/deal_stage_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by deal stage (deprecated; use deal_status_id instead). budgeted_time: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/budgeted_time" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/budgeted_time" eq: "$ref": "#/components/schemas/resource_service_report/properties/budgeted_time" contains: "$ref": "#/components/schemas/resource_service_report/properties/budgeted_time" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/budgeted_time" description: Filter by the service's budgeted time (in minutes). billing_type: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/billing_type" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/billing_type" eq: "$ref": "#/components/schemas/resource_service_report/properties/billing_type" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/billing_type" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/billing_type" description: Filter by billing type (hourly, fixed, non-billable, etc.). budget_used: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_used" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/budget_used" contains: "$ref": "#/components/schemas/resource_service_report/properties/budget_used" eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_used" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/budget_used" description: Filter by amount of budget already used. pipeline_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/pipeline_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/pipeline_id" eq: "$ref": "#/components/schemas/resource_service_report/properties/pipeline_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/pipeline_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/pipeline_id" description: Filter by the ID of the pipeline the service's deal belongs to. booked_time: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/booked_time" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/booked_time" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/booked_time" contains: "$ref": "#/components/schemas/resource_service_report/properties/booked_time" eq: "$ref": "#/components/schemas/resource_service_report/properties/booked_time" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total time booked (scheduled) on the service. after: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/after" eq: "$ref": "#/components/schemas/resource_service_report/properties/after" contains: "$ref": "#/components/schemas/resource_service_report/properties/after" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/after" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/after" description: Filter by the bookable date of the service — services bookable after this date. contract_id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/contract_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/contract_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/contract_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/contract_id" eq: "$ref": "#/components/schemas/resource_service_report/properties/contract_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated contract ID. cost: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/cost" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/cost" eq: "$ref": "#/components/schemas/resource_service_report/properties/cost" contains: "$ref": "#/components/schemas/resource_service_report/properties/cost" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/cost" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by work cost (labor cost) range. bookable_date_for_period: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/bookable_date_for_period" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/bookable_date_for_period" eq: "$ref": "#/components/schemas/resource_service_report/properties/bookable_date_for_period" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/bookable_date_for_period" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/bookable_date_for_period" description: Filter services that are bookable on the given date (falls within the service's bookable period). markup: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/markup" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/markup" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/markup" eq: "$ref": "#/components/schemas/resource_service_report/properties/markup" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/markup" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the service's markup percentage range. deal_custom_fields: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/deal_custom_fields" eq: "$ref": "#/components/schemas/resource_service_report/properties/deal_custom_fields" contains: "$ref": "#/components/schemas/resource_service_report/properties/deal_custom_fields" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/deal_custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/deal_custom_fields" description: Filter by deal-level custom field values. query: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/query" eq: "$ref": "#/components/schemas/resource_service_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/query" contains: "$ref": "#/components/schemas/resource_service_report/properties/query" description: Filter operator object for query. description: Filter service report results by query. budget_date: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/budget_date" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_date" eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_date" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/budget_date" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/budget_date" description: Filter by the start date of the associated budget. markup_amount: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/markup_amount" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/markup_amount" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/markup_amount" contains: "$ref": "#/components/schemas/resource_service_report/properties/markup_amount" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/markup_amount" description: Filter by markup amount range. budget_remaining: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_remaining" contains: "$ref": "#/components/schemas/resource_service_report/properties/budget_remaining" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/budget_remaining" eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_remaining" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/budget_remaining" description: Filter by remaining budget amount (budget total minus budget used) in the deal currency. responsible_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/responsible_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/responsible_id" description: Filter operator object for responsible id. - "$ref": "#/components/schemas/resource_service_report/properties/responsible_id" description: Filter service report results by responsible id. person_id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/person_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/person_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/person_id" eq: "$ref": "#/components/schemas/resource_service_report/properties/person_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter to services accessible to the specified person for time tracking. project_id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/project_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/project_id" eq: "$ref": "#/components/schemas/resource_service_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/project_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated project. time_tracking_enabled: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/time_tracking_enabled" eq: "$ref": "#/components/schemas/resource_service_report/properties/time_tracking_enabled" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/time_tracking_enabled" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/time_tracking_enabled" description: Filter operator object for time tracking enabled. - "$ref": "#/components/schemas/resource_service_report/properties/time_tracking_enabled" description: Filter service report results by time tracking enabled. booking_tracking_enabled: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/booking_tracking_enabled" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/booking_tracking_enabled" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/booking_tracking_enabled" eq: "$ref": "#/components/schemas/resource_service_report/properties/booking_tracking_enabled" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/booking_tracking_enabled" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether booking tracking is enabled on the service. revamped_unit: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/revamped_unit" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/revamped_unit" eq: "$ref": "#/components/schemas/resource_service_report/properties/revamped_unit" contains: "$ref": "#/components/schemas/resource_service_report/properties/revamped_unit" description: Filter operator object for revamped unit. - "$ref": "#/components/schemas/resource_service_report/properties/revamped_unit" description: Filter service report results by revamped unit. deal_id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/deal_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/deal_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/deal_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated deal or budget. before: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/before" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/before" eq: "$ref": "#/components/schemas/resource_service_report/properties/before" contains: "$ref": "#/components/schemas/resource_service_report/properties/before" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/before" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the bookable date of the service — services bookable before this date. budget_custom_fields: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_custom_fields" contains: "$ref": "#/components/schemas/resource_service_report/properties/budget_custom_fields" eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_custom_fields" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/budget_custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/budget_custom_fields" description: Filter by budget-level custom field values. service_type_id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/service_type_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_service_report/properties/service_type_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/service_type_id" description: Filter operator object for service type id. description: Filter service report results by service type id. origin_service_id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/origin_service_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/origin_service_id" contains: "$ref": "#/components/schemas/resource_service_report/properties/origin_service_id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/origin_service_id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/origin_service_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the service this service was copied or derived from. estimated_cost: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/estimated_cost" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/estimated_cost" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/estimated_cost" eq: "$ref": "#/components/schemas/resource_service_report/properties/estimated_cost" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/estimated_cost" description: Filter by estimated cost range. stage_type: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/stage_type" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/stage_type" contains: "$ref": "#/components/schemas/resource_service_report/properties/stage_type" eq: "$ref": "#/components/schemas/resource_service_report/properties/stage_type" description: Filter operator object for stage type. - "$ref": "#/components/schemas/resource_service_report/properties/stage_type" description: Filter service report results by stage type. id: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/id" eq: "$ref": "#/components/schemas/resource_service_report/properties/id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by service ID. limitation_type: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/limitation_type" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_report/properties/limitation_type" contains: "$ref": "#/components/schemas/resource_service_report/properties/limitation_type" eq: "$ref": "#/components/schemas/resource_service_report/properties/limitation_type" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/limitation_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the limitation type of the service — e.g. hours, amount, or none. rolled_over_time: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/rolled_over_time" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/rolled_over_time" contains: "$ref": "#/components/schemas/resource_service_report/properties/rolled_over_time" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/rolled_over_time" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/rolled_over_time" description: Filter operator object for rolled over time. description: Filter service report results by rolled over time. projectless_budgets: oneOf: - "$ref": "#/components/schemas/resource_service_report/properties/projectless_budgets" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/projectless_budgets" eq: "$ref": "#/components/schemas/resource_service_report/properties/projectless_budgets" contains: "$ref": "#/components/schemas/resource_service_report/properties/projectless_budgets" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/projectless_budgets" description: Filter operator object for projectless budgets. description: Filter service report results by projectless budgets. billable_time: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/billable_time" contains: "$ref": "#/components/schemas/resource_service_report/properties/billable_time" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/billable_time" eq: "$ref": "#/components/schemas/resource_service_report/properties/billable_time" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/billable_time" description: Filter by total billable time logged against the service (in minutes). updated_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_service_report/properties/updated_at" eq: "$ref": "#/components/schemas/resource_service_report/properties/updated_at" contains: "$ref": "#/components/schemas/resource_service_report/properties/updated_at" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/updated_at" description: Filter operator object for updated at. - "$ref": "#/components/schemas/resource_service_report/properties/updated_at" description: Filter service report results by updated at. recognized_revenue: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/recognized_revenue" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/recognized_revenue" contains: "$ref": "#/components/schemas/resource_service_report/properties/recognized_revenue" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/recognized_revenue" description: Filter operator object for recognized revenue. - "$ref": "#/components/schemas/resource_service_report/properties/recognized_revenue" description: Filter service report results by recognized revenue. budget_status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/budget_status" eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_status" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/budget_status" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/budget_status" description: Filter by the status of the budget the service belongs to — open or delivered. budget_cap_enabled: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_cap_enabled" contains: "$ref": "#/components/schemas/resource_service_report/properties/budget_cap_enabled" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/budget_cap_enabled" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/budget_cap_enabled" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/budget_cap_enabled" description: Filter by whether a budget cap is enabled on the service. left_to_schedule_time: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_report/properties/left_to_schedule_time" not_contain: "$ref": "#/components/schemas/resource_service_report/properties/left_to_schedule_time" not_eq: "$ref": "#/components/schemas/resource_service_report/properties/left_to_schedule_time" eq: "$ref": "#/components/schemas/resource_service_report/properties/left_to_schedule_time" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_service_report/properties/left_to_schedule_time" description: Filter by the time remaining to schedule on the service — estimated minus already scheduled. patternProperties: "^deal..*$": title: Deal relationship "^budget..*$": title: Budget relationship "^section..*$": title: Section relationship "^bookings..*$": title: Bookings relationship "^service_type..*$": title: Service type relationship description: Available filter parameters for querying aggregated service report data. resource_document_style: type: object title: Document style Resource properties: styles: type: object title: Styles description: A JSON object containing the CSS and layout settings that define the visual appearance of documents using this style. attachments: title: Attachments description: Attachments (e.g. logo images) used as branding assets for this document style. attachment_ids: title: Attachment Ids description: IDs of attachments (e.g. logo images) associated with this document style. id: type: integer title: Id description: The unique identifier of this document style. name: type: string title: Name description: The display name of this document style. organization: title: Organization description: The organization this document style belongs to. description: A visual styling preset for documents such as proposals and contracts, containing CSS styles and branding assets. filter_price_report: type: object title: Filter price report properties: expense_tracking_enabled: oneOf: - "$ref": "#/components/schemas/resource_price_report/properties/expense_tracking_enabled" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_price_report/properties/expense_tracking_enabled" contains: "$ref": "#/components/schemas/resource_price_report/properties/expense_tracking_enabled" not_eq: "$ref": "#/components/schemas/resource_price_report/properties/expense_tracking_enabled" eq: "$ref": "#/components/schemas/resource_price_report/properties/expense_tracking_enabled" description: Filter operator object for expense tracking enabled. description: Filter price report results by expense tracking enabled. custom_fields: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_price_report/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_price_report/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_price_report/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_price_report/properties/custom_fields" description: Filter operator object for custom fields. - "$ref": "#/components/schemas/resource_price_report/properties/custom_fields" description: Filter price report results by custom fields. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_price_report/properties/id" contains: "$ref": "#/components/schemas/resource_price_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_price_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_price_report/properties/id" description: Filter operator object for id. - "$ref": "#/components/schemas/resource_price_report/properties/id" description: Filter price report results by id. billing_type_id: oneOf: - "$ref": "#/components/schemas/resource_price_report/properties/billing_type_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_price_report/properties/billing_type_id" not_eq: "$ref": "#/components/schemas/resource_price_report/properties/billing_type_id" not_contain: "$ref": "#/components/schemas/resource_price_report/properties/billing_type_id" contains: "$ref": "#/components/schemas/resource_price_report/properties/billing_type_id" description: Filter operator object for billing type id. description: Filter price report results by billing type id. service_type_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_price_report/properties/service_type_id" not_eq: "$ref": "#/components/schemas/resource_price_report/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_price_report/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_price_report/properties/service_type_id" description: Filter operator object for service type id. - "$ref": "#/components/schemas/resource_price_report/properties/service_type_id" description: Filter price report results by service type id. rate_card_status: oneOf: - "$ref": "#/components/schemas/resource_price_report/properties/rate_card_status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_price_report/properties/rate_card_status" contains: "$ref": "#/components/schemas/resource_price_report/properties/rate_card_status" not_eq: "$ref": "#/components/schemas/resource_price_report/properties/rate_card_status" eq: "$ref": "#/components/schemas/resource_price_report/properties/rate_card_status" description: Filter operator object for rate card status. description: Filter price report results by rate card status. rate_card_id: oneOf: - "$ref": "#/components/schemas/resource_price_report/properties/rate_card_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_price_report/properties/rate_card_id" eq: "$ref": "#/components/schemas/resource_price_report/properties/rate_card_id" contains: "$ref": "#/components/schemas/resource_price_report/properties/rate_card_id" not_contain: "$ref": "#/components/schemas/resource_price_report/properties/rate_card_id" description: Filter operator object for rate card id. description: Filter price report results by rate card id. unit_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_price_report/properties/unit_id" eq: "$ref": "#/components/schemas/resource_price_report/properties/unit_id" not_contain: "$ref": "#/components/schemas/resource_price_report/properties/unit_id" not_eq: "$ref": "#/components/schemas/resource_price_report/properties/unit_id" description: Filter operator object for unit id. - "$ref": "#/components/schemas/resource_price_report/properties/unit_id" description: Filter price report results by unit id. company_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_price_report/properties/company_id" contains: "$ref": "#/components/schemas/resource_price_report/properties/company_id" eq: "$ref": "#/components/schemas/resource_price_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_price_report/properties/company_id" description: Filter operator object for company id. - "$ref": "#/components/schemas/resource_price_report/properties/company_id" description: Filter price report results by company id. time_tracking_enabled: oneOf: - "$ref": "#/components/schemas/resource_price_report/properties/time_tracking_enabled" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_price_report/properties/time_tracking_enabled" not_eq: "$ref": "#/components/schemas/resource_price_report/properties/time_tracking_enabled" contains: "$ref": "#/components/schemas/resource_price_report/properties/time_tracking_enabled" not_contain: "$ref": "#/components/schemas/resource_price_report/properties/time_tracking_enabled" description: Filter operator object for time tracking enabled. description: Filter price report results by time tracking enabled. booking_tracking_enabled: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_price_report/properties/booking_tracking_enabled" not_contain: "$ref": "#/components/schemas/resource_price_report/properties/booking_tracking_enabled" contains: "$ref": "#/components/schemas/resource_price_report/properties/booking_tracking_enabled" not_eq: "$ref": "#/components/schemas/resource_price_report/properties/booking_tracking_enabled" description: Filter operator object for booking tracking enabled. - "$ref": "#/components/schemas/resource_price_report/properties/booking_tracking_enabled" description: Filter price report results by booking tracking enabled. patternProperties: "^company..*$": title: Company relationship "^rate_card..*$": title: Rate card relationship description: Available filter parameters for querying aggregated price report data. filter_company: type: object title: Filter company properties: name: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company/properties/name" not_contain: "$ref": "#/components/schemas/resource_company/properties/name" eq: "$ref": "#/components/schemas/resource_company/properties/name" not_eq: "$ref": "#/components/schemas/resource_company/properties/name" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/name" description: Filter by company name (text search). default_tax_rate_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company/properties/default_tax_rate_id" eq: "$ref": "#/components/schemas/resource_company/properties/default_tax_rate_id" not_contain: "$ref": "#/components/schemas/resource_company/properties/default_tax_rate_id" contains: "$ref": "#/components/schemas/resource_company/properties/default_tax_rate_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/default_tax_rate_id" description: Filter by the company's default tax rate. fuzzy_dates: oneOf: - "$ref": "#/components/schemas/resource_company/properties/fuzzy_dates" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_company/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_company/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_company/properties/fuzzy_dates" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by fuzzy date range (e.g. this_week, last_month). project_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_company/properties/project_id" contains: "$ref": "#/components/schemas/resource_company/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_company/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_company/properties/project_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/project_id" description: Filter by companies associated with a project. parent_company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_company/properties/parent_company_id" not_contain: "$ref": "#/components/schemas/resource_company/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_company/properties/parent_company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/parent_company_id" description: Filter by the parent company of the company. created_at: oneOf: - "$ref": "#/components/schemas/resource_company/properties/created_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company/properties/created_at" contains: "$ref": "#/components/schemas/resource_company/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_company/properties/created_at" eq: "$ref": "#/components/schemas/resource_company/properties/created_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by creation date range (`created_at`). company_code: oneOf: - "$ref": "#/components/schemas/resource_company/properties/company_code" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company/properties/company_code" not_eq: "$ref": "#/components/schemas/resource_company/properties/company_code" eq: "$ref": "#/components/schemas/resource_company/properties/company_code" not_contain: "$ref": "#/components/schemas/resource_company/properties/company_code" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by company code (text search). subscriber_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company/properties/subscriber_id" contains: "$ref": "#/components/schemas/resource_company/properties/subscriber_id" eq: "$ref": "#/components/schemas/resource_company/properties/subscriber_id" not_contain: "$ref": "#/components/schemas/resource_company/properties/subscriber_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/subscriber_id" description: Filter by subscriber (person subscribed to company notifications). query: oneOf: - "$ref": "#/components/schemas/resource_company/properties/query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company/properties/query" contains: "$ref": "#/components/schemas/resource_company/properties/query" not_contain: "$ref": "#/components/schemas/resource_company/properties/query" eq: "$ref": "#/components/schemas/resource_company/properties/query" description: Operator object — supports eq, not_eq, contains, not_contain. description: Search companies by name (text search). archived_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company/properties/archived_at" contains: "$ref": "#/components/schemas/resource_company/properties/archived_at" not_contain: "$ref": "#/components/schemas/resource_company/properties/archived_at" eq: "$ref": "#/components/schemas/resource_company/properties/archived_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/archived_at" description: Filter by archive date range (`archived_at`). due_days: oneOf: - "$ref": "#/components/schemas/resource_company/properties/due_days" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company/properties/due_days" eq: "$ref": "#/components/schemas/resource_company/properties/due_days" contains: "$ref": "#/components/schemas/resource_company/properties/due_days" not_contain: "$ref": "#/components/schemas/resource_company/properties/due_days" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by default payment terms (days). tags: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company/properties/tags" not_contain: "$ref": "#/components/schemas/resource_company/properties/tags" eq: "$ref": "#/components/schemas/resource_company/properties/tags" not_eq: "$ref": "#/components/schemas/resource_company/properties/tags" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/tags" description: Filter by tag. default_currency: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company/properties/default_currency" eq: "$ref": "#/components/schemas/resource_company/properties/default_currency" not_contain: "$ref": "#/components/schemas/resource_company/properties/default_currency" contains: "$ref": "#/components/schemas/resource_company/properties/default_currency" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/default_currency" description: Filter by the company's default invoice currency. has_parent_company: oneOf: - "$ref": "#/components/schemas/resource_company/properties/has_parent_company" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_company/properties/has_parent_company" not_contain: "$ref": "#/components/schemas/resource_company/properties/has_parent_company" contains: "$ref": "#/components/schemas/resource_company/properties/has_parent_company" not_eq: "$ref": "#/components/schemas/resource_company/properties/has_parent_company" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the company has a parent company assigned. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_company/properties/id" not_contain: "$ref": "#/components/schemas/resource_company/properties/id" contains: "$ref": "#/components/schemas/resource_company/properties/id" not_eq: "$ref": "#/components/schemas/resource_company/properties/id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/id" description: Filter by company ID. default_subsidiary_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company/properties/default_subsidiary_id" contains: "$ref": "#/components/schemas/resource_company/properties/default_subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_company/properties/default_subsidiary_id" eq: "$ref": "#/components/schemas/resource_company/properties/default_subsidiary_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/default_subsidiary_id" description: Filter by the company's default subsidiary. fuzzy_people: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_company/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_company/properties/fuzzy_people" not_contain: "$ref": "#/components/schemas/resource_company/properties/fuzzy_people" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/fuzzy_people" description: Filter by person using fuzzy matching. last_activity_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_company/properties/last_activity_at" contains: "$ref": "#/components/schemas/resource_company/properties/last_activity_at" not_contain: "$ref": "#/components/schemas/resource_company/properties/last_activity_at" not_eq: "$ref": "#/components/schemas/resource_company/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/last_activity_at" description: Filter by last activity date range (`last_activity_at`). full_query: oneOf: - "$ref": "#/components/schemas/resource_company/properties/full_query" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company/properties/full_query" eq: "$ref": "#/components/schemas/resource_company/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_company/properties/full_query" contains: "$ref": "#/components/schemas/resource_company/properties/full_query" description: Operator object — supports eq, not_eq, contains, not_contain. description: Full-text search across company name, billing name, and other text fields. exclude_company_and_children: oneOf: - "$ref": "#/components/schemas/resource_company/properties/exclude_company_and_children" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company/properties/exclude_company_and_children" not_eq: "$ref": "#/components/schemas/resource_company/properties/exclude_company_and_children" eq: "$ref": "#/components/schemas/resource_company/properties/exclude_company_and_children" contains: "$ref": "#/components/schemas/resource_company/properties/exclude_company_and_children" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by excluding a company and all its subsidiaries from results. vat: oneOf: - "$ref": "#/components/schemas/resource_company/properties/vat" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company/properties/vat" not_eq: "$ref": "#/components/schemas/resource_company/properties/vat" not_contain: "$ref": "#/components/schemas/resource_company/properties/vat" eq: "$ref": "#/components/schemas/resource_company/properties/vat" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by VAT / tax ID number. status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_company/properties/status" not_contain: "$ref": "#/components/schemas/resource_company/properties/status" eq: "$ref": "#/components/schemas/resource_company/properties/status" contains: "$ref": "#/components/schemas/resource_company/properties/status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/status" description: Filter by company status (active or archived). billing_name: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company/properties/billing_name" eq: "$ref": "#/components/schemas/resource_company/properties/billing_name" not_contain: "$ref": "#/components/schemas/resource_company/properties/billing_name" not_eq: "$ref": "#/components/schemas/resource_company/properties/billing_name" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/billing_name" description: Filter by billing name (full legal company name). payment_terms: oneOf: - "$ref": "#/components/schemas/resource_company/properties/payment_terms" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company/properties/payment_terms" not_eq: "$ref": "#/components/schemas/resource_company/properties/payment_terms" not_contain: "$ref": "#/components/schemas/resource_company/properties/payment_terms" eq: "$ref": "#/components/schemas/resource_company/properties/payment_terms" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by payment terms (days until invoice due). company_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_company/properties/company_id" eq: "$ref": "#/components/schemas/resource_company/properties/company_id" contains: "$ref": "#/components/schemas/resource_company/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_company/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/company_id" description: Filter by company ID (alias for `id`). subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_company/properties/subsidiary_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_company/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_company/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_company/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_company/properties/subsidiary_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the company's subsidiary (alias for `default_subsidiary_id`). jump_query: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_company/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_company/properties/jump_query" contains: "$ref": "#/components/schemas/resource_company/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_company/properties/jump_query" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/jump_query" description: Quick search query for jumping to a specific company by name. custom_fields: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_company/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_company/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_company/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_company/properties/custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_company/properties/custom_fields" description: Filter by custom field values. patternProperties: "^contact..*$": title: Contact relationship "^subsidiary..*$": title: Subsidiary relationship "^parent_company..*$": title: Parent company relationship "^default_subsidiary..*$": title: Default subsidiary relationship description: Filter parameters for companies (clients). filter_filter: type: object title: Filter filter properties: report_category_id: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/report_category_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_filter/properties/report_category_id" contains: "$ref": "#/components/schemas/resource_filter/properties/report_category_id" not_eq: "$ref": "#/components/schemas/resource_filter/properties/report_category_id" not_contain: "$ref": "#/components/schemas/resource_filter/properties/report_category_id" description: Filter operator object for report category ID. description: Filter saved filters by report category ID. type_id: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/type_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_filter/properties/type_id" not_eq: "$ref": "#/components/schemas/resource_filter/properties/type_id" not_contain: "$ref": "#/components/schemas/resource_filter/properties/type_id" contains: "$ref": "#/components/schemas/resource_filter/properties/type_id" description: Filter using explicit operator syntax. description: Filter by filter type ID. project_id: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/project_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_filter/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_filter/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_filter/properties/project_id" contains: "$ref": "#/components/schemas/resource_filter/properties/project_id" description: Filter using explicit operator syntax. description: Filter by the associated project (returns saved filters scoped to the given workspace). report_layout_id: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/report_layout_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_filter/properties/report_layout_id" eq: "$ref": "#/components/schemas/resource_filter/properties/report_layout_id" not_eq: "$ref": "#/components/schemas/resource_filter/properties/report_layout_id" contains: "$ref": "#/components/schemas/resource_filter/properties/report_layout_id" description: Filter operator object for report layout ID. description: Filter saved filters by report layout ID. pulse: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/pulse" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_filter/properties/pulse" not_eq: "$ref": "#/components/schemas/resource_filter/properties/pulse" eq: "$ref": "#/components/schemas/resource_filter/properties/pulse" contains: "$ref": "#/components/schemas/resource_filter/properties/pulse" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by whether the saved filter has an active pulse (digest notification) configured for it. chart_type_id: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/chart_type_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_filter/properties/chart_type_id" not_contain: "$ref": "#/components/schemas/resource_filter/properties/chart_type_id" not_eq: "$ref": "#/components/schemas/resource_filter/properties/chart_type_id" eq: "$ref": "#/components/schemas/resource_filter/properties/chart_type_id" description: Filter using explicit operator syntax. description: Filter by chart type ID. query: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_filter/properties/query" eq: "$ref": "#/components/schemas/resource_filter/properties/query" not_contain: "$ref": "#/components/schemas/resource_filter/properties/query" contains: "$ref": "#/components/schemas/resource_filter/properties/query" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_filter/properties/query" description: Filter by name (text search). last_accessed_at: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/last_accessed_at" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_filter/properties/last_accessed_at" eq: "$ref": "#/components/schemas/resource_filter/properties/last_accessed_at" not_contain: "$ref": "#/components/schemas/resource_filter/properties/last_accessed_at" contains: "$ref": "#/components/schemas/resource_filter/properties/last_accessed_at" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the most recent access date, calculated as the greatest of updated_at, last_viewed_at, and last_pulse_sent_at. shared: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_filter/properties/shared" contains: "$ref": "#/components/schemas/resource_filter/properties/shared" not_contain: "$ref": "#/components/schemas/resource_filter/properties/shared" eq: "$ref": "#/components/schemas/resource_filter/properties/shared" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_filter/properties/shared" description: Filter to include only saved filters that are shared with others. report: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/report" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_filter/properties/report" not_contain: "$ref": "#/components/schemas/resource_filter/properties/report" not_eq: "$ref": "#/components/schemas/resource_filter/properties/report" contains: "$ref": "#/components/schemas/resource_filter/properties/report" description: Filter operator object for the report flag. description: Filter saved filters (reports) by the report flag. created_at: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/created_at" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_filter/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_filter/properties/created_at" eq: "$ref": "#/components/schemas/resource_filter/properties/created_at" contains: "$ref": "#/components/schemas/resource_filter/properties/created_at" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the date the saved filter was created. creator_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_filter/properties/creator_id" contains: "$ref": "#/components/schemas/resource_filter/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_filter/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_filter/properties/creator_id" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_filter/properties/creator_id" description: Filter by the ID of the person who created the saved filter. name: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/name" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_filter/properties/name" not_contain: "$ref": "#/components/schemas/resource_filter/properties/name" contains: "$ref": "#/components/schemas/resource_filter/properties/name" not_eq: "$ref": "#/components/schemas/resource_filter/properties/name" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the name of the saved filter. id: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_filter/properties/id" eq: "$ref": "#/components/schemas/resource_filter/properties/id" contains: "$ref": "#/components/schemas/resource_filter/properties/id" not_eq: "$ref": "#/components/schemas/resource_filter/properties/id" description: Filter using explicit operator syntax. description: Filter by ID. last_viewed_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_filter/properties/last_viewed_at" not_eq: "$ref": "#/components/schemas/resource_filter/properties/last_viewed_at" contains: "$ref": "#/components/schemas/resource_filter/properties/last_viewed_at" eq: "$ref": "#/components/schemas/resource_filter/properties/last_viewed_at" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_filter/properties/last_viewed_at" description: Filter by the date the saved filter was last viewed. filterable_id: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/filterable_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_filter/properties/filterable_id" not_contain: "$ref": "#/components/schemas/resource_filter/properties/filterable_id" eq: "$ref": "#/components/schemas/resource_filter/properties/filterable_id" contains: "$ref": "#/components/schemas/resource_filter/properties/filterable_id" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the ID of the resource (project, deal, etc.) the saved filter is scoped to. filterable_type: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/filterable_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_filter/properties/filterable_type" not_eq: "$ref": "#/components/schemas/resource_filter/properties/filterable_type" eq: "$ref": "#/components/schemas/resource_filter/properties/filterable_type" not_contain: "$ref": "#/components/schemas/resource_filter/properties/filterable_type" description: Filter using explicit operator syntax. description: Filter by the resource type (e.g. tasks, deals) the saved filter applies to. filterable_collection: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/filterable_collection" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_filter/properties/filterable_collection" not_contain: "$ref": "#/components/schemas/resource_filter/properties/filterable_collection" eq: "$ref": "#/components/schemas/resource_filter/properties/filterable_collection" contains: "$ref": "#/components/schemas/resource_filter/properties/filterable_collection" description: Operator object for filtering by collection (list) values — supports eq, not_eq, contains, not_contain. description: Filter by the filterable collection (resource type group) the saved filter applies to. updated_at: oneOf: - "$ref": "#/components/schemas/resource_filter/properties/updated_at" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_filter/properties/updated_at" eq: "$ref": "#/components/schemas/resource_filter/properties/updated_at" not_contain: "$ref": "#/components/schemas/resource_filter/properties/updated_at" contains: "$ref": "#/components/schemas/resource_filter/properties/updated_at" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the date the saved filter was last updated. last_pulse_sent_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_filter/properties/last_pulse_sent_at" eq: "$ref": "#/components/schemas/resource_filter/properties/last_pulse_sent_at" contains: "$ref": "#/components/schemas/resource_filter/properties/last_pulse_sent_at" not_eq: "$ref": "#/components/schemas/resource_filter/properties/last_pulse_sent_at" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_filter/properties/last_pulse_sent_at" description: Filter by the date the last pulse notification was sent for this saved filter. patternProperties: {} description: Filter parameters for saved filters (custom views). filter_lost_reason: type: object title: Filter lost reason properties: id: oneOf: - "$ref": "#/components/schemas/resource_lost_reason/properties/id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_lost_reason/properties/id" eq: "$ref": "#/components/schemas/resource_lost_reason/properties/id" not_contain: "$ref": "#/components/schemas/resource_lost_reason/properties/id" not_eq: "$ref": "#/components/schemas/resource_lost_reason/properties/id" description: Filter using explicit operator syntax. description: Filter by ID. patternProperties: {} description: Filter parameters for lost reasons. _filter_root_activity: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_activity" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_activity" description: Filter schema for `activity` list endpoints — pass a single condition or a logical group. _filter_root_survey_response: oneOf: - "$ref": "#/components/schemas/filter_survey_response" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_survey_response" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `survey_response` list endpoints — pass a single condition or a logical group. filter_invoice_template: type: object title: Filter invoice template properties: document_type_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice_template/properties/document_type_id" not_contain: "$ref": "#/components/schemas/resource_invoice_template/properties/document_type_id" eq: "$ref": "#/components/schemas/resource_invoice_template/properties/document_type_id" not_eq: "$ref": "#/components/schemas/resource_invoice_template/properties/document_type_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_invoice_template/properties/document_type_id" description: Filter by document type. issuer_id: oneOf: - "$ref": "#/components/schemas/resource_invoice_template/properties/issuer_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_template/properties/issuer_id" contains: "$ref": "#/components/schemas/resource_invoice_template/properties/issuer_id" not_eq: "$ref": "#/components/schemas/resource_invoice_template/properties/issuer_id" not_contain: "$ref": "#/components/schemas/resource_invoice_template/properties/issuer_id" description: Filter using explicit operator syntax. description: Filter by the person set as the invoice issuer. subsidiary_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_template/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_invoice_template/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_invoice_template/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_invoice_template/properties/subsidiary_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_invoice_template/properties/subsidiary_id" description: Filter by the associated subsidiary. company_id: oneOf: - "$ref": "#/components/schemas/resource_invoice_template/properties/company_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice_template/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_invoice_template/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_invoice_template/properties/company_id" eq: "$ref": "#/components/schemas/resource_invoice_template/properties/company_id" description: Filter using explicit operator syntax. description: Filter by client company. creator_id: oneOf: - "$ref": "#/components/schemas/resource_invoice_template/properties/creator_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_template/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_invoice_template/properties/creator_id" contains: "$ref": "#/components/schemas/resource_invoice_template/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_invoice_template/properties/creator_id" description: Filter using explicit operator syntax. description: Filter by the person who created the invoice template. budget_id: oneOf: - "$ref": "#/components/schemas/resource_invoice_template/properties/budget_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_template/properties/budget_id" contains: "$ref": "#/components/schemas/resource_invoice_template/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_invoice_template/properties/budget_id" not_eq: "$ref": "#/components/schemas/resource_invoice_template/properties/budget_id" description: Filter using explicit operator syntax. description: Filter by the associated budget. custom_fields: oneOf: - "$ref": "#/components/schemas/resource_invoice_template/properties/custom_fields" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_template/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_invoice_template/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_invoice_template/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_invoice_template/properties/custom_fields" description: Filter using explicit operator syntax. description: Filter by custom field values. id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_template/properties/id" eq: "$ref": "#/components/schemas/resource_invoice_template/properties/id" not_contain: "$ref": "#/components/schemas/resource_invoice_template/properties/id" contains: "$ref": "#/components/schemas/resource_invoice_template/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_invoice_template/properties/id" description: Filter by invoice template ID. patternProperties: {} description: Filter parameters for invoice templates used in automatic invoicing. _filter_root_person_report: oneOf: - "$ref": "#/components/schemas/filter_person_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_person_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `person_report` list endpoints — pass a single condition or a logical group. resource_expense_report: type: object title: Expense report Resource properties: reimbursable: type: boolean title: Reimbursable description: Reimbursable for this expense report group. formulas: type: integer title: Formulas description: Formulas for this expense report group. recognized_revenue: title: Recognized Revenue description: Recognized revenue for this expense report group. invoiced: type: integer title: Invoiced description: Invoiced for this expense report group. currency: type: string title: Currency description: Currency for this expense report group. approved_at: type: string title: Approved At format: date description: Timestamp when the expense was approved, or null if not yet approved. pay_on_before: type: string title: Pay On Before format: date description: Pay on before for this expense report group. currency_normalized: type: string title: Currency Normalized description: Currency in the normalized currency for this expense report group. total_profit: title: Total Profit description: Sum of profit across all records in this expense report group. purchase_order: title: Purchase Order description: Purchase order for this expense report group. example: data: type: purchase_orders id: '1234567' approval_status: enum: - 1 - 2 - 3 - 4 type: integer title: Approval Status description: Approval status for this expense report group. date_after: type: string title: Date After format: date description: Date after for this expense report group. total_tax_amount_default: title: Total Tax Amount Default description: Sum of tax amount in the organization's default currency across all records in this expense report group. person: title: Person description: Person for this expense report group. responsible_id: type: integer title: Responsible description: Responsible id for this expense report group. quote_type: title: Quote Type description: Quote type for this expense report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this expense report group. count: type: integer title: Count description: Number of expenses in this report group. formula_fields: title: Formula Fields description: Formula fields for this expense report group. paid_on: type: string title: Paid On format: date description: Paid on for this expense report group. designated_approver_id: type: integer title: Designated Approver description: ID of the person designated as the approver for the budget linked to this expense entry. vendor: title: Vendor description: Vendor for this expense report group. service: title: Service description: Service for this expense report group. profit: title: Profit description: Profit for this expense report group. deal: title: Deal description: Deal for this expense report group. date: type: string title: Date format: date description: Date for this expense report group. full_query: type: string title: Full Query description: Full query for this expense report group. project: title: Project description: Project for this expense report group. amount_with_tax: title: Amount With Tax description: Amount with tax for this expense report group. expense_reimbursed_on: title: Expense Reimbursed On description: Expense reimbursed on for this expense report group. export_status: enum: - 1 - 2 type: integer title: Export Status description: Export status for this expense report group. paid_on_before: type: string title: Paid On Before format: date description: Paid on before for this expense report group. purchase_order_id: type: integer title: Purchase Order description: Purchase order id for this expense report group. example: 1234567 vendor_id: type: integer title: Vendor description: Vendor id for this expense report group. average_profit_margin_normalized: type: number title: Average Profit Margin Normalized description: Average profit margin in the normalized currency for this expense report group. created_at_period: title: Created At Period description: Time period grouping for created at (e.g. week, month, quarter). creator: title: Creator description: Creator for this expense report group. average_profit_margin_default: type: number title: Average Profit Margin Default description: Average profit margin in the organization's default currency for this expense report group. service_type_id: type: integer title: Service Type description: Service type id for this expense report group. quarter: type: string title: Quarter description: Quarter grouping for this expense report row. custom_fields: type: string title: Custom Fields description: Custom fields for this expense report group. stage_type: enum: - 1 - 2 type: integer title: Stage Type description: Stage type for this expense report group. approved_at_period: title: Approved At Period description: The date period (year, quarter, month) of when the expense was approved. date_before: type: string title: Date Before format: date description: Date before for this expense report group. week: type: string title: Week description: Week grouping for this expense report row. project_id: type: integer title: Project description: Project id for this expense report group. company_id: type: integer title: Company description: Company id for this expense report group. invoicing_status: enum: - 1 - 2 - 3 type: integer title: Invoicing Status description: Invoicing status for this expense report group. total_tax_amount_normalized: title: Total Tax Amount Normalized description: Sum of tax amount in the normalized currency across all records in this expense report group. month: type: string title: Month description: Month grouping for this expense report row. total_billable_amount: title: Total Billable Amount description: Sum of billable amount across all records in this expense report group. expense_created_at: title: Expense Created At description: Expense created at for this expense report group. total_amount_normalized: title: Total Amount Normalized description: Sum of amount in the normalized currency across all records in this expense report group. expense_date: title: Expense Date description: Expense date for this expense report group. quantity: type: integer title: Quantity description: Quantity for this expense report group. project_report: title: Project Report description: Project report for this expense report group. expense_name: title: Expense Name description: Expense name for this expense report group. paid_on_period: title: Paid On Period description: Time period grouping for paid on (e.g. week, month, quarter). awaiting_approval_from_approver_id: type: integer title: Awaiting Approval From Approver description: Awaiting approval from approver id for this expense report group. section_name: type: string title: Section Name description: Section name for this expense report group. allocation_status: enum: - 1 - 2 type: string title: Allocation Status description: Whether this expense report entry has been allocated to a service, or is unallocated. designated_approver: title: Designated Approver description: The person designated as the approver for the budget linked to this expense entry. total_profit_normalized: title: Total Profit Normalized description: Sum of profit in the normalized currency across all records in this expense report group. amount: title: Amount description: Amount for this expense report group. reimbursed_on_period: title: Reimbursed On Period description: Time period grouping for reimbursed on (e.g. week, month, quarter). group: type: string title: Group description: The grouping dimension for this expense report row. created_at: type: string title: Created At format: date description: Created at for this expense report group. status: enum: - 1 - 2 type: integer title: Status description: Status for this expense report group. company: title: Company description: Company for this expense report group. approver_id: type: integer title: Approver description: Approver id for this expense report group. person_id: type: integer title: Person description: Person id for this expense report group. total_recognized_revenue_normalized: title: Total Recognized Revenue Normalized description: Sum of recognized revenue in the normalized currency across all records in this expense report group. fuzzy_people: type: integer title: Fuzzy People description: Fuzzy people for this expense report group. approver: title: Approver description: Approver for this expense report group. vendor_report: title: Vendor Report description: Vendor report for this expense report group. total_amount_default: title: Total Amount Default description: Sum of amount in the organization's default currency across all records in this expense report group. date_period: title: Date Period description: Time period grouping for date (e.g. week, month, quarter). total_amount_with_tax: title: Total Amount With Tax description: Sum of amount with tax across all records in this expense report group. total_billable_amount_default: title: Total Billable Amount Default description: Sum of billable amount in the organization's default currency across all records in this expense report group. expense_paid_on: title: Expense Paid On description: Expense paid on for this expense report group. deal_id: type: integer title: Deal description: Deal id for this expense report group. deal_or_budget_report: title: Deal Or Budget Report description: Report object for the deal or budget associated with this expense entry. total_tax_amount: title: Total Tax Amount description: Sum of tax amount across all records in this expense report group. creator_id: type: integer title: Creator description: Creator id for this expense report group. report: title: Report description: Report for this expense report group. total_recognized_revenue: title: Total Recognized Revenue description: Sum of recognized revenue across all records in this expense report group. total_profit_default: title: Total Profit Default description: Sum of profit in the organization's default currency across all records in this expense report group. jump_query: type: string title: Jump Query description: Jump query for this expense report group. average_profit_margin: type: number title: Average Profit Margin description: Average profit margin for this expense report group. person_report: title: Person Report description: The person associated with this expense report row. pay_on: type: string title: Pay On format: date description: Pay on for this expense report group. reimbursed_on: type: string title: Reimbursed On format: date description: Reimbursed on for this expense report group. id: type: integer title: Id description: Unique identifier for this expense report row. total_amount_with_tax_default: title: Total Amount With Tax Default description: Sum of amount with tax in the organization's default currency across all records in this expense report group. paid_on_after: type: string title: Paid On After format: date description: Paid on after for this expense report group. service_id: type: integer title: Service description: Service id for this expense report group. reimbursement: enum: - 1 - 2 - 3 type: integer title: Reimbursement description: Reimbursement for this expense report group. year: type: string title: Year description: Year grouping for this expense report row. with_draft: type: boolean title: With Draft description: With draft for this expense report group. name: type: string title: Name description: Name for this expense report group. total_amount_with_tax_normalized: title: Total Amount With Tax Normalized description: Sum of amount with tax in the normalized currency across all records in this expense report group. company_report: title: Company Report description: Company report for this expense report group. expense: title: Expense description: Expense for this expense report group. tax_rate_id: type: integer title: Tax Rate description: Tax rate id for this expense report group. billable_amount: title: Billable Amount description: Billable amount for this expense report group. query: type: string title: Query description: Query for this expense report group. invoice_id: type: integer title: Invoice description: Invoice id for this expense report group. responsible: title: Responsible description: Responsible for this expense report group. total_billable_amount_normalized: title: Total Billable Amount Normalized description: Sum of billable amount in the normalized currency across all records in this expense report group. pay_on_period: title: Pay On Period description: Time period grouping for pay on (e.g. week, month, quarter). organization: title: Organization description: Organization for this expense report group. total_amount: title: Total Amount description: Sum of amount across all records in this expense report group. total_recognized_revenue_default: title: Total Recognized Revenue Default description: Sum of recognized revenue in the organization's default currency across all records in this expense report group. pay_on_after: type: string title: Pay On After format: date description: Pay on after for this expense report group. service_type: title: Service Type description: Service type for this expense report group. invoice: title: Invoice description: Invoice for this expense report group. fuzzy_dates: type: string title: Fuzzy Dates format: date description: Fuzzy dates for this expense report group. tax_rate: title: Tax Rate description: Tax rate for this expense report group. draft: type: boolean title: Draft description: Draft for this expense report group. assigned_approver_id: type: integer title: Assigned Approver description: Assigned approver id for this expense report group. expense_pay_on: title: Expense Pay On description: Expense pay on for this expense report group. description: An aggregated expense report row grouping expenses by configurable dimensions with cost totals, billing metrics, and approval status. filter_bank_account: type: object title: Filter bank account properties: subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_bank_account/properties/subsidiary_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_bank_account/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_bank_account/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_bank_account/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_bank_account/properties/subsidiary_id" description: Filter using explicit operator syntax. description: Filter by the associated subsidiary. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_bank_account/properties/id" contains: "$ref": "#/components/schemas/resource_bank_account/properties/id" not_eq: "$ref": "#/components/schemas/resource_bank_account/properties/id" not_contain: "$ref": "#/components/schemas/resource_bank_account/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_bank_account/properties/id" description: Filter by bank account ID. name: oneOf: - "$ref": "#/components/schemas/resource_bank_account/properties/name" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_bank_account/properties/name" not_eq: "$ref": "#/components/schemas/resource_bank_account/properties/name" not_contain: "$ref": "#/components/schemas/resource_bank_account/properties/name" contains: "$ref": "#/components/schemas/resource_bank_account/properties/name" description: Filter using explicit operator syntax. description: Filter by account name (text search). bank_name: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_bank_account/properties/bank_name" not_eq: "$ref": "#/components/schemas/resource_bank_account/properties/bank_name" not_contain: "$ref": "#/components/schemas/resource_bank_account/properties/bank_name" eq: "$ref": "#/components/schemas/resource_bank_account/properties/bank_name" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_bank_account/properties/bank_name" description: Filter by bank name (text search). status: oneOf: - "$ref": "#/components/schemas/resource_bank_account/properties/status" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_bank_account/properties/status" contains: "$ref": "#/components/schemas/resource_bank_account/properties/status" eq: "$ref": "#/components/schemas/resource_bank_account/properties/status" not_contain: "$ref": "#/components/schemas/resource_bank_account/properties/status" description: Filter using explicit operator syntax. description: Filter by active/archived status. patternProperties: "^subsidiary..*$": title: Subsidiary relationship description: Filter parameters for bank accounts. _filter_root_holiday: oneOf: - "$ref": "#/components/schemas/filter_holiday" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_holiday" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `holiday` list endpoints — pass a single condition or a logical group. resource_financial_item_report: type: object title: Financial item report Resource properties: subsidiary_id: type: integer title: Subsidiary description: Subsidiary id for this financial item report group. budget: title: Budget description: Budget for this financial item report group. report: title: Report description: Report for this financial item report group. total_time_entry_cost_default: title: Total Time Entry Cost Default description: Sum of time entry cost in the organization's default currency across all records in this financial item report group. total_draft_invoiced_default: title: Total Draft Invoiced Default description: Total draft invoiced amount for financial items in this group, in the organization's default currency. total_scheduled_cost_normalized: title: Total Scheduled Cost Normalized description: Sum of scheduled cost in the normalized currency across all records in this financial item report group. average_margin_normalized: type: number title: Average Margin Normalized description: Average margin in the normalized currency for this financial item report group. expense: title: Expense description: Expense for this financial item report group. total_expense_cost_default: title: Total Expense Cost Default description: Sum of expense cost in the organization's default currency across all records in this financial item report group. parent_company_id: type: integer title: Parent Company description: ID of the parent company of the client linked to this financial item entry, used for hierarchical company filtering. person: title: Person description: Person for this financial item report group. origin_deal_report: title: Origin Deal Report description: Related origin deal report data for this financial item report group. company: title: Company description: Company for this financial item report group. origin_deal_id: type: integer title: Origin Deal description: Origin deal id for this financial item report group. total_overhead_cost: title: Total Overhead Cost description: Sum of overhead cost across all records in this financial item report group. total_billable_time: type: number title: Total Billable Time description: Sum of billable time across all records in this financial item report group. date: type: string title: Date format: date description: Date for this financial item report group. total_time_entry_cost_normalized: title: Total Time Entry Cost Normalized description: Sum of time entry cost in the normalized currency across all records in this financial item report group. average_margin: type: number title: Average Margin description: Average margin for this financial item report group. invoice_attribution: title: Invoice Attribution description: Invoice attribution for this financial item report group. total_projected_revenue_normalized: title: Total Projected Revenue Normalized description: Sum of projected revenue in the normalized currency across all records in this financial item report group. credited: title: Credited description: Credited for this financial item report group. invoiced: title: Invoiced description: Invoiced for this financial item report group. deal_status: title: Deal Status description: Deal status for this financial item report group. probability: type: integer title: Probability description: Probability for this financial item report group. total_budget_used_default: title: Total Budget Used Default description: Sum of budget used in the organization's default currency across all records in this financial item report group. total_recognized_revenue_normalized: title: Total Recognized Revenue Normalized description: Sum of recognized revenue in the normalized currency across all records in this financial item report group. total_estimated_time: type: number title: Total Estimated Time description: Sum of estimated time across all records in this financial item report group. total_scheduled_cost: title: Total Scheduled Cost description: Sum of scheduled cost across all records in this financial item report group. profit: title: Profit description: Profit for this financial item report group. total_overhead_cost_default: title: Total Overhead Cost Default description: Sum of overhead cost in the organization's default currency across all records in this financial item report group. organization: title: Organization description: Organization for this financial item report group. total_scheduled_revenue: title: Total Scheduled Revenue description: Sum of scheduled revenue across all records in this financial item report group. total_budget_total_normalized: title: Total Budget Total Normalized description: Sum of budget total in the normalized currency across all records in this financial item report group. stage_status: enum: - 1 - 2 - 3 - 4 - 5 type: integer title: Stage Status description: Stage status for this financial item report group. future: type: integer title: Future description: Future for this financial item report group. total_time_entry_cost: title: Total Time Entry Cost description: Sum of time entry cost across all records in this financial item report group. total_budget_used: title: Total Budget Used description: Sum of budget used across all records in this financial item report group. total_projected_revenue: title: Total Projected Revenue description: Sum of projected revenue across all records in this financial item report group. project: title: Project description: Project for this financial item report group. overhead_cost: title: Overhead Cost description: Overhead cost for this financial item report group. total_recognized_revenue_default: title: Total Recognized Revenue Default description: Sum of recognized revenue in the organization's default currency across all records in this financial item report group. total_estimated_cost_normalized: title: Total Estimated Cost Normalized description: Sum of estimated cost in the normalized currency across all records in this financial item report group. scheduled_cost: title: Scheduled Cost description: Scheduled cost for this financial item report group. estimated_cost: title: Estimated Cost description: Estimated cost for this financial item report group. service_type: title: Service Type description: Service type for this financial item report group. currency: type: string title: Currency description: Currency for this financial item report group. financial_item_id: type: string title: Financial Item description: Financial item id for this financial item report group. total_scheduled_cost_default: title: Total Scheduled Cost Default description: Sum of scheduled cost in the organization's default currency across all records in this financial item report group. pipeline_id: type: integer title: Pipeline description: Pipeline id for this financial item report group. project_id: type: integer title: Project description: Project id for this financial item report group. total_recognized_time: type: number title: Total Recognized Time description: Sum of recognized time across all records in this financial item report group. person_report: title: Person Report description: The person associated with this financial item report row. service_id: type: integer title: Service description: Service id for this financial item report group. subsidiary: title: Subsidiary description: Subsidiary for this financial item report group. locked: type: boolean title: Locked description: Locked for this financial item report group. company_id: type: integer title: Company description: Company id for this financial item report group. total_cost_normalized: title: Total Cost Normalized description: Sum of cost in the normalized currency across all records in this financial item report group. total_budget_total: title: Total Budget Total description: Sum of budget total across all records in this financial item report group. total_credited_normalized: title: Total Credited Normalized description: Sum of credited in the normalized currency across all records in this financial item report group. total_cost: title: Total Cost description: Sum of cost across all records in this financial item report group. average_blended_rate: title: Average Blended Rate description: Average blended rate for this financial item report group. billing_type_id: type: integer title: Billing Type description: Billing type id for this financial item report group. service: title: Service description: Service for this financial item report group. total_invoiced_normalized: title: Total Invoiced Normalized description: Sum of invoiced in the normalized currency across all records in this financial item report group. billing_type: enum: - 1 - 2 - 3 - 4 type: integer title: Billing Type description: Billing type for this financial item report group. count: type: integer title: Count description: Number of financial items in this report group. total_scheduled_revenue_normalized: title: Total Scheduled Revenue Normalized description: Sum of scheduled revenue in the normalized currency across all records in this financial item report group. budget_used: title: Budget Used description: Budget used for this financial item report group. booking_item: title: Booking Item description: Booking item for this financial item report group. average_blended_rate_default: title: Average Blended Rate Default description: Average blended rate in the organization's default currency for this financial item report group. responsible_id: type: integer title: Responsible description: Responsible id for this financial item report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this financial item report group. owner_report: title: Owner Report description: Owner report for this financial item report group. total_worked_time: type: number title: Total Worked Time description: Sum of worked time across all records in this financial item report group. financial_item_type: type: string title: Financial Item Type description: Financial item type for this financial item report group. total_recognized_profit_default: title: Total Recognized Profit Default description: Sum of recognized profit in the organization's default currency across all records in this financial item report group. total_budget_used_normalized: title: Total Budget Used Normalized description: Sum of budget used in the normalized currency across all records in this financial item report group. custom_fields: type: string title: Custom Fields description: Custom fields for this financial item report group. average_margin_default: type: number title: Average Margin Default description: Average margin in the organization's default currency for this financial item report group. person_id: type: integer title: Person description: Person id for this financial item report group. scheduled_revenue: title: Scheduled Revenue description: Scheduled revenue for this financial item report group. company_report: title: Company Report description: Company report for this financial item report group. origin_deal: title: Origin Deal description: Origin deal for this financial item report group. total_budgeted_time: type: number title: Total Budgeted Time description: Sum of budgeted time across all records in this financial item report group. total_draft_invoiced_normalized: title: Total Draft Invoiced Normalized description: Total draft invoiced amount for financial items in this group, normalized to the deal currency. total_recognized_revenue: title: Total Recognized Revenue description: Sum of recognized revenue across all records in this financial item report group. total_estimated_cost: title: Total Estimated Cost description: Sum of estimated cost across all records in this financial item report group. average_blended_rate_normalized: title: Average Blended Rate Normalized description: Average blended rate in the normalized currency for this financial item report group. total_scheduled_time: type: number title: Total Scheduled Time description: Sum of scheduled time across all records in this financial item report group. total_credited: title: Total Credited description: Sum of credited across all records in this financial item report group. revenue: title: Revenue description: Revenue for this financial item report group. total_overhead_cost_normalized: title: Total Overhead Cost Normalized description: Sum of overhead cost in the normalized currency across all records in this financial item report group. total_recognized_profit: title: Total Recognized Profit description: Sum of recognized profit across all records in this financial item report group. budget_id: type: integer title: Budget description: Budget id for this financial item report group. total_estimated_cost_default: title: Total Estimated Cost Default description: Sum of estimated cost in the organization's default currency across all records in this financial item report group. total_draft_invoiced: title: Total Draft Invoiced description: Total draft invoiced amount for financial items in this group, in the deal currency. total_expense_cost_normalized: title: Total Expense Cost Normalized description: Sum of expense cost in the normalized currency across all records in this financial item report group. financial_item: title: Financial Item description: Financial item for this financial item report group. cost: title: Cost description: Cost for this financial item report group. total_invoiced_default: title: Total Invoiced Default description: Sum of invoiced in the organization's default currency across all records in this financial item report group. financial_item_date: title: Financial Item Date description: Financial item date for this financial item report group. project_type_id: enum: - 1 - 2 type: integer title: Project Type description: Project type id for this financial item report group. section_id: type: integer title: Section description: Section id for this financial item report group. total_expense_cost: title: Total Expense Cost description: Sum of expense cost across all records in this financial item report group. time_entry: title: Time Entry description: Time entry for this financial item report group. total_credited_default: title: Total Credited Default description: Sum of credited in the organization's default currency across all records in this financial item report group. section: title: Section description: Section for this financial item report group. total_budget_total_default: title: Total Budget Total Default description: Sum of budget total in the organization's default currency across all records in this financial item report group. revenue_item: title: Revenue Item description: Revenue item for this financial item report group. total_time: type: number title: Total Time description: Sum of time across all records in this financial item report group. currency_normalized: type: string title: Currency Normalized description: Currency in the normalized currency for this financial item report group. company_billing_name: title: Company Billing Name description: Company billing name for this financial item report group. total_recognized_profit_normalized: title: Total Recognized Profit Normalized description: Sum of recognized profit in the normalized currency across all records in this financial item report group. deal_or_budget_report: title: Deal Or Budget Report description: Report object for the deal or budget associated with this financial item entry. stage_type: enum: - 1 - 2 type: integer title: Stage Type description: Stage type for this financial item report group. formulas: type: integer title: Formulas description: Formulas for this financial item report group. date_period: title: Date Period description: Time period grouping for date (e.g. week, month, quarter). project_report: title: Project Report description: Project report for this financial item report group. financial_item_description: type: string title: Financial Item Description description: Financial item description for this financial item report group. unit: enum: - 1 - 2 - 3 type: integer title: Unit description: The billing unit type used to filter financial items (e.g., hours, days, fixed). budget_total: title: Budget Total description: Budget total for this financial item report group. budget_status: enum: - 1 - 2 type: integer title: Budget Status description: Budget status for this financial item report group. service_report: title: Service Report description: Service report for this financial item report group. group: type: string title: Group description: The grouping dimension for this financial item report row. total_cost_default: title: Total Cost Default description: Sum of cost in the organization's default currency across all records in this financial item report group. deal_status_id: type: integer title: Deal Status description: Deal status id for this financial item report group. blended_rate: title: Blended Rate description: Blended rate for this financial item report group. formula_fields: title: Formula Fields description: Formula fields for this financial item report group. draft_invoiced: title: Draft Invoiced description: Whether this financial item entry has been draft invoiced. approval_status: type: integer title: Approval Status description: Approval status for this financial item report group. responsible: title: Responsible description: Responsible for this financial item report group. total_scheduled_revenue_default: title: Total Scheduled Revenue Default description: Sum of scheduled revenue in the organization's default currency across all records in this financial item report group. project_type: title: Project Type description: Project type for this financial item report group. service_type_id: type: integer title: Service Type description: Service type id for this financial item report group. total_projected_revenue_default: title: Total Projected Revenue Default description: Sum of projected revenue in the organization's default currency across all records in this financial item report group. average_recognized_margin: type: number title: Average Recognized Margin description: Average recognized margin for this financial item report group. total_invoiced: title: Total Invoiced description: Sum of invoiced across all records in this financial item report group. description: An aggregated financial item report row combining budget, invoice, and time entry data for line-level profitability analysis. filter_einvoice_identity: type: object title: Filter einvoice identity properties: company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_einvoice_identity/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_einvoice_identity/properties/company_id" contains: "$ref": "#/components/schemas/resource_einvoice_identity/properties/company_id" eq: "$ref": "#/components/schemas/resource_einvoice_identity/properties/company_id" description: Comparison operators for this filter field. example: eq: '89' - "$ref": "#/components/schemas/resource_einvoice_identity/properties/company_id" description: Filter by the ID of the associated company. example: '89' subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_einvoice_identity/properties/subsidiary_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_einvoice_identity/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_einvoice_identity/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_einvoice_identity/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_einvoice_identity/properties/subsidiary_id" description: Comparison operators for this filter field. example: eq: '42' description: Filter by the ID of the associated subsidiary. example: '42' description: Available filter fields for e-invoice identity resources. example: company_id: '89' _filter_root_survey_field_option: oneOf: - "$ref": "#/components/schemas/filter_survey_field_option" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_survey_field_option" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `survey_field_option` list endpoints — pass a single condition or a logical group. _filter_root_placeholder: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_placeholder" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_placeholder" description: Filter schema for `placeholder` list endpoints — pass a single condition or a logical group. _filter_root_task: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_task" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_task" description: Filter schema for `task` list endpoints — pass a single condition or a logical group. _filter_root_integration_exporter_configuration: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_integration_exporter_configuration" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_integration_exporter_configuration" description: Filter schema for `integration_exporter_configuration` list endpoints — pass a single condition or a logical group. _resource: type: object title: Resource Identifier properties: type: type: string description: The resource type name (e.g. `tasks`, `people`, `deals`). id: type: integer description: The unique identifier of the resource. description: A JSON:API resource identifier object containing the resource type and ID. _filter_root_placeholder_usage: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_placeholder_usage" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_placeholder_usage" description: Filter schema for `placeholder_usage` list endpoints — pass a single condition or a logical group. filter_user: type: object title: Filter user properties: {} patternProperties: {} description: Filter parameters for listing user resources, which represent login credentials and authentication accounts distinct from person profiles. resource_holiday_calendar: type: object title: Holiday calendar Resource properties: country: type: string title: Country description: The country code used to determine which national holidays to include in this calendar. autogenerate_holidays: type: boolean title: Autogenerate Holidays description: When true, holidays for this calendar are automatically generated based on the configured country and state. id: type: integer title: Id description: The unique identifier of this holiday calendar. state: type: string title: State description: The state or region code used to narrow holidays to a specific sub-national region. organization: title: Organization description: The organization this holiday calendar belongs to. name: type: string title: Name description: The display name of this holiday calendar. description: A set of holidays for a country or region that affects person availability and capacity calculations. resource_invoice: type: object title: Invoice Resource properties: overdue_status: enum: - 1 - 2 type: integer title: Overdue Status description: Overdue status indicating whether the invoice is past its due date. invoicing_method: enum: - 1 - 2 - 3 type: integer title: Invoicing Method description: Method used to generate line items on this invoice. attachment: title: Attachment description: The generated PDF document attached to this invoice. footer_interpolated: title: Footer Interpolated description: Footer text with template variables resolved. custom_field_attachments: title: Custom Field Attachments description: Files in file-type custom fields on this invoice. company_reference_id: type: integer title: Company Reference description: Company reference ID in the external accounting system. creation_options: type: object title: Creation Options description: Configuration options used when creating the invoice. amount_unpaid_normalized: title: Amount Unpaid Normalized description: Outstanding balance, normalized to the organization default currency. responsible_id: type: integer title: Responsible description: ID of the person responsible for this invoice. invoice_state: enum: - 1 - 2 type: integer title: Invoice State description: Current lifecycle state of the invoice (draft, finalized, sent, or paid). document_type: title: Document Type description: The PDF template used for rendering this invoice. bank_account_details: type: object title: Bank Account Details description: Bank account details shown on the invoice. amount_unpaid: title: Amount Unpaid description: Outstanding balance, in the invoice currency. finalized_on: type: string title: Finalized On format: date description: Date when the invoice was finalized (locked for editing). subsidiary: title: Subsidiary description: The subsidiary issuing this invoice. amount_with_tax_normalized: title: Amount With Tax Normalized description: Invoice total including tax, normalized to the organization default currency. invoice_status: enum: - 0 - 1 - 2 - 3 - 4 type: integer title: Invoice Status description: Combined payment and lifecycle status for display purposes. parent_invoice_id: type: integer title: Parent Invoice description: ID of the original invoice if this is a credit note. amount_credited: title: Amount Credited description: Amount credited via credit notes, excluding tax, in the invoice currency. parent_invoice: title: Parent Invoice description: The original invoice this credit note credits. automatically_created: type: boolean title: Automatically Created description: Whether this invoice was automatically generated from a template. tags: type: string title: Tags description: Tags applied to this invoice. finalized_at: type: string title: Finalized At format: date-time description: Timestamp when the invoice was finalized. paid_on: type: string title: Paid On format: date description: Date when the invoice was paid by the client. amount_paid_normalized: title: Amount Paid Normalized description: Amount already paid, normalized to the organization default currency. subscriber_id: type: integer title: Subscriber description: ID of the subscriber person for this invoice. exchange_date: type: string title: Exchange Date format: date description: Date used for currency exchange rate lookup. amount: title: Amount description: Invoice amount excluding tax, in the invoice currency. payment_terms: type: integer title: Payment Terms description: Number of days between the invoice issue date and the due date. issuer: title: Issuer description: The person issuing or finalizing this invoice. id: type: integer title: Id description: Unique identifier for this invoice. amount_unpaid_default: title: Amount Unpaid Default description: Outstanding balance, in the organization default currency. amount_credited_normalized: title: Amount Credited Normalized description: Amount credited via credit notes, excluding tax, normalized to the organization default currency. export_status: enum: - 1 - 2 type: integer title: Export Status description: Export status to external accounting software. amount_tax_default: title: Amount Tax Default description: Total tax amount, in the organization default currency. amount_default: title: Amount Default description: Invoice amount excluding tax, in the organization default currency. invoice_type: enum: - 1 - 2 type: integer title: Invoice Type description: Display label for the invoice type (standard invoice or credit note). parent_company_id: type: integer title: Parent Company description: ID of the parent company of the client linked to this invoice, used for hierarchical company filtering. sent_status: enum: - 1 - 2 type: integer title: Sent Status description: Sent status of the invoice. note_interpolated: title: Note Interpolated description: Invoice note with template variables resolved. amount_credited_with_tax: title: Amount Credited With Tax description: Amount credited including tax, in the invoice currency. export_invoice_url: type: string title: Export Invoice Url description: URL to view this invoice in the external accounting system. invoice_attributions: title: Invoice Attributions description: Links between this invoice and the budgets it bills. amount_written_off_normalized: title: Amount Written Off Normalized description: Amount written off as uncollectible, normalized to the organization default currency. line_item_tax: type: boolean title: Line Item Tax description: Whether tax is applied per line item rather than at the invoice level. subject: type: string title: Subject description: Short description of what is being invoiced. document_type_id: type: integer title: Document Type description: ID of the PDF template used for rendering this invoice. company_name: title: Company Name description: Name of the client company at the time of invoicing. amount_tax_normalized: title: Amount Tax Normalized description: Total tax amount, normalized to the organization default currency. exchange_rate: type: number title: Exchange Rate description: Exchange rate from the invoice currency to the organization default currency. custom_fields: type: object title: Custom Fields description: Custom field values on this invoice. invoice_template_id: type: integer title: Invoice Template description: ID of the invoice template used for auto-generation. project_id: type: integer title: Project description: ID of the project associated with this invoice. currency: type: string title: Currency description: Currency code of the invoice. pay_on_relative: type: boolean title: Pay On Relative description: Payment due as relative days from the invoice issue date. discount: type: number title: Discount description: Discount percentage applied to the invoice total. full_query: type: string title: Full Query description: Full-text search index value for this invoice. sample_data: type: boolean title: Sample Data description: Whether this record is demo data. delivery_on: type: string title: Delivery On format: date description: Date when the goods or services were delivered. number: type: string title: Number description: Unique invoice number. subscriber_ids: title: Subscriber Ids description: IDs of people subscribed to notifications for this invoice. bill_from: title: Bill From description: The subsidiary contact issuing the invoice. last_activity_at: type: string title: Last Activity At format: date-time description: Date of the last activity recorded on this invoice. issuer_id: type: integer title: Issuer description: ID of the person issuing or finalizing this invoice. credited: type: boolean title: Credited description: Whether this invoice has been credited via a credit note. creator_id: type: integer title: Creator description: ID of the person who created the invoice. note: type: string title: Note description: Internal notes on the invoice. invoice_aging: enum: - 0 - 1 - 2 - 3 - 4 type: integer title: Invoice Aging description: Number of days since the invoice was issued (aging). bill_to: title: Bill To description: The client contact receiving the invoice. currency_normalized: title: Currency Normalized description: Normalized currency code for cross-currency comparisons. query: type: string title: Query description: Search index representation of this invoice. organization: title: Organization description: The organization this invoice belongs to. currency_default: title: Currency Default description: Organization default currency code. amount_tax: title: Amount Tax description: Total tax amount, in the invoice currency. payment_status: enum: - 1 - 2 - 3 type: integer title: Payment Status description: Payment status of the invoice. exported: type: boolean title: Exported description: Whether this invoice has been exported to external accounting software. amount_credited_with_tax_default: title: Amount Credited With Tax Default description: Amount credited including tax, in the organization default currency. jump_query: type: string title: Jump Query description: Quick search index value for this invoice. attachment_id: type: integer title: Attachment description: ID of the generated PDF attachment for this invoice. tax1_name: type: string title: Tax1 Name description: Name of the primary tax (e.g. VAT). custom_field_people: title: Custom Field People description: People in person-type custom fields on this invoice. amount_paid: title: Amount Paid description: Amount already paid, in the invoice currency. bank_account_id: type: integer title: Bank Account description: ID of the bank account for payment. amount_paid_default: title: Amount Paid Default description: Amount already paid, in the organization default currency. amount_written_off: title: Amount Written Off description: Amount written off as uncollectible, in the invoice currency. tag_list: type: string title: Tag List description: Tags applied to this invoice. company: title: Company description: The client company being billed. company_id: type: integer title: Company description: ID of the client company being billed. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary issuing this invoice. amount_written_off_default: title: Amount Written Off Default description: Amount written off as uncollectible, in the organization default currency. email_key: type: string title: Email Key description: Unique key for email-based interactions with this invoice. invoice_type_id: enum: - 1 - 2 type: integer title: Invoice Type description: Whether this is a standard invoice or a credit note. status: enum: - 1 - 2 type: integer title: Status description: Combined status for display purposes. export_integration_type_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 type: integer title: Export Integration Type description: Type of accounting integration used for export. exported_at: type: string title: Exported At format: date-time description: Timestamp when this invoice was exported to accounting software. sent_on: type: string title: Sent On format: date description: Date when the invoice was sent to the client. footer: title: Footer description: Footer text on the invoice document. amount_normalized: title: Amount Normalized description: Invoice amount excluding tax, normalized to the organization default currency. fuzzy_dates: type: string title: Fuzzy Dates format: date description: Fuzzy date representation for flexible date-based display. deleted_at: type: string title: Deleted At format: date-time description: Soft-deletion timestamp; present if the invoice has been deleted. amount_with_tax: title: Amount With Tax description: Invoice total including tax, in the invoice currency. amount_credited_default: title: Amount Credited Default description: Amount credited via credit notes, excluding tax, in the organization default currency. tax2_value: type: number title: Tax2 Value description: Secondary tax rate percentage. tax2_name: type: string title: Tax2 Name description: Name of the secondary tax, if applicable. creator: title: Creator description: The person who created the invoice. pay_on: type: string title: Pay On format: date description: Due date for payment. bank_account: title: Bank Account description: The bank account for payment. amount_with_tax_default: title: Amount With Tax Default description: Invoice total including tax, in the organization default currency. amount_credited_with_tax_normalized: title: Amount Credited With Tax Normalized description: Amount credited including tax, normalized to the organization default currency. purchase_order_number: type: string title: Purchase Order Number description: Client-provided purchase order number for reference. example: PO-2024-017 tax1_value: type: number title: Tax1 Value description: Primary tax rate percentage. created_at: type: string title: Created At format: date-time description: Timestamp when the invoice was created. invoiced_on: type: string title: Invoiced On format: date description: Date when the invoice was issued. deal_id: type: integer title: Deal description: ID of the budget (deal) this invoice is linked to. updated_at: type: string title: Updated At format: date-time description: Timestamp of the last modification to this invoice. export_id: type: string title: Export description: ID of this invoice in the external accounting system. fuzzy_people: type: integer title: Fuzzy People description: Fuzzy people representation for flexible person-based display. description: A billing document issued to a client. Invoices progress through draft, finalized, sent, and paid stages, and contain line items drawn from budget services. _filter_root_booking_report: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_booking_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_booking_report" description: Filter schema for `booking_report` list endpoints — pass a single condition or a logical group. filter_custom_domain: type: object title: Filter custom domain properties: id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_custom_domain/properties/id" contains: "$ref": "#/components/schemas/resource_custom_domain/properties/id" eq: "$ref": "#/components/schemas/resource_custom_domain/properties/id" not_eq: "$ref": "#/components/schemas/resource_custom_domain/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_custom_domain/properties/id" description: Filter by custom domain ID. name: oneOf: - "$ref": "#/components/schemas/resource_custom_domain/properties/name" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_custom_domain/properties/name" not_eq: "$ref": "#/components/schemas/resource_custom_domain/properties/name" contains: "$ref": "#/components/schemas/resource_custom_domain/properties/name" eq: "$ref": "#/components/schemas/resource_custom_domain/properties/name" description: Filter using explicit operator syntax. description: Filter by domain name (text search). patternProperties: {} description: Filter parameters for custom domains. _filter_root_entitlement: oneOf: - "$ref": "#/components/schemas/filter_entitlement" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_entitlement" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `entitlement` list endpoints — pass a single condition or a logical group. _filter_root_session: oneOf: - "$ref": "#/components/schemas/filter_session" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_session" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `session` list endpoints — pass a single condition or a logical group. resource_folder: type: object title: Folder Resource properties: query: type: string title: Query description: The name of this folder, used as a search query field in filter operations. id: type: integer title: Id description: The unique identifier of this folder. name: type: string title: Name description: The display name of this folder. project_id: type: integer title: Project description: The ID of the project this folder belongs to. hidden: type: boolean title: Hidden description: Whether this folder is hidden from the project view. organization: title: Organization description: The organization this folder belongs to. archived_at: type: string title: Archived At format: date-time description: The timestamp when this folder was archived, or null if the folder is active. status: enum: - 1 - 2 type: integer title: Status description: The archive status of this folder. Returns 1 for active folders and 2 for archived folders. placement: type: integer title: Placement description: The fractional index used for ordering folders within a project, managed by the reposition endpoint. position: type: integer title: Position description: The integer sort position of this folder within its project. project: title: Project description: The project this folder belongs to. description: The folder resource schema representing a collection of task lists within a project. filter_timer: type: object title: Filter timer properties: stopped_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_timer/properties/stopped_at" eq: "$ref": "#/components/schemas/resource_timer/properties/stopped_at" contains: "$ref": "#/components/schemas/resource_timer/properties/stopped_at" not_eq: "$ref": "#/components/schemas/resource_timer/properties/stopped_at" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_timer/properties/stopped_at" description: Filter by the date the timer was stopped. person_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_timer/properties/person_id" eq: "$ref": "#/components/schemas/resource_timer/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_timer/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_timer/properties/person_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_timer/properties/person_id" description: Filter by the associated person. started_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_timer/properties/started_at" eq: "$ref": "#/components/schemas/resource_timer/properties/started_at" not_eq: "$ref": "#/components/schemas/resource_timer/properties/started_at" not_contain: "$ref": "#/components/schemas/resource_timer/properties/started_at" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_timer/properties/started_at" description: Filter by the date the timer was started. time_entry_id: oneOf: - "$ref": "#/components/schemas/resource_timer/properties/time_entry_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_timer/properties/time_entry_id" not_eq: "$ref": "#/components/schemas/resource_timer/properties/time_entry_id" contains: "$ref": "#/components/schemas/resource_timer/properties/time_entry_id" eq: "$ref": "#/components/schemas/resource_timer/properties/time_entry_id" description: Filter using explicit operator syntax. description: Filter by the associated time entry. patternProperties: {} description: Filter parameters for listing timer resources, which represent live running timers for active time tracking. resource_widget: type: object title: Widget Resource properties: attachment_ids: title: Attachment Ids description: IDs of attachments to associate with this widget. filter: title: Filter description: The saved filter applied to this widget's data. column_position: type: integer title: Column Position description: The horizontal column position of this widget within the dashboard grid. title: type: string title: Title description: The display title shown at the top of this widget. row_position: type: integer title: Row Position description: The vertical row position of this widget within the dashboard grid. height: type: integer title: Height description: The height of this widget in dashboard grid units. organization: title: Organization description: The organization this widget belongs to. widget_type_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 14 - 15 - 16 - 17 type: integer title: Widget Type description: The type of content this widget displays, such as Tasks, Report, or Note. report_layout_id: type: integer title: Report Layout description: ID of the report layout used by this widget. dashboard_id: type: integer title: Dashboard description: ID of the dashboard this widget belongs to. width: type: integer title: Width description: The width of this widget in dashboard grid units. attachments: title: Attachments description: Attachments linked to this widget. dashboard: title: Dashboard description: The dashboard this widget belongs to. content: type: string title: Content description: The rich text or HTML content of this widget, used for note-type widgets. params: title: Params description: Additional configuration parameters for this widget's data and display. filter_id: type: integer title: Filter description: ID of the saved filter applied to this widget's data. default_filter_id: title: Default Filter description: ID of the default filter applied to this widget when no user filter is selected. description: A widget is a configurable panel on a dashboard that displays a specific type of data such as tasks, time, expenses, or a report, and can be positioned and sized within the dashboard grid. filter_folder: type: object title: Filter folder properties: project_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_folder/properties/project_id" eq: "$ref": "#/components/schemas/resource_folder/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_folder/properties/project_id" contains: "$ref": "#/components/schemas/resource_folder/properties/project_id" description: Filter project ID using a specific comparison operator. - "$ref": "#/components/schemas/resource_folder/properties/project_id" description: Filter by the ID of the project the folder belongs to. query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_folder/properties/query" contains: "$ref": "#/components/schemas/resource_folder/properties/query" eq: "$ref": "#/components/schemas/resource_folder/properties/query" not_eq: "$ref": "#/components/schemas/resource_folder/properties/query" description: Filter folder name using a specific comparison operator. - "$ref": "#/components/schemas/resource_folder/properties/query" description: Filter by folder name using a text search query. id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_folder/properties/id" not_contain: "$ref": "#/components/schemas/resource_folder/properties/id" not_eq: "$ref": "#/components/schemas/resource_folder/properties/id" eq: "$ref": "#/components/schemas/resource_folder/properties/id" description: Filter folder ID using a specific comparison operator. - "$ref": "#/components/schemas/resource_folder/properties/id" description: Filter by folder ID. status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_folder/properties/status" not_contain: "$ref": "#/components/schemas/resource_folder/properties/status" eq: "$ref": "#/components/schemas/resource_folder/properties/status" not_eq: "$ref": "#/components/schemas/resource_folder/properties/status" description: Filter folder status using a specific comparison operator. - "$ref": "#/components/schemas/resource_folder/properties/status" description: Filter by folder archive status. patternProperties: "^project..*$": title: Project relationship description: Filter parameters for listing folders. _filter_root_timesheet: oneOf: - "$ref": "#/components/schemas/filter_timesheet" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_timesheet" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `timesheet` list endpoints — pass a single condition or a logical group. filter_survey_field: type: object title: Filter survey field properties: survey_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_survey_field/properties/survey_id" not_contain: "$ref": "#/components/schemas/resource_survey_field/properties/survey_id" eq: "$ref": "#/components/schemas/resource_survey_field/properties/survey_id" not_eq: "$ref": "#/components/schemas/resource_survey_field/properties/survey_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_survey_field/properties/survey_id" description: Filter by the associated survey. origin_field_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_survey_field/properties/origin_field_id" not_contain: "$ref": "#/components/schemas/resource_survey_field/properties/origin_field_id" not_eq: "$ref": "#/components/schemas/resource_survey_field/properties/origin_field_id" contains: "$ref": "#/components/schemas/resource_survey_field/properties/origin_field_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_survey_field/properties/origin_field_id" description: Filter by the original field this field was copied from. archived: oneOf: - "$ref": "#/components/schemas/resource_survey_field/properties/archived" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_survey_field/properties/archived" not_contain: "$ref": "#/components/schemas/resource_survey_field/properties/archived" contains: "$ref": "#/components/schemas/resource_survey_field/properties/archived" eq: "$ref": "#/components/schemas/resource_survey_field/properties/archived" description: Filter using explicit operator syntax. description: Filter to include only archived (or non-archived) survey fields. global: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_survey_field/properties/global" eq: "$ref": "#/components/schemas/resource_survey_field/properties/global" not_eq: "$ref": "#/components/schemas/resource_survey_field/properties/global" contains: "$ref": "#/components/schemas/resource_survey_field/properties/global" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_survey_field/properties/global" description: Filter by whether the survey field applies globally across all projects. name: oneOf: - "$ref": "#/components/schemas/resource_survey_field/properties/name" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_survey_field/properties/name" eq: "$ref": "#/components/schemas/resource_survey_field/properties/name" not_eq: "$ref": "#/components/schemas/resource_survey_field/properties/name" contains: "$ref": "#/components/schemas/resource_survey_field/properties/name" description: Filter using explicit operator syntax. description: Filter by field name (text search). show_in_add_edit_views: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_survey_field/properties/show_in_add_edit_views" contains: "$ref": "#/components/schemas/resource_survey_field/properties/show_in_add_edit_views" not_contain: "$ref": "#/components/schemas/resource_survey_field/properties/show_in_add_edit_views" not_eq: "$ref": "#/components/schemas/resource_survey_field/properties/show_in_add_edit_views" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_survey_field/properties/show_in_add_edit_views" description: Filter by whether the field is shown in add/edit form views. project_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_survey_field/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_survey_field/properties/project_id" contains: "$ref": "#/components/schemas/resource_survey_field/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_survey_field/properties/project_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_survey_field/properties/project_id" description: Filter by the associated project. patternProperties: {} description: Filter parameters for listing survey fields. Supports filtering by survey. Standard ID operators apply. _filter_root_line_item: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_line_item" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_line_item" description: Filter schema for `line_item` list endpoints — pass a single condition or a logical group. filter_approval_policy: type: object title: Filter approval policy properties: type_id: oneOf: - "$ref": "#/components/schemas/resource_approval_policy/properties/type_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_approval_policy/properties/type_id" not_eq: "$ref": "#/components/schemas/resource_approval_policy/properties/type_id" eq: "$ref": "#/components/schemas/resource_approval_policy/properties/type_id" not_contain: "$ref": "#/components/schemas/resource_approval_policy/properties/type_id" description: Filter using explicit operator syntax. description: Filter by approval policy type ID. custom: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_approval_policy/properties/custom" contains: "$ref": "#/components/schemas/resource_approval_policy/properties/custom" not_eq: "$ref": "#/components/schemas/resource_approval_policy/properties/custom" not_contain: "$ref": "#/components/schemas/resource_approval_policy/properties/custom" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_approval_policy/properties/custom" description: Filter by whether the approval policy is custom (true) or system-defined (false). status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_approval_policy/properties/status" not_contain: "$ref": "#/components/schemas/resource_approval_policy/properties/status" contains: "$ref": "#/components/schemas/resource_approval_policy/properties/status" eq: "$ref": "#/components/schemas/resource_approval_policy/properties/status" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_approval_policy/properties/status" description: Filter by active/archived status. patternProperties: {} description: Filter parameters for listing approval policies. Supports filtering by policy type, service, and person. Standard ID operators apply. filter_contract: type: object title: Filter contract properties: ends_on: oneOf: - "$ref": "#/components/schemas/resource_contract/properties/ends_on" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_contract/properties/ends_on" not_eq: "$ref": "#/components/schemas/resource_contract/properties/ends_on" eq: "$ref": "#/components/schemas/resource_contract/properties/ends_on" not_contain: "$ref": "#/components/schemas/resource_contract/properties/ends_on" description: Filter using explicit operator syntax. description: Filter by contract end date range (`ends_on`). id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_contract/properties/id" contains: "$ref": "#/components/schemas/resource_contract/properties/id" not_eq: "$ref": "#/components/schemas/resource_contract/properties/id" eq: "$ref": "#/components/schemas/resource_contract/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_contract/properties/id" description: Filter by contract ID. starts_on: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_contract/properties/starts_on" not_eq: "$ref": "#/components/schemas/resource_contract/properties/starts_on" contains: "$ref": "#/components/schemas/resource_contract/properties/starts_on" eq: "$ref": "#/components/schemas/resource_contract/properties/starts_on" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_contract/properties/starts_on" description: Filter by contract start date range (`starts_on`). contract_interval_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_contract/properties/contract_interval_id" contains: "$ref": "#/components/schemas/resource_contract/properties/contract_interval_id" not_eq: "$ref": "#/components/schemas/resource_contract/properties/contract_interval_id" eq: "$ref": "#/components/schemas/resource_contract/properties/contract_interval_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_contract/properties/contract_interval_id" description: Filter by the associated contract interval. next_occurrence_on: oneOf: - "$ref": "#/components/schemas/resource_contract/properties/next_occurrence_on" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_contract/properties/next_occurrence_on" not_eq: "$ref": "#/components/schemas/resource_contract/properties/next_occurrence_on" not_contain: "$ref": "#/components/schemas/resource_contract/properties/next_occurrence_on" eq: "$ref": "#/components/schemas/resource_contract/properties/next_occurrence_on" description: Filter using explicit operator syntax. description: Filter by next occurrence date range (`next_occurrence_on`). patternProperties: {} description: Filter parameters for listing contracts (recurring retainers). Supports filtering by template deal, start/end dates, interval, and next occurrence. Standard ID and date operators apply. _filter_root_task_dependency: oneOf: - "$ref": "#/components/schemas/filter_task_dependency" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_task_dependency" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `task_dependency` list endpoints — pass a single condition or a logical group. _filter_root_time_tracking_policy: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_time_tracking_policy" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_time_tracking_policy" description: Filter schema for `time_tracking_policy` list endpoints — pass a single condition or a logical group. _filter_root_report_category: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_report_category" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_report_category" description: Filter schema for `report_category` list endpoints — pass a single condition or a logical group. _filter_root_board: oneOf: - "$ref": "#/components/schemas/filter_board" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_board" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `board` list endpoints — pass a single condition or a logical group. filter_todo: type: object title: Filter todo properties: id: oneOf: - "$ref": "#/components/schemas/resource_todo/properties/id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_todo/properties/id" contains: "$ref": "#/components/schemas/resource_todo/properties/id" not_contain: "$ref": "#/components/schemas/resource_todo/properties/id" eq: "$ref": "#/components/schemas/resource_todo/properties/id" description: Filter using explicit operator syntax. description: Filter by todo ID. due_date: oneOf: - "$ref": "#/components/schemas/resource_todo/properties/due_date" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_todo/properties/due_date" eq: "$ref": "#/components/schemas/resource_todo/properties/due_date" contains: "$ref": "#/components/schemas/resource_todo/properties/due_date" not_eq: "$ref": "#/components/schemas/resource_todo/properties/due_date" description: Filter using explicit operator syntax. description: Filter by due date range. deal_id: oneOf: - "$ref": "#/components/schemas/resource_todo/properties/deal_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_todo/properties/deal_id" contains: "$ref": "#/components/schemas/resource_todo/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_todo/properties/deal_id" eq: "$ref": "#/components/schemas/resource_todo/properties/deal_id" description: Filter using explicit operator syntax. description: Filter by the associated deal. assignee_id: oneOf: - "$ref": "#/components/schemas/resource_todo/properties/assignee_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_todo/properties/assignee_id" not_eq: "$ref": "#/components/schemas/resource_todo/properties/assignee_id" eq: "$ref": "#/components/schemas/resource_todo/properties/assignee_id" contains: "$ref": "#/components/schemas/resource_todo/properties/assignee_id" description: Filter using explicit operator syntax. description: Filter by the assigned person. todoable_type: oneOf: - "$ref": "#/components/schemas/resource_todo/properties/todoable_type" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_todo/properties/todoable_type" not_eq: "$ref": "#/components/schemas/resource_todo/properties/todoable_type" not_contain: "$ref": "#/components/schemas/resource_todo/properties/todoable_type" contains: "$ref": "#/components/schemas/resource_todo/properties/todoable_type" description: Filter using explicit operator syntax. description: Filter by the type of parent resource the todo belongs to (task or deal). status: oneOf: - "$ref": "#/components/schemas/resource_todo/properties/status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_todo/properties/status" contains: "$ref": "#/components/schemas/resource_todo/properties/status" eq: "$ref": "#/components/schemas/resource_todo/properties/status" not_eq: "$ref": "#/components/schemas/resource_todo/properties/status" description: Filter using explicit operator syntax. description: Filter by completion status (open or closed). task_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_todo/properties/task_id" not_contain: "$ref": "#/components/schemas/resource_todo/properties/task_id" not_eq: "$ref": "#/components/schemas/resource_todo/properties/task_id" contains: "$ref": "#/components/schemas/resource_todo/properties/task_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_todo/properties/task_id" description: Filter by the associated task. patternProperties: "^assignee..*$": title: Assignee relationship description: Filter parameters for listing todos (checklist items). Supports filtering by parent resource (task or deal), assignee, completion status, due date, and position. Standard ID and date operators apply. _filter_root_document_type: oneOf: - "$ref": "#/components/schemas/filter_document_type" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_document_type" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `document_type` list endpoints — pass a single condition or a logical group. filter_survey_report: type: object title: Filter survey report properties: id: oneOf: - "$ref": "#/components/schemas/resource_survey_report/properties/id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_survey_report/properties/id" eq: "$ref": "#/components/schemas/resource_survey_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_survey_report/properties/id" contains: "$ref": "#/components/schemas/resource_survey_report/properties/id" description: Filter operator object for id. description: Filter survey report results by id. project_id: oneOf: - "$ref": "#/components/schemas/resource_survey_report/properties/project_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_survey_report/properties/project_id" eq: "$ref": "#/components/schemas/resource_survey_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_survey_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_survey_report/properties/project_id" description: Filter operator object for project id. description: Filter survey report results by project id. query: oneOf: - "$ref": "#/components/schemas/resource_survey_report/properties/query" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_survey_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_survey_report/properties/query" contains: "$ref": "#/components/schemas/resource_survey_report/properties/query" not_eq: "$ref": "#/components/schemas/resource_survey_report/properties/query" description: Filter operator object for query. description: Filter survey report results by query. title: oneOf: - "$ref": "#/components/schemas/resource_survey_report/properties/title" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_survey_report/properties/title" not_contain: "$ref": "#/components/schemas/resource_survey_report/properties/title" not_eq: "$ref": "#/components/schemas/resource_survey_report/properties/title" contains: "$ref": "#/components/schemas/resource_survey_report/properties/title" description: Filter operator object for title. description: Filter survey report results by title. creator_id: oneOf: - "$ref": "#/components/schemas/resource_survey_report/properties/creator_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_survey_report/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_survey_report/properties/creator_id" eq: "$ref": "#/components/schemas/resource_survey_report/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_survey_report/properties/creator_id" description: Filter operator object for creator id. description: Filter survey report results by creator id. created_at: oneOf: - "$ref": "#/components/schemas/resource_survey_report/properties/created_at" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_survey_report/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_survey_report/properties/created_at" contains: "$ref": "#/components/schemas/resource_survey_report/properties/created_at" eq: "$ref": "#/components/schemas/resource_survey_report/properties/created_at" description: Filter operator object for created at. description: Filter survey report results by created at. editable: oneOf: - "$ref": "#/components/schemas/resource_survey_report/properties/editable" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_survey_report/properties/editable" contains: "$ref": "#/components/schemas/resource_survey_report/properties/editable" not_eq: "$ref": "#/components/schemas/resource_survey_report/properties/editable" not_contain: "$ref": "#/components/schemas/resource_survey_report/properties/editable" description: Filter operator object for editable. description: Filter survey report results by editable. patternProperties: "^creator..*$": title: Creator relationship "^project..*$": title: Project relationship description: Available filter parameters for querying aggregated survey report data. filter_project: type: object title: Filter project properties: project_color: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project/properties/project_color" not_eq: "$ref": "#/components/schemas/resource_project/properties/project_color" eq: "$ref": "#/components/schemas/resource_project/properties/project_color" not_contain: "$ref": "#/components/schemas/resource_project/properties/project_color" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/project_color" description: Filter by the project's color label. for_tracking: oneOf: - "$ref": "#/components/schemas/resource_project/properties/for_tracking" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project/properties/for_tracking" eq: "$ref": "#/components/schemas/resource_project/properties/for_tracking" not_contain: "$ref": "#/components/schemas/resource_project/properties/for_tracking" not_eq: "$ref": "#/components/schemas/resource_project/properties/for_tracking" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter to only include projects eligible for time tracking (active projects only). number: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project/properties/number" eq: "$ref": "#/components/schemas/resource_project/properties/number" contains: "$ref": "#/components/schemas/resource_project/properties/number" not_eq: "$ref": "#/components/schemas/resource_project/properties/number" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/number" description: Filter by auto-generated project number. fuzzy_people: oneOf: - "$ref": "#/components/schemas/resource_project/properties/fuzzy_people" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_project/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_project/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_project/properties/fuzzy_people" description: Operator object — supports eq, not_eq, contains, not_contain. description: Fuzzy person filter — matches projects by associated people (members or project manager). estimated_time: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project/properties/estimated_time" not_contain: "$ref": "#/components/schemas/resource_project/properties/estimated_time" not_eq: "$ref": "#/components/schemas/resource_project/properties/estimated_time" eq: "$ref": "#/components/schemas/resource_project/properties/estimated_time" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/estimated_time" description: Filter by total estimated time across open budgets (in minutes). project_type: oneOf: - "$ref": "#/components/schemas/resource_project/properties/project_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project/properties/project_type" not_contain: "$ref": "#/components/schemas/resource_project/properties/project_type" not_eq: "$ref": "#/components/schemas/resource_project/properties/project_type" eq: "$ref": "#/components/schemas/resource_project/properties/project_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by project type — 1 for internal/overhead, 2 for billable client work. workflow_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_project/properties/workflow_id" not_eq: "$ref": "#/components/schemas/resource_project/properties/workflow_id" not_contain: "$ref": "#/components/schemas/resource_project/properties/workflow_id" contains: "$ref": "#/components/schemas/resource_project/properties/workflow_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/workflow_id" description: Filter by the project's task workflow. cost: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/cost" contains: "$ref": "#/components/schemas/resource_project/properties/cost" eq: "$ref": "#/components/schemas/resource_project/properties/cost" not_contain: "$ref": "#/components/schemas/resource_project/properties/cost" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/cost" description: Filter by total cost across open budgets (in base currency). jump_query: oneOf: - "$ref": "#/components/schemas/resource_project/properties/jump_query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/jump_query" contains: "$ref": "#/components/schemas/resource_project/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_project/properties/jump_query" eq: "$ref": "#/components/schemas/resource_project/properties/jump_query" description: Operator object — supports eq, not_eq, contains, not_contain. description: Quick-jump search query for fast project navigation by name. responsible_id: oneOf: - "$ref": "#/components/schemas/resource_project/properties/responsible_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_project/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_project/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_project/properties/responsible_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by responsible person (project manager) ID. created_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_project/properties/created_at" eq: "$ref": "#/components/schemas/resource_project/properties/created_at" contains: "$ref": "#/components/schemas/resource_project/properties/created_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/created_at" description: Filter by creation date range (created_at). parent_company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/parent_company_id" not_contain: "$ref": "#/components/schemas/resource_project/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_project/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_project/properties/parent_company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/parent_company_id" description: Filter by the parent company of the project's company. query: oneOf: - "$ref": "#/components/schemas/resource_project/properties/query" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project/properties/query" not_eq: "$ref": "#/components/schemas/resource_project/properties/query" eq: "$ref": "#/components/schemas/resource_project/properties/query" contains: "$ref": "#/components/schemas/resource_project/properties/query" description: Operator object — supports eq, not_eq, contains, not_contain. description: Full-text search query — matches project name and other fields. id: oneOf: - "$ref": "#/components/schemas/resource_project/properties/id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_project/properties/id" not_contain: "$ref": "#/components/schemas/resource_project/properties/id" not_eq: "$ref": "#/components/schemas/resource_project/properties/id" contains: "$ref": "#/components/schemas/resource_project/properties/id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by project ID. status: oneOf: - "$ref": "#/components/schemas/resource_project/properties/status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project/properties/status" eq: "$ref": "#/components/schemas/resource_project/properties/status" contains: "$ref": "#/components/schemas/resource_project/properties/status" not_eq: "$ref": "#/components/schemas/resource_project/properties/status" description: Operator object — supports eq, not_eq. description: Filter by project status. 1 = active, 2 = archived. name: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/name" not_contain: "$ref": "#/components/schemas/resource_project/properties/name" contains: "$ref": "#/components/schemas/resource_project/properties/name" eq: "$ref": "#/components/schemas/resource_project/properties/name" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/name" description: Filter by project name (text search). with_templates: oneOf: - "$ref": "#/components/schemas/resource_project/properties/with_templates" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/with_templates" contains: "$ref": "#/components/schemas/resource_project/properties/with_templates" not_contain: "$ref": "#/components/schemas/resource_project/properties/with_templates" eq: "$ref": "#/components/schemas/resource_project/properties/with_templates" description: Operator object — supports eq, not_eq, contains, not_contain. description: When true, includes template projects in results (removes the default filter that excludes templates). worked_time: oneOf: - "$ref": "#/components/schemas/resource_project/properties/worked_time" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project/properties/worked_time" eq: "$ref": "#/components/schemas/resource_project/properties/worked_time" contains: "$ref": "#/components/schemas/resource_project/properties/worked_time" not_eq: "$ref": "#/components/schemas/resource_project/properties/worked_time" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total worked time across open budgets only (in minutes). pending_invoicing: oneOf: - "$ref": "#/components/schemas/resource_project/properties/pending_invoicing" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/pending_invoicing" not_contain: "$ref": "#/components/schemas/resource_project/properties/pending_invoicing" contains: "$ref": "#/components/schemas/resource_project/properties/pending_invoicing" eq: "$ref": "#/components/schemas/resource_project/properties/pending_invoicing" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by amount pending invoicing across open budgets (in base currency). project_number: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_project/properties/project_number" not_eq: "$ref": "#/components/schemas/resource_project/properties/project_number" not_contain: "$ref": "#/components/schemas/resource_project/properties/project_number" contains: "$ref": "#/components/schemas/resource_project/properties/project_number" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/project_number" description: Filter by formatted project number string (e.g. ACME-001). profit: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project/properties/profit" contains: "$ref": "#/components/schemas/resource_project/properties/profit" eq: "$ref": "#/components/schemas/resource_project/properties/profit" not_eq: "$ref": "#/components/schemas/resource_project/properties/profit" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/profit" description: Filter by total profit across open budgets (in base currency). total_worked_time: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project/properties/total_worked_time" eq: "$ref": "#/components/schemas/resource_project/properties/total_worked_time" contains: "$ref": "#/components/schemas/resource_project/properties/total_worked_time" not_eq: "$ref": "#/components/schemas/resource_project/properties/total_worked_time" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/total_worked_time" description: Filter by total worked time across all budgets including closed ones (in minutes). budget_id: oneOf: - "$ref": "#/components/schemas/resource_project/properties/budget_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/budget_id" eq: "$ref": "#/components/schemas/resource_project/properties/budget_id" contains: "$ref": "#/components/schemas/resource_project/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_project/properties/budget_id" description: Operator object — supports eq, not_eq. description: Filter by the associated budget (deal). custom_fields: oneOf: - "$ref": "#/components/schemas/resource_project/properties/custom_fields" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_project/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_project/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_project/properties/custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by custom field values. person_id: oneOf: - "$ref": "#/components/schemas/resource_project/properties/person_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project/properties/person_id" eq: "$ref": "#/components/schemas/resource_project/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_project/properties/person_id" contains: "$ref": "#/components/schemas/resource_project/properties/person_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by person ID — returns projects where the person is a member or project manager. full_query: oneOf: - "$ref": "#/components/schemas/resource_project/properties/full_query" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_project/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_project/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_project/properties/full_query" eq: "$ref": "#/components/schemas/resource_project/properties/full_query" description: Operator object — supports eq, not_eq, contains, not_contain. description: Full-text search across all project content fields. revenue: oneOf: - "$ref": "#/components/schemas/resource_project/properties/revenue" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project/properties/revenue" eq: "$ref": "#/components/schemas/resource_project/properties/revenue" not_eq: "$ref": "#/components/schemas/resource_project/properties/revenue" contains: "$ref": "#/components/schemas/resource_project/properties/revenue" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total revenue across open budgets (in base currency). fuzzy_dates: oneOf: - "$ref": "#/components/schemas/resource_project/properties/fuzzy_dates" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/fuzzy_dates" not_contain: "$ref": "#/components/schemas/resource_project/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_project/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_project/properties/fuzzy_dates" description: Operator object — supports eq, not_eq, contains, not_contain. description: Fuzzy date range filter — matches projects by start/end date proximity. public_access: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/public_access" contains: "$ref": "#/components/schemas/resource_project/properties/public_access" eq: "$ref": "#/components/schemas/resource_project/properties/public_access" not_contain: "$ref": "#/components/schemas/resource_project/properties/public_access" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/public_access" description: Deprecated. No-op filter — has no effect on results. project_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/project_id" eq: "$ref": "#/components/schemas/resource_project/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_project/properties/project_id" contains: "$ref": "#/components/schemas/resource_project/properties/project_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/project_id" description: Alias for id — filter by project ID. profit_margin: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project/properties/profit_margin" contains: "$ref": "#/components/schemas/resource_project/properties/profit_margin" not_eq: "$ref": "#/components/schemas/resource_project/properties/profit_margin" eq: "$ref": "#/components/schemas/resource_project/properties/profit_margin" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/profit_margin" description: Filter by the project's profit margin across open budgets. template: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_project/properties/template" contains: "$ref": "#/components/schemas/resource_project/properties/template" eq: "$ref": "#/components/schemas/resource_project/properties/template" not_eq: "$ref": "#/components/schemas/resource_project/properties/template" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_project/properties/template" description: Filter to only return template projects. company_id: oneOf: - "$ref": "#/components/schemas/resource_project/properties/company_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_project/properties/company_id" eq: "$ref": "#/components/schemas/resource_project/properties/company_id" contains: "$ref": "#/components/schemas/resource_project/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by client company. patternProperties: "^deals..*$": title: Deals relationship "^budgets..*$": title: Budgets relationship "^company..*$": title: Company relationship "^project_manager..*$": title: Project manager relationship description: Available filter parameters for querying projects. resource_timesheet_report: type: object title: Timesheet report Resource properties: tuesday_capacity: type: integer title: Tuesday Capacity description: Tuesday capacity for this timesheet report group. week: type: string title: Week description: Week grouping for this timesheet report row. report: title: Report description: Report for this timesheet report group. after: type: string title: After format: date description: After for this timesheet report group. group: type: string title: Group description: The grouping dimension for this timesheet report row. currency_normalized: title: Currency Normalized description: Currency in the normalized currency for this timesheet report group. wednesday_time: type: integer title: Wednesday Time description: Wednesday time for this timesheet report group. before: type: string title: Before format: date description: Before for this timesheet report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this timesheet report group. friday_available: type: integer title: Friday Available description: Friday available for this timesheet report group. sunday_capacity: type: integer title: Sunday Capacity description: Sunday capacity for this timesheet report group. monday_available: type: integer title: Monday Available description: Monday available for this timesheet report group. monday_capacity: type: integer title: Monday Capacity description: Monday capacity for this timesheet report group. saturday_capacity: type: integer title: Saturday Capacity description: Saturday capacity for this timesheet report group. sunday_time: type: integer title: Sunday Time description: Sunday time for this timesheet report group. saturday_time: type: integer title: Saturday Time description: Saturday time for this timesheet report group. people_custom_fields: type: string title: People Custom Fields description: People custom fields for this timesheet report group. saturday_available: type: integer title: Saturday Available description: Saturday available for this timesheet report group. friday_capacity: type: integer title: Friday Capacity description: Friday capacity for this timesheet report group. sunday_available: type: integer title: Sunday Available description: Sunday available for this timesheet report group. monday_time: type: integer title: Monday Time description: Monday time for this timesheet report group. wednesday_capacity: type: integer title: Wednesday Capacity description: Wednesday capacity for this timesheet report group. person: title: Person description: Person for this timesheet report group. thursday_time: type: integer title: Thursday Time description: Thursday time for this timesheet report group. friday_time: type: integer title: Friday Time description: Friday time for this timesheet report group. count: type: integer title: Count description: Number of timesheets in this report group. person_status: type: integer title: Person Status description: Person status for this timesheet report group. tuesday_time: type: integer title: Tuesday Time description: Tuesday time for this timesheet report group. formula_fields: title: Formula Fields description: Formula fields for this timesheet report group. tags: type: string title: Tags description: Tags for this timesheet report group. wednesday_available: type: integer title: Wednesday Available description: Wednesday available for this timesheet report group. query: type: string title: Query description: Query for this timesheet report group. tuesday_available: type: integer title: Tuesday Available description: Tuesday available for this timesheet report group. person_id: type: integer title: Person description: Person id for this timesheet report group. week_submission_status: enum: - submitted - partially_submitted - not_submitted type: string title: Week Submission Status description: Week submission status for this timesheet report group. currency: title: Currency description: Currency for this timesheet report group. organization: title: Organization description: Organization for this timesheet report group. thursday_available: type: integer title: Thursday Available description: Thursday available for this timesheet report group. thursday_capacity: type: integer title: Thursday Capacity description: Thursday capacity for this timesheet report group. description: An aggregated timesheet report row grouping timesheet records by configurable dimensions with time metrics. _filter_root_service_report: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_service_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_service_report" description: Filter schema for `service_report` list endpoints — pass a single condition or a logical group. filter_integration_exporter_configuration: type: object title: Filter integration exporter configuration properties: company_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/company_id" eq: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/company_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/company_id" description: Filter by client company. patternProperties: {} description: Filter parameters for integration exporter configurations. _filter_root_role: oneOf: - "$ref": "#/components/schemas/filter_role" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_role" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `role` list endpoints — pass a single condition or a logical group. filter_service_assignment: type: object title: Filter service assignment properties: id: oneOf: - "$ref": "#/components/schemas/resource_service_assignment/properties/id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_assignment/properties/id" not_eq: "$ref": "#/components/schemas/resource_service_assignment/properties/id" eq: "$ref": "#/components/schemas/resource_service_assignment/properties/id" not_contain: "$ref": "#/components/schemas/resource_service_assignment/properties/id" description: Filter using explicit operator syntax. description: Filter by service assignment ID. service_id: oneOf: - "$ref": "#/components/schemas/resource_service_assignment/properties/service_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_assignment/properties/service_id" contains: "$ref": "#/components/schemas/resource_service_assignment/properties/service_id" not_eq: "$ref": "#/components/schemas/resource_service_assignment/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_service_assignment/properties/service_id" description: Filter using explicit operator syntax. description: Filter by the associated service. person_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_assignment/properties/person_id" contains: "$ref": "#/components/schemas/resource_service_assignment/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_service_assignment/properties/person_id" eq: "$ref": "#/components/schemas/resource_service_assignment/properties/person_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_service_assignment/properties/person_id" description: Filter by the assigned person. patternProperties: {} description: Filter parameters for querying service assignments. filter_kpd_code: type: object title: Filter kpd code properties: id: oneOf: - "$ref": "#/components/schemas/resource_kpd_code/properties/id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_kpd_code/properties/id" eq: "$ref": "#/components/schemas/resource_kpd_code/properties/id" not_eq: "$ref": "#/components/schemas/resource_kpd_code/properties/id" not_contain: "$ref": "#/components/schemas/resource_kpd_code/properties/id" description: Comparison operators for this filter field. example: eq: '42' description: Filter by the KPD code record ID. example: '42' code: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_kpd_code/properties/code" eq: "$ref": "#/components/schemas/resource_kpd_code/properties/code" not_eq: "$ref": "#/components/schemas/resource_kpd_code/properties/code" not_contain: "$ref": "#/components/schemas/resource_kpd_code/properties/code" description: Comparison operators for this filter field. example: eq: '01.11' - "$ref": "#/components/schemas/resource_kpd_code/properties/code" description: Filter by the classification code value. example: '01.11' query: oneOf: - "$ref": "#/components/schemas/resource_kpd_code/properties/query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_kpd_code/properties/query" eq: "$ref": "#/components/schemas/resource_kpd_code/properties/query" contains: "$ref": "#/components/schemas/resource_kpd_code/properties/query" not_contain: "$ref": "#/components/schemas/resource_kpd_code/properties/query" description: Comparison operators for this filter field. example: contains: žitarica description: Full-text search across KPD and NKD code names. example: žitarica is_kpd: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_kpd_code/properties/is_kpd" eq: "$ref": "#/components/schemas/resource_kpd_code/properties/is_kpd" description: Comparison operators for this filter field. example: eq: true - "$ref": "#/components/schemas/resource_kpd_code/properties/is_kpd" description: Filter by whether the code is a KPD classification (true) or an NKD classification (false). example: true description: Available filter fields for KPD code resources. example: is_kpd: true query: žitarica filter_membership: type: object title: Filter membership properties: agent_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_membership/properties/agent_id" eq: "$ref": "#/components/schemas/resource_membership/properties/agent_id" contains: "$ref": "#/components/schemas/resource_membership/properties/agent_id" not_eq: "$ref": "#/components/schemas/resource_membership/properties/agent_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_membership/properties/agent_id" description: Filter memberships where the target is the specified agent. target_type: oneOf: - "$ref": "#/components/schemas/resource_membership/properties/target_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_membership/properties/target_type" not_eq: "$ref": "#/components/schemas/resource_membership/properties/target_type" eq: "$ref": "#/components/schemas/resource_membership/properties/target_type" contains: "$ref": "#/components/schemas/resource_membership/properties/target_type" description: Filter using explicit operator syntax. description: Filter by the type of the target resource (used together with target_id). id: oneOf: - "$ref": "#/components/schemas/resource_membership/properties/id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_membership/properties/id" not_contain: "$ref": "#/components/schemas/resource_membership/properties/id" eq: "$ref": "#/components/schemas/resource_membership/properties/id" not_eq: "$ref": "#/components/schemas/resource_membership/properties/id" description: Filter using explicit operator syntax. description: Filter by membership ID. access_type_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_membership/properties/access_type_id" not_contain: "$ref": "#/components/schemas/resource_membership/properties/access_type_id" contains: "$ref": "#/components/schemas/resource_membership/properties/access_type_id" eq: "$ref": "#/components/schemas/resource_membership/properties/access_type_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_membership/properties/access_type_id" description: Filter by the membership access type. type_id: oneOf: - "$ref": "#/components/schemas/resource_membership/properties/type_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_membership/properties/type_id" not_eq: "$ref": "#/components/schemas/resource_membership/properties/type_id" contains: "$ref": "#/components/schemas/resource_membership/properties/type_id" eq: "$ref": "#/components/schemas/resource_membership/properties/type_id" description: Filter using explicit operator syntax. description: Filter by the membership type (e.g. person, team, dynamic group). project_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_membership/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_membership/properties/project_id" contains: "$ref": "#/components/schemas/resource_membership/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_membership/properties/project_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_membership/properties/project_id" description: Filter by the associated project. filter_id: oneOf: - "$ref": "#/components/schemas/resource_membership/properties/filter_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_membership/properties/filter_id" eq: "$ref": "#/components/schemas/resource_membership/properties/filter_id" not_eq: "$ref": "#/components/schemas/resource_membership/properties/filter_id" not_contain: "$ref": "#/components/schemas/resource_membership/properties/filter_id" description: Filter using explicit operator syntax. description: Filter by the associated saved filter. deal_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_membership/properties/deal_id" contains: "$ref": "#/components/schemas/resource_membership/properties/deal_id" eq: "$ref": "#/components/schemas/resource_membership/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_membership/properties/deal_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_membership/properties/deal_id" description: Filter by the associated deal. dynamic_group_id: oneOf: - "$ref": "#/components/schemas/resource_membership/properties/dynamic_group_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_membership/properties/dynamic_group_id" not_contain: "$ref": "#/components/schemas/resource_membership/properties/dynamic_group_id" not_eq: "$ref": "#/components/schemas/resource_membership/properties/dynamic_group_id" contains: "$ref": "#/components/schemas/resource_membership/properties/dynamic_group_id" description: Filter using explicit operator syntax. description: Filter by the associated dynamic group. dashboard_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_membership/properties/dashboard_id" eq: "$ref": "#/components/schemas/resource_membership/properties/dashboard_id" not_eq: "$ref": "#/components/schemas/resource_membership/properties/dashboard_id" contains: "$ref": "#/components/schemas/resource_membership/properties/dashboard_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_membership/properties/dashboard_id" description: Filter by the associated dashboard. person_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_membership/properties/person_id" eq: "$ref": "#/components/schemas/resource_membership/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_membership/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_membership/properties/person_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_membership/properties/person_id" description: Filter by specific person. target_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_membership/properties/target_id" eq: "$ref": "#/components/schemas/resource_membership/properties/target_id" not_eq: "$ref": "#/components/schemas/resource_membership/properties/target_id" contains: "$ref": "#/components/schemas/resource_membership/properties/target_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_membership/properties/target_id" description: Filter by the ID of the target resource (used together with target_type). page_id: oneOf: - "$ref": "#/components/schemas/resource_membership/properties/page_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_membership/properties/page_id" eq: "$ref": "#/components/schemas/resource_membership/properties/page_id" not_contain: "$ref": "#/components/schemas/resource_membership/properties/page_id" not_eq: "$ref": "#/components/schemas/resource_membership/properties/page_id" description: Filter using explicit operator syntax. description: Filter by the associated page (doc). survey_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_membership/properties/survey_id" not_contain: "$ref": "#/components/schemas/resource_membership/properties/survey_id" eq: "$ref": "#/components/schemas/resource_membership/properties/survey_id" not_eq: "$ref": "#/components/schemas/resource_membership/properties/survey_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_membership/properties/survey_id" description: Filter by the associated survey. patternProperties: {} description: Filter parameters for listing memberships. Supports filtering by target resource type (project, deal, page, dashboard, filter, survey), person, team, access type, and dynamic group. Standard ID and string operators apply. filter_comment: type: object title: Filter comment properties: full_query: oneOf: - "$ref": "#/components/schemas/resource_comment/properties/full_query" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_comment/properties/full_query" eq: "$ref": "#/components/schemas/resource_comment/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_comment/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_comment/properties/full_query" description: Filter using explicit operator syntax. description: Full-text search across comment content. task_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_comment/properties/task_id" not_eq: "$ref": "#/components/schemas/resource_comment/properties/task_id" eq: "$ref": "#/components/schemas/resource_comment/properties/task_id" not_contain: "$ref": "#/components/schemas/resource_comment/properties/task_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_comment/properties/task_id" description: Filter by the associated task. sales_status_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_comment/properties/sales_status_id" contains: "$ref": "#/components/schemas/resource_comment/properties/sales_status_id" eq: "$ref": "#/components/schemas/resource_comment/properties/sales_status_id" not_eq: "$ref": "#/components/schemas/resource_comment/properties/sales_status_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_comment/properties/sales_status_id" description: Filter by sales pipeline status (used in full-text search context). draft: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_comment/properties/draft" not_contain: "$ref": "#/components/schemas/resource_comment/properties/draft" contains: "$ref": "#/components/schemas/resource_comment/properties/draft" eq: "$ref": "#/components/schemas/resource_comment/properties/draft" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_comment/properties/draft" description: Filter to include only draft comments. responsible_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_comment/properties/responsible_id" not_eq: "$ref": "#/components/schemas/resource_comment/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_comment/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_comment/properties/responsible_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_comment/properties/responsible_id" description: Filter by the person responsible (used in full-text search context). discussion_id: oneOf: - "$ref": "#/components/schemas/resource_comment/properties/discussion_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_comment/properties/discussion_id" not_contain: "$ref": "#/components/schemas/resource_comment/properties/discussion_id" eq: "$ref": "#/components/schemas/resource_comment/properties/discussion_id" not_eq: "$ref": "#/components/schemas/resource_comment/properties/discussion_id" description: Filter using explicit operator syntax. description: Filter by the associated discussion. jump_query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_comment/properties/jump_query" eq: "$ref": "#/components/schemas/resource_comment/properties/jump_query" contains: "$ref": "#/components/schemas/resource_comment/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_comment/properties/jump_query" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_comment/properties/jump_query" description: Jump (prefix) full-text search across comment content. budget_status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_comment/properties/budget_status" contains: "$ref": "#/components/schemas/resource_comment/properties/budget_status" not_contain: "$ref": "#/components/schemas/resource_comment/properties/budget_status" eq: "$ref": "#/components/schemas/resource_comment/properties/budget_status" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_comment/properties/budget_status" description: Filter comments by budget status (used in full-text search context). project_id: oneOf: - "$ref": "#/components/schemas/resource_comment/properties/project_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_comment/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_comment/properties/project_id" eq: "$ref": "#/components/schemas/resource_comment/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_comment/properties/project_id" description: Filter using explicit operator syntax. description: Filter by the associated project (via task). person_type: oneOf: - "$ref": "#/components/schemas/resource_comment/properties/person_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_comment/properties/person_type" eq: "$ref": "#/components/schemas/resource_comment/properties/person_type" not_eq: "$ref": "#/components/schemas/resource_comment/properties/person_type" not_contain: "$ref": "#/components/schemas/resource_comment/properties/person_type" description: Filter using explicit operator syntax. description: Filter by person type (used in full-text search context). workflow_status_category_id: oneOf: - "$ref": "#/components/schemas/resource_comment/properties/workflow_status_category_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_comment/properties/workflow_status_category_id" not_contain: "$ref": "#/components/schemas/resource_comment/properties/workflow_status_category_id" contains: "$ref": "#/components/schemas/resource_comment/properties/workflow_status_category_id" eq: "$ref": "#/components/schemas/resource_comment/properties/workflow_status_category_id" description: Filter using explicit operator syntax. description: Filter by workflow status category. role_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_comment/properties/role_id" not_eq: "$ref": "#/components/schemas/resource_comment/properties/role_id" not_contain: "$ref": "#/components/schemas/resource_comment/properties/role_id" eq: "$ref": "#/components/schemas/resource_comment/properties/role_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_comment/properties/role_id" description: Filter by role (used in full-text search context). commentable_project_id: oneOf: - "$ref": "#/components/schemas/resource_comment/properties/commentable_project_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_comment/properties/commentable_project_id" not_eq: "$ref": "#/components/schemas/resource_comment/properties/commentable_project_id" not_contain: "$ref": "#/components/schemas/resource_comment/properties/commentable_project_id" eq: "$ref": "#/components/schemas/resource_comment/properties/commentable_project_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the project containing the commented-on resource. status: oneOf: - "$ref": "#/components/schemas/resource_comment/properties/status" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_comment/properties/status" not_contain: "$ref": "#/components/schemas/resource_comment/properties/status" contains: "$ref": "#/components/schemas/resource_comment/properties/status" not_eq: "$ref": "#/components/schemas/resource_comment/properties/status" description: Filter using explicit operator syntax. description: Filter by company status (used in full-text search context). fuzzy_dates: oneOf: - "$ref": "#/components/schemas/resource_comment/properties/fuzzy_dates" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_comment/properties/fuzzy_dates" not_contain: "$ref": "#/components/schemas/resource_comment/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_comment/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_comment/properties/fuzzy_dates" description: Filter using explicit operator syntax. description: Filter by fuzzy date range (relative date expression). page_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_comment/properties/page_id" not_eq: "$ref": "#/components/schemas/resource_comment/properties/page_id" not_contain: "$ref": "#/components/schemas/resource_comment/properties/page_id" eq: "$ref": "#/components/schemas/resource_comment/properties/page_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_comment/properties/page_id" description: Filter by the associated document page. public_access: oneOf: - "$ref": "#/components/schemas/resource_comment/properties/public_access" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_comment/properties/public_access" not_eq: "$ref": "#/components/schemas/resource_comment/properties/public_access" contains: "$ref": "#/components/schemas/resource_comment/properties/public_access" eq: "$ref": "#/components/schemas/resource_comment/properties/public_access" description: Filter using explicit operator syntax. description: Filter by public access setting (used in full-text search context). company_id: oneOf: - "$ref": "#/components/schemas/resource_comment/properties/company_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_comment/properties/company_id" contains: "$ref": "#/components/schemas/resource_comment/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_comment/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_comment/properties/company_id" description: Filter using explicit operator syntax. description: Filter by client company (used in full-text search context). status_id: oneOf: - "$ref": "#/components/schemas/resource_comment/properties/status_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_comment/properties/status_id" not_eq: "$ref": "#/components/schemas/resource_comment/properties/status_id" not_contain: "$ref": "#/components/schemas/resource_comment/properties/status_id" eq: "$ref": "#/components/schemas/resource_comment/properties/status_id" description: Filter using explicit operator syntax. description: Filter by workflow status (used in full-text search context). fuzzy_people: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_comment/properties/fuzzy_people" not_contain: "$ref": "#/components/schemas/resource_comment/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_comment/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_comment/properties/fuzzy_people" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_comment/properties/fuzzy_people" description: Filter by person using fuzzy matching. patternProperties: {} description: Filter parameters for listing comments. Supports filtering by parent resource (task, deal, company, person, page, project, purchase order), author, discussion thread, draft status, and full-text search. Standard string operators apply. resource_deal: type: object title: Deal Resource properties: projected_revenue_normalized: title: Projected Revenue Normalized description: Expected revenue = budget total * probability (normalized currency). previous_probability: type: integer title: Previous Probability description: The probability value before the last status change. revenue_distribution_type: enum: - default - even - custom type: string title: Revenue Distribution Type description: How revenue is distributed across services. future_budget_used: title: Future Budget Used description: Forecasted budget used including future bookings. retainer_deal_value_type: enum: - total - per_interval type: string title: Retainer Deal Value Type description: Determines how the deal value is calculated for retainer deals (e.g., per period or total). designated_approver_id: type: integer title: Designated Approver description: ID of the person designated as the approver for this deal. custom_fields: type: object title: Custom Fields description: Custom field values set on this deal. proposal_footer_interpolated: title: Proposal Footer Interpolated description: Proposal footer with template variables resolved. future_revenue: title: Future Revenue description: Total future revenue from upcoming bookings. budget_used_default: title: Budget Used Default description: Amount of budget consumed so far (organization default currency). suffix: type: string title: Suffix description: Optional suffix appended to the deal number for display. deal_value_per_period_default: title: Deal Value Per Period Default description: The deal value per retainer period in the organization's default currency. revenue_distribution_method: enum: - percentage - amount type: string title: Revenue Distribution Method description: Method for distributing revenue recognition across periods. tax_rate_id: type: integer title: Tax Rate description: ID of the default tax rate. pending_invoicing_normalized: title: Pending Invoicing Normalized description: Amount ready to invoice but not yet invoiced (normalized currency). expenses_billable: title: Expenses Billable description: Whether expenses on this deal are billable to the client. manual_invoicing_reason: title: Manual Invoicing Reason description: Manual invoicing reason note. services_revenue_default: title: Services Revenue Default description: Revenue from services only, excluding adjustments (organization default currency). external_sync: type: boolean title: External Sync description: Whether this deal syncs with an external system. future_cost: title: Future Cost description: Total future cost based on upcoming bookings. profit_margin: type: number title: Profit Margin description: Profit as a percentage of revenue, in budget currency. actual_rate: title: Actual Rate description: Actual average billing rate across services on this deal. primary_contact: title: Primary Contact description: The primary contact person for the company linked to this deal. company_id: type: integer title: Company description: ID of the client company. budget_total_default: title: Budget Total Default description: Total budget amount across all services (organization default currency). deal_value_per_period: title: Deal Value Per Period description: The deal value per retainer period in the deal's currency. status: enum: - 1 - 2 type: integer title: Status description: Deal lifecycle status (open/won/lost/delivered). projected_revenue: title: Projected Revenue description: Expected revenue = budget total * probability (budget currency). tag_list: title: Tag List description: Tags applied to this deal. budgets_first: title: Budgets First description: Whether budgets appear first in pipeline ordering. stage_status: title: Stage Status description: Current pipeline stage status label. deal_number: title: Deal Number description: Unique number identifying the deal within the organization. number: type: string title: Number description: Short numeric identifier (alias for deal_number). expense: title: Expense description: Total expense costs on this deal (budget currency). sales_status_id: enum: - 1 - 2 - 3 - 4 type: integer title: Sales Status description: ID of the sales status (open/won/lost). won_date: type: string title: Won Date format: date description: Date when the deal was won. needs_closing: type: boolean title: Needs Closing description: Whether the deal requires closing action. origin_deal: title: Origin Deal description: The original deal if this was duplicated or generated. invoiced_normalized: title: Invoiced Normalized description: Total amount already invoiced (normalized currency). closed_at: type: string title: Closed At format: date-time description: Timestamp when the deal was closed. rounding_method_id: enum: - 1 - 2 - 3 - 4 type: integer title: Rounding Method description: How billable time is rounded (up, down, nearest). revenue_default: title: Revenue Default description: Total revenue from services (organization default currency). position: type: integer title: Position description: Sort position within the pipeline stage. contact_name: title: Contact Name description: Name of the client contact person. open_hours: title: Open Hours description: Total open (untracked) hours on this deal. recurring_ends_on: type: string title: Recurring Ends On format: date description: Date when the retainer contract ends. future_booked_time: type: integer title: Future Booked Time description: Total future booked time on this deal. budgeted_time: type: integer title: Budgeted Time description: Total budgeted hours across all services. custom_field_attachments: title: Custom Field Attachments description: Files uploaded to file-type custom fields. draft_invoiced_default: title: Draft Invoiced Default description: Amount on draft (unsent) invoices (organization default currency). services_revenue: title: Services Revenue description: Revenue from services only, excluding adjustments (budget currency). deals_first: title: Deals First description: Whether sales deals appear first in pipeline ordering. proposal_document_type: title: Proposal Document Type description: The PDF template used for proposals. lost_date: type: string title: Lost Date format: date description: Date when the deal was marked as lost. responsible: title: Responsible description: The deal owner / project manager. probability: type: number title: Probability description: Likelihood of winning (0-100%). 100% for won deals, 0% for lost deals. date: type: string title: Date format: date description: Start date of the deal. sales_closed_at: type: string title: Sales Closed At format: date-time description: Timestamp when the deal was won or lost. rounding_interval_id: enum: - 1 - 2 - 3 type: integer title: Rounding Interval description: Time rounding interval for billable time (e.g. 15 minutes). budget_warning: type: integer title: Budget Warning description: Budget consumption percentage that triggers a warning. draft_invoiced: title: Draft Invoiced description: Amount on draft (unsent) invoices (budget currency). subsidiary: title: Subsidiary description: The billing subsidiary for this deal. man_day_minutes: type: integer title: Man Day Minutes description: How many minutes equal one man-day for this deal (for man-day billing). invoiced_percentage: type: integer title: Invoiced Percentage description: Percentage of revenue already invoiced. validate_expense_when_closing: type: boolean title: Validate Expense When Closing description: Whether all expenses must be invoiced before the deal can be closed. sample_data: type: boolean title: Sample Data description: Whether this is sample/demo data. credited: title: Credited description: Total amount credited against this deal. profit_margin_default: title: Profit Margin Default description: Profit margin in organization default currency. unapproved_time: type: integer title: Unapproved Time description: Total unapproved time entries on this deal. deal_value_total_normalized: title: Deal Value Total Normalized description: The total deal value across all retainer periods normalized to the deal's currency. work_cost: title: Work Cost description: Total labor costs on this deal. exchange_rate: type: number title: Exchange Rate description: Exchange rate from deal currency to organization default currency. forecasted_billable_time: type: integer title: Forecasted Billable Time description: Forecasted total billable time based on bookings. recurring_starts_on: type: string title: Recurring Starts On format: date description: Date when the retainer contract starts. forecasted_budget_usage: type: number title: Forecasted Budget Usage description: Forecasted budget consumption percentage. profit: title: Profit description: Revenue minus costs (budget currency). todo_count: type: integer title: Todo Count description: Total number of to-do items on the deal. document_type: title: Document Type description: The PDF template used for deal documents. connection_status: title: Connection Status description: Integration connection status (for Productive Connect). days_since_created: type: integer title: Days Since Created description: Number of days since this deal was created. budget_total: title: Budget Total description: Total budget amount across all services (budget currency). time_to_close: title: Time To Close description: Number of days between date opened and date closed. discount: type: number title: Discount description: Default discount percentage applied to services on this deal. revenue: title: Revenue description: Total revenue from services (budget currency). approval_policy_assignment: title: Approval Policy Assignment description: The approval policy governing this deal. creator: title: Creator description: The person who created this deal. company: title: Company description: The client company this deal is for. email_key: type: string title: Email Key description: Unique key for creating comments on this deal via email. budget_usage: type: number title: Budget Usage description: Percentage of budget consumed so far. full_query: type: string title: Full Query description: Full-text search query applied to this deal. subsidiary_id: type: integer title: Subsidiary description: ID of the billing subsidiary for this deal. creator_name: title: Creator Name description: Name of the person who created this deal. cost_normalized: title: Cost Normalized description: Total costs including labor and expenses (normalized currency). sales_closed_on: type: string title: Sales Closed On format: date description: Date when the deal was won or lost. template: type: string title: Template description: The deal template this was created from, if applicable. deal_value_total_default: title: Deal Value Total Default description: The total deal value across all retainer periods in the organization's default currency. project_id: type: integer title: Project description: ID of the project linked to this deal. project_name: title: Project Name description: Name of the project linked to this deal. creator_id: type: integer title: Creator description: ID of the person who created this deal. lost_reason: title: Lost Reason description: The reason this deal was lost, if applicable. estimated_time: type: integer title: Estimated Time description: Total estimated hours across all services. contract: title: Contract description: The retainer contract that generated this deal, if applicable. query: type: string title: Query description: Quick search query applied to this deal. id: type: integer title: Id description: The unique identifier of this deal. currency_default: title: Currency Default description: Organization default currency code. lost_at: type: string title: Lost At format: date description: Timestamp when the deal was marked as lost. manually_invoiced: enum: - 1 - 2 type: integer title: Manually Invoiced description: Amount marked as manually invoiced outside Productive (budget currency). responsible_name: title: Responsible Name description: Name of the deal owner / project manager. amount_credited: title: Amount Credited description: Total credit notes issued against this deal (budget currency). todo_due_date: type: string title: Todo Due Date format: date description: Due date of the next to-do item. services_revenue_normalized: title: Services Revenue Normalized description: Revenue from services only, excluding adjustments (normalized currency). next_occurrence_on: type: string title: Next Occurrence On format: date description: Date when the next retainer occurrence is generated. deal_type_id: enum: - 1 - 2 type: integer title: Deal Type description: Whether this is a one-off deal or a retainer. invoiced_rate: title: Invoiced Rate description: Average billing rate at which revenue was invoiced. company_name: title: Company Name description: Name of the client company. recurring: type: boolean title: Recurring description: Whether this deal is a recurring retainer. project_type: enum: - 1 - 2 type: integer title: Project Type description: Type of project linked to this deal. previous_deal_status_id: type: integer title: Previous Deal Status description: ID of the previous pipeline stage before the last transition. needs_invoicing: type: boolean title: Needs Invoicing description: Whether the deal has uninvoiced services. invoiced: title: Invoiced description: Total amount already invoiced (budget currency). manually_invoiced_default: title: Manually Invoiced Default description: Amount marked as manually invoiced outside Productive (organization default currency). stage_status_id: enum: - 1 - 2 - 3 - 4 type: integer title: Stage Status description: ID of the current pipeline stage status. contact: title: Contact description: The client contact person for this deal. amount_credited_default: title: Amount Credited Default description: Total credit notes issued against this deal (organization default currency). next_todo: title: Next Todo description: The next upcoming to-do item on this deal. origin_deal_id: type: integer title: Origin Deal description: ID of the original deal if duplicated or generated from a contract. forecasted_profit: title: Forecasted Profit description: Forecasted profit based on current trajectory. projected_revenue_default: title: Projected Revenue Default description: Expected revenue = budget total * probability (organization default currency). pending_invoicing: title: Pending Invoicing description: Amount ready to invoice but not yet invoiced (budget currency). time_approval: type: boolean title: Time Approval description: Whether time entries on this deal require approval before they count. custom_field_people: title: Custom Field People description: People referenced in person-type custom fields. tax_rate: title: Tax Rate description: Default tax rate applied to this deal's invoices. contact_id: type: integer title: Contact description: ID of the client contact person. worked_time: type: integer title: Worked Time description: Total hours tracked by team members on this deal. proposal_footer: title: Proposal Footer description: Proposal document footer text. purchase_order_number: type: string title: Purchase Order Number description: Client-provided purchase order number for invoicing reference. example: PO-2024-017 profit_normalized: title: Profit Normalized description: Revenue minus costs (normalized currency). cost_default: title: Cost Default description: Total costs including labor and expenses (organization default currency). project: title: Project description: The project linked to this deal. document_type_id: type: integer title: Document Type description: ID of the PDF template for deal documents. pipeline_id: type: integer title: Pipeline description: ID of the pipeline this deal belongs to. fuzzy_dates: type: string title: Fuzzy Dates format: date description: Approximate date range for the deal (fuzzy). deal_value: type: number title: Deal Value description: The configured deal value in the deal's currency, in cents. days_since_last_activity: type: integer title: Days Since Last Activity description: Number of days since the last activity was recorded on this deal. jump_query: type: string title: Jump Query description: Quick search query applied to this deal. end_date: type: string title: End Date format: date description: End date of the deal. profit_margin_normalized: title: Profit Margin Normalized description: Profit margin in normalized currency. deal_value_per_period_normalized: title: Deal Value Per Period Normalized description: The deal value per retainer period normalized to the deal's currency. retainer_interval: enum: - week - two_weeks - month - quarter - half_year - year type: string title: Retainer Interval description: The billing interval of this retainer deal (e.g., monthly, quarterly). destroy_future_bookings: type: boolean title: Destroy Future Bookings description: Whether to cancel future bookings when the deal is closed. client_access: type: boolean title: Client Access description: Whether client contacts can view this deal's details. billable_time: type: integer title: Billable Time description: Total billable hours across all services on this deal. budget_total_normalized: title: Budget Total Normalized description: Total budget amount across all services (normalized currency). subscriber_id: type: integer title: Subscriber description: ID of the subscriber of this deal. revenue_normalized: title: Revenue Normalized description: Total revenue from services (normalized currency). budget_used_normalized: title: Budget Used Normalized description: Amount of budget consumed so far (normalized currency). budget_remaining: title: Budget Remaining description: Remaining budget (budget total minus budget used). expense_normalized: title: Expense Normalized description: Total expense costs on this deal (normalized currency). access_to_deal: title: Access To Deal description: Whether the current user has permission to view this deal's financial details. approval_policy_id: type: integer title: Approval Policy description: ID of the approval policy assigned to this deal. footer_interpolated: title: Footer Interpolated description: Deal footer with template variables resolved. manual_invoicing_status_id: enum: - 1 - 2 type: integer title: Manual Invoicing Status description: Manual invoicing tracking status. days_in_current_stage: type: integer title: Days In Current Stage description: Number of days this deal has been in its current pipeline stage. estimated_remaining_time: type: integer title: Estimated Remaining Time description: Estimated remaining time to complete the deal. subscriber_ids: title: Subscriber Ids description: IDs of people subscribed to this deal. budget_status: enum: - 1 - 2 type: integer title: Budget Status description: Budget health status based on consumption vs. warning threshold. editor_config: type: object title: Editor Config description: Rich text editor configuration for deal notes. responsible_id: type: integer title: Responsible description: ID of the deal owner / project manager. tracking_type_id: enum: - 1 - 2 - 3 type: integer title: Tracking Type description: How time is tracked on this deal's services. type: enum: - 1 - 2 type: integer title: Type description: The type of this resource (always deal). stage_updated_at: type: string title: Stage Updated At format: date description: Timestamp when the deal last moved to a new pipeline stage. footer: title: Footer description: Deal document footer text. retainer_interval_count: type: integer title: Retainer Interval Count description: The number of interval units per retainer period (e.g., 3 for quarterly when interval is monthly). external_id: type: string title: External description: ID in an external integrated system. service_type_restricted_tracking: type: boolean title: Service Type Restricted Tracking description: Whether time tracking is restricted to specific service types. forecasted_cost: title: Forecasted Cost description: Forecasted total cost based on bookings and actuals. forecasted_revenue: title: Forecasted Revenue description: Forecasted revenue based on bookings and actuals. manually_invoiced_normalized: title: Manually Invoiced Normalized description: Amount marked as manually invoiced outside Productive (normalized currency). manual_invoicing_status: type: boolean title: Manual Invoicing Status description: Manual invoicing tracking status label. created_at: type: string title: Created At format: date-time description: When the deal was created. color_id: type: integer title: Color description: Color used for visual identification in pipeline views. expense_default: title: Expense Default description: Total expense costs on this deal (organization default currency). currency: type: string title: Currency description: Deal currency code (budget currency). lost_reason_id: type: integer title: Lost Reason description: ID of the lost reason. amount_credited_normalized: title: Amount Credited Normalized description: Total credit notes issued against this deal (normalized currency). forecasted_time_usage: type: number title: Forecasted Time Usage description: Forecasted time usage as a percentage of budgeted time. name: type: string title: Name description: Descriptive name for the deal. expense_approval_workflow: title: Expense Approval Workflow description: The approval workflow for expenses. previous_or_current_deal_status_id: type: integer title: Previous Or Current Deal Status description: ID of the previous or current pipeline stage. organization: title: Organization description: The organization this deal belongs to. won_at: type: string title: Won At format: date description: Timestamp when the deal was won. parent_company_id: type: integer title: Parent Company description: ID of the parent company of the client linked to this deal, used for hierarchical company filtering. recurring_interval_id: enum: - 3 - 2 - 1 - 6 - 5 - 4 type: integer title: Recurring Interval description: ID of the recurring interval for retainer deals. budget_used: title: Budget Used description: Amount of budget consumed so far (budget currency). estimated_cost: title: Estimated Cost description: Estimated total cost based on planned services. pipeline: title: Pipeline description: The sales or production pipeline this deal belongs to. profit_default: title: Profit Default description: Revenue minus costs (organization default currency). note_interpolated: title: Note Interpolated description: Deal note with template variables resolved. invoiced_default: title: Invoiced Default description: Total amount already invoiced (organization default currency). currency_normalized: title: Currency Normalized description: Normalized currency code. last_activity_at: type: string title: Last Activity At format: date-time description: Timestamp of the most recent change on this deal. automatic_invoicing_rule: title: Automatic Invoicing Rule description: The automatic invoicing rule configured for this deal, if any. proposal_note_interpolated: title: Proposal Note Interpolated description: Proposal note with template variables resolved. forecasted_margin: type: number title: Forecasted Margin description: Forecasted profit margin based on current trajectory. deal_value_total: title: Deal Value Total description: The total deal value across all retainer periods in the deal's currency. status_id: type: integer title: Status description: ID of the deal lifecycle status. budget: type: boolean title: Budget description: Whether this deal is a production budget (true) or a sales deal (false). lost_comment: type: string title: Lost Comment description: Notes explaining why the deal was lost. delivered_on: type: string title: Delivered On format: date description: Date when the deal was marked as delivered. forecasted_budget_used: title: Forecasted Budget Used description: Forecasted budget used based on current trajectory. contract_id: type: integer title: Contract description: ID of the retainer contract, if applicable. deleted_at: type: string title: Deleted At format: date-time description: Soft-deletion timestamp. exchange_date: type: string title: Exchange Date format: date description: Date used for the exchange rate calculation. sales_status_updated_at: type: string title: Sales Status Updated At format: date-time description: Timestamp when the deal status (open/won/lost) last changed. tags: type: string title: Tags description: Tags applied to this deal. proposal_document_type_id: type: integer title: Proposal Document Type description: ID of the PDF template used for proposals. deal_status_id: type: integer title: Deal Status description: ID of the current pipeline stage. invoice_template: title: Invoice Template description: The invoice template associated with this deal, used as the default when generating invoices. deal_status: title: Deal Status description: Current pipeline stage of this deal. expense_approval: type: boolean title: Expense Approval description: Whether expenses on this deal require approval. designated_approver: title: Designated Approver description: The person designated as the approver for this deal, as determined by the approval policy. draft_invoiced_normalized: title: Draft Invoiced Normalized description: Amount on draft (unsent) invoices (normalized currency). time_approval_workflow: title: Time Approval Workflow description: The approval workflow for time entries. deal_value_source: enum: - from_services - manual type: string title: Deal Value Source description: The source used to determine the deal value (e.g., from services or manually set). cost: title: Cost description: Total costs including labor and expenses (budget currency). pending_invoicing_default: title: Pending Invoicing Default description: Amount ready to invoice but not yet invoiced (organization default currency). accessible_by_person: type: integer title: Accessible By Person description: The person whose access permissions are used to scope the deals returned in this response. proposal_note: type: string title: Proposal Note description: Notes included in proposals sent to clients. note: type: string title: Note description: Internal deal notes (rich text). fuzzy_people: type: integer title: Fuzzy People description: People loosely associated with this deal. description: A deal or budget representing a sales opportunity or production budget, with services, financials, and pipeline tracking. resource_budget_report: type: object title: Budget report Resource properties: custom_fields: type: string title: Custom Fields description: Custom field values attached to the budget, keyed by custom field ID. discount: type: number title: Discount description: Discount amount applied to the budget. budget_warning: type: integer title: Budget Warning description: Whether the budget has exceeded its warning threshold. color_id: type: integer title: Color description: Color ID assigned to this budget for visual grouping in the UI. sales_closed_on: type: string title: Sales Closed On format: date description: Date when the deal/budget was closed (won). budget_custom_fields: title: Budget Custom Fields description: Custom field values on the associated budget. profit_margin: type: number title: Profit Margin description: 'Profit margin as a percentage: profit divided by revenue.' owner_report: title: Owner Report description: Related person report data for the budget owner. average_budget_usage: type: number title: Average Budget Usage description: Average budget usage percentage across grouped budgets. quarter: type: string title: Quarter description: Quarter grouping label for this report row (e.g. Q1 2026). invoiced: title: Invoiced description: Amount of money invoiced to the client from this budget. total_future_budget_used_normalized: title: Total Future Budget Used Normalized description: Sum of future budget used amounts in the normalized currency across all budgets in this report group. total_forecasted_billable_time: type: number title: Total Forecasted Billable Time description: Sum of forecasted billable hours across all budgets in this report group. total_estimated_remaining_time: type: number title: Total Estimated Remaining Time description: Sum of estimated remaining hours across all budgets in this report group. total_manually_invoiced_default: title: Total Manually Invoiced Default description: Sum of manually invoiced amounts in the organization's default currency across all budgets in this report group. status: enum: - 1 - 2 type: integer title: Status description: Current status of the budget (e.g. open, delivered). full_query: type: string title: Full Query description: Full API query object used to generate this report row, including all applied filters and groupings. closed_at: type: string title: Closed At format: date description: Timestamp when this budget was closed. invoiced_rate: title: Invoiced Rate description: Invoiced amount divided by worked hours (invoiced rate per hour). primary_contact: title: Primary Contact description: The primary contact person for the company linked to this budget. total_profit: title: Total Profit description: Sum of profit amounts across all budgets in this report group. average_forecasted_time_usage: type: number title: Average Forecasted Time Usage description: Average forecasted time usage percentage across grouped budgets. average_forecasted_budget_overrun_default: type: number title: Average Forecasted Budget Overrun Default description: Average forecasted budget overrun in the organization's default currency. subsidiary: title: Subsidiary description: The subsidiary (legal entity) that this budget's revenue is attributed to. deal_type_id: type: integer title: Deal Type description: ID of the budget type (Client or Internal). expenses_billable: title: Expenses Billable description: Total billable expense amount charged to the client. total_estimated_time: type: number title: Total Estimated Time description: Sum of estimated hours across all budgets in this report group. total_budget_remaining_normalized: title: Total Budget Remaining Normalized description: Sum of remaining budget amounts in the normalized currency across all budgets in this report group. average_invoiced_percentage_default: type: number title: Average Invoiced Percentage Default description: Average invoiced percentage in the organization's default currency context. total_forecasted_cost_normalized: title: Total Forecasted Cost Normalized description: Sum of forecasted costs in the normalized currency across all budgets in this report group. recurring_starts_on_period: title: Recurring Starts On Period description: Time period grouping for the recurring start date (e.g. week, month, quarter). currency: type: string title: Currency description: The budget's currency code (e.g. USD, EUR). Used as the base currency for all non-normalized financial values in this report row. total_billable_time: type: number title: Total Billable Time description: Sum of billable hours tracked across all budgets in this report group. total_future_budget_used: title: Total Future Budget Used description: Sum of future budget used amounts across all budgets in this report group. average_forecasted_budget_usage_normalized: title: Average Forecasted Budget Usage Normalized description: Average forecasted budget usage percentage normalized across currencies. total_budget_total_normalized: title: Total Budget Total Normalized description: Sum of total approved budget amounts in the normalized currency across all budgets in this report group. formula_fields: title: Formula Fields description: Computed values for custom formula fields defined on the report. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary this budget's revenue is attributed to. budget_last_activity_at: title: Budget Last Activity At description: Timestamp of the most recent activity on the budget associated with this report row. week: type: string title: Week description: Week grouping label for this report row (e.g. Week 13, 2026). fuzzy_people: type: integer title: Fuzzy People description: Relative person references (e.g. current_user) used in people-based filters. fuzzy_dates: type: string title: Fuzzy Dates format: date description: Relative date range expressions (e.g. this_month, last_quarter) used in date filters. designated_approver: title: Designated Approver description: The person designated as the approver for this budget, as determined by the approval policy. total_revenue: title: Total Revenue description: Sum of revenue amounts across all budgets in this report group. currency_default: title: Currency Default description: The organization's default currency code. Financial values with the suffix are converted to this currency. next_occurrence_on_period: title: Next Occurrence On Period description: Time period grouping for the next occurrence date (e.g. week, month, quarter). work_cost: title: Work Cost description: Labor cost on services (salaries and overhead) for this budget. days_since_created: type: integer title: Days Since Created description: Number of days since the deal was created. recurring_starts_on: type: string title: Recurring Starts On format: date description: Date when the budget recurrence starts. project_id: type: integer title: Project description: ID of the project this budget is associated with. primary_contact_report: title: Primary Contact Report description: Report object for the primary contact person of the company linked to this budget. total_credited_normalized: title: Total Credited Normalized description: Sum of credited amounts in the normalized currency across all budgets in this report group. total_forecasted_budget_overrun_default: title: Total Forecasted Budget Overrun Default description: Sum of forecasted budget overrun amounts in the organization's default currency across all budgets in this report group. actual_rate: title: Actual Rate description: The actual average hourly rate on this budget (revenue divided by billable time). retainer_interval: enum: - week - two_weeks - month - quarter - half_year - year type: string title: Retainer Interval description: The billing interval of this retainer deal (e.g., monthly, quarterly). average_invoiced_percentage: type: number title: Average Invoiced Percentage description: Average invoiced percentage across grouped budgets. parent_company_id: type: integer title: Parent Company description: ID of the parent company of the client company linked to this budget, used for hierarchical company filtering. forecasted_billable_time: type: integer title: Forecasted Billable Time description: 'Forecasted billable time: current billable time plus future scheduled time.' days_in_current_stage: type: integer title: Days In Current Stage description: Number of days the deal has been in its current pipeline stage. forecasted_budget_used: title: Forecasted Budget Used description: 'Forecasted total budget used: current budget used plus future budget used (from resourcing).' total_estimated_cost_default: title: Total Estimated Cost Default description: Sum of estimated costs in the organization's default currency across all budgets in this report group. created_at_period: title: Created At Period description: Time period grouping for the created_at date (e.g. week, month, quarter). last_activity_at_period: title: Last Activity At Period description: Time period grouping for last activity date (e.g. week, month, quarter). forecasted_revenue: title: Forecasted Revenue description: Forecasted revenue amount. stage_status_id: enum: - 1 - 2 - 3 - 4 type: integer title: Stage Status description: ID of the current pipeline stage status. estimated_time: type: integer title: Estimated Time description: Estimated hours needed to complete all work in this budget's scope. total_expense_normalized: title: Total Expense Normalized description: Sum of expense costs in the normalized currency across all budgets in this report group. total_budget_used: title: Total Budget Used description: Sum of budget used amounts across all budgets in this report group. average_actual_rate_default: title: Average Actual Rate Default description: Average actual rate in the organization's default currency. date_period: title: Date Period description: Time period grouping for the budget start date (e.g. week, month, quarter). next_occurrence_on: type: string title: Next Occurrence On format: date description: Date when the next recurring occurrence of this budget will be generated. average_invoiced_rate: title: Average Invoiced Rate description: Average effective invoiced rate across grouped budgets (invoiced divided by billable time). month: type: string title: Month description: Month grouping label for this report row (e.g. March 2026). total_forecasted_budget_overrun_normalized: title: Total Forecasted Budget Overrun Normalized description: Sum of forecasted budget overrun amounts in the normalized currency across all budgets in this report group. recurring_interval_id: enum: - 3 - 2 - 1 - 6 - 5 - 4 type: integer title: Recurring Interval description: ID of the recurring interval type. total_estimated_cost_normalized: title: Total Estimated Cost Normalized description: Sum of estimated costs in the normalized currency across all budgets in this report group. responsible: title: Responsible description: The person responsible for managing this budget. estimated_cost: title: Estimated Cost description: Estimated cost for this budget. end_date: type: string title: End Date format: date description: The planned end date of the budget. total_future_cost: title: Total Future Cost description: Sum of future cost amounts across all budgets in this report group. total_estimated_cost: title: Total Estimated Cost description: Sum of estimated costs across all budgets in this report group. recurring_ends_on: type: string title: Recurring Ends On format: date description: Date when the budget recurrence ends. organization: title: Organization description: The organization this budget belongs to. created_at: type: string title: Created At format: date description: Timestamp when this budget was created. total_pending_invoicing: title: Total Pending Invoicing description: Sum of pending invoicing amounts across all budgets in this report group. average_invoiced_rate_default: title: Average Invoiced Rate Default description: Average invoiced rate in the organization's default currency. total_services_revenue_default: title: Total Services Revenue Default description: Sum of services revenue in the organization's default currency across all budgets in this report group. total_work_cost_default: title: Total Work Cost Default description: Sum of labor costs in the organization's default currency across all budgets in this report group. total_forecasted_cost_default: title: Total Forecasted Cost Default description: Sum of forecasted costs in the organization's default currency across all budgets in this report group. budget_usage: type: number title: Budget Usage description: Budget usage percentage (budget used divided by budget total). origin_deal: title: Origin Deal description: The original deal from which this budget was created. worked_time: type: integer title: Worked Time description: Total hours worked on this budget. budget_time_approval: title: Budget Time Approval description: Whether time entry approval is enabled on the associated budget. manually_invoiced: enum: - 1 - 2 type: integer title: Manually Invoiced description: Amount manually marked as invoiced on this budget. creator_id: type: integer title: Creator description: ID of the person who created this budget. total_profit_normalized: title: Total Profit Normalized description: Sum of profit amounts in the normalized currency across all budgets in this report group. budget: title: Budget description: Reference to the deal/budget associated with this report row. average_budget_usage_default: type: number title: Average Budget Usage Default description: Average budget usage percentage in the organization's default currency context. last_activity_at: type: string title: Last Activity At format: date description: Timestamp of the most recent activity on this budget. approval_policy_id: type: integer title: Approval Policy description: ID of the approval policy assigned to this budget for time entry approvals. unapproved_time: type: integer title: Unapproved Time description: Number of hours awaiting approval for this budget. budgeted_time: type: integer title: Budgeted Time description: Total time budgeted on this budget, in minutes. deal_status_id: type: integer title: Deal Status description: ID of the deal status associated with this budget. billable_time: type: integer title: Billable Time description: Total billable time logged against this budget, in minutes. deal_type: type: integer title: Deal Type description: Budget type label — either Client or Internal. won_at: type: string title: Won At format: date description: Timestamp when the deal/budget was won. previous_deal_status_id: type: integer title: Previous Deal Status description: ID of the previous deal status for this budget (used for tracking stage transitions). total_worked_time: type: number title: Total Worked Time description: Sum of worked hours across all budgets in this report group. number: type: string title: Number description: Unique number identifying this budget. stage_updated_at: type: string title: Stage Updated At format: date description: Timestamp when the pipeline stage was last updated. average_profit_margin_default: type: number title: Average Profit Margin Default description: Average profit margin percentage in the organization's default currency context. previous_or_current_deal_status_id: type: integer title: Previous Or Current Deal Status description: ID of the previous or current deal status (used for pipeline stage tracking). designated_approver_id: type: integer title: Designated Approver description: ID of the person designated as the approver for this budget. total_pending_invoicing_normalized: title: Total Pending Invoicing Normalized description: Sum of pending invoicing amounts in the normalized currency across all budgets in this report group. total_revenue_normalized: title: Total Revenue Normalized description: Sum of revenue amounts in the normalized currency across all budgets in this report group. forecasted_profit: title: Forecasted Profit description: Forecasted profit amount. average_actual_rate_normalized: title: Average Actual Rate Normalized description: Average actual rate normalized to the organization's base currency. budget_remaining: title: Budget Remaining description: Remaining budget amount (budget total minus budget used). delivered_on_period: title: Delivered On Period description: Time period grouping for the delivered-on date (e.g. week, month, quarter). previous_probability: type: integer title: Previous Probability description: Probability percentage of the deal before the last status change. total_future_cost_normalized: title: Total Future Cost Normalized description: Sum of future cost amounts in the normalized currency across all budgets in this report group. total_manually_invoiced_normalized: title: Total Manually Invoiced Normalized description: Sum of manually invoiced amounts in the normalized currency across all budgets in this report group. forecasted_margin: type: number title: Forecasted Margin description: Forecasted profit margin as a percentage. total_services_revenue: title: Total Services Revenue description: Sum of services revenue (excluding billable expenses) across all budgets in this report group. year: type: string title: Year description: Year grouping label for this report row (e.g. 2026). average_forecasted_budget_overrun_normalized: title: Average Forecasted Budget Overrun Normalized description: Average forecasted budget overrun normalized to the organization's base currency. project_report: title: Project Report description: Related project report data for this budget. total_future_cost_default: title: Total Future Cost Default description: Sum of future cost amounts in the organization's default currency across all budgets in this report group. budget_total: title: Budget Total description: Total budget amount set on the budget. total_expense_billable: title: Total Expense Billable description: Sum of billable expense amounts across all budgets in this report group. total_budget_remaining_default: title: Total Budget Remaining Default description: Sum of remaining budget amounts in the organization's default currency across all budgets in this report group. profit: title: Profit description: 'Profit after all costs: revenue minus service costs and expense costs.' forecasted_budget_usage: type: number title: Forecasted Budget Usage description: 'Forecasted budget usage as a percentage: forecasted budget used divided by budget total.' total_work_cost_normalized: title: Total Work Cost Normalized description: Sum of labor costs in the normalized currency across all budgets in this report group. total_forecasted_cost: title: Total Forecasted Cost description: Sum of forecasted costs across all budgets in this report group. delivered_on: type: string title: Delivered On format: date description: Date when the budget status was changed from Open to Delivered. future_booked_time: type: integer title: Future Booked Time description: Number of hours scheduled on this budget in the future (from resourcing). status_id: type: integer title: Status description: ID of the current budget status. projected_revenue: title: Projected Revenue description: Projected revenue based on current data and forecasts. budget_suffix: title: Budget Suffix description: Suffix appended to the budget name for display purposes. total_expense: title: Total Expense description: Sum of expense costs across all budgets in this report group. pending_invoicing: title: Pending Invoicing description: Amount of money pending invoicing for this budget. origin_deal_report: title: Origin Deal Report description: Related deal report data for the origin deal of this budget. end_date_period: title: End Date Period description: Time period grouping for the budget end date (e.g. week, month, quarter). budget_status: enum: - 1 - 2 type: integer title: Budget Status description: Current status of the budget (e.g. active, closed, lost). total_unapproved_time: type: number title: Total Unapproved Time description: Sum of unapproved hours across all budgets in this report group. date: type: string title: Date format: date description: Start date of the budget and the date for which revenue is reported. total_expense_billable_default: title: Total Expense Billable Default description: Sum of billable expense amounts in the organization's default currency across all budgets in this report group. days_since_last_activity: type: integer title: Days Since Last Activity description: Number of days since the last activity was recorded on the deal. contract_id: type: integer title: Contract description: ID of the contract that generated this budget. needs_invoicing: type: boolean title: Needs Invoicing description: Indicates whether the budget has outstanding amounts pending invoicing. query: type: string title: Query description: The query parameters applied when generating this report row. total_services_revenue_normalized: title: Total Services Revenue Normalized description: Sum of services revenue in the normalized currency across all budgets in this report group. sales_status_id: enum: - 1 - 2 - 3 - 4 type: integer title: Sales Status description: ID of the sales status for this budget. accessible_by_person: type: integer title: Accessible By Person description: Whether this budget is accessible by the querying person. revenue_distribution_type: enum: - default - even - custom type: string title: Revenue Distribution Type description: Revenue recognition method used for this budget (e.g. time-based, milestone-based). total_credited: title: Total Credited description: Sum of credited amounts across all budgets in this report group. company_id: type: integer title: Company description: ID of the client company associated with this budget. tracking_type_id: type: integer title: Tracking Type description: ID of the tracking type configured on this budget. cost: title: Cost description: Total labor cost from tracked time entries on this budget. budget_purchase_order_number: title: Budget Purchase Order Number description: Purchase order number associated with the budget. example: PO-2024-017 average_invoiced_percentage_normalized: title: Average Invoiced Percentage Normalized description: Average invoiced percentage normalized across currencies. purchase_order_number: type: string title: Purchase Order Number description: The Purchase Order number provided by the client for this budget. example: PO-2024-017 probability: type: integer title: Probability description: Probability percentage of winning or delivering this deal/budget. recurring_interval: title: Recurring Interval description: How often this budget recurs (e.g. weekly, monthly). total_draft_invoiced_normalized: title: Total Draft Invoiced Normalized description: Sum of draft invoiced amounts in the normalized currency across all budgets in this report group. revenue: title: Revenue description: 'Total revenue amount for this budget: the amount to be invoiced in total.' project: title: Project description: The project this budget is associated with. project_type: enum: - 1 - 2 type: integer title: Project Type description: Project type label (e.g. Internal or Client). total_budget_remaining: title: Total Budget Remaining description: Sum of remaining budget amounts across all budgets in this report group (budget total minus budget used). total_budgeted_time: type: number title: Total Budgeted Time description: Sum of budgeted (estimated) hours across all budgets in this report group. budget_end_date: title: Budget End Date description: End date of the associated budget. total_budget_total_default: title: Total Budget Total Default description: Sum of total approved budget amounts in the organization's default currency across all budgets in this report group. forecasted_cost: title: Forecasted Cost description: 'Forecasted cost: current cost plus future cost (including service and expense costs).' budget_used: title: Budget Used description: Amount of budget consumed so far. future_budget_used: title: Future Budget Used description: Total future budget used, calculated from resourcing data. total_forecasted_budget_used_normalized: title: Total Forecasted Budget Used Normalized description: Sum of forecasted budget used amounts in the normalized currency across all budgets in this report group. total_cost_default: title: Total Cost Default description: Sum of total costs in the organization's default currency across all budgets in this report group. total_draft_invoiced: title: Total Draft Invoiced description: Sum of draft invoiced amounts across all budgets in this report group. budget_created_at: title: Budget Created At description: Timestamp when the associated budget was created. total_future_booked_time: type: number title: Total Future Booked Time description: Sum of future scheduled hours across all budgets in this report group. sales_closed_at: type: string title: Sales Closed At format: date description: Timestamp when the deal/budget was closed (won). responsible_id: type: integer title: Responsible description: ID of the person responsible for managing this budget. total_expense_billable_normalized: title: Total Expense Billable Normalized description: Sum of billable expense amounts in the normalized currency across all budgets in this report group. lost_reason_id: type: integer title: Lost Reason description: ID of the reason why the deal/budget was lost. total_work_cost: title: Total Work Cost description: Sum of labor costs (salaries and overheads) across all budgets in this report group. budget_delivered_on: title: Budget Delivered On description: Date the associated budget was delivered. type: enum: - 1 - 2 type: integer title: Type description: Resource type identifier for this report row (always budget_report). id: type: integer title: Id description: Unique identifier for this budget report row. invoiced_percentage: type: integer title: Invoiced Percentage description: Percentage of the budget total that has been invoiced. total_forecasted_budget_used: title: Total Forecasted Budget Used description: Sum of forecasted budget used amounts across all budgets in this report group. budget_closed_at: title: Budget Closed At description: Timestamp when the associated budget was closed. budget_number: title: Budget Number description: Sequential number of the associated budget within the organization. total_invoiced_normalized: title: Total Invoiced Normalized description: Sum of invoiced amounts in the normalized currency across all budgets in this report group. average_profit_margin: type: number title: Average Profit Margin description: Average profit margin percentage across grouped budgets. contact_id: type: integer title: Contact description: ID of the contact person associated with this budget. company_report: title: Company Report description: Reference to the company report for the company associated with this budget. total_cost: title: Total Cost description: Sum of total costs (service and expense) across all budgets in this report group. total_profit_default: title: Total Profit Default description: Sum of profit amounts in the organization's default currency across all budgets in this report group. name: type: string title: Name description: Name of the budget. total_forecasted_budget_overrun: title: Total Forecasted Budget Overrun description: Sum of forecasted budget overrun amounts across all budgets in this report group. total_future_budget_used_default: title: Total Future Budget Used Default description: Sum of future budget used amounts in the organization's default currency across all budgets in this report group. total_cost_normalized: title: Total Cost Normalized description: Sum of total costs in the normalized currency across all budgets in this report group. total_budget_used_normalized: title: Total Budget Used Normalized description: Sum of budget used amounts in the normalized currency across all budgets in this report group. forecasted_time_usage: type: number title: Forecasted Time Usage description: Forecasted time usage as a percentage of estimated time. total_draft_invoiced_default: title: Total Draft Invoiced Default description: Sum of draft invoiced amounts in the organization's default currency across all budgets in this report group. group: type: string title: Group description: The grouping dimension for this report row (e.g. the company, project, or person being grouped by). budget_warning_percentage: title: Budget Warning Percentage description: Warning threshold percentage for this budget. Budget usage exceeding this value triggers a warning. total_pending_invoicing_default: title: Total Pending Invoicing Default description: Sum of pending invoicing amounts in the organization's default currency across all budgets in this report group. count: type: integer title: Count description: Number of budgets aggregated in this report row (when grouped). future_revenue: title: Future Revenue description: Projected future revenue based on resourcing data. total_credited_default: title: Total Credited Default description: Sum of credited amounts in the organization's default currency across all budgets in this report group. average_actual_rate: title: Average Actual Rate description: Average actual hourly rate across grouped budgets in the report row. origin_deal_id: type: integer title: Origin Deal description: ID of the original deal from which this budget was created. deal_status: title: Deal Status description: The deal/pipeline status label associated with this budget. tags: type: string title: Tags description: Tags applied to this budget. budget_client_access: title: Budget Client Access description: Whether the budget is accessible to client users. recurring_ends_on_period: title: Recurring Ends On Period description: Time period grouping for the recurring end date (e.g. week, month, quarter). draft_invoiced: title: Draft Invoiced description: Total amount of invoices currently in draft status for this budget. average_forecasted_budget_usage: type: number title: Average Forecasted Budget Usage description: Average forecasted budget usage percentage across grouped budgets. template: type: string title: Template description: Indicates whether this budget was created from a template. formulas: type: integer title: Formulas description: Custom formula definitions applied to this report row. total_revenue_default: title: Total Revenue Default description: Sum of revenue amounts in the organization's default currency across all budgets in this report group. total_expense_default: title: Total Expense Default description: Sum of expense costs in the organization's default currency across all budgets in this report group. total_forecasted_budget_used_default: title: Total Forecasted Budget Used Default description: Sum of forecasted budget used amounts in the organization's default currency across all budgets in this report group. credited: title: Credited description: Total credit amount applied to this budget. total_invoiced: title: Total Invoiced description: Sum of invoiced amounts across all budgets in this report group. services_revenue: title: Services Revenue description: Revenue from services only, excluding revenue from billable expenses. future_cost: title: Future Cost description: Total future cost including service and expense costs, calculated from resourcing data. recurring: type: integer title: Recurring description: Indicates whether this budget automatically recurs on a schedule. pipeline_id: type: integer title: Pipeline description: ID of the pipeline this budget belongs to. total_budget_used_default: title: Total Budget Used Default description: Sum of budget used amounts in the organization's default currency across all budgets in this report group. time_approval: type: boolean title: Time Approval description: Indicates whether time entries on this budget require approval. average_profit_margin_normalized: title: Average Profit Margin Normalized description: Average profit margin percentage normalized across currencies. lost_at: type: string title: Lost At format: date description: Timestamp when the deal/budget was marked as lost. contract: title: Contract description: The recurring contract that generated this budget. report: title: Report description: Related budget report data for this group (self-referential for drill-down). needs_closing: type: boolean title: Needs Closing description: Indicates whether the budget requires closing action. estimated_remaining_time: type: integer title: Estimated Remaining Time description: Estimated hours remaining until the work is complete. total_manually_invoiced: title: Total Manually Invoiced description: Sum of manually invoiced amounts across all budgets in this report group. expense: title: Expense description: Cost of out-of-pocket expenses on this budget. pipeline: title: Pipeline description: The sales pipeline this budget belongs to. average_forecasted_budget_overrun: type: number title: Average Forecasted Budget Overrun description: Average forecasted budget overrun amount across grouped budgets. todo_due_date: type: string title: Todo Due Date format: date description: Due date for todo items associated with this budget. total_invoiced_default: title: Total Invoiced Default description: Sum of invoiced amounts in the organization's default currency across all budgets in this report group. company: title: Company description: The client company associated with this budget. closed_at_period: title: Closed At Period description: Time period grouping for the closed_at date (e.g. week, month, quarter). average_budget_usage_normalized: title: Average Budget Usage Normalized description: Average budget usage percentage normalized across currencies. manual_invoicing_status: type: boolean title: Manual Invoicing Status description: Indicates whether the budget has been manually marked as invoiced. won_date: type: string title: Won Date format: date description: Date when the deal/budget was won. jump_query: type: string title: Jump Query description: Condensed query object used for quick navigation to drill-down report views. total_budget_total: title: Total Budget Total description: Sum of total approved budget amounts across all budgets in this report group. budget_date: title: Budget Date description: Report date for the associated budget row. currency_normalized: title: Currency Normalized description: The normalized (common cross-organization) currency code. Financial values with the suffix are converted to this currency for cross-currency comparisons. lost_date: type: string title: Lost Date format: date description: Date when the deal/budget was marked as lost. average_invoiced_rate_normalized: title: Average Invoiced Rate Normalized description: Average invoiced rate normalized to the organization's base currency. average_forecasted_budget_usage_default: type: number title: Average Forecasted Budget Usage Default description: Average forecasted budget usage percentage in the organization's default currency context. subscriber_id: type: integer title: Subscriber description: ID of the subscriber (person following this budget for notifications). description: An aggregated budget report row. Budget reports group deals/budgets by configurable dimensions and calculate financial totals, time metrics, and profitability. filter_timesheet_report: type: object title: Filter timesheet report properties: people_custom_fields: oneOf: - "$ref": "#/components/schemas/resource_timesheet_report/properties/people_custom_fields" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_timesheet_report/properties/people_custom_fields" contains: "$ref": "#/components/schemas/resource_timesheet_report/properties/people_custom_fields" not_eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/people_custom_fields" eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/people_custom_fields" description: Filter operator object for people custom fields. description: Filter timesheet report results by people custom fields. tags: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_timesheet_report/properties/tags" not_contain: "$ref": "#/components/schemas/resource_timesheet_report/properties/tags" not_eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/tags" eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/tags" description: Filter operator object for tags. - "$ref": "#/components/schemas/resource_timesheet_report/properties/tags" description: Filter timesheet report results by tags. week_submission_status: oneOf: - "$ref": "#/components/schemas/resource_timesheet_report/properties/week_submission_status" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/week_submission_status" not_eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/week_submission_status" contains: "$ref": "#/components/schemas/resource_timesheet_report/properties/week_submission_status" not_contain: "$ref": "#/components/schemas/resource_timesheet_report/properties/week_submission_status" description: Filter operator object for week submission status. description: Filter timesheet report results by week submission status. person_status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/person_status" not_contain: "$ref": "#/components/schemas/resource_timesheet_report/properties/person_status" contains: "$ref": "#/components/schemas/resource_timesheet_report/properties/person_status" eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/person_status" description: Filter operator object for person status. - "$ref": "#/components/schemas/resource_timesheet_report/properties/person_status" description: Filter timesheet report results by person status. query: oneOf: - "$ref": "#/components/schemas/resource_timesheet_report/properties/query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_timesheet_report/properties/query" eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/query" contains: "$ref": "#/components/schemas/resource_timesheet_report/properties/query" description: Filter operator object for query. description: Filter timesheet report results by query. after: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/after" contains: "$ref": "#/components/schemas/resource_timesheet_report/properties/after" not_eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/after" not_contain: "$ref": "#/components/schemas/resource_timesheet_report/properties/after" description: Filter operator object for after. - "$ref": "#/components/schemas/resource_timesheet_report/properties/after" description: Filter timesheet report results by after. person_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_timesheet_report/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/person_id" contains: "$ref": "#/components/schemas/resource_timesheet_report/properties/person_id" eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/person_id" description: Filter operator object for person id. - "$ref": "#/components/schemas/resource_timesheet_report/properties/person_id" description: Filter timesheet report results by person id. before: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_timesheet_report/properties/before" not_contain: "$ref": "#/components/schemas/resource_timesheet_report/properties/before" not_eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/before" eq: "$ref": "#/components/schemas/resource_timesheet_report/properties/before" description: Filter operator object for before. - "$ref": "#/components/schemas/resource_timesheet_report/properties/before" description: Filter timesheet report results by before. patternProperties: "^person..*$": title: Person relationship "^time_entry..*$": title: Time entry relationship description: Available filter parameters for querying aggregated timesheet report data. _filter_root_custom_domain: oneOf: - "$ref": "#/components/schemas/filter_custom_domain" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_custom_domain" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `custom_domain` list endpoints — pass a single condition or a logical group. resource_activity: type: object title: Activity Resource properties: project_id: type: integer title: Project description: ID of the related project, if applicable. root_type: type: string title: Root Type description: Resource type of the root-level entity. task_id: type: integer title: Task description: ID of the related task, if this activity is about a task or its children. booking_id: type: integer title: Booking description: ID of the related booking, if applicable. creator_id: type: integer title: Creator description: ID of the person who made this change. deal_is_budget: title: Deal Is Budget description: Whether the related deal is a production budget (in a production pipeline) rather than a sales deal. item_id: type: integer title: Item description: ID of the entity that was changed. root_name: title: Root Name description: Human-readable name of the root-level entity. invoice_id: type: integer title: Invoice description: ID of the related invoice, if applicable. purchase_order_id: type: integer title: Purchase Order description: ID of the related purchase order, if applicable. example: 1234567 after: type: string title: After format: date-time description: Cursor for pagination — return activities after this timestamp. root_id: type: integer title: Root description: ID of the root-level entity in the hierarchy. parent_name: title: Parent Name description: Human-readable name of the parent entity. type: type: string title: Type description: 'Activity type: 1=Comment, 2=Changeset (field change), 3=Email.' item_name: title: Item Name description: Human-readable name of the changed entity. deal_id: type: integer title: Deal description: ID of the related deal/budget, if applicable. item_type: type: string title: Item Type description: Resource type of the changed entity (e.g. "task", "deal", "invoice"). email: title: Email description: The email associated with this activity, if it was an email event. made_by_automation: title: Made By Automation description: Whether this change was triggered by an automation rule rather than a person. company_id: type: integer title: Company description: ID of the related company, if applicable. before: type: string title: Before format: date-time description: Cursor for pagination — return activities before this timestamp. creator: title: Creator description: The person who made this change. person_id: type: integer title: Person description: ID of the related person, if applicable. root_deleted_at: type: string title: Root Deleted At format: date-time description: Timestamp if the root entity has been soft-deleted, null otherwise. attachment: title: Attachment description: The attachment associated with this activity, if applicable. resource_request_id: type: integer title: Resource Request description: ID of the related resource request, if applicable. event: type: string title: Event description: The type of change event (e.g. create, update, destroy). has_attachments: type: boolean title: Has Attachments description: Whether this activity entry has file attachments. pinned: type: boolean title: Pinned description: Whether this activity has a pinned comment. discussion_id: type: integer title: Discussion description: ID of the related doc discussion, if applicable. parent_deleted_at: type: string title: Parent Deleted At format: date-time description: Timestamp if the parent entity has been soft-deleted, null otherwise. organization: title: Organization description: The organization this activity belongs to. engagement_id: type: integer title: Engagement description: ID of the related salary record, if applicable. role: title: Role description: The role associated with this activity, if it was a role change. created_at: type: string title: Created At format: date-time description: When this activity occurred. parent_id: type: integer title: Parent description: ID of the parent entity (e.g. the project a task belongs to). expense_id: type: integer title: Expense description: ID of the related expense, if this activity is about an expense. normalized_item_type: type: string title: Normalized Item Type description: Normalized resource type of the changed entity, distinguishing between deals and budgets. participant_id: type: integer title: Participant description: ID of a person who participated in the activity (as creator, email recipient, or subject). id: type: integer title: Id description: Unique identifier for this activity. comment: title: Comment description: The comment associated with this activity, if it was a comment event. parent_type: type: string title: Parent Type description: Resource type of the parent entity. item_deleted_at: type: string title: Item Deleted At format: date-time description: Timestamp if the changed entity has been soft-deleted, null otherwise. changeset: title: Changeset description: The set of field changes made in this activity, formatted as before/after pairs. Sensitive fields are filtered based on viewer permissions. page_id: type: integer title: Page description: ID of the related doc page, if applicable. proposal_id: type: integer title: Proposal description: ID of the related proposal, if applicable. description: An activity feed entry recording a change event on an entity. Activities track who changed what, when, and how — forming the audit log for tasks, deals, projects, invoices, and other resources. _filter_root_price: oneOf: - "$ref": "#/components/schemas/filter_price" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_price" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `price` list endpoints — pass a single condition or a logical group. _filter_root_notification: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_notification" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_notification" description: Filter schema for `notification` list endpoints — pass a single condition or a logical group. filter_payroll_item_report: type: object title: Filter payroll item report properties: salary_id: oneOf: - "$ref": "#/components/schemas/resource_payroll_item_report/properties/salary_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/salary_id" contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/salary_id" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/salary_id" eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/salary_id" description: Filter operator object for salary id. description: Filter payroll item report results by salary id. payroll_item_type: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/payroll_item_type" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/payroll_item_type" not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/payroll_item_type" eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/payroll_item_type" description: Filter operator object for payroll item type. - "$ref": "#/components/schemas/resource_payroll_item_report/properties/payroll_item_type" description: Filter payroll item report results by payroll item type. formulas: oneOf: - "$ref": "#/components/schemas/resource_payroll_item_report/properties/formulas" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/formulas" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/formulas" description: Filter operator object for formulas. description: Filter payroll item report results by formulas. person_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_id" contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_id" description: Filter operator object for person id. - "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_id" description: Filter payroll item report results by person id. group: oneOf: - "$ref": "#/components/schemas/resource_payroll_item_report/properties/group" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/group" not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/group" eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/group" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/group" description: Filter operator object for group. description: Filter payroll item report results by group. custom_fields: oneOf: - "$ref": "#/components/schemas/resource_payroll_item_report/properties/custom_fields" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/custom_fields" description: Filter operator object for custom fields. description: Filter payroll item report results by custom fields. role_id: oneOf: - "$ref": "#/components/schemas/resource_payroll_item_report/properties/role_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/role_id" eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/role_id" contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/role_id" not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/role_id" description: Filter operator object for role id. description: Filter payroll item report results by role id. person_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_type" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_type" contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_type" not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_type" description: Filter operator object for person type. - "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_type" description: Filter payroll item report results by person type. company_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/company_id" contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/company_id" description: Filter operator object for company id. - "$ref": "#/components/schemas/resource_payroll_item_report/properties/company_id" description: Filter payroll item report results by company id. date: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/date" eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/date" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/date" contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/date" description: Filter operator object for date. - "$ref": "#/components/schemas/resource_payroll_item_report/properties/date" description: Filter payroll item report results by date. person_status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_status" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_status" contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_status" eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_status" description: Filter operator object for person status. - "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_status" description: Filter payroll item report results by person status. booking_id: oneOf: - "$ref": "#/components/schemas/resource_payroll_item_report/properties/booking_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/booking_id" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/booking_id" eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/booking_id" contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/booking_id" description: Filter operator object for booking id. description: Filter payroll item report results by booking id. salary_type_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/salary_type_id" contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/salary_type_id" eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/salary_type_id" not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/salary_type_id" description: Filter operator object for salary type id. - "$ref": "#/components/schemas/resource_payroll_item_report/properties/salary_type_id" description: Filter payroll item report results by salary type id. subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_payroll_item_report/properties/subsidiary_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/subsidiary_id" description: Filter operator object for subsidiary id. description: Filter payroll item report results by subsidiary id. time_entry_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/time_entry_id" contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/time_entry_id" not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/time_entry_id" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/time_entry_id" description: Filter operator object for time entry id. - "$ref": "#/components/schemas/resource_payroll_item_report/properties/time_entry_id" description: Filter payroll item report results by time entry id. parent_company_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payroll_item_report/properties/parent_company_id" not_eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_payroll_item_report/properties/parent_company_id" not_contain: "$ref": "#/components/schemas/resource_payroll_item_report/properties/parent_company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_payroll_item_report/properties/parent_company_id" description: Filter by the parent company of the payroll item's company. patternProperties: "^person..*$": title: Person relationship description: Available filter parameters for querying aggregated payroll item report data. _filter_root_deal: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_deal" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_deal" description: Filter schema for `deal` list endpoints — pass a single condition or a logical group. filter_pulse: type: object title: Filter pulse properties: filter_id: oneOf: - "$ref": "#/components/schemas/resource_pulse/properties/filter_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_pulse/properties/filter_id" not_contain: "$ref": "#/components/schemas/resource_pulse/properties/filter_id" contains: "$ref": "#/components/schemas/resource_pulse/properties/filter_id" eq: "$ref": "#/components/schemas/resource_pulse/properties/filter_id" description: Filter using explicit operator syntax. description: Filter by the associated saved filter used to generate the Pulse. subscriber_id: oneOf: - "$ref": "#/components/schemas/resource_pulse/properties/subscriber_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_pulse/properties/subscriber_id" not_eq: "$ref": "#/components/schemas/resource_pulse/properties/subscriber_id" not_contain: "$ref": "#/components/schemas/resource_pulse/properties/subscriber_id" contains: "$ref": "#/components/schemas/resource_pulse/properties/subscriber_id" description: Filter using explicit operator syntax. description: Filter by the person subscribed to the Pulse. id: oneOf: - "$ref": "#/components/schemas/resource_pulse/properties/id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_pulse/properties/id" not_eq: "$ref": "#/components/schemas/resource_pulse/properties/id" contains: "$ref": "#/components/schemas/resource_pulse/properties/id" eq: "$ref": "#/components/schemas/resource_pulse/properties/id" description: Filter using explicit operator syntax. description: Filter by ID. creator_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_pulse/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_pulse/properties/creator_id" contains: "$ref": "#/components/schemas/resource_pulse/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_pulse/properties/creator_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_pulse/properties/creator_id" description: Filter by the person who created the Pulse entry. patternProperties: {} description: Filter parameters for Pulse entries (team activity feed items). filter_purchase_order: type: object title: Filter purchase order properties: payment_status_id: oneOf: - "$ref": "#/components/schemas/resource_purchase_order/properties/payment_status_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/payment_status_id" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/payment_status_id" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/payment_status_id" eq: "$ref": "#/components/schemas/resource_purchase_order/properties/payment_status_id" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: - 1 description: Filter by payment status. example: eq: - 1 project_id: oneOf: - "$ref": "#/components/schemas/resource_purchase_order/properties/project_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_purchase_order/properties/project_id" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/project_id" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: - 567890 description: Filter by the project the parent deal belongs to. example: eq: - 567890 sent_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_purchase_order/properties/sent_on" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/sent_on" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/sent_on" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/sent_on" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: '2026-04-10' - "$ref": "#/components/schemas/resource_purchase_order/properties/sent_on" description: Filter by the date the purchase order was sent. example: eq: '2026-04-10' id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/id" eq: "$ref": "#/components/schemas/resource_purchase_order/properties/id" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/id" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/id" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: - 1234567 - "$ref": "#/components/schemas/resource_purchase_order/properties/id" description: Filter by purchase order ID. example: eq: - 1234567 status_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_purchase_order/properties/status_id" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/status_id" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/status_id" eq: "$ref": "#/components/schemas/resource_purchase_order/properties/status_id" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: - 1 - "$ref": "#/components/schemas/resource_purchase_order/properties/status_id" description: Filter by purchase order status. example: eq: - 1 total_cost_with_tax: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_with_tax" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_with_tax" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_with_tax" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_with_tax" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: '187500.000000' - "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_with_tax" description: Filter by total amount including tax. example: eq: '187500.000000' creator_id: oneOf: - "$ref": "#/components/schemas/resource_purchase_order/properties/creator_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_purchase_order/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/creator_id" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/creator_id" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: - 345678 description: Filter by the person who created the purchase order. example: eq: - 345678 vendor_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_purchase_order/properties/vendor_id" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/vendor_id" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/vendor_id" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/vendor_id" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: - 234567 - "$ref": "#/components/schemas/resource_purchase_order/properties/vendor_id" description: Filter by the vendor company fulfilling the purchase order. example: eq: - 234567 number: oneOf: - "$ref": "#/components/schemas/resource_purchase_order/properties/number" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/number" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/number" eq: "$ref": "#/components/schemas/resource_purchase_order/properties/number" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/number" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: PO-2024-017 description: Filter by the human-readable purchase order number. example: eq: PO-2024-017 total_received: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_purchase_order/properties/total_received" eq: "$ref": "#/components/schemas/resource_purchase_order/properties/total_received" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/total_received" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/total_received" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: '150000.000000' - "$ref": "#/components/schemas/resource_purchase_order/properties/total_received" description: Filter by amount already received. example: eq: '150000.000000' sent_status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/sent_status" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/sent_status" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/sent_status" eq: "$ref": "#/components/schemas/resource_purchase_order/properties/sent_status" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: - 1 - "$ref": "#/components/schemas/resource_purchase_order/properties/sent_status" description: Filter by whether the purchase order has been sent. One of `sent` or `not_sent`. example: eq: - 1 received_on: oneOf: - "$ref": "#/components/schemas/resource_purchase_order/properties/received_on" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_purchase_order/properties/received_on" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/received_on" eq: "$ref": "#/components/schemas/resource_purchase_order/properties/received_on" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/received_on" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: '2026-04-15T10:30:00.000Z' description: Filter by the date goods or services were received. example: eq: '2026-04-15T10:30:00.000Z' deal_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/deal_id" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/deal_id" eq: "$ref": "#/components/schemas/resource_purchase_order/properties/deal_id" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: - 456789 - "$ref": "#/components/schemas/resource_purchase_order/properties/deal_id" description: Filter by the parent deal (budget) the purchase order belongs to. example: eq: - 456789 query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/query" eq: "$ref": "#/components/schemas/resource_purchase_order/properties/query" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/query" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/query" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: PO-2024 - "$ref": "#/components/schemas/resource_purchase_order/properties/query" description: Free-text search across the purchase order number and quick-search terms. example: eq: PO-2024 issued_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_purchase_order/properties/issued_on" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/issued_on" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/issued_on" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/issued_on" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: '2026-04-10' - "$ref": "#/components/schemas/resource_purchase_order/properties/issued_on" description: Filter by issue date. example: eq: '2026-04-10' created_at: oneOf: - "$ref": "#/components/schemas/resource_purchase_order/properties/created_at" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_purchase_order/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/created_at" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/created_at" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: '2026-04-01T09:00:00.000Z' description: Filter by creation timestamp. example: eq: '2026-04-01T09:00:00.000Z' total_cost: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: '150000.000000' - "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost" description: Filter by pre-tax total amount. example: eq: '150000.000000' delivery_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_purchase_order/properties/delivery_on" contains: "$ref": "#/components/schemas/resource_purchase_order/properties/delivery_on" not_eq: "$ref": "#/components/schemas/resource_purchase_order/properties/delivery_on" not_contain: "$ref": "#/components/schemas/resource_purchase_order/properties/delivery_on" description: 'Operator-based filter: specify one or more of `eq`, `not_eq`, `contains`, `not_contain`, or range operators.' example: eq: '2026-04-17' - "$ref": "#/components/schemas/resource_purchase_order/properties/delivery_on" description: Filter by expected delivery date. example: eq: '2026-04-17' description: Filter shape for the purchase orders collection — per-field filters keyed by purchase order attributes. example: id: eq: - 1234567 status_id: eq: - 1 issued_on: gt: '2026-01-01' resource_service_report: type: object title: Service report Resource properties: total_budgeted_time: type: number title: Total Budgeted Time description: Sum of budgeted time across all records in this service report group. updated_at: type: string title: Updated At format: date description: Updated at for this service report group. average_actual_rate_default: title: Average Actual Rate Default description: Average actual rate in the organization's default currency for this service report group. with_memberships: type: boolean title: With Memberships description: With memberships for this service report group. section_id: type: integer title: Section description: Section id for this service report group. price: title: Price description: Price for this service report group. average_actual_rate: title: Average Actual Rate description: Average actual rate for this service report group. bookable_after: type: string title: Bookable After format: date description: Bookable after for this service report group. bookable_before: type: string title: Bookable Before format: date description: Bookable before for this service report group. average_markup: type: string title: Average Markup description: Average markup for this service report group. report: title: Report description: Report for this service report group. total_estimated_cost_default: title: Total Estimated Cost Default description: Sum of estimated cost in the organization's default currency across all records in this service report group. profit: type: integer title: Profit description: Profit for this service report group. organization: title: Organization description: Organization for this service report group. service_markup: title: Service Markup description: Service markup for this service report group. subsidiary_id: type: integer title: Subsidiary description: Subsidiary id for this service report group. id: type: integer title: Id description: Unique identifier for this service report row. markup_amount: title: Markup Amount description: Markup amount for this service report group. cost: title: Cost description: Cost for this service report group. left_to_schedule_time: type: integer title: Left To Schedule Time description: Left to schedule time for this service report group. estimated_time: type: integer title: Estimated Time description: Estimated time for this service report group. total_unapproved_time: type: number title: Total Unapproved Time description: Sum of unapproved time across all records in this service report group. average_profit_margin: type: number title: Average Profit Margin description: Average profit margin for this service report group. budget: title: Budget description: Budget for this service report group. bookable_date_for_period: type: string title: Bookable Date For Period format: date description: Filter services in this report group to those bookable on the specified date. total_price_default: title: Total Price Default description: Sum of price in the organization's default currency across all records in this service report group. quantity: type: number title: Quantity description: Quantity for this service report group. total_estimated_cost_normalized: title: Total Estimated Cost Normalized description: Sum of estimated cost in the normalized currency across all records in this service report group. total_budget_remaining_normalized: title: Total Budget Remaining Normalized description: Sum of budget remaining in the normalized currency across all records in this service report group. profit_margin: type: number title: Profit Margin description: Profit margin for this service report group. project_type: enum: - 1 - 2 type: integer title: Project Type description: Project type for this service report group. currency: type: string title: Currency description: Currency for this service report group. total_discount_amount_normalized: title: Total Discount Amount Normalized description: Sum of discount amount in the normalized currency across all records in this service report group. limitation_type: enum: - no_limitation - estimate_limitation - quantity_limitation - budget_fully_used type: string title: Limitation Type description: Limitation type for this service report group. budgets_and_deals: type: boolean title: Budgets And Deals description: Budgets and deals for this service report group. billable_time: type: integer title: Billable Time description: Billable time for this service report group. total_rolled_over_time: type: number title: Total Rolled Over Time description: Sum of rolled over time across all records in this service report group. total_profit: title: Total Profit description: Sum of profit across all records in this service report group. count: type: integer title: Count description: Number of services in this report group. deal_id: type: integer title: Deal description: Deal id for this service report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this service report group. total_budget_used_normalized: title: Total Budget Used Normalized description: Sum of budget used in the normalized currency across all records in this service report group. total_future_budget_used_normalized: title: Total Future Budget Used Normalized description: Sum of future budget used in the normalized currency across all records in this service report group. total_recognized_revenue: title: Total Recognized Revenue description: Sum of recognized revenue across all records in this service report group. deal_custom_fields: type: string title: Deal Custom Fields description: Deal custom fields for this service report group. total_cost_normalized: title: Total Cost Normalized description: Sum of cost in the normalized currency across all records in this service report group. bookable_date: type: string title: Bookable Date format: date description: Bookable date for this service report group. expense_tracking_enabled: type: integer title: Expense Tracking Enabled description: Expense tracking enabled for this service report group. projected_revenue: title: Projected Revenue description: Projected revenue for this service report group. initial_service_id: type: integer title: Initial Service description: Initial service id for this service report group. discount: type: number title: Discount description: Discount for this service report group. revenue: title: Revenue description: Revenue for this service report group. contract: title: Contract description: Contract for this service report group. unit: enum: - 1 - 2 - 3 type: integer title: Unit description: Unit for this service report group. total_future_budget_used_default: title: Total Future Budget Used Default description: Sum of future budget used in the organization's default currency across all records in this service report group. total_budget_used: title: Total Budget Used description: Sum of budget used across all records in this service report group. discount_amount: title: Discount Amount description: Discount amount for this service report group. trackable_by_person_id: type: integer title: Trackable By Person description: Trackable by person id for this service report group. formulas: type: integer title: Formulas description: Formulas for this service report group. total_cost_default: title: Total Cost Default description: Sum of cost in the organization's default currency across all records in this service report group. total_projected_revenue_normalized: title: Total Projected Revenue Normalized description: Sum of projected revenue in the normalized currency across all records in this service report group. total_discount_amount: title: Total Discount Amount description: Sum of discount amount across all records in this service report group. total_forecasted_budget_used_normalized: title: Total Forecasted Budget Used Normalized description: Sum of forecasted budget used in the normalized currency across all records in this service report group. budget_total: title: Budget Total description: Budget total for this service report group. deal_or_budget_report: title: Deal Or Budget Report description: Report object for the deal or budget associated with services in this group. origin_deal: title: Origin Deal description: Origin deal for this service report group. service_name: title: Service Name description: Service name for this service report group. service_type_id: type: integer title: Service Type description: Service type id for this service report group. origin_deal_id: type: integer title: Origin Deal description: Origin deal id for this service report group. deal_stage_id: type: integer title: Deal Stage description: Deal stage id for this service report group. recurring: type: integer title: Recurring description: Recurring for this service report group. pipeline: title: Pipeline description: Pipeline for this service report group. total_forecasted_budget_used: title: Total Forecasted Budget Used description: Sum of forecasted budget used across all records in this service report group. date: title: Date description: Date for this service report group. total_budget_remaining_default: title: Total Budget Remaining Default description: Sum of budget remaining in the organization's default currency across all records in this service report group. unapproved_time: type: integer title: Unapproved Time description: Unapproved time for this service report group. total_revenue_normalized: title: Total Revenue Normalized description: Sum of revenue in the normalized currency across all records in this service report group. stage_type: enum: - 1 - 2 type: integer title: Stage Type description: Stage type for this service report group. average_profit_margin_default: type: number title: Average Profit Margin Default description: Average profit margin in the organization's default currency for this service report group. custom_fields: type: string title: Custom Fields description: Custom fields for this service report group. markup: type: number title: Markup description: Markup for this service report group. average_forecasted_time_usage: type: number title: Average Forecasted Time Usage description: Average forecasted time usage for this service report group. total_future_budget_used: title: Total Future Budget Used description: Sum of future budget used across all records in this service report group. probability: type: integer title: Probability description: Probability for this service report group. date_period: title: Date Period description: Time period grouping for date (e.g. week, month, quarter). subsidiary: title: Subsidiary description: Subsidiary for this service report group. total_price: title: Total Price description: Sum of price across all records in this service report group. responsible: title: Responsible description: Responsible for this service report group. billing_type: enum: - 1 - 2 - 3 - 4 type: integer title: Billing Type description: Billing type for this service report group. query: type: string title: Query description: Query for this service report group. estimated_cost: title: Estimated Cost description: Estimated cost for this service report group. budget_id: type: integer title: Budget description: Budget id for this service report group. future_booked_time: type: integer title: Future Booked Time description: Future booked time for this service report group. budget_date: type: string title: Budget Date format: date description: Budget date for this service report group. service_discount: title: Service Discount description: Service discount for this service report group. projectless_budgets: type: boolean title: Projectless Budgets description: Projectless budgets for this service report group. contract_id: type: integer title: Contract description: Contract id for this service report group. section: title: Section description: Section for this service report group. after: type: string title: After format: date description: After for this service report group. person_id: type: integer title: Person description: Person id for this service report group. worked_time: type: integer title: Worked Time description: Worked time for this service report group. responsible_id: type: integer title: Responsible description: Responsible id for this service report group. formula_fields: title: Formula Fields description: Formula fields for this service report group. expense_cost: title: Expense Cost description: Expense cost for this service report group. service_description: title: Service Description description: Service description for this service report group. task_id: type: integer title: Task description: Task id for this service report group. total_billable_time: type: number title: Total Billable Time description: Sum of billable time across all records in this service report group. total_worked_cost_default: title: Total Worked Cost Default description: Sum of worked cost in the organization's default currency across all records in this service report group. owner_report: title: Owner Report description: Owner report for this service report group. total_revenue: title: Total Revenue description: Sum of revenue across all records in this service report group. stage_status_id: enum: - 1 - 2 - 3 - 4 type: integer title: Stage Status description: Stage status id for this service report group. total_markup_amount: title: Total Markup Amount description: Sum of markup amount across all records in this service report group. booked_time: type: integer title: Booked Time description: Booked time for this service report group. stage_status: title: Stage Status description: Stage status for this service report group. total_markup_amount_normalized: title: Total Markup Amount Normalized description: Sum of markup amount in the normalized currency across all records in this service report group. worked_cost: title: Worked Cost description: Worked cost for this service report group. budget_cap_enabled: type: integer title: Budget Cap Enabled description: Budget cap enabled for this service report group. origin_deal_report: title: Origin Deal Report description: Related origin deal report data for this service report group. total_expense_cost: title: Total Expense Cost description: Sum of expense cost across all records in this service report group. deal_status: title: Deal Status description: Deal status for this service report group. total_forecasted_budget_used_default: title: Total Forecasted Budget Used Default description: Sum of forecasted budget used in the organization's default currency across all records in this service report group. explicit_access: type: boolean title: Explicit Access description: When true, filters service report entries to those the current user has explicit access to. total_budget_total_normalized: title: Total Budget Total Normalized description: Sum of budget total in the normalized currency across all records in this service report group. recognized_revenue: title: Recognized Revenue description: Recognized revenue for this service report group. total_budget_used_default: title: Total Budget Used Default description: Sum of budget used in the organization's default currency across all records in this service report group. sales_status_id: enum: - 1 - 2 - 3 - 4 type: integer title: Sales Status description: Sales status id for this service report group. total_booked_time: type: number title: Total Booked Time description: Sum of booked time across all records in this service report group. total_expense_cost_normalized: title: Total Expense Cost Normalized description: Sum of expense cost in the normalized currency across all records in this service report group. service_position: title: Service Position description: Service position for this service report group. total_recognized_revenue_normalized: title: Total Recognized Revenue Normalized description: Sum of recognized revenue in the normalized currency across all records in this service report group. origin_service_id: type: integer title: Origin Service description: Origin service id for this service report group. company: title: Company description: Company for this service report group. average_discount: type: string title: Average Discount description: Average discount for this service report group. budget_remaining: type: integer title: Budget Remaining description: Budget remaining for this service report group. service_unit: title: Service Unit description: Service unit for this service report group. total_forecasted_billable_time: type: number title: Total Forecasted Billable Time description: Sum of forecasted billable time across all records in this service report group. section_position: title: Section Position description: Section position for this service report group. remaining_scheduled_time: type: integer title: Remaining Scheduled Time description: Remaining scheduled time for this service report group. total_projected_revenue_default: title: Total Projected Revenue Default description: Sum of projected revenue in the organization's default currency across all records in this service report group. project_id: type: integer title: Project description: Project id for this service report group. type: type: integer title: Type description: Type for this service report group. billable: type: integer title: Billable description: Billable for this service report group. average_budget_usage_normalized: title: Average Budget Usage Normalized description: Average budget usage in the normalized currency for this service report group. service_type: title: Service Type description: Service type for this service report group. total_future_booked_time: type: number title: Total Future Booked Time description: Sum of future booked time across all records in this service report group. service_deal_date: title: Service Deal Date description: Service deal date for this service report group. total_cost: title: Total Cost description: Sum of cost across all records in this service report group. future_budget_used: title: Future Budget Used description: Future budget used for this service report group. total_profit_default: title: Total Profit Default description: Sum of profit in the organization's default currency across all records in this service report group. total_estimated_time: type: number title: Total Estimated Time description: Sum of estimated time across all records in this service report group. budget_custom_fields: type: string title: Budget Custom Fields description: Budget custom fields for this service report group. average_retainer_interval_count: type: integer title: Average Retainer Interval Count description: The average number of interval units per retainer period across services in this group. time_tracking_enabled: type: integer title: Time Tracking Enabled description: Time tracking enabled for this service report group. for_tracking: type: boolean title: For Tracking description: For tracking for this service report group. total_budget_remaining: title: Total Budget Remaining description: Sum of budget remaining across all records in this service report group. average_actual_rate_normalized: title: Average Actual Rate Normalized description: Average actual rate in the normalized currency for this service report group. total_projected_revenue: title: Total Projected Revenue description: Sum of projected revenue across all records in this service report group. pipeline_id: type: integer title: Pipeline description: Pipeline id for this service report group. service_billable: title: Service Billable description: Service billable for this service report group. total_markup_amount_default: title: Total Markup Amount Default description: Sum of markup amount in the organization's default currency across all records in this service report group. group: type: string title: Group description: The grouping dimension for this service report row. total_estimated_remaining_time: type: number title: Total Estimated Remaining Time description: Sum of estimated remaining time across all records in this service report group. before: type: string title: Before format: date description: Before for this service report group. total_expense_cost_default: title: Total Expense Cost Default description: Sum of expense cost in the organization's default currency across all records in this service report group. template: type: boolean title: Template description: Template for this service report group. total_profit_normalized: title: Total Profit Normalized description: Sum of profit in the normalized currency across all records in this service report group. budget_status: enum: - 1 - 2 type: integer title: Budget Status description: Budget status for this service report group. company_report: title: Company Report description: Company report for this service report group. total_budget_total_default: title: Total Budget Total Default description: Sum of budget total in the organization's default currency across all records in this service report group. average_forecasted_budget_usage: type: number title: Average Forecasted Budget Usage description: Average forecasted budget usage for this service report group. project_report: title: Project Report description: Project report for this service report group. rolled_over_time: type: integer title: Rolled Over Time description: Rolled over time for this service report group. total_budget_total: title: Total Budget Total description: Sum of budget total across all records in this service report group. total_estimated_cost: title: Total Estimated Cost description: Sum of estimated cost across all records in this service report group. total_price_normalized: title: Total Price Normalized description: Sum of price in the normalized currency across all records in this service report group. total_revenue_default: title: Total Revenue Default description: Sum of revenue in the organization's default currency across all records in this service report group. total_left_to_schedule_time: type: number title: Total Left To Schedule Time description: Sum of left to schedule time across all records in this service report group. average_forecasted_budget_usage_default: type: number title: Average Forecasted Budget Usage Default description: Average forecasted budget usage in the organization's default currency for this service report group. deal_status_id: type: integer title: Deal Status description: Deal status id for this service report group. average_budget_usage: type: number title: Average Budget Usage description: Average budget usage for this service report group. company_id: type: integer title: Company description: Company id for this service report group. total_recognized_revenue_default: title: Total Recognized Revenue Default description: Sum of recognized revenue in the organization's default currency across all records in this service report group. average_forecasted_budget_usage_normalized: title: Average Forecasted Budget Usage Normalized description: Average forecasted budget usage in the normalized currency for this service report group. total_discount_amount_default: title: Total Discount Amount Default description: Sum of discount amount in the organization's default currency across all records in this service report group. booking_tracking_enabled: type: integer title: Booking Tracking Enabled description: Booking tracking enabled for this service report group. budget_used: title: Budget Used description: Budget used for this service report group. budgeted_time: type: integer title: Budgeted Time description: Budgeted time for this service report group. revamped_unit: enum: - 1 - 2 - 3 type: integer title: Revamped Unit description: Revamped unit for this service report group. total_remaining_scheduled_time: type: number title: Total Remaining Scheduled Time description: Sum of remaining scheduled time across all records in this service report group. total_worked_cost_normalized: title: Total Worked Cost Normalized description: Sum of worked cost in the normalized currency across all records in this service report group. project: title: Project description: Project for this service report group. average_profit_margin_normalized: title: Average Profit Margin Normalized description: Average profit margin in the normalized currency for this service report group. currency_normalized: title: Currency Normalized description: Currency in the normalized currency for this service report group. section_name: type: string title: Section Name description: Section name for this service report group. total_worked_cost: title: Total Worked Cost description: Sum of worked cost across all records in this service report group. sales_status: title: Sales Status description: Sales status for this service report group. name: type: string title: Name description: Name for this service report group. service: title: Service description: Service for this service report group. average_budget_usage_default: type: number title: Average Budget Usage Default description: Average budget usage in the organization's default currency for this service report group. total_worked_time: type: number title: Total Worked Time description: Sum of worked time across all records in this service report group. description: An aggregated service report row grouping services by configurable dimensions with financial totals, time metrics, and billing analysis. resource_organization_subscription: type: object title: Organization subscription Resource properties: discount: type: integer title: Discount description: The discount percentage applied to the subscription price. trial_ends_at: type: string title: Trial Ends At format: date-time description: Timestamp when the free trial ends, or null if not on a trial. billing_email: type: object title: Billing Email description: The email address used for billing communications and invoices. seats_used: type: integer title: Seats Used description: The number of seats currently occupied by active members. subscription_state_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 8 - 9 type: integer title: Subscription State description: ID of the current subscription state (e.g. active, trialing, past_due, canceled). billing_group_admin: type: boolean title: Billing Group Admin description: Whether this organization is the admin of a billing group (manages billing for member organizations). card_brand: type: string title: Card Brand description: The brand of the credit or debit card on file (e.g. Visa, Mastercard). seats: type: integer title: Seats description: The total number of seats purchased for this subscription. organization: title: Organization description: The organization this subscription belongs to. seats_pending: title: Seats Pending description: The number of seats with a pending change (e.g. scheduled to be added or removed). subscription_started_at: type: string title: Subscription Started At format: date-time description: Timestamp when the subscription started. contract_min_seats: type: integer title: Contract Min Seats description: The minimum number of seats specified in the organization's contract. plan_cycle: title: Plan Cycle description: The billing cycle of the plan (monthly or annual). stripe_token: title: Stripe Token description: The Stripe payment token used to update the payment method on file. current_products: title: Current Products description: The list of product modules currently active on the subscription. card_month: type: string title: Card Month description: The expiry month of the card on file. subscription_ended_at: type: string title: Subscription Ended At format: date-time description: Timestamp when the subscription ended, or null if still active. trial_plan_ends_at: type: string title: Trial Plan Ends At format: date-time description: The trial plan ends at. card_last4: type: string title: Card Last4 description: The last four digits of the credit or debit card on file. discount_expires_on: type: string title: Discount Expires On format: date description: Date when the current discount expires, or null if it does not expire. trial_plan_active: title: Trial Plan Active description: Whether a trial plan upgrade is currently active for this organization. stripe_customer_id: type: integer title: Stripe Customer description: The Stripe customer ID associated with this organization's billing account. product_types: type: array items: description: A product type entry within the subscription's product_types list. title: Product Types description: The list of product module types included in the subscription. contract_date: type: string title: Contract Date format: date description: The date the contract with this organization started. next_billing_cycle_at: type: string title: Next Billing Cycle At format: date-time description: The next billing cycle at. contract_seats: type: integer title: Contract Seats description: The number of seats specified in the organization's current contract. billing_group_owner: title: Billing Group Owner description: The billing group owner organization, if this organization is a billing group member. billing_group_members: title: Billing Group Members description: Organizations in the billing group managed by this organization, if it is a billing group admin. trial_product_ids: type: object title: Trial Product Ids description: List of product IDs included in the trial subscription for this organization. billing_address: type: object title: Billing Address description: The billing address on file for this organization's subscription. plan_type: title: Plan Type description: The type identifier of the current plan (e.g. essential, professional, ultimate). billing_group_seats: type: integer title: Billing Group Seats description: Total number of seats across all organizations in this billing group. collection_method_id: enum: - 1 - 2 type: integer title: Collection Method description: ID of the collection method used to charge this subscription (e.g., charge automatically or send invoice). plan_price: title: Plan Price description: The price per seat per billing cycle for the current plan, after discount. grace_period_ends_at: type: string title: Grace Period Ends At format: date-time description: The grace period ends at. balance: title: Balance description: The account's current Stripe balance in cents (negative means credit). payment_method_id: enum: - 1 - 2 type: integer title: Payment Method description: ID of the payment method on file for this subscription. card_year: type: string title: Card Year description: The expiry year of the card on file. trial_plan_type: title: Trial Plan Type description: The type of plan being trialed, if a trial plan upgrade is active. billing_group_member: title: Billing Group Member description: Whether this organization is a member of a billing group managed by another organization. active_products: type: object title: Active Products description: The list of currently active product modules enabled on this subscription. current_plan: title: Current Plan description: The organization's current billing plan details. description: The subscription details for an organization's Productive plan, including billing, seats, and plan information. filter_budget_report: type: object title: Filter budget report properties: budget_used: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/budget_used" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/budget_used" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/budget_used" contains: "$ref": "#/components/schemas/resource_budget_report/properties/budget_used" eq: "$ref": "#/components/schemas/resource_budget_report/properties/budget_used" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by budget used amount range. sales_status_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/sales_status_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/sales_status_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/sales_status_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/sales_status_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/sales_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the sales deal status (opportunity pipeline stage). origin_deal_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/origin_deal_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/origin_deal_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/origin_deal_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/origin_deal_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/origin_deal_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the originating deal this budget was created from. profit_margin: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/profit_margin" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/profit_margin" contains: "$ref": "#/components/schemas/resource_budget_report/properties/profit_margin" eq: "$ref": "#/components/schemas/resource_budget_report/properties/profit_margin" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/profit_margin" description: Filter by profit margin percentage (profit divided by revenue). lost_reason_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/lost_reason_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/lost_reason_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/lost_reason_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/lost_reason_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/lost_reason_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the reason the deal was lost. sales_closed_on: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/sales_closed_on" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/sales_closed_on" eq: "$ref": "#/components/schemas/resource_budget_report/properties/sales_closed_on" contains: "$ref": "#/components/schemas/resource_budget_report/properties/sales_closed_on" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/sales_closed_on" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the date the budget was closed in sales (won or lost). projected_revenue: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/projected_revenue" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/projected_revenue" contains: "$ref": "#/components/schemas/resource_budget_report/properties/projected_revenue" eq: "$ref": "#/components/schemas/resource_budget_report/properties/projected_revenue" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/projected_revenue" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by projected revenue amount range. number: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/number" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/number" eq: "$ref": "#/components/schemas/resource_budget_report/properties/number" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/number" contains: "$ref": "#/components/schemas/resource_budget_report/properties/number" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the budget number (sequential identifier within the organization). previous_deal_status_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/previous_deal_status_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/previous_deal_status_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/previous_deal_status_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/previous_deal_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/previous_deal_status_id" description: Filter by the previous deal status (pipeline stage before the current one). type: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/type" contains: "$ref": "#/components/schemas/resource_budget_report/properties/type" eq: "$ref": "#/components/schemas/resource_budget_report/properties/type" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/type" description: Filter by the resource type of the report row (e.g. budget_report). status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/status" eq: "$ref": "#/components/schemas/resource_budget_report/properties/status" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/status" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/status" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/status" description: Filter by the budget status label (e.g. active, closed, lost). stage_status_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/stage_status_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/stage_status_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/stage_status_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/stage_status_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/stage_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the current pipeline stage (stage status). needs_closing: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/needs_closing" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/needs_closing" contains: "$ref": "#/components/schemas/resource_budget_report/properties/needs_closing" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/needs_closing" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/needs_closing" description: Filter to budgets that need closing (overdue or exceeded budget). invoiced: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/invoiced" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/invoiced" contains: "$ref": "#/components/schemas/resource_budget_report/properties/invoiced" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/invoiced" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/invoiced" description: Filter by invoiced amount range. invoiced_percentage: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/invoiced_percentage" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/invoiced_percentage" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/invoiced_percentage" contains: "$ref": "#/components/schemas/resource_budget_report/properties/invoiced_percentage" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/invoiced_percentage" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the invoiced percentage (invoiced amount divided by budget total). revenue: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/revenue" eq: "$ref": "#/components/schemas/resource_budget_report/properties/revenue" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/revenue" contains: "$ref": "#/components/schemas/resource_budget_report/properties/revenue" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/revenue" description: Filter by revenue amount range. created_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/created_at" contains: "$ref": "#/components/schemas/resource_budget_report/properties/created_at" eq: "$ref": "#/components/schemas/resource_budget_report/properties/created_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/created_at" description: Filter by budget creation date range (created_at). recurring_interval_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/recurring_interval_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_interval_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_interval_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_interval_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_interval_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the recurrence interval (e.g. monthly, quarterly). color_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/color_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/color_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/color_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/color_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/color_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the display color assigned to the budget. purchase_order_number: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/purchase_order_number" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/purchase_order_number" eq: "$ref": "#/components/schemas/resource_budget_report/properties/purchase_order_number" contains: "$ref": "#/components/schemas/resource_budget_report/properties/purchase_order_number" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. example: eq: PO-2024-017 - "$ref": "#/components/schemas/resource_budget_report/properties/purchase_order_number" description: Filter by purchase order number. example: eq: PO-2024-017 recurring: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/recurring" contains: "$ref": "#/components/schemas/resource_budget_report/properties/recurring" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/recurring" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/recurring" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/recurring" description: Filter to recurring budgets only (generated from contracts). date: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/date" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/date" contains: "$ref": "#/components/schemas/resource_budget_report/properties/date" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/date" eq: "$ref": "#/components/schemas/resource_budget_report/properties/date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the report date (used to scope the time range of aggregated metrics). forecasted_time_usage: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_time_usage" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_time_usage" contains: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_time_usage" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_time_usage" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_time_usage" description: Filter by forecasted time usage percentage (forecasted billable time divided by budgeted time). delivered_on: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/delivered_on" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/delivered_on" contains: "$ref": "#/components/schemas/resource_budget_report/properties/delivered_on" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/delivered_on" eq: "$ref": "#/components/schemas/resource_budget_report/properties/delivered_on" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by delivery date range (delivered_on). forecasted_budget_usage: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_budget_usage" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_budget_usage" eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_budget_usage" contains: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_budget_usage" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_budget_usage" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by forecasted budget usage percentage (forecasted budget used divided by budget total). jump_query: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/jump_query" contains: "$ref": "#/components/schemas/resource_budget_report/properties/jump_query" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/jump_query" description: Jump-to search query for quickly navigating to a budget by name prefix. parent_company_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/parent_company_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/parent_company_id" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_budget_report/properties/parent_company_id" description: Filter by parent company ID, returning budgets linked to companies that are children of the specified parent. won_at: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/won_at" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/won_at" eq: "$ref": "#/components/schemas/resource_budget_report/properties/won_at" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/won_at" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/won_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the date the deal was marked as won (won_at). credited: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/credited" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/credited" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/credited" contains: "$ref": "#/components/schemas/resource_budget_report/properties/credited" eq: "$ref": "#/components/schemas/resource_budget_report/properties/credited" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by credited amount range. expenses_billable: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/expenses_billable" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/expenses_billable" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/expenses_billable" eq: "$ref": "#/components/schemas/resource_budget_report/properties/expenses_billable" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/expenses_billable" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by billable expenses amount range. estimated_remaining_time: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/estimated_remaining_time" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/estimated_remaining_time" contains: "$ref": "#/components/schemas/resource_budget_report/properties/estimated_remaining_time" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/estimated_remaining_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/estimated_remaining_time" description: Filter by estimated remaining time on the budget, in minutes. services_revenue: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/services_revenue" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/services_revenue" eq: "$ref": "#/components/schemas/resource_budget_report/properties/services_revenue" contains: "$ref": "#/components/schemas/resource_budget_report/properties/services_revenue" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/services_revenue" description: Filter by revenue from services only (excluding expenses and manual invoicing). recurring_ends_on: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_ends_on" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_ends_on" eq: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_ends_on" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_ends_on" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/recurring_ends_on" description: Filter by the recurring contract end date range (recurring_ends_on). pipeline_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/pipeline_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/pipeline_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/pipeline_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/pipeline_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/pipeline_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the pipeline (production pipeline) this budget belongs to. invoiced_rate: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/invoiced_rate" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/invoiced_rate" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/invoiced_rate" contains: "$ref": "#/components/schemas/resource_budget_report/properties/invoiced_rate" eq: "$ref": "#/components/schemas/resource_budget_report/properties/invoiced_rate" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the effective invoiced rate (invoiced amount divided by worked time). won_date: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/won_date" contains: "$ref": "#/components/schemas/resource_budget_report/properties/won_date" eq: "$ref": "#/components/schemas/resource_budget_report/properties/won_date" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/won_date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/won_date" description: Filter by the sales closed date when the deal status was set to won. future_budget_used: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/future_budget_used" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/future_budget_used" contains: "$ref": "#/components/schemas/resource_budget_report/properties/future_budget_used" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/future_budget_used" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/future_budget_used" description: Filter by future budget used amount range. sales_closed_at: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/sales_closed_at" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/sales_closed_at" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/sales_closed_at" eq: "$ref": "#/components/schemas/resource_budget_report/properties/sales_closed_at" contains: "$ref": "#/components/schemas/resource_budget_report/properties/sales_closed_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by sales close date range (sales_closed_at). profit: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/profit" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/profit" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/profit" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/profit" eq: "$ref": "#/components/schemas/resource_budget_report/properties/profit" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total profit (revenue minus cost) on this budget. estimated_time: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/estimated_time" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/estimated_time" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/estimated_time" contains: "$ref": "#/components/schemas/resource_budget_report/properties/estimated_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/estimated_time" description: Filter by the total estimated time on this budget, in minutes. future_booked_time: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/future_booked_time" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/future_booked_time" eq: "$ref": "#/components/schemas/resource_budget_report/properties/future_booked_time" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/future_booked_time" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/future_booked_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by future booked time from scheduled bookings, in minutes. draft_invoiced: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/draft_invoiced" contains: "$ref": "#/components/schemas/resource_budget_report/properties/draft_invoiced" eq: "$ref": "#/components/schemas/resource_budget_report/properties/draft_invoiced" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/draft_invoiced" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/draft_invoiced" description: Filter by draft invoiced amount range. query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/query" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/query" eq: "$ref": "#/components/schemas/resource_budget_report/properties/query" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/query" description: Full-text search query applied to budget name and description. cost: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/cost" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/cost" contains: "$ref": "#/components/schemas/resource_budget_report/properties/cost" eq: "$ref": "#/components/schemas/resource_budget_report/properties/cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/cost" description: Filter by total cost amount range (work cost plus expenses). retainer_interval: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/retainer_interval" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/retainer_interval" contains: "$ref": "#/components/schemas/resource_budget_report/properties/retainer_interval" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/retainer_interval" eq: "$ref": "#/components/schemas/resource_budget_report/properties/retainer_interval" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the budget retainer billing interval (week, two_weeks, month, quarter, half_year, or year). forecasted_budget_used: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_budget_used" contains: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_budget_used" eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_budget_used" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_budget_used" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_budget_used" description: Filter by the forecasted budget used amount (current budget used plus future cost). deal_type_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/deal_type_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/deal_type_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/deal_type_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/deal_type_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/deal_type_id" description: Filter by the deal type (e.g. fixed price, hourly, retainer). end_date: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/end_date" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/end_date" eq: "$ref": "#/components/schemas/resource_budget_report/properties/end_date" contains: "$ref": "#/components/schemas/resource_budget_report/properties/end_date" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/end_date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by budget end date range (end_date). responsible_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/responsible_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/responsible_id" description: Filter by the person responsible for the budget. budget_warning: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/budget_warning" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/budget_warning" eq: "$ref": "#/components/schemas/resource_budget_report/properties/budget_warning" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/budget_warning" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/budget_warning" description: Filter by the budget warning threshold percentage. When budget usage exceeds this percentage, the budget is flagged as a warning. subscriber_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/subscriber_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/subscriber_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/subscriber_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/subscriber_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/subscriber_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter to budgets where the specified person is a subscriber. budgeted_time: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/budgeted_time" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/budgeted_time" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/budgeted_time" eq: "$ref": "#/components/schemas/resource_budget_report/properties/budgeted_time" contains: "$ref": "#/components/schemas/resource_budget_report/properties/budgeted_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total time budgeted on the budget, in minutes. fuzzy_people: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/fuzzy_people" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/fuzzy_people" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_budget_report/properties/fuzzy_people" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter using fuzzy person references (e.g. me, my_team) for person fields. creator_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/creator_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/creator_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/creator_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the person who created the budget. days_since_created: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/days_since_created" eq: "$ref": "#/components/schemas/resource_budget_report/properties/days_since_created" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/days_since_created" contains: "$ref": "#/components/schemas/resource_budget_report/properties/days_since_created" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_budget_report/properties/days_since_created" description: Filter by the number of days elapsed since the budget was created (`created_at`). currency: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/currency" contains: "$ref": "#/components/schemas/resource_budget_report/properties/currency" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/currency" eq: "$ref": "#/components/schemas/resource_budget_report/properties/currency" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/currency" description: Filter by the currency code of the budget (e.g. USD, EUR). pending_invoicing: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/pending_invoicing" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/pending_invoicing" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/pending_invoicing" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/pending_invoicing" eq: "$ref": "#/components/schemas/resource_budget_report/properties/pending_invoicing" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the amount pending invoicing (billable work not yet invoiced). formulas: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/formulas" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_budget_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/formulas" contains: "$ref": "#/components/schemas/resource_budget_report/properties/formulas" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Formula columns applied to this report. closed_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/closed_at" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/closed_at" eq: "$ref": "#/components/schemas/resource_budget_report/properties/closed_at" contains: "$ref": "#/components/schemas/resource_budget_report/properties/closed_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/closed_at" description: Filter by budget close date range (closed_at). recurring_starts_on: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/recurring_starts_on" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_starts_on" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_starts_on" contains: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_starts_on" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_starts_on" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the recurring contract start date range (recurring_starts_on). forecasted_revenue: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_revenue" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_revenue" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_revenue" contains: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_revenue" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_revenue" description: Filter by forecasted revenue (current revenue plus future revenue). budget_usage: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/budget_usage" eq: "$ref": "#/components/schemas/resource_budget_report/properties/budget_usage" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/budget_usage" contains: "$ref": "#/components/schemas/resource_budget_report/properties/budget_usage" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/budget_usage" description: Filter by the budget usage percentage (budget used divided by budget total). unapproved_time: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/unapproved_time" contains: "$ref": "#/components/schemas/resource_budget_report/properties/unapproved_time" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/unapproved_time" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/unapproved_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/unapproved_time" description: Filter by total unapproved time range. project_type: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/project_type" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/project_type" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/project_type" eq: "$ref": "#/components/schemas/resource_budget_report/properties/project_type" contains: "$ref": "#/components/schemas/resource_budget_report/properties/project_type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by project type (billable or overhead). fuzzy_dates: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/fuzzy_dates" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/fuzzy_dates" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_budget_report/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_budget_report/properties/fuzzy_dates" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter using relative date expressions (e.g. this_week, last_month) for date fields. days_in_current_stage: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/days_in_current_stage" contains: "$ref": "#/components/schemas/resource_budget_report/properties/days_in_current_stage" eq: "$ref": "#/components/schemas/resource_budget_report/properties/days_in_current_stage" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/days_in_current_stage" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_budget_report/properties/days_in_current_stage" description: Filter by the number of days the budget has been in its current pipeline stage. tracking_type_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/tracking_type_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/tracking_type_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/tracking_type_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/tracking_type_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/tracking_type_id" description: Filter by time tracking type. previous_probability: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/previous_probability" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/previous_probability" eq: "$ref": "#/components/schemas/resource_budget_report/properties/previous_probability" contains: "$ref": "#/components/schemas/resource_budget_report/properties/previous_probability" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/previous_probability" description: Filter by the previous deal win probability percentage range. stage_updated_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/stage_updated_at" eq: "$ref": "#/components/schemas/resource_budget_report/properties/stage_updated_at" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/stage_updated_at" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/stage_updated_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/stage_updated_at" description: Filter by the date the deal stage was last updated (stage_updated_at). deal_status_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/deal_status_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/deal_status_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/deal_status_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/deal_status_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/deal_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the deal status (pipeline stage) of this budget. contract_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/contract_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/contract_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/contract_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/contract_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/contract_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the associated contract. approval_policy_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/approval_policy_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/approval_policy_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/approval_policy_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/approval_policy_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/approval_policy_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the assigned approval policy. budget_status: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/budget_status" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/budget_status" eq: "$ref": "#/components/schemas/resource_budget_report/properties/budget_status" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/budget_status" contains: "$ref": "#/components/schemas/resource_budget_report/properties/budget_status" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the budget status (e.g. active, closed). future_cost: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/future_cost" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/future_cost" eq: "$ref": "#/components/schemas/resource_budget_report/properties/future_cost" contains: "$ref": "#/components/schemas/resource_budget_report/properties/future_cost" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/future_cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by future cost amount range. forecasted_cost: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_cost" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_cost" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_cost" contains: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_cost" eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the forecasted total cost (current cost plus future cost). manually_invoiced: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/manually_invoiced" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/manually_invoiced" eq: "$ref": "#/components/schemas/resource_budget_report/properties/manually_invoiced" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/manually_invoiced" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/manually_invoiced" description: Filter by manually invoiced amount range. estimated_cost: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/estimated_cost" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/estimated_cost" contains: "$ref": "#/components/schemas/resource_budget_report/properties/estimated_cost" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/estimated_cost" eq: "$ref": "#/components/schemas/resource_budget_report/properties/estimated_cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the estimated cost (based on estimated time and rates). budget_remaining: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/budget_remaining" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/budget_remaining" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/budget_remaining" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/budget_remaining" eq: "$ref": "#/components/schemas/resource_budget_report/properties/budget_remaining" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the remaining budget amount (budget total minus budget used). contact_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/contact_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/contact_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/contact_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/contact_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/contact_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the contact person associated with the budget. actual_rate: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/actual_rate" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/actual_rate" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/actual_rate" contains: "$ref": "#/components/schemas/resource_budget_report/properties/actual_rate" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/actual_rate" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by actual billing rate range (revenue per hour worked). project_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/project_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/project_id" description: Filter by the associated project. designated_approver_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/designated_approver_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/designated_approver_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/designated_approver_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/designated_approver_id" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_budget_report/properties/designated_approver_id" description: Filter by the designated approver person ID set on the budget (`designated_approver_id`). full_query: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/full_query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/full_query" eq: "$ref": "#/components/schemas/resource_budget_report/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/full_query" contains: "$ref": "#/components/schemas/resource_budget_report/properties/full_query" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Full search query string applied to budget names and metadata. worked_time: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/worked_time" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/worked_time" contains: "$ref": "#/components/schemas/resource_budget_report/properties/worked_time" eq: "$ref": "#/components/schemas/resource_budget_report/properties/worked_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/worked_time" description: Filter by total time logged on this budget, in minutes. probability: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/probability" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/probability" eq: "$ref": "#/components/schemas/resource_budget_report/properties/probability" contains: "$ref": "#/components/schemas/resource_budget_report/properties/probability" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/probability" description: Filter by deal win probability percentage range. lost_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/lost_at" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/lost_at" eq: "$ref": "#/components/schemas/resource_budget_report/properties/lost_at" contains: "$ref": "#/components/schemas/resource_budget_report/properties/lost_at" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/lost_at" description: Filter by the date the deal was marked as lost (lost_at). previous_or_current_deal_status_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/previous_or_current_deal_status_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/previous_or_current_deal_status_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/previous_or_current_deal_status_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/previous_or_current_deal_status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/previous_or_current_deal_status_id" description: Filter by deals that are currently or were previously in the specified deal status. forecasted_profit: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_profit" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_profit" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_profit" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_profit" contains: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_profit" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by forecasted profit (forecasted revenue minus forecasted cost). todo_due_date: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/todo_due_date" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/todo_due_date" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/todo_due_date" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/todo_due_date" eq: "$ref": "#/components/schemas/resource_budget_report/properties/todo_due_date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by todo due date range on the budget. company_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/company_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/company_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/company_id" description: Filter by the client company associated with the budget. next_occurrence_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/next_occurrence_on" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/next_occurrence_on" contains: "$ref": "#/components/schemas/resource_budget_report/properties/next_occurrence_on" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/next_occurrence_on" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/next_occurrence_on" description: Filter by the next recurring occurrence date (next_occurrence_on). discount: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/discount" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/discount" eq: "$ref": "#/components/schemas/resource_budget_report/properties/discount" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/discount" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/discount" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by discount percentage range. expense: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/expense" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/expense" eq: "$ref": "#/components/schemas/resource_budget_report/properties/expense" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/expense" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/expense" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total non-labor expense amount on this budget. manual_invoicing_status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/manual_invoicing_status" contains: "$ref": "#/components/schemas/resource_budget_report/properties/manual_invoicing_status" eq: "$ref": "#/components/schemas/resource_budget_report/properties/manual_invoicing_status" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/manual_invoicing_status" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/manual_invoicing_status" description: Filter by manual invoicing status (e.g. not_started, in_progress, completed). custom_fields: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_budget_report/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_budget_report/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/custom_fields" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/custom_fields" description: Filter by custom field values. needs_invoicing: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/needs_invoicing" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/needs_invoicing" eq: "$ref": "#/components/schemas/resource_budget_report/properties/needs_invoicing" contains: "$ref": "#/components/schemas/resource_budget_report/properties/needs_invoicing" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/needs_invoicing" description: Filter to budgets that have uninvoiced billable work ready to invoice. budget_total: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/budget_total" contains: "$ref": "#/components/schemas/resource_budget_report/properties/budget_total" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/budget_total" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/budget_total" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/budget_total" description: Filter by total budget amount range. accessible_by_person: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/accessible_by_person" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/accessible_by_person" contains: "$ref": "#/components/schemas/resource_budget_report/properties/accessible_by_person" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/accessible_by_person" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/accessible_by_person" description: Filter to budgets accessible by the specified person. id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by budget ID. future_revenue: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/future_revenue" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/future_revenue" eq: "$ref": "#/components/schemas/resource_budget_report/properties/future_revenue" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/future_revenue" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/future_revenue" description: Filter by future revenue amount range. forecasted_billable_time: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_billable_time" contains: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_billable_time" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_billable_time" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_billable_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_billable_time" description: Filter by the forecasted billable time (worked + future booked billable time), in minutes. revenue_distribution_type: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/revenue_distribution_type" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/revenue_distribution_type" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/revenue_distribution_type" contains: "$ref": "#/components/schemas/resource_budget_report/properties/revenue_distribution_type" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/revenue_distribution_type" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by revenue distribution type (e.g. time_and_materials, fixed_price, as_invoiced). time_approval: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/time_approval" eq: "$ref": "#/components/schemas/resource_budget_report/properties/time_approval" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/time_approval" contains: "$ref": "#/components/schemas/resource_budget_report/properties/time_approval" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/time_approval" description: Filter by time approval setting (whether time entries require approval on this budget). lost_date: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/lost_date" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/lost_date" contains: "$ref": "#/components/schemas/resource_budget_report/properties/lost_date" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/lost_date" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/lost_date" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the sales closed date when the deal status was set to lost. name: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/name" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/name" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/name" eq: "$ref": "#/components/schemas/resource_budget_report/properties/name" contains: "$ref": "#/components/schemas/resource_budget_report/properties/name" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by budget name. status_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/status_id" contains: "$ref": "#/components/schemas/resource_budget_report/properties/status_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/status_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/status_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/status_id" description: Filter by the current deal status (pipeline stage). forecasted_margin: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_margin" contains: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_margin" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_margin" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_margin" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/forecasted_margin" description: Filter by forecasted profit margin percentage range. tags: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/tags" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/tags" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/tags" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/tags" eq: "$ref": "#/components/schemas/resource_budget_report/properties/tags" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by tag. subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/subsidiary_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_budget_report/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/subsidiary_id" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by the subsidiary (legal entity) associated with this budget. days_since_last_activity: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/days_since_last_activity" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/days_since_last_activity" eq: "$ref": "#/components/schemas/resource_budget_report/properties/days_since_last_activity" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/days_since_last_activity" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_budget_report/properties/days_since_last_activity" description: Filter by the number of days since the last activity was recorded on the budget (`last_activity_at`). work_cost: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/work_cost" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/work_cost" eq: "$ref": "#/components/schemas/resource_budget_report/properties/work_cost" contains: "$ref": "#/components/schemas/resource_budget_report/properties/work_cost" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. - "$ref": "#/components/schemas/resource_budget_report/properties/work_cost" description: Filter by work cost amount range. template: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/template" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_budget_report/properties/template" eq: "$ref": "#/components/schemas/resource_budget_report/properties/template" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/template" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/template" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter to template budgets only. last_activity_at: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/last_activity_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/last_activity_at" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/last_activity_at" eq: "$ref": "#/components/schemas/resource_budget_report/properties/last_activity_at" contains: "$ref": "#/components/schemas/resource_budget_report/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by last activity date range (last_activity_at). billable_time: oneOf: - "$ref": "#/components/schemas/resource_budget_report/properties/billable_time" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_budget_report/properties/billable_time" not_contain: "$ref": "#/components/schemas/resource_budget_report/properties/billable_time" contains: "$ref": "#/components/schemas/resource_budget_report/properties/billable_time" not_eq: "$ref": "#/components/schemas/resource_budget_report/properties/billable_time" description: Operator object — supports `eq`, `not_eq`, `contains`, `not_contain`. description: Filter by total billable time logged on this budget, in minutes. patternProperties: "^company..*$": title: Company relationship "^contact..*$": title: Contact relationship "^creator..*$": title: Creator relationship "^project..*$": title: Project relationship "^contract..*$": title: Contract relationship "^services..*$": title: Services relationship "^deal_status..*$": title: Deal status relationship "^lost_reason..*$": title: Lost reason relationship "^origin_deal..*$": title: Origin deal relationship "^responsible..*$": title: Responsible relationship "^document_type..*$": title: Document type relationship "^designated_approver..*$": title: Designated approver relationship "^previous_deal_status..*$": title: Previous deal status relationship description: Available filter parameters for querying aggregated budget report data. _filter_root_page_version: oneOf: - "$ref": "#/components/schemas/filter_page_version" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_page_version" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `page_version` list endpoints — pass a single condition or a logical group. resource_payment_report: type: object title: Payment report Resource properties: paid_on: type: string title: Paid On format: date description: Paid on for this payment report group. invoice_id: type: integer title: Invoice description: Invoice id for this payment report group. payment: title: Payment description: Payment for this payment report group. formula_fields: title: Formula Fields description: Formula fields for this payment report group. paid_after: type: string title: Paid After format: date description: Paid after for this payment report group. total_amount_normalized: title: Total Amount Normalized description: Sum of amount in the normalized currency across all records in this payment report group. total_amount: title: Total Amount description: Sum of amount across all records in this payment report group. date: title: Date description: Date for this payment report group. quarter: type: string title: Quarter description: Quarter grouping for this payment report row. month: type: string title: Month description: Month grouping for this payment report row. year: type: string title: Year description: Year grouping for this payment report row. payment_written_off_on: title: Payment Written Off On description: Payment written off on for this payment report group. currency_normalized: title: Currency Normalized description: Currency in the normalized currency for this payment report group. budget_id: type: integer title: Budget description: Budget id for this payment report group. subsidiary: title: Subsidiary description: Subsidiary for this payment report group. paid_before: type: string title: Paid Before format: date description: Paid before for this payment report group. invoice: title: Invoice description: Invoice for this payment report group. external_id: type: string title: External description: External id for this payment report group. invoice_report: title: Invoice Report description: Invoice report for this payment report group. payment_paid_on: title: Payment Paid On description: Payment paid on for this payment report group. payment_date: title: Payment Date description: Payment date for this payment report group. company_id: type: integer title: Company description: Company id for this payment report group. total_amount_default: title: Total Amount Default description: Sum of amount in the organization's default currency across all records in this payment report group. amount: title: Amount description: Amount for this payment report group. subsidiary_id: type: integer title: Subsidiary description: Subsidiary id for this payment report group. organization: title: Organization description: Organization for this payment report group. written_off_on: type: string title: Written Off On format: date description: Written off on for this payment report group. payment_external_id: title: Payment External description: Payment external id for this payment report group. date_period: title: Date Period description: Time period grouping for date (e.g. week, month, quarter). company_report: title: Company Report description: Company report for this payment report group. report: title: Report description: Report for this payment report group. payment_note: title: Payment Note description: Payment note for this payment report group. formulas: type: integer title: Formulas description: Formulas for this payment report group. week: type: string title: Week description: Week grouping for this payment report row. project_id: type: integer title: Project description: Project id for this payment report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this payment report group. count: type: integer title: Count description: Number of payments in this report group. deal: title: Deal description: Deal for this payment report group. company: title: Company description: Company for this payment report group. group: type: string title: Group description: The grouping dimension for this payment report row. project: title: Project description: Project for this payment report group. query: type: string title: Query description: Query for this payment report group. id: type: integer title: Id description: Unique identifier for this payment report row. number: type: string title: Number description: Number for this payment report group. currency: type: string title: Currency description: Currency for this payment report group. description: An aggregated payment report row grouping invoices and payments by configurable dimensions with payment amount metrics. resource_survey_response: type: object title: Survey response Resource properties: custom_fields: type: string title: Custom Fields description: The custom field values submitted as part of this response. creator: title: Creator description: The person who submitted this survey response. custom_field_attachments: title: Custom Field Attachments description: File attachments associated with custom field values in this response. updated_at: type: string title: Updated At format: date-time description: Timestamp when this survey response was last updated. survey_fields: title: Survey Fields description: The survey field responses included in this submission. survey: title: Survey description: The survey this response was submitted for. survey_id: type: integer title: Survey description: ID of the survey this response was submitted for. organization: title: Organization description: The organization this survey response belongs to. created_at: type: string title: Created At format: date-time description: Timestamp when this survey response was created. creator_id: type: integer title: Creator description: ID of the person who submitted this survey response. id: type: integer title: Id description: The unique identifier of this survey response. description: Submitted form response for a survey. Contains field values keyed by survey_field_id. Triggers any automations configured on the parent survey. resource_booking: type: object title: Booking Resource properties: company_id: type: integer title: Company description: ID of the client company associated with this booking. canceled: type: boolean title: Canceled description: Whether this booking has been canceled. use_salary_currency: type: boolean title: Use Salary Currency description: When true, cost calculations use the person's salary currency instead of the service currency. approved: title: Approved description: Indicates whether the booking has been approved. note: type: string title: Note description: An optional note or description for this booking. last_activity_at: type: string title: Last Activity At format: date-time description: Timestamp of the last activity recorded on this booking. approved_at: type: string title: Approved At format: date-time description: Timestamp when the booking was approved, or null if not yet approved. project_type: enum: - 1 - 2 type: integer title: Project Type description: Type of the associated project (e.g. billable or internal). tags: type: integer title: Tags description: Tags associated with this booking. attachments: title: Attachments description: Files attached to this booking. task_id: type: integer title: Task description: The ID of the task associated with this booking, if applicable. status: title: Status description: The current approval status of the booking (e.g. pending, approved, rejected). ended_on: type: string title: Ended On format: date description: Booking end date. id: type: integer title: Id description: Unique identifier of the booking. service: title: Service description: The budget service being scheduled in this booking. booking_type: type: string title: Booking Type description: Whether this is a project booking or an absence booking. rejected_at: type: string title: Rejected At format: date-time description: Date when the booking was rejected. resource_request: title: Resource Request description: The resource request this booking fulfills, if applicable. updater: title: Updater description: The person who last updated this booking. task: title: Task description: The task associated with this booking, if applicable. rejected_reason: type: string title: Rejected Reason description: Reason provided when the booking was rejected. draft: type: boolean title: Draft description: Whether the booking is tentative (draft) or confirmed. autotracking: type: boolean title: Autotracking description: When true, time entries are automatically tracked against this booking. person: title: Person description: The person assigned to this booking. total_working_days: type: integer title: Total Working Days description: The total number of working days covered by this booking. people_custom_fields: type: string title: People Custom Fields description: Custom field values defined on the assigned person. person_id: type: integer title: Person description: ID of the person assigned to this booking. rejected: title: Rejected description: Whether this booking has been rejected. person_type: enum: - 1 - 2 - 3 - 4 type: integer title: Person Type description: Type of the assigned person (e.g. employee, contractor, placeholder). custom_field_people: title: Custom Field People description: People linked via custom fields on this booking. billing_type_id: enum: - 1 - 2 - 3 - 4 type: integer title: Billing Type description: ID of the billing type of the associated service. created_at: type: string title: Created At format: date-time description: Date when the booking was created. resource_request_id: type: integer title: Resource Request description: ID of the resource request this booking fulfills. budget_id: type: integer title: Budget description: ID of the budget (deal) associated with the booking's service. approval_statuses: title: Approval Statuses description: Per-approver approval status records for this booking. project_id: type: integer title: Project description: ID of the project this booking relates to. approver: title: Approver description: The person who approved this booking. event: title: Event description: The absence event category (e.g. vacation, sick leave) for absence bookings. person_subsidiary_id: type: integer title: Person Subsidiary description: ID of the subsidiary the assigned person belongs to. after: type: string title: After format: date description: Internal field used for date-range filtering. event_id: type: integer title: Event description: ID of the absence event category for this booking. custom_field_attachments: title: Custom Field Attachments description: File attachments linked via custom fields on this booking. hours: type: integer title: Hours description: Scheduled hours per day for this booking. started_on: type: string title: Started On format: date description: The start date of the booking. custom_fields: type: object title: Custom Fields description: Custom field values for this booking. scenario_item: title: Scenario Item description: The scenario item this booking is linked to, if created from a scenario. updated_at: type: string title: Updated At format: date-time description: Timestamp when this booking was last updated. booking_method_id: enum: - 1 - 2 - 3 type: integer title: Booking Method description: ID of the booking method used to create this booking (e.g. hours per day, percentage, total hours). canceled_at: type: string title: Canceled At format: date-time description: Date when the booking was canceled. origin: title: Origin description: The booking origin (e.g. the resource request that generated this booking). external_id: type: string title: External description: External identifier for integration with third-party systems. stage_type: enum: - 1 - 2 type: integer title: Stage Type description: The stage type of the booking within the resource planning workflow. before: type: string title: Before format: date description: Internal field used for date-range filtering. canceler: title: Canceler description: The person who canceled this booking. approval_status: enum: - 1 - 2 - 3 - 5 type: integer title: Approval Status description: Whether the booking has been approved. Reflects the overall approval_status. attachment_ids: title: Attachment Ids description: Array of IDs of files attached to this booking. rejecter: title: Rejecter description: The person who rejected this booking. time: type: integer title: Time description: The booked time in minutes per day. organization: title: Organization description: The organization this booking belongs to. percentage: type: integer title: Percentage description: Scheduled time as a percentage of the person's daily capacity. total_time: type: integer title: Total Time description: The total booked time in minutes across the entire booking period. service_id: type: integer title: Service description: The ID of the service this booking is scheduled against. with_draft: type: boolean title: With Draft description: When true, draft bookings are included in availability and planning views. creator: title: Creator description: The person who created this booking. approver_id: type: integer title: Approver description: The ID of the person who approved this booking. origin_id: type: integer title: Origin description: The ID of the origin record (e.g. resource request) that created this booking. description: A booking represents planned work or an absence scheduled for a person, linked to a service or absence category. filter_holiday_calendar: type: object title: Filter holiday calendar properties: id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_holiday_calendar/properties/id" not_eq: "$ref": "#/components/schemas/resource_holiday_calendar/properties/id" eq: "$ref": "#/components/schemas/resource_holiday_calendar/properties/id" not_contain: "$ref": "#/components/schemas/resource_holiday_calendar/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_holiday_calendar/properties/id" description: Filter by ID. patternProperties: {} description: Filter parameters for holiday calendars. _filter_root_custom_field_section: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_custom_field_section" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_custom_field_section" description: Filter schema for `custom_field_section` list endpoints — pass a single condition or a logical group. _filter_root_tag: oneOf: - "$ref": "#/components/schemas/filter_tag" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_tag" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `tag` list endpoints — pass a single condition or a logical group. filter_deal_status: type: object title: Filter deal status properties: status_id: oneOf: - "$ref": "#/components/schemas/resource_deal_status/properties/status_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_status/properties/status_id" contains: "$ref": "#/components/schemas/resource_deal_status/properties/status_id" not_eq: "$ref": "#/components/schemas/resource_deal_status/properties/status_id" eq: "$ref": "#/components/schemas/resource_deal_status/properties/status_id" description: Filter using explicit operator syntax. description: Filter by pipeline stage outcome (open, won, lost, delivered). time_tracking_enabled: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_status/properties/time_tracking_enabled" contains: "$ref": "#/components/schemas/resource_deal_status/properties/time_tracking_enabled" eq: "$ref": "#/components/schemas/resource_deal_status/properties/time_tracking_enabled" not_contain: "$ref": "#/components/schemas/resource_deal_status/properties/time_tracking_enabled" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_deal_status/properties/time_tracking_enabled" description: Filter to stages with time tracking enabled or disabled. probability_enabled: oneOf: - "$ref": "#/components/schemas/resource_deal_status/properties/probability_enabled" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_status/properties/probability_enabled" not_eq: "$ref": "#/components/schemas/resource_deal_status/properties/probability_enabled" contains: "$ref": "#/components/schemas/resource_deal_status/properties/probability_enabled" eq: "$ref": "#/components/schemas/resource_deal_status/properties/probability_enabled" description: Filter using explicit operator syntax. description: Filter to stages with probability tracking enabled or disabled. booking_tracking_enabled: oneOf: - "$ref": "#/components/schemas/resource_deal_status/properties/booking_tracking_enabled" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_status/properties/booking_tracking_enabled" not_contain: "$ref": "#/components/schemas/resource_deal_status/properties/booking_tracking_enabled" contains: "$ref": "#/components/schemas/resource_deal_status/properties/booking_tracking_enabled" eq: "$ref": "#/components/schemas/resource_deal_status/properties/booking_tracking_enabled" description: Filter using explicit operator syntax. description: Filter to stages with booking tracking enabled or disabled. pipeline_type_id: oneOf: - "$ref": "#/components/schemas/resource_deal_status/properties/pipeline_type_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_status/properties/pipeline_type_id" contains: "$ref": "#/components/schemas/resource_deal_status/properties/pipeline_type_id" not_eq: "$ref": "#/components/schemas/resource_deal_status/properties/pipeline_type_id" not_contain: "$ref": "#/components/schemas/resource_deal_status/properties/pipeline_type_id" description: Filter using explicit operator syntax. description: Filter by pipeline type (sales or production). query: oneOf: - "$ref": "#/components/schemas/resource_deal_status/properties/query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_status/properties/query" eq: "$ref": "#/components/schemas/resource_deal_status/properties/query" not_contain: "$ref": "#/components/schemas/resource_deal_status/properties/query" contains: "$ref": "#/components/schemas/resource_deal_status/properties/query" description: Filter using explicit operator syntax. description: Filter by deal status name (text search). lost_reason_enabled: oneOf: - "$ref": "#/components/schemas/resource_deal_status/properties/lost_reason_enabled" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_status/properties/lost_reason_enabled" not_contain: "$ref": "#/components/schemas/resource_deal_status/properties/lost_reason_enabled" not_eq: "$ref": "#/components/schemas/resource_deal_status/properties/lost_reason_enabled" contains: "$ref": "#/components/schemas/resource_deal_status/properties/lost_reason_enabled" description: Filter using explicit operator syntax. description: Filter to stages where lost reason entry is enabled or disabled. id: oneOf: - "$ref": "#/components/schemas/resource_deal_status/properties/id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_status/properties/id" not_contain: "$ref": "#/components/schemas/resource_deal_status/properties/id" contains: "$ref": "#/components/schemas/resource_deal_status/properties/id" not_eq: "$ref": "#/components/schemas/resource_deal_status/properties/id" description: Filter using explicit operator syntax. description: Filter by deal status ID. pipeline_id: oneOf: - "$ref": "#/components/schemas/resource_deal_status/properties/pipeline_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_status/properties/pipeline_id" contains: "$ref": "#/components/schemas/resource_deal_status/properties/pipeline_id" not_contain: "$ref": "#/components/schemas/resource_deal_status/properties/pipeline_id" not_eq: "$ref": "#/components/schemas/resource_deal_status/properties/pipeline_id" description: Filter using explicit operator syntax. description: Filter by associated pipeline. expense_tracking_enabled: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_status/properties/expense_tracking_enabled" not_contain: "$ref": "#/components/schemas/resource_deal_status/properties/expense_tracking_enabled" contains: "$ref": "#/components/schemas/resource_deal_status/properties/expense_tracking_enabled" not_eq: "$ref": "#/components/schemas/resource_deal_status/properties/expense_tracking_enabled" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_deal_status/properties/expense_tracking_enabled" description: Filter to stages with expense tracking enabled or disabled. patternProperties: {} description: Filter parameters for listing deal statuses. Supports filtering by pipeline and status category. Standard ID operators apply. resource_approval_workflow: type: object title: Approval workflow Resource properties: dynamic_approver_ids: type: string title: Dynamic Approver Ids description: Array of IDs of roles or rule-based approvers dynamically resolved at approval time. approval_policy_id: type: integer title: Approval Policy description: The ID of the approval policy this workflow belongs to. dynamic_subscriber_ids: type: string title: Dynamic Subscriber Ids description: Array of IDs of roles or rule-based subscribers dynamically resolved at approval time. approver_ids: title: Approver Ids description: Array of IDs of people explicitly assigned as approvers in this workflow. id: type: integer title: Id description: Unique identifier for the approval workflow. approval_policy: title: Approval Policy description: The approval policy this workflow belongs to. event: title: Event description: The absence category (event) this workflow applies to, if the target type is absence. event_id: type: integer title: Event description: The ID of the absence category (event) this workflow applies to, if applicable. approval_requirement_id: enum: - 1 - 2 - 3 type: integer title: Approval Requirement description: Internal identifier for the approval requirement configuration. subscriber_ids: title: Subscriber Ids description: Array of IDs of people subscribed to receive notifications about approval decisions. target_type_id: enum: - 1 - 2 - 3 type: integer title: Target Type description: Numeric identifier for the approval target type (e.g. time entries, expenses, absences). approvers: title: Approvers description: The people assigned as approvers in this workflow. subscribers: title: Subscribers description: The people subscribed to receive notifications about approval decisions. organization: title: Organization description: The organization this approval workflow belongs to. description: An approval workflow defines the approvers and subscribers for a specific approval target type within an approval policy. _filter_root_survey_field: oneOf: - "$ref": "#/components/schemas/filter_survey_field" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_survey_field" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `survey_field` list endpoints — pass a single condition or a logical group. filter_automatic_invoicing_rule: type: object title: Filter automatic invoicing rule properties: creator_id: oneOf: - "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/creator_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/creator_id" eq: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/creator_id" description: Filter using explicit operator syntax. description: Filter by the person who created the rule. id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/id" not_contain: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/id" eq: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/id" not_eq: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/id" description: Filter by automatic invoicing rule ID. budget_id: oneOf: - "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/budget_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/budget_id" not_eq: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/budget_id" contains: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/budget_id" description: Filter using explicit operator syntax. description: Filter by the associated budget (deal). patternProperties: {} description: Filter parameters for automatic invoicing rules. filter_deal_report: type: object title: Filter deal report properties: won_date: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/won_date" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/won_date" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/won_date" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/won_date" contains: "$ref": "#/components/schemas/resource_deal_report/properties/won_date" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the date the deal was won (based on sales closed date with won status). parent_company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/parent_company_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/parent_company_id" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_deal_report/properties/parent_company_id" description: Filter by parent company ID, returning deals linked to companies that are children of the specified parent. expense: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/expense" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/expense" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/expense" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/expense" eq: "$ref": "#/components/schemas/resource_deal_report/properties/expense" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total expenses amount on the deal. forecasted_budget_used: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_budget_used" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_budget_used" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_budget_used" eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_budget_used" contains: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_budget_used" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by forecasted budget used amount. days_since_last_activity: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/days_since_last_activity" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/days_since_last_activity" eq: "$ref": "#/components/schemas/resource_deal_report/properties/days_since_last_activity" contains: "$ref": "#/components/schemas/resource_deal_report/properties/days_since_last_activity" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/days_since_last_activity" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the number of days since the last activity was recorded on the deal (`last_activity_at`). budget_total: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/budget_total" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/budget_total" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/budget_total" contains: "$ref": "#/components/schemas/resource_deal_report/properties/budget_total" eq: "$ref": "#/components/schemas/resource_deal_report/properties/budget_total" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total deal budget amount. company_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/company_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/company_id" description: Filter by client company. project_id: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/project_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/project_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by associated project. pipeline_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/pipeline_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/pipeline_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/pipeline_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/pipeline_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/pipeline_id" description: Filter by pipeline. subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/subsidiary_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/subsidiary_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by subsidiary organization. future_budget_used: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/future_budget_used" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/future_budget_used" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/future_budget_used" contains: "$ref": "#/components/schemas/resource_deal_report/properties/future_budget_used" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/future_budget_used" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by future budget used amount (cost of upcoming scheduled work). profit: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/profit" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/profit" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/profit" eq: "$ref": "#/components/schemas/resource_deal_report/properties/profit" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/profit" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by deal profit amount (revenue minus cost). status_id: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/status_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/status_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/status_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/status_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/status_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by pipeline stage. status: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/status" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/status" eq: "$ref": "#/components/schemas/resource_deal_report/properties/status" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/status" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/status" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the deal status (open, won, lost, delivered). retainer_interval: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/retainer_interval" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/retainer_interval" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/retainer_interval" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/retainer_interval" contains: "$ref": "#/components/schemas/resource_deal_report/properties/retainer_interval" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the deal retainer billing interval (week, two_weeks, month, quarter, half_year, or year). worked_time: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/worked_time" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/worked_time" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/worked_time" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/worked_time" contains: "$ref": "#/components/schemas/resource_deal_report/properties/worked_time" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total time worked on the deal. invoiced_rate: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/invoiced_rate" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/invoiced_rate" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/invoiced_rate" contains: "$ref": "#/components/schemas/resource_deal_report/properties/invoiced_rate" eq: "$ref": "#/components/schemas/resource_deal_report/properties/invoiced_rate" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the invoiced rate (invoiced amount divided by tracked time). id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/id" description: Filter by deal ID. recurring_ends_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/recurring_ends_on" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/recurring_ends_on" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/recurring_ends_on" contains: "$ref": "#/components/schemas/resource_deal_report/properties/recurring_ends_on" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/recurring_ends_on" description: Filter by the end date of the recurring contract. sales_status_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/sales_status_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/sales_status_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/sales_status_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/sales_status_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/sales_status_id" description: Filter by the sales status of the deal — open, won, or lost. next_occurrence_on: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/next_occurrence_on" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/next_occurrence_on" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/next_occurrence_on" eq: "$ref": "#/components/schemas/resource_deal_report/properties/next_occurrence_on" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/next_occurrence_on" description: Filter by the next recurrence date on the associated contract. fuzzy_dates: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_deal_report/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_deal_report/properties/fuzzy_dates" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/fuzzy_dates" description: Filter using fuzzy date matching for deal dates. project_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/project_type" contains: "$ref": "#/components/schemas/resource_deal_report/properties/project_type" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/project_type" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/project_type" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/project_type" description: Filter by project type. origin_deal_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/origin_deal_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/origin_deal_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/origin_deal_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/origin_deal_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/origin_deal_id" description: Filter by the ID of the deal this was originated from (e.g. via rollover). contact_id: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/contact_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/contact_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/contact_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/contact_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/contact_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by associated contact person. recurring_interval_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/recurring_interval_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/recurring_interval_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/recurring_interval_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/recurring_interval_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/recurring_interval_id" description: Filter by the billing interval of the recurring contract. forecasted_profit: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_profit" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_profit" contains: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_profit" eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_profit" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_profit" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by forecasted profit amount. needs_invoicing: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/needs_invoicing" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/needs_invoicing" contains: "$ref": "#/components/schemas/resource_deal_report/properties/needs_invoicing" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/needs_invoicing" eq: "$ref": "#/components/schemas/resource_deal_report/properties/needs_invoicing" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the deal (budget) needs invoicing (closed with pending invoicing). projected_revenue: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/projected_revenue" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/projected_revenue" eq: "$ref": "#/components/schemas/resource_deal_report/properties/projected_revenue" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/projected_revenue" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/projected_revenue" description: Filter by projected revenue amount. credited: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/credited" eq: "$ref": "#/components/schemas/resource_deal_report/properties/credited" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/credited" contains: "$ref": "#/components/schemas/resource_deal_report/properties/credited" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/credited" description: Filter by the credited amount on the deal. last_activity_at: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/last_activity_at" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/last_activity_at" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/last_activity_at" eq: "$ref": "#/components/schemas/resource_deal_report/properties/last_activity_at" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the date of the last activity on the deal. previous_or_current_deal_status_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/previous_or_current_deal_status_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/previous_or_current_deal_status_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/previous_or_current_deal_status_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/previous_or_current_deal_status_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/previous_or_current_deal_status_id" description: Filter by deals that are currently or were previously in the given pipeline stage. recurring: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/recurring" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/recurring" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/recurring" contains: "$ref": "#/components/schemas/resource_deal_report/properties/recurring" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/recurring" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the deal is recurring (has an associated contract). pending_invoicing: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/pending_invoicing" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/pending_invoicing" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/pending_invoicing" eq: "$ref": "#/components/schemas/resource_deal_report/properties/pending_invoicing" contains: "$ref": "#/components/schemas/resource_deal_report/properties/pending_invoicing" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by pending invoicing amount (invoiced to date minus total invoiced). estimated_time: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/estimated_time" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/estimated_time" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/estimated_time" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/estimated_time" contains: "$ref": "#/components/schemas/resource_deal_report/properties/estimated_time" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total estimated time on the deal. unapproved_time: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/unapproved_time" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/unapproved_time" contains: "$ref": "#/components/schemas/resource_deal_report/properties/unapproved_time" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/unapproved_time" eq: "$ref": "#/components/schemas/resource_deal_report/properties/unapproved_time" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total unapproved time on the deal. revenue_distribution_type: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/revenue_distribution_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/revenue_distribution_type" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/revenue_distribution_type" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/revenue_distribution_type" eq: "$ref": "#/components/schemas/resource_deal_report/properties/revenue_distribution_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by revenue distribution type. accessible_by_person: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/accessible_by_person" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/accessible_by_person" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/accessible_by_person" eq: "$ref": "#/components/schemas/resource_deal_report/properties/accessible_by_person" contains: "$ref": "#/components/schemas/resource_deal_report/properties/accessible_by_person" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter deals accessible by the given person. future_revenue: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/future_revenue" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/future_revenue" contains: "$ref": "#/components/schemas/resource_deal_report/properties/future_revenue" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/future_revenue" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/future_revenue" description: Filter by future revenue amount (revenue from upcoming scheduled work). lost_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/lost_at" contains: "$ref": "#/components/schemas/resource_deal_report/properties/lost_at" eq: "$ref": "#/components/schemas/resource_deal_report/properties/lost_at" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/lost_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/lost_at" description: Filter by the datetime the deal was marked as lost. budgeted_time: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/budgeted_time" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/budgeted_time" contains: "$ref": "#/components/schemas/resource_deal_report/properties/budgeted_time" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/budgeted_time" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/budgeted_time" description: Filter by total budgeted time on the deal. end_date: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/end_date" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/end_date" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/end_date" eq: "$ref": "#/components/schemas/resource_deal_report/properties/end_date" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/end_date" description: Filter by deal end date. creator_id: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/creator_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/creator_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/creator_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the person who created the deal. type: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/type" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/type" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/type" eq: "$ref": "#/components/schemas/resource_deal_report/properties/type" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/type" description: Filter by deal type (deal or budget). profit_margin: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/profit_margin" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/profit_margin" eq: "$ref": "#/components/schemas/resource_deal_report/properties/profit_margin" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/profit_margin" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/profit_margin" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by profit margin percentage. invoiced: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/invoiced" contains: "$ref": "#/components/schemas/resource_deal_report/properties/invoiced" eq: "$ref": "#/components/schemas/resource_deal_report/properties/invoiced" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/invoiced" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/invoiced" description: Filter by total invoiced amount on the deal. budget_warning: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/budget_warning" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/budget_warning" contains: "$ref": "#/components/schemas/resource_deal_report/properties/budget_warning" eq: "$ref": "#/components/schemas/resource_deal_report/properties/budget_warning" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/budget_warning" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by budget warning threshold percentage. stage_updated_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/stage_updated_at" contains: "$ref": "#/components/schemas/resource_deal_report/properties/stage_updated_at" eq: "$ref": "#/components/schemas/resource_deal_report/properties/stage_updated_at" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/stage_updated_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/stage_updated_at" description: Filter by the date the deal's pipeline stage was last updated. date: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/date" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/date" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/date" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/date" eq: "$ref": "#/components/schemas/resource_deal_report/properties/date" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the deal date. fuzzy_people: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/fuzzy_people" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_deal_report/properties/fuzzy_people" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/fuzzy_people" description: Filter using fuzzy matching for people associated with deals. currency: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/currency" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/currency" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/currency" eq: "$ref": "#/components/schemas/resource_deal_report/properties/currency" contains: "$ref": "#/components/schemas/resource_deal_report/properties/currency" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the currency of deal financial values. previous_deal_status_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/previous_deal_status_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/previous_deal_status_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/previous_deal_status_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/previous_deal_status_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/previous_deal_status_id" description: Filter by the previous deal status ID (pipeline stage before the current one). cost: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/cost" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/cost" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/cost" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/cost" contains: "$ref": "#/components/schemas/resource_deal_report/properties/cost" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by total deal cost amount (work cost plus expenses). retainer: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/retainer" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/retainer" contains: "$ref": "#/components/schemas/resource_deal_report/properties/retainer" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/retainer" eq: "$ref": "#/components/schemas/resource_deal_report/properties/retainer" description: Object form with operator key (eq, not_eq). description: Filter by whether the deal is a retainer (has a recurring billing interval count greater than 1). future_cost: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/future_cost" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/future_cost" contains: "$ref": "#/components/schemas/resource_deal_report/properties/future_cost" eq: "$ref": "#/components/schemas/resource_deal_report/properties/future_cost" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/future_cost" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by future cost amount (cost of upcoming scheduled work). approval_policy_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/approval_policy_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/approval_policy_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/approval_policy_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/approval_policy_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/approval_policy_id" description: Filter by approval policy. billable_time: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/billable_time" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/billable_time" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/billable_time" contains: "$ref": "#/components/schemas/resource_deal_report/properties/billable_time" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/billable_time" description: Filter by total billable time logged on the deal. days_in_current_stage: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/days_in_current_stage" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/days_in_current_stage" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/days_in_current_stage" eq: "$ref": "#/components/schemas/resource_deal_report/properties/days_in_current_stage" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_deal_report/properties/days_in_current_stage" description: Filter by the number of days the deal has been in its current pipeline stage. budget_remaining: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/budget_remaining" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/budget_remaining" contains: "$ref": "#/components/schemas/resource_deal_report/properties/budget_remaining" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/budget_remaining" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/budget_remaining" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the remaining budget amount (budget total minus budget used). sales_closed_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/sales_closed_on" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/sales_closed_on" contains: "$ref": "#/components/schemas/resource_deal_report/properties/sales_closed_on" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/sales_closed_on" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/sales_closed_on" description: Filter by the date the deal was closed for sales. estimated_remaining_time: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/estimated_remaining_time" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/estimated_remaining_time" contains: "$ref": "#/components/schemas/resource_deal_report/properties/estimated_remaining_time" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/estimated_remaining_time" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/estimated_remaining_time" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by estimated remaining time (estimated time minus worked time). previous_probability: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/previous_probability" contains: "$ref": "#/components/schemas/resource_deal_report/properties/previous_probability" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/previous_probability" eq: "$ref": "#/components/schemas/resource_deal_report/properties/previous_probability" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/previous_probability" description: Filter by the previous win probability percentage. tracking_type_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/tracking_type_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/tracking_type_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/tracking_type_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/tracking_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/tracking_type_id" description: Filter by time tracking type. invoiced_percentage: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/invoiced_percentage" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/invoiced_percentage" contains: "$ref": "#/components/schemas/resource_deal_report/properties/invoiced_percentage" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/invoiced_percentage" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/invoiced_percentage" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by invoiced percentage (invoiced amount as a percentage of revenue). time_approval: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/time_approval" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/time_approval" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/time_approval" eq: "$ref": "#/components/schemas/resource_deal_report/properties/time_approval" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/time_approval" description: Filter by whether time entry approval is required on the deal. forecasted_revenue: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_revenue" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_revenue" contains: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_revenue" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_revenue" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_revenue" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by forecasted revenue amount. forecasted_time_usage: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_time_usage" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_time_usage" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_time_usage" contains: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_time_usage" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_time_usage" description: Filter by forecasted time usage percentage (forecasted billable time as a percentage of budgeted time). subscriber_id: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/subscriber_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/subscriber_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/subscriber_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/subscriber_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/subscriber_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by subscriber (person subscribed to deal notifications). lost_reason_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/lost_reason_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/lost_reason_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/lost_reason_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/lost_reason_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/lost_reason_id" description: Filter by the reason the deal was lost. forecasted_cost: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_cost" eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_cost" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_cost" contains: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_cost" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_cost" description: Filter by forecasted cost amount. responsible_id: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/responsible_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/responsible_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/responsible_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the deal owner (responsible person). discount: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/discount" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/discount" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/discount" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/discount" eq: "$ref": "#/components/schemas/resource_deal_report/properties/discount" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by deal discount percentage. revenue: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/revenue" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/revenue" eq: "$ref": "#/components/schemas/resource_deal_report/properties/revenue" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/revenue" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/revenue" description: Filter by deal revenue amount range. services_revenue: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/services_revenue" contains: "$ref": "#/components/schemas/resource_deal_report/properties/services_revenue" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/services_revenue" eq: "$ref": "#/components/schemas/resource_deal_report/properties/services_revenue" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/services_revenue" description: Filter by services revenue amount. name: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/name" eq: "$ref": "#/components/schemas/resource_deal_report/properties/name" contains: "$ref": "#/components/schemas/resource_deal_report/properties/name" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/name" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/name" description: Filter by deal name. deal_type_id: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/deal_type_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/deal_type_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/deal_type_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/deal_type_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/deal_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by deal type. number: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/number" eq: "$ref": "#/components/schemas/resource_deal_report/properties/number" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/number" contains: "$ref": "#/components/schemas/resource_deal_report/properties/number" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/number" description: Filter by deal number. draft_invoiced: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/draft_invoiced" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/draft_invoiced" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/draft_invoiced" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/draft_invoiced" eq: "$ref": "#/components/schemas/resource_deal_report/properties/draft_invoiced" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the draft-invoiced amount on deals. estimated_cost: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/estimated_cost" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/estimated_cost" eq: "$ref": "#/components/schemas/resource_deal_report/properties/estimated_cost" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/estimated_cost" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/estimated_cost" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by estimated cost amount. delivered_on: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/delivered_on" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/delivered_on" contains: "$ref": "#/components/schemas/resource_deal_report/properties/delivered_on" eq: "$ref": "#/components/schemas/resource_deal_report/properties/delivered_on" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/delivered_on" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the date the deal was delivered. closed_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/closed_at" eq: "$ref": "#/components/schemas/resource_deal_report/properties/closed_at" contains: "$ref": "#/components/schemas/resource_deal_report/properties/closed_at" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/closed_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/closed_at" description: Filter by the date the deal (budget) was closed. full_query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/full_query" eq: "$ref": "#/components/schemas/resource_deal_report/properties/full_query" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/full_query" description: Full-text search across all deal fields. work_cost: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/work_cost" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/work_cost" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/work_cost" eq: "$ref": "#/components/schemas/resource_deal_report/properties/work_cost" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/work_cost" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by work cost amount (cost of labor, excluding expenses). expenses_billable: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/expenses_billable" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/expenses_billable" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/expenses_billable" eq: "$ref": "#/components/schemas/resource_deal_report/properties/expenses_billable" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/expenses_billable" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by billable expenses amount. budget_used: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/budget_used" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/budget_used" contains: "$ref": "#/components/schemas/resource_deal_report/properties/budget_used" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/budget_used" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/budget_used" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by budget amount used to date. created_at: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/created_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/created_at" eq: "$ref": "#/components/schemas/resource_deal_report/properties/created_at" contains: "$ref": "#/components/schemas/resource_deal_report/properties/created_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by deal creation date range. formulas: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/formulas" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/formulas" contains: "$ref": "#/components/schemas/resource_deal_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_deal_report/properties/formulas" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/formulas" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by custom formula field values. days_since_created: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/days_since_created" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/days_since_created" eq: "$ref": "#/components/schemas/resource_deal_report/properties/days_since_created" contains: "$ref": "#/components/schemas/resource_deal_report/properties/days_since_created" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/days_since_created" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the number of days elapsed since the deal was created (`created_at`). manual_invoicing_status: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/manual_invoicing_status" contains: "$ref": "#/components/schemas/resource_deal_report/properties/manual_invoicing_status" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/manual_invoicing_status" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/manual_invoicing_status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/manual_invoicing_status" description: Filter by manual invoicing status (true when manually invoiced). query: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/query" eq: "$ref": "#/components/schemas/resource_deal_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/query" contains: "$ref": "#/components/schemas/resource_deal_report/properties/query" description: Operator object — supports eq, not_eq, contains, not_contain. description: Full-text search query — matches deal name and other fields. deal_status_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/deal_status_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/deal_status_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/deal_status_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/deal_status_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/deal_status_id" description: Filter by the deal status ID (pipeline stage). budget_status: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/budget_status" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/budget_status" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/budget_status" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/budget_status" contains: "$ref": "#/components/schemas/resource_deal_report/properties/budget_status" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the budget status of deals (e.g. on track, over budget). contract_id: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/contract_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/contract_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/contract_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/contract_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/contract_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by associated contract. purchase_order_number: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/purchase_order_number" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/purchase_order_number" contains: "$ref": "#/components/schemas/resource_deal_report/properties/purchase_order_number" eq: "$ref": "#/components/schemas/resource_deal_report/properties/purchase_order_number" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/purchase_order_number" description: Operator object — supports eq, not_eq, contains, not_contain. example: eq: PO-2024-017 description: Filter by purchase order number. example: eq: PO-2024-017 sales_closed_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/sales_closed_at" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/sales_closed_at" eq: "$ref": "#/components/schemas/resource_deal_report/properties/sales_closed_at" contains: "$ref": "#/components/schemas/resource_deal_report/properties/sales_closed_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/sales_closed_at" description: Filter by the datetime the deal was closed for sales. todo_due_date: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/todo_due_date" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/todo_due_date" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/todo_due_date" contains: "$ref": "#/components/schemas/resource_deal_report/properties/todo_due_date" eq: "$ref": "#/components/schemas/resource_deal_report/properties/todo_due_date" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the to-do due date on deals. budget_usage: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/budget_usage" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/budget_usage" contains: "$ref": "#/components/schemas/resource_deal_report/properties/budget_usage" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/budget_usage" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/budget_usage" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by budget usage percentage (budget used as a percentage of budget total). forecasted_billable_time: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_billable_time" eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_billable_time" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_billable_time" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_billable_time" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_billable_time" description: Filter by forecasted billable time (billable time minus future booked time). manually_invoiced: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/manually_invoiced" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/manually_invoiced" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/manually_invoiced" eq: "$ref": "#/components/schemas/resource_deal_report/properties/manually_invoiced" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/manually_invoiced" description: Filter by total manually invoiced amount. lost_date: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/lost_date" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/lost_date" eq: "$ref": "#/components/schemas/resource_deal_report/properties/lost_date" contains: "$ref": "#/components/schemas/resource_deal_report/properties/lost_date" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/lost_date" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the date the deal was lost (based on sales closed date with lost status). probability: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/probability" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/probability" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/probability" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/probability" contains: "$ref": "#/components/schemas/resource_deal_report/properties/probability" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by win probability percentage. forecasted_margin: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_margin" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_margin" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_margin" contains: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_margin" eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_margin" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by forecasted profit margin percentage. custom_fields: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_deal_report/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_deal_report/properties/custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/custom_fields" description: Filter by custom field values. designated_approver_id: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/designated_approver_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/designated_approver_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/designated_approver_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/designated_approver_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/designated_approver_id" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the designated approver person ID set on the deal (`designated_approver_id`). needs_closing: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/needs_closing" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/needs_closing" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/needs_closing" contains: "$ref": "#/components/schemas/resource_deal_report/properties/needs_closing" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/needs_closing" description: Filter by whether the deal needs closing (open with a past end date). color_id: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/color_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_deal_report/properties/color_id" contains: "$ref": "#/components/schemas/resource_deal_report/properties/color_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/color_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/color_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by deal color label. won_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/won_at" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/won_at" eq: "$ref": "#/components/schemas/resource_deal_report/properties/won_at" contains: "$ref": "#/components/schemas/resource_deal_report/properties/won_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/won_at" description: Filter by the datetime the deal was marked as won. recurring_starts_on: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/recurring_starts_on" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/recurring_starts_on" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/recurring_starts_on" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/recurring_starts_on" eq: "$ref": "#/components/schemas/resource_deal_report/properties/recurring_starts_on" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the start date of the recurring contract. future_booked_time: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/future_booked_time" contains: "$ref": "#/components/schemas/resource_deal_report/properties/future_booked_time" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/future_booked_time" eq: "$ref": "#/components/schemas/resource_deal_report/properties/future_booked_time" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/future_booked_time" description: Filter by future booked time (upcoming scheduled work hours). stage_status_id: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/stage_status_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_report/properties/stage_status_id" eq: "$ref": "#/components/schemas/resource_deal_report/properties/stage_status_id" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/stage_status_id" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/stage_status_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the current pipeline stage status (e.g., open, won, lost). forecasted_budget_usage: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_budget_usage" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_budget_usage" contains: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_budget_usage" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_budget_usage" eq: "$ref": "#/components/schemas/resource_deal_report/properties/forecasted_budget_usage" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by forecasted budget usage percentage. template: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/template" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/template" eq: "$ref": "#/components/schemas/resource_deal_report/properties/template" contains: "$ref": "#/components/schemas/resource_deal_report/properties/template" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/template" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the deal is a template. tags: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/tags" eq: "$ref": "#/components/schemas/resource_deal_report/properties/tags" contains: "$ref": "#/components/schemas/resource_deal_report/properties/tags" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/tags" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/tags" description: Filter by tag. jump_query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/jump_query" contains: "$ref": "#/components/schemas/resource_deal_report/properties/jump_query" eq: "$ref": "#/components/schemas/resource_deal_report/properties/jump_query" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_deal_report/properties/jump_query" description: Partial text search query for quickly jumping to matching deals. actual_rate: oneOf: - "$ref": "#/components/schemas/resource_deal_report/properties/actual_rate" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_deal_report/properties/actual_rate" eq: "$ref": "#/components/schemas/resource_deal_report/properties/actual_rate" not_contain: "$ref": "#/components/schemas/resource_deal_report/properties/actual_rate" contains: "$ref": "#/components/schemas/resource_deal_report/properties/actual_rate" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the actual hourly rate (services revenue divided by tracked time). patternProperties: "^company..*$": title: Company relationship "^contact..*$": title: Contact relationship "^creator..*$": title: Creator relationship "^project..*$": title: Project relationship "^contract..*$": title: Contract relationship "^services..*$": title: Services relationship "^deal_status..*$": title: Deal status relationship "^lost_reason..*$": title: Lost reason relationship "^origin_deal..*$": title: Origin deal relationship "^responsible..*$": title: Responsible relationship "^document_type..*$": title: Document type relationship "^designated_approver..*$": title: Designated approver relationship "^previous_deal_status..*$": title: Previous deal status relationship description: Available filter parameters for querying aggregated deal report data. _filter_root_widget: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_widget" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_widget" description: Filter schema for `widget` list endpoints — pass a single condition or a logical group. filter_deal_cost_rate: type: object title: Filter deal cost rate properties: deal_id: oneOf: - "$ref": "#/components/schemas/resource_deal_cost_rate/properties/deal_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/deal_id" eq: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/deal_id" description: Filter using explicit operator syntax. description: Filter by deal ID. person_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/person_id" eq: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/person_id" contains: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/person_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_deal_cost_rate/properties/person_id" description: Filter by person ID. patternProperties: {} description: Filter parameters for querying deal cost rates. _filter_root_kpd_code: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator for combining filter conditions. Use to require all conditions, or to match any. example: and patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_kpd_code" description: Object form allowing multiple filter conditions combined with a logical operator. required: - "$op" example: '0': subsidiary_id: '42' "$op": and - "$ref": "#/components/schemas/filter_kpd_code" description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. example: is_kpd: true filter_person_report: type: object title: Filter person report properties: eligible_replacement_managers: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/eligible_replacement_managers" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/eligible_replacement_managers" eq: "$ref": "#/components/schemas/resource_person_report/properties/eligible_replacement_managers" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/eligible_replacement_managers" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/eligible_replacement_managers" description: Filter to people eligible to replace the specified person as a manager. last_name: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person_report/properties/last_name" eq: "$ref": "#/components/schemas/resource_person_report/properties/last_name" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/last_name" contains: "$ref": "#/components/schemas/resource_person_report/properties/last_name" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/last_name" description: Filter by the person's last name. created_at: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/created_at" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/created_at" eq: "$ref": "#/components/schemas/resource_person_report/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/created_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by creation date range (created_at). full_query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person_report/properties/full_query" contains: "$ref": "#/components/schemas/resource_person_report/properties/full_query" eq: "$ref": "#/components/schemas/resource_person_report/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/full_query" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/full_query" description: Full-text search query — matches across person name, email, and other fields. offboarding_status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person_report/properties/offboarding_status" contains: "$ref": "#/components/schemas/resource_person_report/properties/offboarding_status" eq: "$ref": "#/components/schemas/resource_person_report/properties/offboarding_status" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/offboarding_status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/offboarding_status" description: Filter by the person's offboarding status. bookings_after: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/bookings_after" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/bookings_after" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/bookings_after" eq: "$ref": "#/components/schemas/resource_person_report/properties/bookings_after" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/bookings_after" description: Include only people with bookings starting after this date. last_activity_at: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/last_activity_at" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person_report/properties/last_activity_at" contains: "$ref": "#/components/schemas/resource_person_report/properties/last_activity_at" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/last_activity_at" eq: "$ref": "#/components/schemas/resource_person_report/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the date of the person's last activity (last_activity_at). two_factor_auth: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person_report/properties/two_factor_auth" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/two_factor_auth" contains: "$ref": "#/components/schemas/resource_person_report/properties/two_factor_auth" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/two_factor_auth" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/two_factor_auth" description: Filter by whether two-factor authentication is enabled for the person. first_name: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/first_name" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person_report/properties/first_name" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/first_name" contains: "$ref": "#/components/schemas/resource_person_report/properties/first_name" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/first_name" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the person's first name. bookings_before: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/bookings_before" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person_report/properties/bookings_before" eq: "$ref": "#/components/schemas/resource_person_report/properties/bookings_before" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/bookings_before" contains: "$ref": "#/components/schemas/resource_person_report/properties/bookings_before" description: Operator object — supports eq, not_eq, contains, not_contain. description: Include only people with bookings ending before this date. approval_workflow_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person_report/properties/approval_workflow_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/approval_workflow_id" contains: "$ref": "#/components/schemas/resource_person_report/properties/approval_workflow_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/approval_workflow_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/approval_workflow_id" description: Filter by approval workflow the person is part of. fuzzy_people: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person_report/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_person_report/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_person_report/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/fuzzy_people" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/fuzzy_people" description: Fuzzy search by person name. role_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person_report/properties/role_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/role_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/role_id" contains: "$ref": "#/components/schemas/resource_person_report/properties/role_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/role_id" description: Filter by the person's assigned role. agent: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/agent" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/agent" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/agent" eq: "$ref": "#/components/schemas/resource_person_report/properties/agent" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/agent" description: Filter by whether the person is an AI agent. custom_role_id: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/custom_role_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/custom_role_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/custom_role_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/custom_role_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/custom_role_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the ID of the person's custom role (permission set). accessible_filter_id: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/accessible_filter_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person_report/properties/accessible_filter_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/accessible_filter_id" contains: "$ref": "#/components/schemas/resource_person_report/properties/accessible_filter_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/accessible_filter_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter to people who have access to the specified saved filter. person_type: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/person_type" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person_report/properties/person_type" eq: "$ref": "#/components/schemas/resource_person_report/properties/person_type" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/person_type" contains: "$ref": "#/components/schemas/resource_person_report/properties/person_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the person's type — employee, contractor, client contact, or placeholder. company_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/company_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/company_id" description: Filter by client company. service_type_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person_report/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/service_type_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/service_type_id" contains: "$ref": "#/components/schemas/resource_person_report/properties/service_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/service_type_id" description: Filter by the person's assigned service type. manager_id: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/manager_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person_report/properties/manager_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/manager_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/manager_id" contains: "$ref": "#/components/schemas/resource_person_report/properties/manager_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the person's direct manager. deactivated_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person_report/properties/deactivated_at" contains: "$ref": "#/components/schemas/resource_person_report/properties/deactivated_at" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/deactivated_at" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/deactivated_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/deactivated_at" description: Filter by deactivation date range (deactivated_at). title: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person_report/properties/title" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/title" eq: "$ref": "#/components/schemas/resource_person_report/properties/title" contains: "$ref": "#/components/schemas/resource_person_report/properties/title" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/title" description: Filter by the person's job title. query: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/query" contains: "$ref": "#/components/schemas/resource_person_report/properties/query" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/query" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/query" description: Full-text search query across person fields. subscribable_type: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person_report/properties/subscribable_type" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/subscribable_type" contains: "$ref": "#/components/schemas/resource_person_report/properties/subscribable_type" eq: "$ref": "#/components/schemas/resource_person_report/properties/subscribable_type" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/subscribable_type" description: Filter by the type of subscribable resource (used together with subscribable_id). subscribable_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/subscribable_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/subscribable_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/subscribable_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/subscribable_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/subscribable_id" description: Filter by the ID of the subscribable resource (used together with subscribable_type). project_id: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/project_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_person_report/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/project_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/project_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated project. joined_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person_report/properties/joined_at" contains: "$ref": "#/components/schemas/resource_person_report/properties/joined_at" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/joined_at" eq: "$ref": "#/components/schemas/resource_person_report/properties/joined_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/joined_at" description: Filter by the date the person joined the organization (joined_at). status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person_report/properties/status" eq: "$ref": "#/components/schemas/resource_person_report/properties/status" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/status" contains: "$ref": "#/components/schemas/resource_person_report/properties/status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/status" description: Filter by the person's account status — active or inactive. holiday_calendar_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person_report/properties/holiday_calendar_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/holiday_calendar_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/holiday_calendar_id" contains: "$ref": "#/components/schemas/resource_person_report/properties/holiday_calendar_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/holiday_calendar_id" description: Filter by the ID of the person's holiday calendar. custom_fields: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_person_report/properties/custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/custom_fields" description: Filter by custom field values. team: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/team" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person_report/properties/team" eq: "$ref": "#/components/schemas/resource_person_report/properties/team" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/team" contains: "$ref": "#/components/schemas/resource_person_report/properties/team" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the person's team membership. permissions: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person_report/properties/permissions" eq: "$ref": "#/components/schemas/resource_person_report/properties/permissions" contains: "$ref": "#/components/schemas/resource_person_report/properties/permissions" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/permissions" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/permissions" description: Filter by the person's permission level in the organization. autotracking: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/autotracking" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/autotracking" eq: "$ref": "#/components/schemas/resource_person_report/properties/autotracking" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/autotracking" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/autotracking" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the person has auto-tracking enabled. timesheet_submission_disabled: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/timesheet_submission_disabled" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person_report/properties/timesheet_submission_disabled" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/timesheet_submission_disabled" eq: "$ref": "#/components/schemas/resource_person_report/properties/timesheet_submission_disabled" contains: "$ref": "#/components/schemas/resource_person_report/properties/timesheet_submission_disabled" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether timesheet submission is disabled for the person. subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/subsidiary_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person_report/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_person_report/properties/subsidiary_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the person's subsidiary. accessible_project_id: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/accessible_project_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/accessible_project_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/accessible_project_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/accessible_project_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/accessible_project_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter to people who have access to the specified project. fuzzy_dates: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/fuzzy_dates" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person_report/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/fuzzy_dates" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_person_report/properties/fuzzy_dates" description: Operator object — supports eq, not_eq, contains, not_contain. description: Enable fuzzy matching for date values in the query. hrm_type_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person_report/properties/hrm_type_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/hrm_type_id" contains: "$ref": "#/components/schemas/resource_person_report/properties/hrm_type_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/hrm_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/hrm_type_id" description: Filter by the person's HR management type ID. schedulable: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/schedulable" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person_report/properties/schedulable" contains: "$ref": "#/components/schemas/resource_person_report/properties/schedulable" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/schedulable" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/schedulable" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the person can be scheduled (has a resourcing-eligible role). archived_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person_report/properties/archived_at" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/archived_at" contains: "$ref": "#/components/schemas/resource_person_report/properties/archived_at" eq: "$ref": "#/components/schemas/resource_person_report/properties/archived_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/archived_at" description: Filter by archival date range (archived_at). accessible_doc_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/accessible_doc_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/accessible_doc_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/accessible_doc_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/accessible_doc_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/accessible_doc_id" description: Filter to people who have access to the specified doc (page). tags: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/tags" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/tags" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/tags" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/tags" eq: "$ref": "#/components/schemas/resource_person_report/properties/tags" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by tag. last_seen_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person_report/properties/last_seen_at" eq: "$ref": "#/components/schemas/resource_person_report/properties/last_seen_at" contains: "$ref": "#/components/schemas/resource_person_report/properties/last_seen_at" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/last_seen_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/last_seen_at" description: Filter by the date the person was last seen (last_seen_at). service_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/service_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/service_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/service_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/service_id" description: Filter by the associated service. id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_person_report/properties/id" eq: "$ref": "#/components/schemas/resource_person_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/id" contains: "$ref": "#/components/schemas/resource_person_report/properties/id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/id" description: Filter by the person's ID. time_tracking_policy_id: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/time_tracking_policy_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_person_report/properties/time_tracking_policy_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/time_tracking_policy_id" contains: "$ref": "#/components/schemas/resource_person_report/properties/time_tracking_policy_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/time_tracking_policy_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the person's assigned time tracking policy. accessible_deal_id: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/accessible_deal_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/accessible_deal_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/accessible_deal_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/accessible_deal_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/accessible_deal_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter to people who have access to the specified deal. approval_policy_id: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/approval_policy_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/approval_policy_id" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/approval_policy_id" eq: "$ref": "#/components/schemas/resource_person_report/properties/approval_policy_id" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/approval_policy_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the person's assigned approval policy. virtual: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/virtual" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_person_report/properties/virtual" contains: "$ref": "#/components/schemas/resource_person_report/properties/virtual" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/virtual" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/virtual" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the person is a virtual/placeholder person. project_watching: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/project_watching" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/project_watching" eq: "$ref": "#/components/schemas/resource_person_report/properties/project_watching" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/project_watching" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/project_watching" description: Filter by project IDs the person is auto-subscribed (watching) to. jump_query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/jump_query" eq: "$ref": "#/components/schemas/resource_person_report/properties/jump_query" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_person_report/properties/jump_query" description: Quick search query for navigating to a person by name. email: oneOf: - "$ref": "#/components/schemas/resource_person_report/properties/email" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_person_report/properties/email" eq: "$ref": "#/components/schemas/resource_person_report/properties/email" not_contain: "$ref": "#/components/schemas/resource_person_report/properties/email" not_eq: "$ref": "#/components/schemas/resource_person_report/properties/email" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by email address (text search). patternProperties: "^company..*$": title: Company relationship "^contact..*$": title: Contact relationship "^bookings..*$": title: Bookings relationship "^subsidiary..*$": title: Subsidiary relationship "^custom_role..*$": title: Custom role relationship description: Available filter parameters for querying aggregated person report data. resource_password: type: object title: Password Resource properties: email: type: string title: Email description: The email address associated with the user whose password is being reset or changed. password: title: Password description: The new password to set for the user. password_confirmation: title: Password Confirmation description: Confirmation of the new password, must match the password field. first_password: type: boolean title: First Password description: When true, the user has not yet set their first password after account creation. description: A password reset or change request, identified by a reset token. filter_notification: type: object title: Filter notification properties: project_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_notification/properties/project_id" eq: "$ref": "#/components/schemas/resource_notification/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_notification/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_notification/properties/project_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_notification/properties/project_id" description: Filter to notifications related to tasks or todos in the given project. type: oneOf: - "$ref": "#/components/schemas/resource_notification/properties/type" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_notification/properties/type" not_contain: "$ref": "#/components/schemas/resource_notification/properties/type" eq: "$ref": "#/components/schemas/resource_notification/properties/type" contains: "$ref": "#/components/schemas/resource_notification/properties/type" description: Filter using explicit operator syntax. description: Filter by notification type (the resource type that triggered the notification). date_after: oneOf: - "$ref": "#/components/schemas/resource_notification/properties/date_after" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_notification/properties/date_after" not_eq: "$ref": "#/components/schemas/resource_notification/properties/date_after" not_contain: "$ref": "#/components/schemas/resource_notification/properties/date_after" contains: "$ref": "#/components/schemas/resource_notification/properties/date_after" description: Filter using explicit operator syntax. description: Filter notifications where the last action occurred on or after this date. mention: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_notification/properties/mention" contains: "$ref": "#/components/schemas/resource_notification/properties/mention" not_eq: "$ref": "#/components/schemas/resource_notification/properties/mention" eq: "$ref": "#/components/schemas/resource_notification/properties/mention" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_notification/properties/mention" description: Filter to include only notifications that are direct mentions. dismissed: oneOf: - "$ref": "#/components/schemas/resource_notification/properties/dismissed" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_notification/properties/dismissed" not_contain: "$ref": "#/components/schemas/resource_notification/properties/dismissed" not_eq: "$ref": "#/components/schemas/resource_notification/properties/dismissed" eq: "$ref": "#/components/schemas/resource_notification/properties/dismissed" description: Filter using explicit operator syntax. description: Filter to include only dismissed (or non-dismissed) notifications. last_action_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_notification/properties/last_action_at" not_eq: "$ref": "#/components/schemas/resource_notification/properties/last_action_at" contains: "$ref": "#/components/schemas/resource_notification/properties/last_action_at" eq: "$ref": "#/components/schemas/resource_notification/properties/last_action_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_notification/properties/last_action_at" description: Filter by the timestamp of the last action triggering this notification. date_before: oneOf: - "$ref": "#/components/schemas/resource_notification/properties/date_before" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_notification/properties/date_before" eq: "$ref": "#/components/schemas/resource_notification/properties/date_before" not_contain: "$ref": "#/components/schemas/resource_notification/properties/date_before" contains: "$ref": "#/components/schemas/resource_notification/properties/date_before" description: Filter using explicit operator syntax. description: Filter notifications where the last action occurred on or before this date. important: oneOf: - "$ref": "#/components/schemas/resource_notification/properties/important" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_notification/properties/important" eq: "$ref": "#/components/schemas/resource_notification/properties/important" not_eq: "$ref": "#/components/schemas/resource_notification/properties/important" not_contain: "$ref": "#/components/schemas/resource_notification/properties/important" description: Filter using explicit operator syntax. description: Filter to include only high-importance notifications. before: oneOf: - "$ref": "#/components/schemas/resource_notification/properties/before" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_notification/properties/before" contains: "$ref": "#/components/schemas/resource_notification/properties/before" not_eq: "$ref": "#/components/schemas/resource_notification/properties/before" eq: "$ref": "#/components/schemas/resource_notification/properties/before" description: Filter using explicit operator syntax. description: Filter by before. after: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_notification/properties/after" not_eq: "$ref": "#/components/schemas/resource_notification/properties/after" not_contain: "$ref": "#/components/schemas/resource_notification/properties/after" eq: "$ref": "#/components/schemas/resource_notification/properties/after" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_notification/properties/after" description: Filter by after. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_notification/properties/id" not_eq: "$ref": "#/components/schemas/resource_notification/properties/id" not_contain: "$ref": "#/components/schemas/resource_notification/properties/id" contains: "$ref": "#/components/schemas/resource_notification/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_notification/properties/id" description: Filter by ID. patternProperties: {} description: Filter parameters for notifications. _filter_root_integration: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_integration" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_integration" description: Filter schema for `integration` list endpoints — pass a single condition or a logical group. resource_deleted_item: type: object title: Deleted item Resource properties: private: type: boolean title: Private description: Whether this deleted item was marked as private at the time of deletion. location: type: string title: Location description: The location description indicating where the item was before deletion (e.g. project name, folder). name: type: string title: Name description: The name of the deleted item at the time it was deleted. item_id: type: integer title: Item description: The ID of the original resource that was deleted. organization: title: Organization description: The organization this deleted item belongs to. item_type: type: string title: Item Type description: The type of resource that was deleted (e.g. task, deal, project). query: type: string title: Query description: A text search query used to filter deleted items by name. recovered_at: type: string title: Recovered At format: date-time description: Timestamp when this deleted item was restored, or null if it has not been recovered. deleter: title: Deleter description: The person who deleted this item. deleter_id: type: integer title: Deleter description: The ID of the person who deleted this item. created_at: type: string title: Created At format: date-time description: Timestamp when the item was deleted. id: type: integer title: Id description: Unique identifier for the deleted item record. description: A soft-deleted record that can be restored from the recycle bin, including the item type, deletion details, and location. _filter_root_line_item_report: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_line_item_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_line_item_report" description: Filter schema for `line_item_report` list endpoints — pass a single condition or a logical group. resource_board: type: object title: Board Resource properties: position: type: integer title: Position description: The display order position of this folder within its project. organization: title: Organization description: The organization this folder belongs to. placement: type: integer title: Placement description: Indicates the folder's placement context (e.g. project or global). archived_at: type: string title: Archived At format: date-time description: Timestamp when the folder was archived, or null if active. hidden: type: boolean title: Hidden description: When true, this folder is hidden from members who do not have explicit access. id: type: integer title: Id description: Unique identifier for the folder. project: title: Project description: The project this folder belongs to. name: type: string title: Name description: The display name of the folder. project_id: type: integer title: Project description: The ID of the project this folder belongs to. query: type: string title: Query description: A saved filter query string applied to this folder view. status: enum: - 1 - 2 type: integer title: Status description: The current status of the folder (e.g. active or archived). description: Folder (called Board internally) grouping task lists within a project. Supports name, position ordering, placement (top or bottom), archiving, and hidden visibility. Used to organize task lists into phases or sprints. resource_resource_request: type: object title: Resource request Resource properties: workplace_id: type: integer title: Workplace description: The workplace ID associated with the requested resource, as stored in the fields. exchange_date: type: string title: Exchange Date format: date description: The date used for the exchange rate lookup on this resource request. resolver: title: Resolver description: The JSON:API relationship object for the person who resolved this resource request. resolved_at: type: string title: Resolved At format: date-time description: Timestamp when this resource request was resolved, or null if still open. max_cost_per_hour: title: Max Cost Per Hour description: The maximum cost per hour for the requested resource in the request currency. created_at: type: string title: Created At format: date-time description: Timestamp when this resource request was created. exchange_rate_normalized: type: number title: Exchange Rate Normalized description: The exchange rate from the resource request currency to the normalized quote currency. canceled_at: type: string title: Canceled At format: date-time description: Timestamp when this resource request was canceled, or null if not canceled. service: title: Service description: The JSON:API relationship object for the service this resource request belongs to. max_cost_per_hour_normalized: title: Max Cost Per Hour Normalized description: The maximum cost per hour converted to the normalized quote currency. exchange_rate: type: number title: Exchange Rate description: The exchange rate from the resource request currency to the default account currency. organization: title: Organization description: The JSON:API relationship object for the organization this resource request belongs to. resolver_id: type: integer title: Resolver description: The ID of the person who resolved this resource request. started_on: type: string title: Started On format: date description: The start date of the requested resource allocation period. currency: type: string title: Currency description: The currency code used for cost calculations on this resource request. team_id: type: integer title: Team description: The team IDs associated with the requested resource, as stored in the fields. time: type: integer title: Time description: The requested time in minutes per day when using per-day booking. max_cost_per_hour_default: title: Max Cost Per Hour Default description: The maximum cost per hour converted to the default account currency. deleted_at: type: string title: Deleted At format: date description: Timestamp when this resource request was soft-deleted, or null if active. rejected_reason: type: string title: Rejected Reason description: The reason provided when the resource request was rejected. tags: type: string title: Tags description: The list of tag labels associated with this resource request. id: type: integer title: Id description: The unique identifier of this resource request. currency_normalized: title: Currency Normalized description: The normalized quote-level currency code used for cost calculations. booking_method_id: enum: - 1 - 2 - 3 type: integer title: Booking Method description: The booking method ID specifying how the requested time is tracked. custom_field_people: title: Custom Field People description: The JSON:API relationship objects for people linked via custom fields. fields: type: object title: Fields description: A JSON object containing additional structured fields such as job_title, subsidiary_id, team_ids, service_type_ids, and tags. service_type_id: type: integer title: Service Type description: The service type IDs associated with the requested resource, as stored in the fields. status: enum: - pending - resolved - rejected - canceled type: string title: Status description: 'The current status of the resource request: pending, resolved, rejected, or canceled.' creator: title: Creator description: The JSON:API relationship object for the person who created this resource request. query: type: string title: Query description: A full-text search string used for matching resource requests by title. currency_default: title: Currency Default description: The default account-level currency code used for cost calculations. title: type: string title: Title description: The title describing the resource being requested. total_time: type: integer title: Total Time description: The total requested time in minutes when using total-hours booking. creator_id: type: integer title: Creator description: The ID of the person who created this resource request. note: type: string title: Note description: An optional HTML note providing additional context for this resource request. ended_on: type: string title: Ended On format: date description: The end date of the requested resource allocation period. time_to_close: type: integer title: Time To Close description: The number of minutes elapsed between creation and resolution of this resource request. custom_fields: type: object title: Custom Fields description: A JSON object containing custom field values for this resource request. job_title: type: string title: Job Title description: The requested job title for the resource, as stored in the resource request fields. service_id: type: integer title: Service description: The ID of the service this resource request is associated with. percentage: type: integer title: Percentage description: The requested allocation percentage from 0 to 100 when using percentage-based booking. subsidiary_id: type: integer title: Subsidiary description: The subsidiary ID associated with the requested resource, as stored in the fields. custom_field_attachments: title: Custom Field Attachments description: The JSON:API relationship objects for file attachments linked via custom fields. description: Schema for a resource request resource object. resource_invitation: type: object title: Invitation Resource properties: first_name: type: string title: First Name description: The first name of the invited user. time_zone: type: string title: Time Zone description: The time zone preference for the invited user, applied after they accept the invitation. newsletter_consent: type: boolean title: Newsletter Consent description: Whether the invited user consented to receive marketing emails. last_name: type: string title: Last Name description: The last name of the invited user. password: title: Password description: The initial password the invited user sets when accepting the invitation. email: type: string title: Email description: The email address of the invited user. description: A pending user invitation to join a Productive organization, identified by an invitation token. filter_expense_report: type: object title: Filter expense report properties: approved_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/approved_at" contains: "$ref": "#/components/schemas/resource_expense_report/properties/approved_at" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/approved_at" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/approved_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/approved_at" description: Filter by the date the expense was approved. quantity: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/quantity" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/quantity" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/quantity" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/quantity" eq: "$ref": "#/components/schemas/resource_expense_report/properties/quantity" description: Filter operator object for quantity. description: Filter expense report results by quantity. reimbursed_on: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursed_on" eq: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursed_on" contains: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursed_on" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursed_on" description: Filter operator object for reimbursed on. - "$ref": "#/components/schemas/resource_expense_report/properties/reimbursed_on" description: Filter expense report results by reimbursed on. paid_on_after: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/paid_on_after" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on_after" eq: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on_after" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on_after" contains: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on_after" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter to include expenses paid after the given date. vendor_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/vendor_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/vendor_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/vendor_id" contains: "$ref": "#/components/schemas/resource_expense_report/properties/vendor_id" description: Filter operator object for vendor id. - "$ref": "#/components/schemas/resource_expense_report/properties/vendor_id" description: Filter expense report results by vendor id. deal_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/deal_id" contains: "$ref": "#/components/schemas/resource_expense_report/properties/deal_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/deal_id" description: Filter by the associated budget or deal. responsible_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/responsible_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_expense_report/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_expense_report/properties/responsible_id" description: Filter operator object for responsible id. - "$ref": "#/components/schemas/resource_expense_report/properties/responsible_id" description: Filter expense report results by responsible id. full_query: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/full_query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/full_query" contains: "$ref": "#/components/schemas/resource_expense_report/properties/full_query" eq: "$ref": "#/components/schemas/resource_expense_report/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/full_query" description: Operator object — supports eq, not_eq, contains, not_contain. description: Full-text search query across expense report fields. approver_id: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/approver_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/approver_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/approver_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/approver_id" eq: "$ref": "#/components/schemas/resource_expense_report/properties/approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the person who approved the expense. person_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/person_id" contains: "$ref": "#/components/schemas/resource_expense_report/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/person_id" description: Filter operator object for person id. - "$ref": "#/components/schemas/resource_expense_report/properties/person_id" description: Filter expense report results by person id. fuzzy_people: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_expense_report/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_expense_report/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/fuzzy_people" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/fuzzy_people" description: Filter using fuzzy/partial person name matching. with_draft: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/with_draft" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/with_draft" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/with_draft" contains: "$ref": "#/components/schemas/resource_expense_report/properties/with_draft" description: Filter operator object for with draft. - "$ref": "#/components/schemas/resource_expense_report/properties/with_draft" description: Filter expense report results by with draft. service_type_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_expense_report/properties/service_type_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/service_type_id" contains: "$ref": "#/components/schemas/resource_expense_report/properties/service_type_id" description: Filter operator object for service type id. - "$ref": "#/components/schemas/resource_expense_report/properties/service_type_id" description: Filter expense report results by service type id. project_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/project_id" eq: "$ref": "#/components/schemas/resource_expense_report/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/project_id" description: Filter operator object for project id. - "$ref": "#/components/schemas/resource_expense_report/properties/project_id" description: Filter expense report results by project id. purchase_order_id: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/purchase_order_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/purchase_order_id" eq: "$ref": "#/components/schemas/resource_expense_report/properties/purchase_order_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/purchase_order_id" contains: "$ref": "#/components/schemas/resource_expense_report/properties/purchase_order_id" description: Filter operator object for purchase order id. example: eq: - 1234567 description: Filter expense report results by purchase order id. example: eq: - 1234567 fuzzy_dates: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/fuzzy_dates" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_expense_report/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_expense_report/properties/fuzzy_dates" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/fuzzy_dates" description: Filter using fuzzy/relative date expressions (e.g. 'this month', 'last quarter'). created_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/created_at" contains: "$ref": "#/components/schemas/resource_expense_report/properties/created_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/created_at" description: Filter by creation date range (`created_at`). recognized_revenue: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/recognized_revenue" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/recognized_revenue" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/recognized_revenue" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/recognized_revenue" eq: "$ref": "#/components/schemas/resource_expense_report/properties/recognized_revenue" description: Filter operator object for recognized revenue. description: Filter expense report results by recognized revenue. pay_on_after: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on_after" contains: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on_after" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on_after" eq: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on_after" description: Filter operator object for pay on after. - "$ref": "#/components/schemas/resource_expense_report/properties/pay_on_after" description: Filter expense report results by pay on after. stage_type: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/stage_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/stage_type" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/stage_type" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/stage_type" eq: "$ref": "#/components/schemas/resource_expense_report/properties/stage_type" description: Filter operator object for stage type. description: Filter expense report results by stage type. status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/status" eq: "$ref": "#/components/schemas/resource_expense_report/properties/status" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/status" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/status" description: Filter operator object for status. - "$ref": "#/components/schemas/resource_expense_report/properties/status" description: Filter expense report results by status. date: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/date" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/date" contains: "$ref": "#/components/schemas/resource_expense_report/properties/date" eq: "$ref": "#/components/schemas/resource_expense_report/properties/date" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/date" description: Filter by expense date range (`date`). query: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/query" contains: "$ref": "#/components/schemas/resource_expense_report/properties/query" eq: "$ref": "#/components/schemas/resource_expense_report/properties/query" description: Filter operator object for query. description: Filter expense report results by query. tax_rate_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/tax_rate_id" eq: "$ref": "#/components/schemas/resource_expense_report/properties/tax_rate_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/tax_rate_id" contains: "$ref": "#/components/schemas/resource_expense_report/properties/tax_rate_id" description: Filter operator object for tax rate id. - "$ref": "#/components/schemas/resource_expense_report/properties/tax_rate_id" description: Filter expense report results by tax rate id. awaiting_approval_from_approver_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/awaiting_approval_from_approver_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/awaiting_approval_from_approver_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/awaiting_approval_from_approver_id" contains: "$ref": "#/components/schemas/resource_expense_report/properties/awaiting_approval_from_approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/awaiting_approval_from_approver_id" description: Filter by approver ID for expenses awaiting that person's approval. section_name: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/section_name" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/section_name" contains: "$ref": "#/components/schemas/resource_expense_report/properties/section_name" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/section_name" eq: "$ref": "#/components/schemas/resource_expense_report/properties/section_name" description: Filter operator object for section name. description: Filter expense report results by section name. assigned_approver_id: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/assigned_approver_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/assigned_approver_id" contains: "$ref": "#/components/schemas/resource_expense_report/properties/assigned_approver_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/assigned_approver_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/assigned_approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by a person assigned as an approver on the expense. amount: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/amount" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/amount" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/amount" contains: "$ref": "#/components/schemas/resource_expense_report/properties/amount" eq: "$ref": "#/components/schemas/resource_expense_report/properties/amount" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by expense amount range (before tax). invoiced: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/invoiced" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/invoiced" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/invoiced" eq: "$ref": "#/components/schemas/resource_expense_report/properties/invoiced" contains: "$ref": "#/components/schemas/resource_expense_report/properties/invoiced" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by invoiced status; when true, includes only invoiced expenses. reimbursement: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/reimbursement" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursement" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursement" eq: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursement" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursement" description: Filter operator object for reimbursement. description: Filter expense report results by reimbursement. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/id" contains: "$ref": "#/components/schemas/resource_expense_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/id" description: Filter by expense ID. draft: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/draft" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/draft" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/draft" eq: "$ref": "#/components/schemas/resource_expense_report/properties/draft" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/draft" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by draft status; when true, includes only draft expenses. date_after: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/date_after" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/date_after" contains: "$ref": "#/components/schemas/resource_expense_report/properties/date_after" eq: "$ref": "#/components/schemas/resource_expense_report/properties/date_after" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/date_after" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter to include expenses with a date after the given value. currency: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/currency" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/currency" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/currency" eq: "$ref": "#/components/schemas/resource_expense_report/properties/currency" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/currency" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the currency code of the expense. invoice_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/invoice_id" eq: "$ref": "#/components/schemas/resource_expense_report/properties/invoice_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/invoice_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/invoice_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/invoice_id" description: Filter by the associated invoice. amount_with_tax: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/amount_with_tax" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/amount_with_tax" contains: "$ref": "#/components/schemas/resource_expense_report/properties/amount_with_tax" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/amount_with_tax" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/amount_with_tax" description: Filter by expense amount range including tax. custom_fields: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/custom_fields" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_expense_report/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by custom field values. name: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/name" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/name" contains: "$ref": "#/components/schemas/resource_expense_report/properties/name" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/name" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/name" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the expense description (what it was for). allocation_status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/allocation_status" eq: "$ref": "#/components/schemas/resource_expense_report/properties/allocation_status" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/allocation_status" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/allocation_status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/allocation_status" description: Filter by the allocation status of the expense (e.g. billable, non-billable). jump_query: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/jump_query" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/jump_query" eq: "$ref": "#/components/schemas/resource_expense_report/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/jump_query" description: Operator object — supports eq, not_eq, contains, not_contain. description: Internal quick-search query for jump navigation. date_before: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/date_before" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/date_before" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/date_before" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/date_before" contains: "$ref": "#/components/schemas/resource_expense_report/properties/date_before" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter to include expenses with a date before the given value. formulas: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/formulas" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/formulas" contains: "$ref": "#/components/schemas/resource_expense_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_expense_report/properties/formulas" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by calculated formula field values. pay_on_before: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/pay_on_before" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on_before" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on_before" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on_before" eq: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on_before" description: Filter operator object for pay on before. description: Filter expense report results by pay on before. billable_amount: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/billable_amount" eq: "$ref": "#/components/schemas/resource_expense_report/properties/billable_amount" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/billable_amount" contains: "$ref": "#/components/schemas/resource_expense_report/properties/billable_amount" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/billable_amount" description: Filter by the billable amount — the cost billed to the client. reimbursable: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursable" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursable" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursable" contains: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursable" description: Filter operator object for reimbursable. - "$ref": "#/components/schemas/resource_expense_report/properties/reimbursable" description: Filter expense report results by reimbursable. service_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/service_id" eq: "$ref": "#/components/schemas/resource_expense_report/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/service_id" contains: "$ref": "#/components/schemas/resource_expense_report/properties/service_id" description: Filter operator object for service id. - "$ref": "#/components/schemas/resource_expense_report/properties/service_id" description: Filter expense report results by service id. profit: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/profit" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/profit" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/profit" contains: "$ref": "#/components/schemas/resource_expense_report/properties/profit" description: Filter operator object for profit. - "$ref": "#/components/schemas/resource_expense_report/properties/profit" description: Filter expense report results by profit. company_id: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/company_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/company_id" eq: "$ref": "#/components/schemas/resource_expense_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/company_id" description: Filter operator object for company id. description: Filter expense report results by company id. pay_on: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on" contains: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on" eq: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on" description: Filter operator object for pay on. - "$ref": "#/components/schemas/resource_expense_report/properties/pay_on" description: Filter expense report results by pay on. creator_id: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/creator_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/creator_id" contains: "$ref": "#/components/schemas/resource_expense_report/properties/creator_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the person who created the expense. paid_on_before: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/paid_on_before" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on_before" contains: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on_before" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on_before" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on_before" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter to include expenses paid before the given date. quote_type: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/quote_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/quote_type" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/quote_type" eq: "$ref": "#/components/schemas/resource_expense_report/properties/quote_type" contains: "$ref": "#/components/schemas/resource_expense_report/properties/quote_type" description: Filter operator object for quote type. description: Filter expense report results by quote type. approval_status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/approval_status" contains: "$ref": "#/components/schemas/resource_expense_report/properties/approval_status" eq: "$ref": "#/components/schemas/resource_expense_report/properties/approval_status" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/approval_status" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/approval_status" description: Filter by expense approval status. export_status: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/export_status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/export_status" eq: "$ref": "#/components/schemas/resource_expense_report/properties/export_status" contains: "$ref": "#/components/schemas/resource_expense_report/properties/export_status" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/export_status" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the export status of the expense (e.g. whether it was copied to accounting software). invoicing_status: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/invoicing_status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/invoicing_status" contains: "$ref": "#/components/schemas/resource_expense_report/properties/invoicing_status" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/invoicing_status" eq: "$ref": "#/components/schemas/resource_expense_report/properties/invoicing_status" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by invoicing status (not invoiced, drafted, or finalized). paid_on: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on" eq: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on" contains: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_expense_report/properties/paid_on" description: Filter by payment date range (`paid_on`). designated_approver_id: oneOf: - "$ref": "#/components/schemas/resource_expense_report/properties/designated_approver_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense_report/properties/designated_approver_id" eq: "$ref": "#/components/schemas/resource_expense_report/properties/designated_approver_id" not_contain: "$ref": "#/components/schemas/resource_expense_report/properties/designated_approver_id" not_eq: "$ref": "#/components/schemas/resource_expense_report/properties/designated_approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the designated approver of the expense's associated quote. patternProperties: "^deal..*$": title: Deal relationship "^budget..*$": title: Budget relationship "^person..*$": title: Person relationship "^vendor..*$": title: Vendor relationship "^approver..*$": title: Approver relationship "^service_type..*$": title: Service type relationship "^purchase_order..*$": title: Purchase order relationship description: Available filter parameters for querying aggregated expense report data. _filter_root_payment_reminder_sequence: oneOf: - "$ref": "#/components/schemas/filter_payment_reminder_sequence" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_payment_reminder_sequence" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `payment_reminder_sequence` list endpoints — pass a single condition or a logical group. _filter_root_contact_entry: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_contact_entry" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_contact_entry" description: Filter schema for `contact_entry` list endpoints — pass a single condition or a logical group. resource_task: type: object title: Task Resource properties: repeat_on_weekday: type: string title: Repeat On Weekday description: Day of the week for weekly recurring tasks. todo_count: type: integer title: Todo Count description: Total number of to-do checklist items on this task. workflow_status: title: Workflow Status description: Current workflow status of this task (e.g. 'To Do', 'In Progress', 'Done'). initial_estimate: type: integer title: Initial Estimate description: Originally forecasted time needed to complete the task, in minutes. email_key: type: string title: Email Key description: Unique key for creating comments on this task via email. board_id: type: integer title: Board description: Filter by folder (board) ID. workflow_status_name: title: Workflow Status Name description: Current workflow status of this task (e.g. 'To Do', 'In Progress', 'Done'). due_date: type: string title: Due Date format: date description: Date by which the task should be completed. attachments: title: Attachments description: Files attached to this task. task_number: type: string title: Task Number description: Unique number identifying a task within the organization. last_actor_name: title: Last Actor Name description: The name of the person who last performed an activity on this task. closed: title: Closed description: Whether the task is closed (derived from closed_at). subtask_placement: type: integer title: Subtask Placement description: Sort position among sibling subtasks under the parent task. todo_assignee_ids: type: object title: Todo Assignee Ids description: IDs of people assigned to open to-do items on this task. project_id: type: integer title: Project description: ID of the project (workspace) this task belongs to. id: type: integer title: Id description: The unique identifier of this task. waiting_on_dependency_count: type: integer title: Waiting On Dependency Count description: Number of tasks this task is waiting on before it can proceed. repeating: type: boolean title: Repeating description: Whether this task is part of a repeating schedule. due_date_before: type: string title: Due Date Before format: date description: Return tasks due on or before this date. query: type: string title: Query description: Quick search matching task title and number. title: type: string title: Title description: Descriptive name of the task. subscriber_ids: title: Subscriber Ids description: Array of IDs of people subscribed to notifications for this task. open_subtask_count: type: integer title: Open Subtask Count description: Number of unclosed subtasks. closed_at: type: string title: Closed At format: date-time description: Timestamp when the task was closed, or null if still open. board_position: title: Board Position description: Sort position of this task within its board (folder). open_todo_count: type: integer title: Open Todo Count description: Number of uncompleted to-do items. tag_list: title: Tag List description: Tags applied to this task. task_list_name: type: string title: Task List Name description: Filter by task list name (text search). fuzzy_dates: type: string title: Fuzzy Dates format: date description: Fuzzy date matching across task date fields. custom_fields: type: object title: Custom Fields description: Custom field values set on this task. last_activity_at: type: string title: Last Activity At format: date-time description: Timestamp of the most recent activity on this task. task_type: enum: - 1 - 2 type: integer title: Task Type description: Filter by parent/subtask distinction. after: type: string title: After format: date description: Return tasks created on or after this date. start_date: type: string title: Start Date format: date description: Date when work on the task is planned to begin. dependency_type: enum: - 1 - 2 - 3 type: integer title: Dependency Type description: 'Filter by dependency type: blocking, waiting on, or linked.' linked_dependency_count: type: integer title: Linked Dependency Count description: Number of tasks linked to this one (informational, no blocking). assignee_id: type: integer title: Assignee description: Filter by assigned person (also matches open to-do assignees). placement: type: integer title: Placement description: Sort position of this task within its task list. task_dependency_count: type: integer title: Task Dependency Count description: Total number of dependency relationships on this task. assignee_name: title: Assignee Name description: Filter by assigned person (also matches open to-do assignees). remaining_time: type: integer title: Remaining Time description: Current projection of time still needed, decreases as time is tracked or can be adjusted manually. service_id: type: integer title: Service description: ID of the service (billing point) this task is linked to. custom_field_attachments: title: Custom Field Attachments description: Files uploaded to file-type custom fields on this task. query_extended: type: string title: Query Extended description: Extended search matching title, number, and description. task_list_position: title: Task List Position description: Sort position of this task within its task list. folder_name: type: string title: Folder Name description: Filter by folder name (alias for board_name). project_name: title: Project Name description: The name of the project this task belongs to. updated_at: type: string title: Updated At format: date-time description: Timestamp when the task was last modified. due_date_on: type: string title: Due Date On format: date description: Return tasks due on this exact date. tags: type: string title: Tags description: Tags applied to this task. template: type: string title: Template description: Return only template tasks. attachment_ids: title: Attachment Ids description: Files attached to this task. blocking_dependency_count: type: integer title: Blocking Dependency Count description: Number of tasks this task is blocking from starting. task_list_status: enum: - 1 - 2 type: integer title: Task List Status description: The open/closed status of the task list this task belongs to. parent_task: title: Parent Task description: The parent task if this is a subtask. subtask_count: type: integer title: Subtask Count description: Total number of subtasks under this task. skip_reposition: type: boolean title: Skip Reposition description: If true, skips reordering of other tasks when placing this one. assignee: title: Assignee description: The person assigned to this task. project_type: enum: - 1 - 2 type: integer title: Project Type description: 'Filter by project type: internal (overhead) or client (billable).' project_manager_id: type: integer title: Project Manager description: Filter by the project's responsible person. repeated_task: title: Repeated Task description: The recurring schedule configuration if this task repeats. creator_name: title: Creator Name description: The name of the person who created this task. folder_id: type: integer title: Folder description: Filter by folder ID (alias for board_id). workflow_status_id: type: integer title: Workflow Status description: ID of the workflow status currently assigned to this task. date_range: type: string title: Date Range format: date description: Filter tasks overlapping a date range (for timeline/Gantt views). before: type: string title: Before format: date description: Return tasks created on or before this date. jump_query: type: string title: Jump Query description: Quick jump search by task name or number. last_actor_id: type: integer title: Last Actor description: ID of the person who last performed an activity on this task. full_query: type: string title: Full Query description: Full-text search across task fields. due_time: type: string title: Due Time format: time description: Time of day for the due date deadline (HH:MM format). company_name: title: Company Name description: Filter by client company (via the task's project). type_id: enum: - 1 - 3 type: integer title: Type description: 'Task type: regular task, subtask, or milestone.' bookable_before: type: string title: Bookable Before format: date description: Filter tasks to those bookable before this date. repeat_on_interval: type: integer title: Repeat On Interval description: How frequently the task repeats (e.g. daily, weekly, monthly). start_date_before: type: string title: Start Date Before format: date description: Return tasks starting on or before this date. workflow_status_position: title: Workflow Status Position description: Sort position of the workflow status within its workflow. deleted_at: type: string title: Deleted At format: date-time description: Timestamp if the task was soft-deleted, null otherwise. last_activity_after: type: string title: Last Activity After format: date description: Return tasks with last activity after this date. worked_time: type: integer title: Worked Time description: Total time tracked on this task across all time entries, in minutes. template_object: title: Template Object description: The template this task was created from, if applicable. repeat_on_date: type: string title: Repeat On Date format: date description: Specific date for date-based recurring tasks. closed_before: type: string title: Closed Before format: date description: Return tasks closed on or before this date. public_access: type: boolean title: Public Access description: Filter by task privacy (deprecated — use `private` filter instead). private: type: boolean title: Private description: Whether this task is visible only to project members (not shared via public links). service: title: Service description: The budget service linked to this task for time tracking and billing. trackable_by_person_id: type: integer title: Trackable By Person description: Filter tasks to those trackable by the specified person, based on restricted tracking settings. folder_status: enum: - 1 - 2 type: integer title: Folder Status description: Filter by whether the folder is active or archived (alias for board_status). overdue_status: enum: - 1 - 2 type: integer title: Overdue Status description: Filter by whether the task is overdue (past due date). due_date_after: type: string title: Due Date After format: date description: Return tasks due on or after this date. workflow_id: type: integer title: Workflow description: ID of the workflow this task's status belongs to. start_date_after: type: string title: Start Date After format: date description: Return tasks starting on or after this date. creator_id: type: integer title: Creator description: ID of the person who created this task. billable_time: type: integer title: Billable Time description: Total billable hours tracked on this task (time + correction for billable services, zero for non-billable). due_date_new: type: string title: Due Date New format: date description: Return tasks due on this exact date. board_status: enum: - 1 - 2 type: integer title: Board Status description: The open/closed status of the task list (board) this task belongs to. folder_position: title: Folder Position description: Sort position of this task within its folder. repeat_schedule_id: enum: - 1 - 2 - 3 - 4 - 5 type: integer title: Repeat Schedule description: ID of the repeat schedule if this task recurs on a regular interval. status: enum: - 1 - 2 type: integer title: Status description: Filter by open (1) or closed (2) status. repeat_origin_id: type: integer title: Repeat Origin description: ID of the original task that spawned this recurring instance. project: title: Project description: The project this task belongs to. custom_field_people: title: Custom Field People description: People referenced in person-type custom fields on this task. creation_method_id: enum: - 1 - 2 - 3 - 4 type: integer title: Creation Method description: How the task was created (e.g. manually, via automation, via email). subtask: type: boolean title: Subtask description: Whether this task is a subtask of another task. closed_after: type: string title: Closed After format: date description: Return tasks closed on or after this date. board_name: type: string title: Board Name description: Filter by folder name (text search). task_list: title: Task List description: The task list this task belongs to within a folder. workflow_status_category_id: enum: - 1 - 2 - 3 type: integer title: Workflow Status Category description: 'Filter by status category: not started (1), started (2), or closed (3).' person_type: type: integer title: Person Type description: Filter by parent/subtask distinction. repeat_on_monthday: type: integer title: Repeat On Monthday description: Day of the month for monthly recurring tasks. bookable_after: type: string title: Bookable After format: date description: Filter tasks to those bookable after this date. number: title: Number description: Short numeric identifier (alias for task_number). fuzzy_people: type: integer title: Fuzzy People description: Fuzzy match by people related to the task. parent_task_id: type: integer title: Parent Task description: Filter by parent task (to find subtasks of a specific task). subscriber_id: type: integer title: Subscriber description: ID of a person who is subscribed to notifications for this task. organization: title: Organization description: The organization this task belongs to. company_id: type: integer title: Company description: Filter by client company (via the task's project). creator: title: Creator description: The person who created this task. bookings_count: type: integer title: Bookings Count description: Number of scheduled bookings referencing this task. created_at: type: string title: Created At format: date-time description: Timestamp when the task was created. task_list_id: type: integer title: Task List description: ID of the task list (milestone) this task belongs to. last_activity_before: type: string title: Last Activity Before format: date description: Return tasks with last activity before this date. last_actor: title: Last Actor description: The last person who made changes to this task. template_id: type: integer title: Template description: ID of the template this task was created from. last_activity: type: string title: Last Activity format: date description: Timestamp of the most recent activity on this task. description: An assignable work item within a project. Tasks progress through workflow statuses, can have subtasks, belong to task lists and folders, and link to services for time tracking and billing. filter_service_type_assignment: type: object title: Filter service type assignment properties: id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_type_assignment/properties/id" not_contain: "$ref": "#/components/schemas/resource_service_type_assignment/properties/id" contains: "$ref": "#/components/schemas/resource_service_type_assignment/properties/id" eq: "$ref": "#/components/schemas/resource_service_type_assignment/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_service_type_assignment/properties/id" description: Filter by service type assignment ID. person_id: oneOf: - "$ref": "#/components/schemas/resource_service_type_assignment/properties/person_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_type_assignment/properties/person_id" eq: "$ref": "#/components/schemas/resource_service_type_assignment/properties/person_id" contains: "$ref": "#/components/schemas/resource_service_type_assignment/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_service_type_assignment/properties/person_id" description: Filter using explicit operator syntax. description: Filter by the assigned person. service_type_id: oneOf: - "$ref": "#/components/schemas/resource_service_type_assignment/properties/service_type_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_type_assignment/properties/service_type_id" not_eq: "$ref": "#/components/schemas/resource_service_type_assignment/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_service_type_assignment/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_service_type_assignment/properties/service_type_id" description: Filter using explicit operator syntax. description: Filter by the associated service type. patternProperties: {} description: Filter parameters for querying service type assignments. _filter_root_task_list: oneOf: - "$ref": "#/components/schemas/filter_task_list" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_task_list" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `task_list` list endpoints — pass a single condition or a logical group. _filter_root_organization: oneOf: - "$ref": "#/components/schemas/filter_organization" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_organization" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `organization` list endpoints — pass a single condition or a logical group. resource_survey: type: object title: Survey Resource properties: creator: title: Creator description: The person who created this survey. created_at: type: string title: Created At format: date-time description: Timestamp when this survey was created. public_uuid: type: string title: Public Uuid description: Public UUID used to identify this survey in shareable links. updater: title: Updater description: The person who last updated this survey. project: title: Project description: The project this survey is associated with. creator_id: type: integer title: Creator description: ID of the person who created this survey. query: type: string title: Query description: Text search query applied when filtering surveys. updated_at: type: string title: Updated At format: date-time description: Timestamp when this survey was last updated. project_id: type: integer title: Project description: ID of the project this survey is associated with. submission_access: enum: - nobody - project_members - organization - public type: string title: Submission Access description: 'Controls who can submit responses to this survey: nobody, project_members, organization, or public.' editable: type: boolean title: Editable description: Whether the current user can edit this survey. organization: title: Organization description: The organization this survey belongs to. id: type: integer title: Id description: The unique identifier of this survey. title: type: string title: Title description: The title of this survey. description: Project form for structured data collection. Supports automation triggers on submission. Responses are stored as survey_response records with field values. _filter_root_company_report: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_company_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_company_report" description: Filter schema for `company_report` list endpoints — pass a single condition or a logical group. resource_bank_account: type: object title: Bank account Resource properties: bank_address: type: string title: Bank Address description: The physical address of the bank associated with this account. status: enum: - 1 - 2 type: integer title: Status description: The current status of the bank account (e.g. active or archived). name: type: string title: Name description: The display name of the bank account. subsidiary: title: Subsidiary description: The subsidiary this bank account belongs to. number: type: string title: Number description: The bank account number (IBAN or local account number). organization: title: Organization description: The organization this bank account belongs to. subsidiary_id: type: integer title: Subsidiary description: The ID of the subsidiary this bank account belongs to. archived_at: type: string title: Archived At format: date-time description: Timestamp when the bank account was archived, or null if active. bank_name: type: string title: Bank Name description: The name of the bank associated with this account. swift_code: type: string title: Swift Code description: The SWIFT/BIC code identifying the bank in international transactions. id: type: integer title: Id description: Unique identifier for the bank account. currency: type: string title: Currency description: The ISO 4217 currency code for this bank account (e.g. USD, EUR). description: A bank account linked to a subsidiary, storing bank name, account number, currency, and SWIFT details. _filter_root_team_membership: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_team_membership" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_team_membership" description: Filter schema for `team_membership` list endpoints — pass a single condition or a logical group. _filter_root_einvoice_transaction: oneOf: - "$ref": "#/components/schemas/filter_einvoice_transaction" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. example: and patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_einvoice_transaction" description: Object form allowing multiple filter conditions combined with a logical operator. required: - "$op" example: '0': subsidiary_id: '42' "$op": and description: Root filter object for e-invoice transaction resources. Supports combining multiple conditions with logical operators. example: invoice_id: '3456' _filter_root_survey: oneOf: - "$ref": "#/components/schemas/filter_survey" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_survey" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `survey` list endpoints — pass a single condition or a logical group. filter_email: type: object title: Filter email properties: status: oneOf: - "$ref": "#/components/schemas/resource_email/properties/status" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_email/properties/status" contains: "$ref": "#/components/schemas/resource_email/properties/status" not_contain: "$ref": "#/components/schemas/resource_email/properties/status" not_eq: "$ref": "#/components/schemas/resource_email/properties/status" description: Filter using explicit operator syntax. description: Filter by email resolution status (unresolved, resolved, or dismissed). sender_or_recipient_id: oneOf: - "$ref": "#/components/schemas/resource_email/properties/sender_or_recipient_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_email/properties/sender_or_recipient_id" not_eq: "$ref": "#/components/schemas/resource_email/properties/sender_or_recipient_id" contains: "$ref": "#/components/schemas/resource_email/properties/sender_or_recipient_id" not_contain: "$ref": "#/components/schemas/resource_email/properties/sender_or_recipient_id" description: Filter using explicit operator syntax. description: Filter by emails where the given person is the sender or a recipient. after: oneOf: - "$ref": "#/components/schemas/resource_email/properties/after" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_email/properties/after" eq: "$ref": "#/components/schemas/resource_email/properties/after" not_eq: "$ref": "#/components/schemas/resource_email/properties/after" not_contain: "$ref": "#/components/schemas/resource_email/properties/after" description: Filter using explicit operator syntax. description: Filter by after. recipient_id: oneOf: - "$ref": "#/components/schemas/resource_email/properties/recipient_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_email/properties/recipient_id" contains: "$ref": "#/components/schemas/resource_email/properties/recipient_id" eq: "$ref": "#/components/schemas/resource_email/properties/recipient_id" not_eq: "$ref": "#/components/schemas/resource_email/properties/recipient_id" description: Filter using explicit operator syntax. description: Filter by a recipient person. company_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_email/properties/company_id" eq: "$ref": "#/components/schemas/resource_email/properties/company_id" contains: "$ref": "#/components/schemas/resource_email/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_email/properties/company_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_email/properties/company_id" description: Filter by emails associated with a client company (via recipients, linked deal, invoice, or project). before: oneOf: - "$ref": "#/components/schemas/resource_email/properties/before" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_email/properties/before" eq: "$ref": "#/components/schemas/resource_email/properties/before" contains: "$ref": "#/components/schemas/resource_email/properties/before" not_eq: "$ref": "#/components/schemas/resource_email/properties/before" description: Filter using explicit operator syntax. description: Filter by before. creator_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_email/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_email/properties/creator_id" eq: "$ref": "#/components/schemas/resource_email/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_email/properties/creator_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_email/properties/creator_id" description: Filter by the person who sent the email. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_email/properties/id" contains: "$ref": "#/components/schemas/resource_email/properties/id" not_contain: "$ref": "#/components/schemas/resource_email/properties/id" not_eq: "$ref": "#/components/schemas/resource_email/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_email/properties/id" description: Filter by email ID. patternProperties: {} description: Filter parameters for emails. _filter_root_invoice: oneOf: - "$ref": "#/components/schemas/filter_invoice" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_invoice" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `invoice` list endpoints — pass a single condition or a logical group. _filter_root_resource_request: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: The logical operator to combine multiple filter conditions (e.g. `and`, `or`). patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_resource_request" description: Filter parameters for listing resource requests using a logical operator. required: - "$op" - "$ref": "#/components/schemas/filter_resource_request" description: Filter parameters for listing resource requests. _filter_root_payment_report: oneOf: - "$ref": "#/components/schemas/filter_payment_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_payment_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `payment_report` list endpoints — pass a single condition or a logical group. _filter_root_salary: oneOf: - "$ref": "#/components/schemas/filter_salary" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_salary" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `salary` list endpoints — pass a single condition or a logical group. _filter_root_deleted_item: oneOf: - "$ref": "#/components/schemas/filter_deleted_item" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_deleted_item" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `deleted_item` list endpoints — pass a single condition or a logical group. _filter_root_exchange_rate: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_exchange_rate" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_exchange_rate" description: Filter schema for `exchange_rate` list endpoints — pass a single condition or a logical group. _filter_root_proposal: oneOf: - "$ref": "#/components/schemas/filter_proposal" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_proposal" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `proposal` list endpoints — pass a single condition or a logical group. filter_session: type: object title: Filter session properties: machine: oneOf: - "$ref": "#/components/schemas/resource_session/properties/machine" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_session/properties/machine" eq: "$ref": "#/components/schemas/resource_session/properties/machine" not_contain: "$ref": "#/components/schemas/resource_session/properties/machine" not_eq: "$ref": "#/components/schemas/resource_session/properties/machine" description: Filter using explicit operator syntax. description: Filter to include only machine (non-human) sessions. read_only: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_session/properties/read_only" eq: "$ref": "#/components/schemas/resource_session/properties/read_only" not_eq: "$ref": "#/components/schemas/resource_session/properties/read_only" not_contain: "$ref": "#/components/schemas/resource_session/properties/read_only" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_session/properties/read_only" description: Filter to include only read-only sessions. creator_id: oneOf: - "$ref": "#/components/schemas/resource_session/properties/creator_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_session/properties/creator_id" contains: "$ref": "#/components/schemas/resource_session/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_session/properties/creator_id" eq: "$ref": "#/components/schemas/resource_session/properties/creator_id" description: Filter using explicit operator syntax. description: Filter by the person who created the session. patternProperties: {} description: Filter parameters for OAuth sessions. _filter_root_holiday_calendar: oneOf: - "$ref": "#/components/schemas/filter_holiday_calendar" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_holiday_calendar" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `holiday_calendar` list endpoints — pass a single condition or a logical group. resource_placeholder: type: object title: Placeholder Resource properties: usage_project_id: type: integer title: Usage Project description: Filter placeholders to those used in tasks or todos within the specified project. created_at: type: string title: Created At format: date-time description: Timestamp when this placeholder was created. id: type: integer title: Id description: The unique identifier of this placeholder. color: type: string title: Color description: The color identifier used to visually represent this placeholder. updated_at: type: string title: Updated At format: date-time description: Timestamp when this placeholder was last updated. name: type: string title: Name description: The display name of this placeholder (e.g. Frontend Developer). organization: title: Organization description: The organization this placeholder belongs to. project: title: Project description: The project this placeholder is scoped to, or null if it is organization-wide. query: type: string title: Query description: A text search query to filter placeholders by name. project_id: type: integer title: Project description: ID of the project this placeholder is scoped to, or null if it is organization-wide. type: enum: - person - date type: string title: Type description: The type of placeholder, either person or date. icon: type: string title: Icon description: The icon identifier used to visually represent this placeholder. category: enum: - project type: string title: Category description: The category of this placeholder, indicating the context in which it is used (e.g. project). description: A named generic resource used in task assignment and scheduling without mapping to a specific person. filter_entitlement_report: type: object title: Filter entitlement report properties: event_id: oneOf: - "$ref": "#/components/schemas/resource_entitlement_report/properties/event_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_entitlement_report/properties/event_id" eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/event_id" not_eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/event_id" contains: "$ref": "#/components/schemas/resource_entitlement_report/properties/event_id" description: Filter operator object for event id. description: Filter entitlement report results by event id. allocated: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/allocated" eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/allocated" contains: "$ref": "#/components/schemas/resource_entitlement_report/properties/allocated" not_contain: "$ref": "#/components/schemas/resource_entitlement_report/properties/allocated" description: Filter operator object for allocated. - "$ref": "#/components/schemas/resource_entitlement_report/properties/allocated" description: Filter entitlement report results by allocated. start_date: oneOf: - "$ref": "#/components/schemas/resource_entitlement_report/properties/start_date" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_entitlement_report/properties/start_date" not_contain: "$ref": "#/components/schemas/resource_entitlement_report/properties/start_date" not_eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/start_date" eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/start_date" description: Filter operator object for start date. description: Filter entitlement report results by start date. used: oneOf: - "$ref": "#/components/schemas/resource_entitlement_report/properties/used" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_entitlement_report/properties/used" eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/used" not_eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/used" not_contain: "$ref": "#/components/schemas/resource_entitlement_report/properties/used" description: Filter operator object for used. description: Filter entitlement report results by used. id: oneOf: - "$ref": "#/components/schemas/resource_entitlement_report/properties/id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_entitlement_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/id" contains: "$ref": "#/components/schemas/resource_entitlement_report/properties/id" eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/id" description: Filter operator object for id. description: Filter entitlement report results by id. date: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/date" eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/date" contains: "$ref": "#/components/schemas/resource_entitlement_report/properties/date" not_contain: "$ref": "#/components/schemas/resource_entitlement_report/properties/date" description: Filter operator object for date. - "$ref": "#/components/schemas/resource_entitlement_report/properties/date" description: Filter entitlement report results by date. person_id: oneOf: - "$ref": "#/components/schemas/resource_entitlement_report/properties/person_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_entitlement_report/properties/person_id" contains: "$ref": "#/components/schemas/resource_entitlement_report/properties/person_id" description: Filter operator object for person id. description: Filter entitlement report results by person id. end_date: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/end_date" not_contain: "$ref": "#/components/schemas/resource_entitlement_report/properties/end_date" contains: "$ref": "#/components/schemas/resource_entitlement_report/properties/end_date" eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/end_date" description: Filter operator object for end date. - "$ref": "#/components/schemas/resource_entitlement_report/properties/end_date" description: Filter entitlement report results by end date. formulas: oneOf: - "$ref": "#/components/schemas/resource_entitlement_report/properties/formulas" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_entitlement_report/properties/formulas" not_contain: "$ref": "#/components/schemas/resource_entitlement_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/formulas" description: Filter operator object for formulas. description: Filter entitlement report results by formulas. absence_type: oneOf: - "$ref": "#/components/schemas/resource_entitlement_report/properties/absence_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_entitlement_report/properties/absence_type" not_eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/absence_type" eq: "$ref": "#/components/schemas/resource_entitlement_report/properties/absence_type" contains: "$ref": "#/components/schemas/resource_entitlement_report/properties/absence_type" description: Filter operator object for absence type. description: Filter entitlement report results by absence type. patternProperties: "^event..*$": title: Event relationship "^person..*$": title: Person relationship description: Available filter parameters for querying aggregated entitlement report data. filter_survey_field_option: type: object title: Filter survey field option properties: survey_field_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_survey_field_option/properties/survey_field_id" contains: "$ref": "#/components/schemas/resource_survey_field_option/properties/survey_field_id" not_eq: "$ref": "#/components/schemas/resource_survey_field_option/properties/survey_field_id" not_contain: "$ref": "#/components/schemas/resource_survey_field_option/properties/survey_field_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_survey_field_option/properties/survey_field_id" description: Filter by the associated survey field. archived: oneOf: - "$ref": "#/components/schemas/resource_survey_field_option/properties/archived" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_survey_field_option/properties/archived" eq: "$ref": "#/components/schemas/resource_survey_field_option/properties/archived" not_eq: "$ref": "#/components/schemas/resource_survey_field_option/properties/archived" contains: "$ref": "#/components/schemas/resource_survey_field_option/properties/archived" description: Filter using explicit operator syntax. description: Filter to include only archived (or non-archived) field options. custom_field_id: oneOf: - "$ref": "#/components/schemas/resource_survey_field_option/properties/custom_field_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_survey_field_option/properties/custom_field_id" not_contain: "$ref": "#/components/schemas/resource_survey_field_option/properties/custom_field_id" contains: "$ref": "#/components/schemas/resource_survey_field_option/properties/custom_field_id" not_eq: "$ref": "#/components/schemas/resource_survey_field_option/properties/custom_field_id" description: Filter using explicit operator syntax. description: Filter by the associated custom field. patternProperties: {} description: Filter parameters for survey field options. resource_deal_cost_rate: type: object title: Deal cost rate Resource properties: deal: title: Deal description: The deal (budget) this cost rate applies to. organization: title: Organization description: The organization this deal cost rate belongs to. deal_id: type: integer title: Deal description: The ID of the deal (budget) this cost rate applies to. person: title: Person description: The person this cost rate applies to. rate_cents: type: number title: Rate Cents description: The cost rate in cents (smallest currency unit). person_id: type: integer title: Person description: The ID of the person this cost rate applies to. currency: type: string title: Currency description: The currency of the cost rate. description: A person-specific cost rate override for a deal, used when the person's cost differs from the standard salary rate. resource_report_category: type: object title: Report category Resource properties: deleted_at: type: string title: Deleted At format: date-time description: Timestamp when this report category was deleted. organization: title: Organization description: The organization this report category belongs to. position: type: integer title: Position description: Display order position of this report category. color_id: type: integer title: Color description: Color identifier for this report category. name: type: string title: Name description: Display name of this report category. description: An aggregated report category resource grouping saved report filters. _filter_root_lost_reason: oneOf: - "$ref": "#/components/schemas/filter_lost_reason" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_lost_reason" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `lost_reason` list endpoints — pass a single condition or a logical group. resource_notification: type: object title: Notification Resource properties: actor: title: Actor description: The person who performed the action that triggered this notification. last_action_at: type: string title: Last Action At format: date-time description: Timestamp of the most recent activity that updated this notification. mention: type: boolean title: Mention description: When true, the current user was directly mentioned in the content that triggered this notification. dismissed: type: boolean title: Dismissed description: When true, this notification has been dismissed by the user. target_id: type: integer title: Target description: The ID of the target resource this notification is about. date_before: type: string title: Date Before format: date description: The start of the date range for filtering notification activity. target_title: title: Target Title description: The display name of the target resource this notification is about. type: type: string title: Type description: Filters notifications by the target resource type (e.g. task, deal, project, page, invoice). before: type: string title: Before format: date-time description: The value of the changed field before the action that triggered this notification. after: type: string title: After format: date-time description: The value of the changed field after the action that triggered this notification. owner: title: Owner description: The organization membership (inbox) that owns this notification. parent_type: title: Parent Type description: The type of the parent resource containing the notification target. title: title: Title description: The localized title text describing what happened in this notification. target_label: title: Target Label description: A human-readable label for the notification target type (e.g. 'budget' for production pipeline deals). new_activities_count: title: New Activities Count description: The number of new activity events since the notification was last read. date_after: type: string title: Date After format: date description: The end of the date range for filtering notification activity. excerpt: title: Excerpt description: A short preview of the content that triggered this notification. parent_title: title: Parent Title description: The display name of the parent resource containing the notification target. target_type: type: string title: Target Type description: The type of the target resource this notification is about (e.g. task, deal, project). made_by_automation: title: Made By Automation description: When true, this notification was triggered by an automation rule rather than a person. id: type: integer title: Id description: Unique identifier for the notification. first_unread_activity_id: type: integer title: First Unread Activity description: ID of the first unread activity in this notification thread. important: type: boolean title: Important description: When true, this notification is marked as important and shown prominently in the inbox. root_id: type: integer title: Root description: The ID of the root resource this notification traces back to (e.g. for shared report membership). parent_id: type: integer title: Parent description: The ID of the parent resource containing the notification target (e.g. project ID for a task). project_id: type: integer title: Project description: The ID of the project associated with the notification target. changeset: title: Changeset description: A summary of the field changes that triggered this notification. root_type: title: Root Type description: The type of the root resource this notification traces back to. read: type: boolean title: Read description: When true, the current user has read this notification. organization: title: Organization description: The organization this notification belongs to. description: An inbox notification for a user about changes to subscribed entities. filter_new_time_report: type: object title: Filter new time report properties: formulas: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/formulas" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/formulas" description: Filter operator object for formulas. - "$ref": "#/components/schemas/resource_new_time_report/properties/formulas" description: Filter using report formula expressions for computed metrics. stage_type: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/stage_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/stage_type" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/stage_type" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/stage_type" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/stage_type" description: Filter operator object for stage type. description: Filter by the budget's deal stage type (e.g. active, delivered). role_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/role_id" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/role_id" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/role_id" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/role_id" description: Filter operator object for role id. - "$ref": "#/components/schemas/resource_new_time_report/properties/role_id" description: Filter by the person's role. project_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_new_time_report/properties/project_type" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/project_type" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/project_type" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/project_type" description: Filter operator object for project type. - "$ref": "#/components/schemas/resource_new_time_report/properties/project_type" description: Filter by project type (billable or internal). company_id: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/company_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_new_time_report/properties/company_id" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/company_id" description: Filter operator object for company id. description: Filter by client company. person_tags: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_new_time_report/properties/person_tags" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/person_tags" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/person_tags" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/person_tags" description: Filter operator object for person tags. - "$ref": "#/components/schemas/resource_new_time_report/properties/person_tags" description: Filter by tags on the associated person. people_custom_fields: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/people_custom_fields" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/people_custom_fields" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/people_custom_fields" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/people_custom_fields" description: Filter operator object for people custom fields. - "$ref": "#/components/schemas/resource_new_time_report/properties/people_custom_fields" description: Filter by custom field values on the associated person. bookings_after: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_after" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_after" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_after" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_after" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_after" description: Filter operator object for bookings after. description: Filter to time entries for bookings that end on or after this date. person_type: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_new_time_report/properties/person_type" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/person_type" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/person_type" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/person_type" description: Filter operator object for person type. - "$ref": "#/components/schemas/resource_new_time_report/properties/person_type" description: Filter by person type (employee, contractor, etc.). subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/subsidiary_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/subsidiary_id" description: Filter operator object for subsidiary id. description: Filter by subsidiary (workplace) ID. budget_tags: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/budget_tags" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/budget_tags" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/budget_tags" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/budget_tags" description: Filter operator object for budget tags. - "$ref": "#/components/schemas/resource_new_time_report/properties/budget_tags" description: Filter by tags on the associated budget. date: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/date" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/date" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/date" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/date" description: Filter operator object for date. - "$ref": "#/components/schemas/resource_new_time_report/properties/date" description: Filter by specific date. Accepts a date string or filter operators. after: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/after" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/after" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/after" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/after" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/after" description: Filter operator object for after. description: Filter by the report end date (exclusive upper bound). Accepts a date string or filter operators. person_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_new_time_report/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/person_id" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/person_id" description: Filter operator object for person id. - "$ref": "#/components/schemas/resource_new_time_report/properties/person_id" description: Filter by specific person. bookings_custom_fields: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_custom_fields" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_custom_fields" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_custom_fields" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_custom_fields" description: Filter operator object for bookings custom fields. - "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_custom_fields" description: Filter by custom field values on the associated booking. year: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/year" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_new_time_report/properties/year" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/year" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/year" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/year" description: Filter operator object for year. description: 'Deprecated: filter by a specific year (use date range filters instead).' week: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_new_time_report/properties/week" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/week" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/week" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/week" description: Filter operator object for week. - "$ref": "#/components/schemas/resource_new_time_report/properties/week" description: 'Deprecated: filter by a specific week (use date range filters instead).' quarter: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/quarter" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/quarter" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/quarter" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/quarter" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/quarter" description: Filter operator object for quarter. description: 'Deprecated: filter by a specific quarter (use date range filters instead).' bookings_before: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_before" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_before" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_before" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_before" description: Filter operator object for bookings before. - "$ref": "#/components/schemas/resource_new_time_report/properties/bookings_before" description: Filter to time entries for bookings that start on or before this date. service_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_new_time_report/properties/service_id" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/service_id" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/service_id" description: Filter operator object for service id. - "$ref": "#/components/schemas/resource_new_time_report/properties/service_id" description: Filter by the associated service. budget_id: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/budget_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/budget_id" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/budget_id" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/budget_id" description: Filter operator object for budget id. description: Filter by budget (deal) ID. month: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/month" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/month" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/month" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/month" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/month" description: Filter operator object for month. description: 'Deprecated: filter by a specific month (use date range filters instead).' event_id: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/event_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_new_time_report/properties/event_id" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/event_id" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/event_id" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/event_id" description: Filter operator object for event id. description: Filter by absence category (event) ID. project_id: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/project_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/project_id" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/project_id" description: Filter operator object for project id. description: Filter by the associated project. future: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/future" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/future" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/future" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/future" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/future" description: Filter operator object for future. description: Filter to include future or past data. When true, includes future scheduled data. day: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_new_time_report/properties/day" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/day" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/day" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/day" description: Filter operator object for day. - "$ref": "#/components/schemas/resource_new_time_report/properties/day" description: 'Deprecated: filter by a specific day (use date range filters instead).' billing_type: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/billing_type" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/billing_type" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/billing_type" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/billing_type" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/billing_type" description: Filter operator object for billing type. description: Filter by billing type of the associated service. service_type_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_new_time_report/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/service_type_id" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/service_type_id" description: Filter operator object for service type id. - "$ref": "#/components/schemas/resource_new_time_report/properties/service_type_id" description: Filter by the associated service type. role_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_new_time_report/properties/role_type" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/role_type" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/role_type" contains: "$ref": "#/components/schemas/resource_new_time_report/properties/role_type" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_new_time_report/properties/role_type" description: Filter by the role type category of the person who tracked time. before: oneOf: - "$ref": "#/components/schemas/resource_new_time_report/properties/before" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_new_time_report/properties/before" not_contain: "$ref": "#/components/schemas/resource_new_time_report/properties/before" not_eq: "$ref": "#/components/schemas/resource_new_time_report/properties/before" eq: "$ref": "#/components/schemas/resource_new_time_report/properties/before" description: Filter operator object for before. description: Filter by the report start date (inclusive lower bound). Accepts a date string or filter operators. patternProperties: "^event..*$": title: Event relationship "^person..*$": title: Person relationship "^service..*$": title: Service relationship "^time_entry..*$": title: Time entry relationship description: Available filter parameters for querying the time report. filter_tax_rate: type: object title: Filter tax rate properties: primary_component_name: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_name" not_contain: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_name" eq: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_name" not_eq: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_name" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_name" description: Filter by the name of the primary tax component. primary_component_value: oneOf: - "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_value" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_value" not_contain: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_value" eq: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_value" not_eq: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_value" description: Filter using explicit operator syntax. description: Filter by the value of the primary tax component. secondary_component_value: oneOf: - "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_value" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_value" not_contain: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_value" contains: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_value" not_eq: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_value" description: Filter using explicit operator syntax. description: Filter by the value of the secondary tax component. status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_tax_rate/properties/status" not_contain: "$ref": "#/components/schemas/resource_tax_rate/properties/status" eq: "$ref": "#/components/schemas/resource_tax_rate/properties/status" contains: "$ref": "#/components/schemas/resource_tax_rate/properties/status" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_tax_rate/properties/status" description: Filter by status (active or archived). name: oneOf: - "$ref": "#/components/schemas/resource_tax_rate/properties/name" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_tax_rate/properties/name" not_contain: "$ref": "#/components/schemas/resource_tax_rate/properties/name" contains: "$ref": "#/components/schemas/resource_tax_rate/properties/name" not_eq: "$ref": "#/components/schemas/resource_tax_rate/properties/name" description: Filter using explicit operator syntax. description: Filter by tax rate name (text search). secondary_component_name: oneOf: - "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_name" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_name" not_eq: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_name" contains: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_name" eq: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_name" description: Filter using explicit operator syntax. description: Filter by the name of the secondary tax component. id: oneOf: - "$ref": "#/components/schemas/resource_tax_rate/properties/id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_tax_rate/properties/id" not_contain: "$ref": "#/components/schemas/resource_tax_rate/properties/id" eq: "$ref": "#/components/schemas/resource_tax_rate/properties/id" contains: "$ref": "#/components/schemas/resource_tax_rate/properties/id" description: Filter using explicit operator syntax. description: Filter by ID. patternProperties: "^subsidiary..*$": title: Subsidiary relationship description: Filter parameters for tax rates. resource_comment: type: object title: Comment Resource properties: deal_id: type: integer title: Deal description: The ID of the deal this comment is associated with. person: title: Person description: The person who authored this comment. status_id: type: integer title: Status description: The ID of the workflow status referenced in this comment's activity context. discussion: title: Discussion description: The discussion thread this comment belongs to, if posted in a doc discussion. person_type: type: integer title: Person Type description: The type of person who authored this comment (e.g. member, client). resource_request_id: type: integer title: Resource Request description: The ID of the resource request this comment belongs to, if applicable. updated_at: type: string title: Updated At format: date-time description: Timestamp when this comment was last updated. fuzzy_people: type: integer title: Fuzzy People description: Fuzzy person references extracted from this comment for search purposes. jump_query: type: string title: Jump Query description: A query string used to deep-link to the specific comment location in the UI. reactions: type: object title: Reactions description: Emoji reactions on this comment, keyed by emoji with people and timestamps. workflow_status_category_id: type: string title: Workflow Status Category description: The ID of the workflow status category referenced in this comment's activity context. responsible_id: type: integer title: Responsible description: The ID of the project manager (responsible person) in an activity comment context. proposal_id: type: integer title: Proposal description: The ID of the proposal this comment belongs to, if applicable. company_id: type: integer title: Company description: The ID of the company this comment is associated with. pinned_at: type: string title: Pinned At format: date-time description: Timestamp when this comment was pinned, or null if not pinned. pinned_by: title: Pinned By description: The person who pinned this comment. fuzzy_dates: type: string title: Fuzzy Dates format: date description: Fuzzy date tokens extracted from this comment for search purposes. role_id: type: integer title: Role description: The ID of the role referenced in this comment's activity context. project: title: Project description: The project this comment belongs to, derived from the commentable resource. edited_at: type: string title: Edited At format: date-time description: Timestamp when this comment was last edited. sales_status_id: type: integer title: Sales Status description: The ID of the sales status referenced in this comment's activity context. creator: title: Creator description: The person who created this comment. public_access: type: boolean title: Public Access description: Indicates whether this comment is publicly accessible without authentication. invoice: title: Invoice description: The invoice associated with this comment, if the comment is on an invoice. hidden: type: boolean title: Hidden description: Whether this comment is hidden from the activity feed (moderated or removed). page_id: type: integer title: Page description: The ID of the page this comment belongs to, if applicable. purchase_order: title: Purchase Order description: The purchase order this comment belongs to, if applicable. example: data: type: purchase_orders id: '1234567' deleted_at: type: string title: Deleted At format: date-time description: Timestamp when this comment was soft-deleted. Null if not deleted. created_at: type: string title: Created At format: date-time description: Timestamp when this comment was created. body: type: string title: Body description: The HTML body of the comment including rich text formatting and @mention markup. budget_status: type: integer title: Budget Status description: The budget status context when this comment was posted (for deal-related comments). purchase_order_id: type: integer title: Purchase Order description: The ID of the purchase order this comment belongs to, if applicable. example: 1234567 attachments: title: Attachments description: File attachments included in this comment. status: type: integer title: Status description: The status label referenced in this comment's activity context. attachment_ids: title: Attachment Ids description: IDs of attachments to add to this comment when creating or updating. task_id: type: integer title: Task description: The ID of the task this comment belongs to, if applicable. deal: title: Deal description: The deal this comment is associated with, if posted on a deal's activity feed. full_query: type: string title: Full Query description: Full-text search query context for this comment. invoice_id: type: integer title: Invoice description: The ID of the invoice this comment belongs to, if applicable. commentable_project_id: type: integer title: Commentable Project description: ID of the project this comment belongs to, derived from the commentable resource. commentable_type: type: string title: Commentable Type description: The type of the parent entity this comment is posted on (e.g. task, deal, company). task: title: Task description: The task this comment belongs to, if applicable. discussion_id: type: integer title: Discussion description: The ID of the discussion thread this comment belongs to. version_number: type: integer title: Version Number description: The version number of this comment, incremented on each edit. project_id: type: integer title: Project description: The ID of the project this comment belongs to, if applicable. organization: title: Organization description: The organization this comment belongs to. person_id: type: integer title: Person description: The ID of the person who authored this comment. draft: type: boolean title: Draft description: Whether this comment is a draft (not yet published and not visible to others). company: title: Company description: The company this comment is associated with, if posted on a company's activity feed. description: A message in the activity feed of a task, deal, company, or other entity. Comments support rich text, @mentions, and file attachments. _filter_root_service_type_assignment: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_service_type_assignment" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_service_type_assignment" description: Filter schema for `service_type_assignment` list endpoints — pass a single condition or a logical group. _filter_root_new_salary_report: oneOf: - "$ref": "#/components/schemas/filter_new_salary_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_new_salary_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `new_salary_report` list endpoints — pass a single condition or a logical group. _filter_root_contract: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_contract" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_contract" description: Filter schema for `contract` list endpoints — pass a single condition or a logical group. resource_einvoice_transaction: type: object title: E-invoice Transaction Resource properties: sender: title: Sender description: The person who initiated the e-invoice submission. example: data: type: people id: '78' invoice_id: type: integer title: Invoice description: ID of the invoice that was sent as an e-invoice. example: '3456' invoice: title: Invoice description: The invoice that was sent as an e-invoice. example: data: type: invoices id: '3456' fiscalization_failed_reason: type: string title: Fiscalization Failed Reason description: Human-readable description of why the fiscalization step failed. example: sender_routing_id: type: string title: Sender Routing Id description: The sender's e-invoicing routing identifier. example: '0088:9876543210123' fiscalization_failed_at: type: string title: Fiscalization Failed At format: date-time description: Timestamp when the fiscalization (tax authority clearance) step failed. example: failed_at: type: string title: Failed At format: date-time description: Timestamp when the e-invoice delivery failed. Null if the transaction has not failed. example: delivered_at: type: string title: Delivered At format: date-time description: Timestamp when the e-invoice was successfully delivered to the recipient. example: '2025-05-20T12:00:00.000Z' failed_reason: type: string title: Failed Reason description: Human-readable description of why the e-invoice delivery failed. example: updated_at: type: string title: Updated At format: date-time description: Timestamp when the record was last updated. example: '2025-06-01T14:22:00.000Z' format_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 type: integer title: Format description: Numeric identifier for the e-invoice format used in this transaction (e.g., 1 = PEPPOL BIS 3.0, 2 = XRechnung, 3 = FACe, 4 = Fiskalizacija, 5 = KSeF). example: 1 created_at: type: string title: Created At format: date-time description: Timestamp when the record was created. example: '2025-03-15T10:30:00.000Z' tax_cleared_at: type: string title: Tax Cleared At format: date-time description: Timestamp when the e-invoice was cleared by the tax authority (applicable for fiscalization-required formats). example: receiver_routing_id: type: string title: Receiver Routing Id description: The recipient's e-invoicing routing identifier (e.g., PEPPOL ID, SDI code, or FACe code). example: '0088:1234567890123' description: 'Represents a single e-invoice submission attempt for an invoice. Created automatically when an invoice is sent as an e-invoice via `POST /invoices/{id}/send_einvoice`. Tracks the full lifecycle: format used, sender and receiver routing IDs, delivery status, and any failure or fiscalization error details. Transactions are read-only.' example: id: '9012' type: einvoice_transactions attributes: format_id: 1 sender_routing_id: '0088:9876543210123' receiver_routing_id: '0088:1234567890123' delivered_at: '2025-05-20T12:00:00.000Z' failed_at: failed_reason: tax_cleared_at: fiscalization_failed_at: fiscalization_failed_reason: created_at: '2025-05-20T11:55:00.000Z' updated_at: '2025-05-20T12:00:00.000Z' relationships: invoice: data: type: invoices id: '3456' sender: data: type: people id: '78' _filter_root_person: oneOf: - "$ref": "#/components/schemas/filter_person" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_person" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `person` list endpoints — pass a single condition or a logical group. _filter_root_todo: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_todo" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_todo" description: Filter schema for `todo` list endpoints — pass a single condition or a logical group. filter_invoice: type: object title: Filter invoice properties: amount_paid: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/amount_paid" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/amount_paid" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_paid" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/amount_paid" eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_paid" description: Filter amount_paid using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Amount already paid (base currency). Supports filtering by exact match, exclusion, and containment operators. sent_status: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/sent_status" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice/properties/sent_status" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/sent_status" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/sent_status" contains: "$ref": "#/components/schemas/resource_invoice/properties/sent_status" description: Filter sent_status using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Sent status of the invoice. Supports filtering by exact match, exclusion, and containment operators. fuzzy_dates: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/fuzzy_dates" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_invoice/properties/fuzzy_dates" description: Filter fuzzy_dates using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/fuzzy_dates" description: Fuzzy date search across date fields. Supports filtering by exact match, exclusion, and containment operators. invoice_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice/properties/invoice_type" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/invoice_type" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/invoice_type" contains: "$ref": "#/components/schemas/resource_invoice/properties/invoice_type" description: Filter invoice_type using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/invoice_type" description: Invoice type (standard invoice or credit note). Supports filtering by exact match, exclusion, and containment operators. created_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/created_at" eq: "$ref": "#/components/schemas/resource_invoice/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/created_at" description: Filter created_at using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/created_at" description: Invoice creation timestamp. Supports filtering by exact match, exclusion, and containment operators. last_activity_at: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/last_activity_at" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/last_activity_at" contains: "$ref": "#/components/schemas/resource_invoice/properties/last_activity_at" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/last_activity_at" eq: "$ref": "#/components/schemas/resource_invoice/properties/last_activity_at" description: Filter last_activity_at using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Date of last activity on this invoice. Supports filtering by exact match, exclusion, and containment operators. creator_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/creator_id" contains: "$ref": "#/components/schemas/resource_invoice/properties/creator_id" description: Filter creator_id using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/creator_id" description: Creator person ID. Supports filtering by exact match, exclusion, and containment operators. parent_company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_invoice/properties/parent_company_id" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_invoice/properties/parent_company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_invoice/properties/parent_company_id" description: Filter by the parent company of the invoice's company. amount_credited_with_tax: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_with_tax" eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_with_tax" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_with_tax" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_with_tax" description: Filter amount_credited_with_tax using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_with_tax" description: Amount credited including tax (base currency). Supports filtering by exact match, exclusion, and containment operators. subscriber_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice/properties/subscriber_id" eq: "$ref": "#/components/schemas/resource_invoice/properties/subscriber_id" contains: "$ref": "#/components/schemas/resource_invoice/properties/subscriber_id" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/subscriber_id" description: Filter subscriber_id using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/subscriber_id" description: Subscriber person ID. Supports filtering by exact match, exclusion, and containment operators. payment_status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/payment_status" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/payment_status" eq: "$ref": "#/components/schemas/resource_invoice/properties/payment_status" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/payment_status" description: Filter payment_status using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/payment_status" description: Payment status of the invoice. Supports filtering by exact match, exclusion, and containment operators. invoiced_on: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/invoiced_on" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice/properties/invoiced_on" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/invoiced_on" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/invoiced_on" contains: "$ref": "#/components/schemas/resource_invoice/properties/invoiced_on" description: Filter invoiced_on using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Date when the invoice was issued. Supports filtering by exact match, exclusion, and containment operators. delivery_on: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/delivery_on" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice/properties/delivery_on" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/delivery_on" contains: "$ref": "#/components/schemas/resource_invoice/properties/delivery_on" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/delivery_on" description: Filter delivery_on using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Date when goods or services were delivered. Supports filtering by exact match, exclusion, and containment operators. query: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice/properties/query" contains: "$ref": "#/components/schemas/resource_invoice/properties/query" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/query" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/query" description: Filter query using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/query" description: Search term across invoice text fields. Supports filtering by exact match, exclusion, and containment operators. overdue_status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/overdue_status" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/overdue_status" eq: "$ref": "#/components/schemas/resource_invoice/properties/overdue_status" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/overdue_status" description: Filter overdue_status using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/overdue_status" description: Overdue status of the invoice. Supports filtering by exact match, exclusion, and containment operators. amount_with_tax: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/amount_with_tax" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_with_tax" eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_with_tax" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/amount_with_tax" contains: "$ref": "#/components/schemas/resource_invoice/properties/amount_with_tax" description: Filter amount_with_tax using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Invoice total including tax (base currency). Supports filtering by exact match, exclusion, and containment operators. payment_terms: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/payment_terms" eq: "$ref": "#/components/schemas/resource_invoice/properties/payment_terms" contains: "$ref": "#/components/schemas/resource_invoice/properties/payment_terms" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/payment_terms" description: Filter payment_terms using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/payment_terms" description: Number of days between invoice issue date and due date. Supports filtering by exact match, exclusion, and containment operators. company_id: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/company_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/company_id" eq: "$ref": "#/components/schemas/resource_invoice/properties/company_id" description: Filter company_id using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Client company ID. Supports filtering by exact match, exclusion, and containment operators. project_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice/properties/project_id" contains: "$ref": "#/components/schemas/resource_invoice/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/project_id" description: Filter project_id using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/project_id" description: Project ID. Supports filtering by exact match, exclusion, and containment operators. tags: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/tags" eq: "$ref": "#/components/schemas/resource_invoice/properties/tags" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/tags" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/tags" description: Filter tags using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/tags" description: Tags applied to this invoice. Supports filtering by exact match, exclusion, and containment operators. subsidiary_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_invoice/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_invoice/properties/subsidiary_id" description: Filter subsidiary_id using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/subsidiary_id" description: Issuing subsidiary ID. Supports filtering by exact match, exclusion, and containment operators. invoicing_method: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/invoicing_method" contains: "$ref": "#/components/schemas/resource_invoice/properties/invoicing_method" eq: "$ref": "#/components/schemas/resource_invoice/properties/invoicing_method" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/invoicing_method" description: Filter invoicing_method using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/invoicing_method" description: Invoicing method used to generate line items. Supports filtering by exact match, exclusion, and containment operators. paid_on: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/paid_on" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/paid_on" contains: "$ref": "#/components/schemas/resource_invoice/properties/paid_on" eq: "$ref": "#/components/schemas/resource_invoice/properties/paid_on" description: Filter paid_on using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/paid_on" description: Date when the invoice was paid. Supports filtering by exact match, exclusion, and containment operators. status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/status" contains: "$ref": "#/components/schemas/resource_invoice/properties/status" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/status" eq: "$ref": "#/components/schemas/resource_invoice/properties/status" description: Filter status using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/status" description: General status filter. Supports filtering by exact match, exclusion, and containment operators. pay_on: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/pay_on" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/pay_on" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/pay_on" eq: "$ref": "#/components/schemas/resource_invoice/properties/pay_on" description: Filter pay_on using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/pay_on" description: Due date for payment. Supports filtering by exact match, exclusion, and containment operators. number: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/number" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice/properties/number" contains: "$ref": "#/components/schemas/resource_invoice/properties/number" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/number" eq: "$ref": "#/components/schemas/resource_invoice/properties/number" description: Filter number using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Invoice number. Supports filtering by exact match, exclusion, and containment operators. invoice_status: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/invoice_status" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/invoice_status" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/invoice_status" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/invoice_status" eq: "$ref": "#/components/schemas/resource_invoice/properties/invoice_status" description: Filter invoice_status using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Invoice payment status. Supports filtering by exact match, exclusion, and containment operators. automatically_created: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/automatically_created" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/automatically_created" eq: "$ref": "#/components/schemas/resource_invoice/properties/automatically_created" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/automatically_created" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/automatically_created" description: Filter automatically_created using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Whether the invoice was automatically generated from a template. Supports filtering by exact match, exclusion, and containment operators. custom_fields: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/custom_fields" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_invoice/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/custom_fields" description: Filter custom_fields using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Custom field values. Supports filtering by exact match, exclusion, and containment operators. id: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice/properties/id" contains: "$ref": "#/components/schemas/resource_invoice/properties/id" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/id" eq: "$ref": "#/components/schemas/resource_invoice/properties/id" description: Filter id using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Invoice ID. Supports filtering by exact match, exclusion, and containment operators. jump_query: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/jump_query" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/jump_query" contains: "$ref": "#/components/schemas/resource_invoice/properties/jump_query" description: Filter jump_query using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Quick search term across key invoice fields. Supports filtering by exact match, exclusion, and containment operators. deal_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/deal_id" eq: "$ref": "#/components/schemas/resource_invoice/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/deal_id" description: Filter deal_id using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/deal_id" description: Budget (deal) ID. Supports filtering by exact match, exclusion, and containment operators. amount_unpaid: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/amount_unpaid" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/amount_unpaid" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_unpaid" eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_unpaid" description: Filter amount_unpaid using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/amount_unpaid" description: Outstanding balance (base currency). Supports filtering by exact match, exclusion, and containment operators. currency: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/currency" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/currency" eq: "$ref": "#/components/schemas/resource_invoice/properties/currency" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/currency" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/currency" description: Filter currency using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Invoice currency code. Supports filtering by exact match, exclusion, and containment operators. issuer_id: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/issuer_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice/properties/issuer_id" eq: "$ref": "#/components/schemas/resource_invoice/properties/issuer_id" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/issuer_id" contains: "$ref": "#/components/schemas/resource_invoice/properties/issuer_id" description: Filter issuer_id using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Issuer person ID. Supports filtering by exact match, exclusion, and containment operators. sent_on: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/sent_on" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice/properties/sent_on" contains: "$ref": "#/components/schemas/resource_invoice/properties/sent_on" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/sent_on" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/sent_on" description: Filter sent_on using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Date when the invoice was sent to the client. Supports filtering by exact match, exclusion, and containment operators. fuzzy_people: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/fuzzy_people" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_invoice/properties/fuzzy_people" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_invoice/properties/fuzzy_people" description: Filter fuzzy_people using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Fuzzy people search across person-related fields. Supports filtering by exact match, exclusion, and containment operators. full_query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/full_query" eq: "$ref": "#/components/schemas/resource_invoice/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/full_query" description: Filter full_query using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/full_query" description: Full-text search across invoice fields. Supports filtering by exact match, exclusion, and containment operators. credited: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/credited" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/credited" contains: "$ref": "#/components/schemas/resource_invoice/properties/credited" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/credited" eq: "$ref": "#/components/schemas/resource_invoice/properties/credited" description: Filter credited using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Whether this invoice has been credited. Supports filtering by exact match, exclusion, and containment operators. parent_invoice_id: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/parent_invoice_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice/properties/parent_invoice_id" eq: "$ref": "#/components/schemas/resource_invoice/properties/parent_invoice_id" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/parent_invoice_id" contains: "$ref": "#/components/schemas/resource_invoice/properties/parent_invoice_id" description: Filter parent_invoice_id using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Parent invoice ID (for credit notes). Supports filtering by exact match, exclusion, and containment operators. export_status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice/properties/export_status" eq: "$ref": "#/components/schemas/resource_invoice/properties/export_status" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/export_status" contains: "$ref": "#/components/schemas/resource_invoice/properties/export_status" description: Filter export_status using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/export_status" description: Export status to external accounting software. Supports filtering by exact match, exclusion, and containment operators. invoice_aging: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice/properties/invoice_aging" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/invoice_aging" contains: "$ref": "#/components/schemas/resource_invoice/properties/invoice_aging" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/invoice_aging" description: Filter invoice_aging using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/invoice_aging" description: Invoice aging value in days since issue date. Supports filtering by exact match, exclusion, and containment operators. amount_credited: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited" eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited" contains: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited" description: Filter amount_credited using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/amount_credited" description: Amount credited via credit notes, excluding tax (base currency). Supports filtering by exact match, exclusion, and containment operators. responsible_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_invoice/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_invoice/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/responsible_id" description: Filter responsible_id using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/responsible_id" description: Responsible person ID. Supports filtering by exact match, exclusion, and containment operators. amount_tax: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/amount_tax" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice/properties/amount_tax" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_tax" eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_tax" contains: "$ref": "#/components/schemas/resource_invoice/properties/amount_tax" description: Filter amount_tax using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Total tax amount (base currency). Supports filtering by exact match, exclusion, and containment operators. amount_written_off: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice/properties/amount_written_off" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/amount_written_off" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_written_off" eq: "$ref": "#/components/schemas/resource_invoice/properties/amount_written_off" description: Filter amount_written_off using explicit operator object with eq, not_eq, contains, and not_contain operators. - "$ref": "#/components/schemas/resource_invoice/properties/amount_written_off" description: Amount written off as uncollectible (base currency). Supports filtering by exact match, exclusion, and containment operators. amount: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/amount" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/amount" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/amount" eq: "$ref": "#/components/schemas/resource_invoice/properties/amount" contains: "$ref": "#/components/schemas/resource_invoice/properties/amount" description: Filter amount using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Invoice amount excluding tax (base currency). Supports filtering by exact match, exclusion, and containment operators. purchase_order_number: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/purchase_order_number" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice/properties/purchase_order_number" contains: "$ref": "#/components/schemas/resource_invoice/properties/purchase_order_number" not_eq: "$ref": "#/components/schemas/resource_invoice/properties/purchase_order_number" eq: "$ref": "#/components/schemas/resource_invoice/properties/purchase_order_number" description: Filter purchase_order_number using explicit operator object with eq, not_eq, contains, and not_contain operators. example: eq: PO-2024-017 description: Client-provided purchase order number. Supports filtering by exact match, exclusion, and containment operators. example: eq: PO-2024-017 invoice_state: oneOf: - "$ref": "#/components/schemas/resource_invoice/properties/invoice_state" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice/properties/invoice_state" contains: "$ref": "#/components/schemas/resource_invoice/properties/invoice_state" not_contain: "$ref": "#/components/schemas/resource_invoice/properties/invoice_state" eq: "$ref": "#/components/schemas/resource_invoice/properties/invoice_state" description: Filter invoice_state using explicit operator object with eq, not_eq, contains, and not_contain operators. description: Invoice lifecycle state (draft, finalized, sent, paid). Supports filtering by exact match, exclusion, and containment operators. patternProperties: "^company..*$": title: Company relationship description: Available filter parameters for querying invoices. resource_project: type: object title: Project Resource properties: status: enum: - 1 - 2 type: integer title: Status description: Project status. 1 = active, 2 = archived. sample_data: type: boolean title: Sample Data description: Whether this project was created with sample/demo data. workflow: title: Workflow description: The task workflow used in this project. project_id: type: integer title: Project description: Alias for the project ID field. revenue: type: integer title: Revenue description: Total revenue across all open budgets for this project, in the organization's base currency. page_custom_fields_ids: type: object title: Page Custom Fields Ids description: Ordered list of custom field IDs enabled for pages in this project. company_id: type: integer title: Company description: ID of the client company associated with this project. template_object: title: Template Object description: The template this project was created from, if any. number: type: string title: Number description: Auto-generated unique project number. budget_id: type: integer title: Budget description: ID of a budget linked to this project. with_templates: type: boolean title: With Templates description: When true, includes project templates in the results (templates are excluded by default). for_tracking: type: boolean title: For Tracking description: Whether this project is eligible for time tracking (i.e. active). page_custom_fields_positions: type: object title: Page Custom Fields Positions description: Display position order for page custom fields in this project. tag_colors: type: string title: Tag Colors description: Color mappings for project tags, keyed by tag name. profit_margin: type: integer title: Profit Margin description: Profit margin percentage across all open budgets for this project. task_custom_fields_ids: type: object title: Task Custom Fields Ids description: Ordered list of custom field IDs enabled for tasks in this project. total_worked_time: type: integer title: Total Worked Time description: Total worked time across all budgets (including closed) for this project, in minutes. profit: type: integer title: Profit description: Total profit across all open budgets for this project, in the organization's base currency. name: type: string title: Name description: Project name. project_number: type: string title: Project Number description: Formatted project number string (e.g. ACME-001). full_query: type: string title: Full Query description: Full-text search query across all project content fields. task_custom_fields_positions: type: object title: Task Custom Fields Positions description: Display position order for task custom fields in this project. fuzzy_people: type: integer title: Fuzzy People description: Fuzzy person filter — matches projects by associated people. last_activity_at: type: string title: Last Activity At format: date-time description: Timestamp of the most recent activity on this project. preferences: type: object title: Preferences description: Project-level display and behavior preferences. jump_query: type: string title: Jump Query description: Quick-jump search query for project navigation. project_manager: title: Project Manager description: The project manager responsible for this project. responsible_id: type: integer title: Responsible description: ID of the responsible person (project manager) for this project. pending_invoicing: type: integer title: Pending Invoicing description: Total amount pending invoicing across all open budgets for this project, in the organization's base currency. id: type: integer title: Id description: Unique project ID. created_at: type: string title: Created At format: date-time description: Timestamp when this project was created. duplication_status: enum: - idle - in_progress - failed type: string title: Duplication Status description: 'Background duplication status when copying from a template. One of: idle, in_progress, done, failed.' last_actor: title: Last Actor description: The person who last performed an activity on this project. parent_company_id: type: integer title: Parent Company description: ID of the parent company of the client linked to this project, used for hierarchical company filtering. cost: type: integer title: Cost description: Total cost across all open budgets for this project, in the organization's base currency. estimated_time: type: integer title: Estimated Time description: Total estimated time across all open budgets for this project, in minutes. project_color: type: integer title: Project Color description: Display color label for the project. project_color_id: type: integer title: Project Color description: Display color ID for the project. company: title: Company description: The client company linked to this project. custom_field_people: title: Custom Field People description: People referenced by person-type custom field values on this project. workflow_id: type: integer title: Workflow description: ID of the task workflow used in this project. organization: title: Organization description: The organization this project belongs to. project_type: enum: - 1 - 2 type: integer title: Project Type description: Human-readable project type label. fuzzy_dates: type: string title: Fuzzy Dates format: date description: Fuzzy date range filter for project start/end dates. worked_time: type: integer title: Worked Time description: Total worked time across all open budgets for this project, in minutes. project_manager_id: type: integer title: Project Manager description: ID of the project manager (responsible person). person_id: type: integer title: Person description: ID of a person who is a member of this project. template: type: string title: Template description: Whether this project is a template. archived_at: type: string title: Archived At format: date-time description: Archived at date public_access: type: boolean title: Public Access description: Deprecated. No-op — has no effect. query: type: string title: Query description: Full-text search query across project fields. project_type_id: enum: - 1 - 2 type: integer title: Project Type description: Whether this project is billable client work (1) or internal overhead (2). custom_fields: type: object title: Custom Fields description: Custom field values for this project, keyed by custom field ID. custom_field_attachments: title: Custom Field Attachments description: File attachments referenced by custom field values on this project. company_name: title: Company Name description: Name of the client company associated with this project. description: A workspace for tasks, documents, surveys, and budgets. Projects can be billable (client work) or internal (overhead), and provide the organizational structure for team collaboration. resource_task_list: type: object title: Task list Resource properties: board_id: type: integer title: Board description: ID of the folder (board) this task list belongs to. email_key: type: string title: Email Key description: A unique key used to create tasks in this task list via email. company_name: title: Company Name description: The name of the client company associated with the project this task list belongs to. organization: title: Organization description: The organization this task list belongs to. project: title: Project description: The project this task list belongs to. folder_name: title: Folder Name description: The name of the folder this task list belongs to. project_name: title: Project Name description: The name of the project this task list belongs to. name: type: string title: Name description: The name of this task list. archived_at: type: string title: Archived At format: date-time description: Timestamp when this task list was archived, or null if active. project_id: type: integer title: Project description: ID of the project this task list belongs to. placement: type: integer title: Placement description: The display placement position of this task list within its folder. board_name: title: Board Name description: The name of the folder (board) this task list belongs to. folder: title: Folder description: The folder this task list belongs to. board: title: Board description: The folder (board) this task list belongs to. position: type: integer title: Position description: The sort position of this task list within its project. query: type: string title: Query description: A search query string used to filter task lists by name. restorable: type: string title: Restorable description: Whether this task list is restorable (archived while its parent folder is still active). id: type: integer title: Id description: The unique identifier of this task list. folder_id: type: integer title: Folder description: ID of the folder this task list belongs to. status: enum: - 1 - 2 type: integer title: Status description: 'The archival status of this task list: active or archived.' description: Task grouping within a project folder. Supports name, position ordering, placement, archiving, and an email_key for creating tasks via email. Task lists belong to a project and optionally to a board (folder). _filter_root_approval_policy: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_approval_policy" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_approval_policy" description: Filter schema for `approval_policy` list endpoints — pass a single condition or a logical group. filter_report_category: type: object title: Filter report category properties: {} patternProperties: {} description: Available filter parameters for querying report category records. resource_integration: type: object title: Integration Resource properties: hubspot_default_company_id: type: integer title: Hubspot Default Company description: The hubspot default company id. fortnox_account_mapping: title: Fortnox Account Mapping description: Mapping of Productive account types to Fortnox account codes. deal_id: type: integer title: Deal description: ID of the deal this integration is scoped to. salesforce_subsidiary_field: title: Salesforce Subsidiary Field description: The Salesforce field used to determine the subsidiary for synced records. export_number: title: Export Number description: Whether to export sequential invoice numbers to the integrated accounting system. xero_reference: title: Xero Reference description: The Xero reference field value added to exported invoices. use_companies_export: title: Use Companies Export description: Whether to export company records to the integrated accounting system. netsuite_line_item_field_mapping: title: Netsuite Line Item Field Mapping description: The netsuite line item field mapping. sage_business_name: title: Sage Business Name description: Legal business name registered in Sage. hubspot_sync_deals: title: Hubspot Sync Deals description: Whether to sync HubSpot deals to Productive. sso_metadata_url: title: Sso Metadata Url description: URL to the identity provider SAML metadata document. request_token: type: string title: Request Token description: OAuth request token used during the authorization flow (non-SSO integrations). subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary this integration is associated with. sage_intacct_export_project: title: Sage Intacct Export Project description: Whether to export project records to Sage Intacct. deal: title: Deal description: The deal this integration is scoped to, if the integration is linked to a specific deal. sso_target_url: title: Sso Target Url description: SSO target URL for SAML-initiated login. sage_ledger_mapping: title: Sage Ledger Mapping description: Mapping of Productive account types to Sage ledger codes. economic_product_mapping: title: Economic Product Mapping description: Mapping of Productive products to e-conomic products. expense_account_code_mapping: title: Expense Account Code Mapping description: Mapping of expense categories to account codes in the accounting integration. redirect_uri: title: Redirect Uri description: The OAuth redirect URI used during the authorization flow for this integration. exact_default_journal: title: Exact Default Journal description: Default journal code used for Exact Online exports. bamboo_default_subsidiary_id: type: integer title: Bamboo Default Subsidiary description: Default subsidiary ID to assign to people imported from BambooHR. salesforce_default_subsidiary_id: type: integer title: Salesforce Default Subsidiary description: The default NetSuite subsidiary ID to use when syncing records via this Salesforce integration. netsuite_line_item_fixed_value_mapping: title: Netsuite Line Item Fixed Value Mapping description: Fixed value mappings applied to NetSuite line items during sync, overriding field-level mappings. hubspot_pipelines: title: Hubspot Pipelines description: List of HubSpot pipeline IDs to sync with Productive. default_item: title: Default Item description: The default account code used when no specific item mapping matches during invoice export. bamboo_enable_cost_rates: title: Bamboo Enable Cost Rates description: Whether to import cost rates from BambooHR. twinfield_offices: title: Twinfield Offices description: The list of Twinfield offices (companies) available under this integration. netsuite_project_field_mapping: title: Netsuite Project Field Mapping description: The netsuite project field mapping. twinfield_project_mapping: title: Twinfield Project Mapping description: A mapping of Productive projects to Twinfield project codes used when exporting invoices. hubspot_stages_mapping: title: Hubspot Stages Mapping description: Mapping of HubSpot pipeline stages to Productive deal statuses. client_id: type: integer title: Client description: The OAuth client ID used to authenticate this integration with the external service. fortnox_default_account: title: Fortnox Default Account description: Default account code used when exporting invoices to Fortnox. quickbooks_default_expense_bank_account_code: title: Quickbooks Default Expense Bank Account Code description: The quickbooks default expense bank account code. import_number: title: Import Number description: When true, invoice numbers from the external integration are imported into Productive. twinfield_default_cost_center: title: Twinfield Default Cost Center description: The twinfield default cost center. netsuite_default_item: title: Netsuite Default Item description: The default NetSuite item used when no specific item mapping matches during invoice export. project_status: type: integer title: Project Status description: Status filter for the linked project. netsuite_customer_form_id: type: integer title: Netsuite Customer Form description: The netsuite customer form id. exact_divisions: title: Exact Divisions description: List of available Exact divisions for the authenticated user. default_product: title: Default Product description: The default product used when no specific item mapping matches during invoice export. netsuite_invoice_pdf_source: title: Netsuite Invoice Pdf Source description: The source used to generate the invoice PDF in NetSuite (e.g., NetSuite-generated or Productive-generated). netsuite_invoice_fixed_value_mapping: title: Netsuite Invoice Fixed Value Mapping description: Fixed value mappings applied to NetSuite invoices during sync, overriding field-level mappings. purchase_order_account_code_mapping: title: Purchase Order Account Code Mapping description: The purchase order account code mapping. example: '200': '47890' '300': '47891' twinfield_default_project: title: Twinfield Default Project description: The default Twinfield project used when no specific project mapping matches during export. economic_export_subject: title: Economic Export Subject description: Subject line template for invoices exported to e-conomic. connected_at: type: string title: Connected At format: date-time description: Timestamp when the integration was successfully authenticated and connected. netsuite_sales_order_form_id: type: integer title: Netsuite Sales Order Form description: The netsuite sales order form id. tax_rate_mapping: title: Tax Rate Mapping description: Mapping of Productive tax rates to tax codes in the integrated accounting system. exact_country: title: Exact Country description: Country code for the Exact Online entity. netsuite_credit_note_form_id: type: integer title: Netsuite Credit Note Form description: The NetSuite form ID to use when creating credit notes during sync. salesforce_project_template_id: type: integer title: Salesforce Project Template description: The ID of the Productive project template to use when creating projects from Salesforce opportunities. salesforce_stage_id: type: integer title: Salesforce Stage description: The Salesforce stage ID used to identify deals when syncing opportunities. xero_purchase_order_status_id: type: integer title: Xero Purchase Order Status description: The xero purchase order status id. example: 1 project_id: type: integer title: Project description: ID of the project this integration is linked to. xero_internal_note_cf_id: type: integer title: Xero Internal Note Cf description: The xero internal note cf id. folders: title: Folders description: List of Productive folders synced with the integrated storage or project tool. bamboo_enable_time_offs: title: Bamboo Enable Time Offs description: Whether to sync time-off records from BambooHR. slack_options: title: Slack Options description: Configuration options for the Slack integration, including notification settings, status sync, and event subscriptions. salesforce_subsidiary_mapping: title: Salesforce Subsidiary Mapping description: Mapping of Salesforce subsidiary values to Productive subsidiaries. xero_organization_id: type: integer title: Xero Organization description: Xero organization ID (tenant ID) this integration is connected to. twinfield_invoice_destiny: title: Twinfield Invoice Destiny description: The Twinfield invoice destiny code that determines where exported invoices are posted in Twinfield. bamboo_workplace_mapping: title: Bamboo Workplace Mapping description: A mapping of BambooHR workplace field values to Productive subsidiaries. sage_country: title: Sage Country description: Country code of the Sage organization. calendar_write_status: title: Calendar Write Status description: Whether events can be written back to Google Calendar (read-only or read-write). export_expense_attachment: title: Export Expense Attachment description: Whether to attach PDF files when exporting expense receipts. salesforce_product_family_mapping: title: Salesforce Product Family Mapping description: Mapping of Salesforce product families to Productive service types. hubspot_default_template_id: type: integer title: Hubspot Default Template description: Default project template ID to use when creating projects from HubSpot deals. xero_default_expense_account_code: title: Xero Default Expense Account Code description: Default account code for expenses exported to Xero. subsidiary: title: Subsidiary description: The subsidiary this integration is scoped to, if the integration is linked to a specific subsidiary. payments_import: title: Payments Import description: When true, payments are imported from the integration into Productive. jira_organization: type: string title: Jira Organization description: Jira organization name or key this integration is connected to. name: type: string title: Name description: Display name of the integration. import_attachment: title: Import Attachment description: When true, invoice PDF attachments are imported from the integration. calendars: title: Calendars description: List of Google Calendar IDs synced with this integration. sage_intacct_entities: title: Sage Intacct Entities description: List of Sage Intacct entities (subsidiaries) available for this integration. item_mapping: title: Item Mapping description: A mapping of Productive service types to integration item codes used when exporting invoices. netsuite_customer_fixed_value_mapping: title: Netsuite Customer Fixed Value Mapping description: Fixed value mappings applied to NetSuite customer records during sync, overriding field-level mappings. google_events_write_scope: title: Google Events Write Scope description: OAuth scope for writing events to Google Calendar. calendar_write_options: title: Calendar Write Options description: Additional write options for calendar event sync. sso_url: title: Sso Url description: SSO login URL provided by the identity provider. netsuite_project_form_id: type: integer title: Netsuite Project Form description: The netsuite project form id. netsuite_invoice_field_mapping: title: Netsuite Invoice Field Mapping description: The netsuite invoice field mapping. integration_type_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 - 12 - 13 - 14 - 15 - 16 - 17 - 18 - 19 - 20 - 21 - 22 - 23 - 24 - 25 - 26 - 27 - 28 - 29 - 30 - 31 type: integer title: Integration Type description: ID of the integration type (e.g. Jira, Slack, QuickBooks, Xero). exact_ledger_mapping: title: Exact Ledger Mapping description: Mapping of Productive accounts to Exact ledger codes. netsuite_customer_field_mapping: title: Netsuite Customer Field Mapping description: The netsuite customer field mapping. quickbooks_default_expense_account_code: title: Quickbooks Default Expense Account Code description: The quickbooks default expense account code. sso_metadata: title: Sso Metadata description: Raw SAML metadata XML from the identity provider. twinfield_ledger_mapping: title: Twinfield Ledger Mapping description: A mapping of Productive service types to Twinfield ledger account codes used when exporting invoices. bamboo_workplace_field: title: Bamboo Workplace Field description: The BambooHR custom field used to determine the workplace or office of each employee. fortnox_default_article: title: Fortnox Default Article description: Default article number used in Fortnox invoice lines. netsuite_default_subsidiary_id: type: integer title: Netsuite Default Subsidiary description: The netsuite default subsidiary id. xero_organizations: title: Xero Organizations description: List of available Xero organizations for the authenticated user. fortnox_article_mapping: title: Fortnox Article Mapping description: Mapping of Productive services to Fortnox article numbers. use_purchase_orders_export: title: Use Purchase Orders Export description: Whether to export purchase orders to Xero. example: true all_folders: title: All Folders description: When true, the integration syncs all folders rather than a selected subset. force_sso_login: type: boolean title: Force Sso Login description: Whether SSO login is enforced for all users in the organization. netsuite_sales_order_field_mapping: title: Netsuite Sales Order Field Mapping description: The netsuite sales order field mapping. jira_project: type: string title: Jira Project description: Jira project key this integration syncs tasks with. use_invoices_export: title: Use Invoices Export description: Whether to export invoices to Xero. id: title: Id description: Unique identifier of the integration. bamboo_enable_user_provisioning: title: Bamboo Enable User Provisioning description: The bamboo enable user provisioning. netsuite_attach_timesheet: title: Netsuite Attach Timesheet description: When true, the integration attaches a timesheet PDF to NetSuite invoices on export. hubspot_default_subsidiary_id: type: integer title: Hubspot Default Subsidiary description: Default subsidiary ID to assign to deals imported from HubSpot. export_purchase_order_number: title: Export Purchase Order Number description: Whether to export purchase order numbers to Xero. example: PO-2024-017 account_code: type: string title: Account Code description: Default account code used when exporting financial data to the integrated system. netsuite_item_mapping: title: Netsuite Item Mapping description: A mapping of Productive service types to NetSuite item IDs used when exporting invoices. export_attachment: title: Export Attachment description: Whether to attach PDF files when exporting invoices. use_expenses_in_xero: title: Use Expenses In Xero description: Whether to sync expense records to Xero. salesforce_default_service_type_id: type: integer title: Salesforce Default Service Type description: The ID of the default service type used when creating Productive services from Salesforce opportunities. netsuite_invoice_form_id: type: integer title: Netsuite Invoice Form description: The netsuite invoice form id. project: title: Project description: The project this integration is scoped to, if the integration is linked to a specific project. account_code_mapping: title: Account Code Mapping description: A mapping of Productive service types to accounting account codes used when exporting invoices to the integration. exact_ledger_manually: title: Exact Ledger Manually description: Whether to assign ledger codes manually rather than via automatic mapping. twinfield_default_ledger: title: Twinfield Default Ledger description: The default Twinfield ledger account used when no specific ledger mapping matches during export. exact_division_id: type: integer title: Exact Division description: Exact division ID this integration is connected to. organization: title: Organization description: The organization this integration belongs to. created_at: title: Created At description: Timestamp when the integration was created. customer_memo_cf_id: type: integer title: Customer Memo Cf description: The customer memo cf id. deactivated_at: type: string title: Deactivated At format: date-time description: Timestamp when the integration was deactivated, or null if currently active. options: type: string title: Options description: Raw options hash containing integration-specific configuration settings. last_synced_at: type: string title: Last Synced At format: date-time description: Timestamp of the last successful data sync. creator: title: Creator description: The person who created this integration. exact_division: title: Exact Division description: Exact division ID (deprecated, use exact_division_id). sage_intacct_account_code_mapping: title: Sage Intacct Account Code Mapping description: Mapping of Productive account types to Sage Intacct account codes. quickbooks_default_expense_payment_type: title: Quickbooks Default Expense Payment Type description: The quickbooks default expense payment type. exact_default_ledger: title: Exact Default Ledger description: Default ledger account code for Exact Online exports. sage_intacct_account_code: title: Sage Intacct Account Code description: Default revenue account code for Sage Intacct exports. xero_default_purchase_order_account_code: title: Xero Default Purchase Order Account Code description: Default account code for purchase orders exported to Xero. example: '200' sage_intacct_project_category: title: Sage Intacct Project Category description: Project category used for Sage Intacct time entry exports. quickbooks_memo: title: Quickbooks Memo description: The QuickBooks memo field value added to exported invoices. request_uri: type: string title: Request Uri description: OAuth callback URI used during the authorization flow (non-SSO integrations). sage_default_ledger: title: Sage Default Ledger description: Default ledger account code for Sage 50/Business Cloud exports. bamboo_custom_field_mapping: title: Bamboo Custom Field Mapping description: Mapping of BambooHR custom fields to Productive person attributes. xero_expense_status_id: type: integer title: Xero Expense Status description: The xero expense status id. requested_at: type: string title: Requested At format: date-time description: Timestamp when OAuth authorization was requested. hubspot_default_deal_owner_id: type: integer title: Hubspot Default Deal Owner description: The hubspot default deal owner id. netsuite_relationship_mapping: title: Netsuite Relationship Mapping description: A mapping of Productive company relationships to NetSuite record types or fields. update_invoice_sent_status: title: Update Invoice Sent Status description: The update invoice sent status. realm_id: type: string title: Realm description: Realm or tenant identifier used by some integrations (e.g. Xero organization ID, Exact division). xero_invoice_status_id: type: integer title: Xero Invoice Status description: The xero invoice status id. use_expense_sync: title: Use Expense Sync description: Whether to sync expense records to the connected invoicing system. twinfield_cost_center_mapping: title: Twinfield Cost Center Mapping description: The twinfield cost center mapping. description: A third-party integration connection (e.g. Jira, Slack, QuickBooks) with sync configuration, field mappings, and authentication settings. _filter_root_user: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_user" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_user" description: Filter schema for `user` list endpoints — pass a single condition or a logical group. _filter_root_purchase_order: oneOf: - "$ref": "#/components/schemas/filter_purchase_order" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Boolean operator joining the numbered filter slots. One of `and` or `or`. example: and patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_purchase_order" description: Grouped form — combine multiple filter slots with a boolean operator. required: - "$op" example: '0': id: eq: - 1234567 '1': status_id: eq: - 1 "$op": and description: 'Root shape of the `filter` parameter: either per-field filters or an indexed `AND`/`OR` group.' example: id: eq: - 1234567 _filter_root_invoice_template: oneOf: - "$ref": "#/components/schemas/filter_invoice_template" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_invoice_template" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `invoice_template` list endpoints — pass a single condition or a logical group. resource_time_entry: type: object title: Time entry Resource properties: overhead_cost_normalized: title: Overhead Cost Normalized description: Total overhead cost in the normalized reporting currency. invoicing_status: enum: - 1 - 2 - 3 type: integer title: Invoicing Status description: Current invoicing status of the time entry. cost: title: Cost description: Total cost of tracked time, including labor and overhead costs. project_type_id: type: integer title: Project Type description: Project type ID. started_at: type: string title: Started At format: date-time description: Start date and time of the time entry. parent_company_id: type: integer title: Parent Company description: Filter time entries by the parent company of the client linked to their budget. creator: title: Creator description: The person who created this time entry. work_cost: title: Work Cost description: Labor cost based on the person's salary rate. service_id: type: integer title: Service description: ID of the service the time was tracked against. id: type: integer title: Id description: Unique identifier of the time entry. approval_policy_id: type: integer title: Approval Policy description: approval policy id of the time entry. jira_issue_status: type: string title: Jira Issue Status description: Current status of the linked Jira issue. billable: type: boolean title: Billable description: Whether the associated service is billable. person_name: title: Person Name description: Name of the person who tracked time. assigned_approver_id: type: integer title: Assigned Approver description: assigned approver id of the time entry. created_before: type: string title: Created Before format: date description: Filter alias — only entries created before this value. person_subsidiary: title: Person Subsidiary description: The subsidiary of the person who tracked time. person: title: Person description: The person who tracked this time. task: title: Task description: The task the person was working on. recognized_time: type: integer title: Recognized Time description: Recognized time used in budget spending and accrual-based revenue calculations. internal_overhead_cost_normalized: title: Internal Overhead Cost Normalized description: Internal overhead cost in the normalized reporting currency. last_actor: title: Last Actor description: The last person who made changes to this entry. autotracked: type: boolean title: Autotracked description: autotracked of the time entry. created_after: type: string title: Created After format: date description: Filter alias — only entries created after this value. invoice_attribution: title: Invoice Attribution description: The invoice attribution linking this entry to an invoice. designated_approver_id: type: integer title: Designated Approver description: Filter time entries to those whose budget has the specified designated approver. task_id: type: integer title: Task description: ID of the task the person was working on. rejecter: title: Rejecter description: The person who rejected this time entry. approval_statuses: title: Approval Statuses description: Per-approver decisions on this time entry. company_id: type: integer title: Company description: ID of the client company associated with the deal. track_method_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 type: integer title: Track Method description: 'How the time was recorded: manually, via timer, or mixed.' overhead_cost_default: title: Overhead Cost Default description: Total overhead cost in the organization's default currency. after: type: string title: After format: date description: after of the time entry. person_subsidiary_id: type: integer title: Person Subsidiary description: ID of the subsidiary of the person who tracked time. internal_overhead_cost: title: Internal Overhead Cost description: Internal overhead portion of the cost. budget_id: type: integer title: Budget description: ID of the deal/budget this time was tracked on. booking_id: type: integer title: Booking description: ID of the booking this time entry was created from. internal_overhead_cost_default: title: Internal Overhead Cost Default description: Internal overhead cost in the organization's default currency. ended_at: type: string title: Ended At format: date description: Computed end timestamp (started_at + time minutes). started_after: type: string title: Started After format: date description: Filter alias — only entries started after this value. unit_id: enum: - 1 - 2 - 3 type: integer title: Unit description: Tracking unit ID of the associated service. invoiced: type: boolean title: Invoiced description: Whether this time entry has been invoiced to the client. last_activity_at: type: string title: Last Activity At format: date-time description: Date when the last change was made (edit, approval, move, etc.). task_list_id: type: integer title: Task List description: ID of the task list the task belongs to. facility_overhead_cost: title: Facility Overhead Cost description: Facility overhead portion of the cost. query: type: string title: Query description: Full-text search query across time entry fields. last_actor_id: type: integer title: Last Actor description: last actor id of the time entry. timer_started_at: type: string title: Timer Started At format: date-time description: When the timer was started (if tracked via timer). budget_type_id: type: integer title: Budget Type description: Budget type ID of the associated deal. person_id: type: integer title: Person description: ID of the person who tracked time. project_manager_id: type: integer title: Project Manager description: ID of the project manager. status: enum: - 1 - 2 - 3 - 4 - 5 - 6 type: integer title: Status description: Approval status of the time entry. invoice_id: type: integer title: Invoice description: ID of the invoice associated via attribution. invoice_attribution_id: type: integer title: Invoice Attribution description: ID of the invoice attribution linking this entry to an invoice. approved: title: Approved description: Whether this time entry has been approved. submitted: title: Submitted description: Whether this time entry has been submitted for approval via a timesheet. approver: title: Approver description: The person who approved this time entry. stage_type: enum: - 1 - 2 type: integer title: Stage Type description: Stage type of the associated deal. jira_organization: type: string title: Jira Organization description: Jira organization name for the linked issue. currency_default: title: Currency Default description: Currency code in the organization's default currency. currency_normalized: title: Currency Normalized description: Currency code in the normalized reporting currency. billing_type_id: enum: - 1 - 2 - 3 - 4 type: integer title: Billing Type description: Billing type of the associated service. work_cost_default: title: Work Cost Default description: Labor cost in the organization's default currency. service: title: Service description: The budget service this time was tracked against. started_before: type: string title: Started Before format: date description: Filter alias — only entries started before this value. creator_id: type: integer title: Creator description: creator id of the time entry. cost_default: title: Cost Default description: Total cost in the organization's default currency. approver_id: type: integer title: Approver description: approver id of the time entry. deal_id: type: integer title: Deal description: ID of the deal/budget this time was tracked on. overhead_cost: title: Overhead Cost description: Total overhead cost (internal + facility) of tracked time. created_at: type: string title: Created At format: date-time description: Date on which the time entry was created. jira_issue_summary: type: string title: Jira Issue Summary description: Summary text of the linked Jira issue. rejected: title: Rejected description: Whether this time entry was rejected during approval. date: type: string title: Date format: date description: Date for which the time was tracked. organization: title: Organization description: The organization this time entry belongs to. awaiting_approval_from_approver_id: type: integer title: Awaiting Approval From Approver description: awaiting approval from approver id of the time entry. intercompany_hours: type: boolean title: Intercompany Hours description: True when the person's subsidiary differs from the deal subsidiary. approved_at: type: string title: Approved At format: date-time description: Timestamp when the time entry was approved. role_id: type: integer title: Role description: Role ID of the person who tracked time. use_salary_currency: type: boolean title: Use Salary Currency description: Whether to compute costs using the person's salary currency instead of the deal currency. note: type: string title: Note description: Description of what the person was working on. project_id: type: integer title: Project description: ID of the project associated with the service. facility_overhead_cost_default: title: Facility Overhead Cost Default description: Facility overhead cost in the organization's default currency. jira_issue_id: type: string title: Jira Issue description: Jira Issue ID if tracked from a Jira integration. cost_normalized: title: Cost Normalized description: Total cost in the normalized reporting currency. timesheet: title: Timesheet description: The daily timesheet this entry belongs to (unit of approval submission). deal_name: title: Deal Name description: Name of the deal/budget this time was tracked on. section_name: type: string title: Section Name description: Name of the section the service belongs to. service_type_id: type: integer title: Service Type description: Service type ID of the associated service. responsible_id: type: integer title: Responsible description: ID of the responsible person. rejected_at: type: string title: Rejected At format: date-time description: Timestamp when the time entry was rejected. work_cost_normalized: title: Work Cost Normalized description: Labor cost in the normalized reporting currency. calendar_event_id: type: string title: Calendar Event description: ID of the calendar event this entry was created from, if applicable. jira_worklog_id: type: string title: Jira Worklog description: Jira Worklog ID for synced entries. time: type: integer title: Time description: Duration of work in minutes. base_cost: title: Base Cost description: Base labor cost before overhead (serialized from work_cost). billable_time: type: integer title: Billable Time description: Hours billable to clients (time + correction for billable services, zero for non-billable). service_name: title: Service Name description: Name of the service the time was tracked against. people_custom_fields: type: string title: People Custom Fields description: Custom field values for the person who tracked time. deal_subsidiary: title: Deal Subsidiary description: The subsidiary of the budget/deal this time was tracked on. person_tags: type: string title: Person Tags description: Tags of the person who tracked time. rejected_reason: type: string title: Rejected Reason description: Reason provided when the time entry was rejected. deal_subsidiary_id: type: integer title: Deal Subsidiary description: ID of the subsidiary of the deal. facility_overhead_cost_normalized: title: Facility Overhead Cost Normalized description: Facility overhead cost in the normalized reporting currency. updated_at: type: string title: Updated At format: date-time description: Timestamp of last modification. currency: type: string title: Currency description: Currency code for financial values on this time entry. overhead: type: boolean title: Overhead description: Whether this time entry is included in overhead calculations. updater: title: Updater description: The person who last updated this time entry. timer_stopped_at: type: string title: Timer Stopped At format: date-time description: When the timer was stopped. before: type: string title: Before format: date description: before of the time entry. description: A time entry records the time a person has logged against a service on a deal or project, capturing the date, duration, and optionally a note describing the work done. filter_document_style: type: object title: Filter document style properties: id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_document_style/properties/id" eq: "$ref": "#/components/schemas/resource_document_style/properties/id" contains: "$ref": "#/components/schemas/resource_document_style/properties/id" not_eq: "$ref": "#/components/schemas/resource_document_style/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_document_style/properties/id" description: Filter by document style ID. name: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_document_style/properties/name" contains: "$ref": "#/components/schemas/resource_document_style/properties/name" eq: "$ref": "#/components/schemas/resource_document_style/properties/name" not_contain: "$ref": "#/components/schemas/resource_document_style/properties/name" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_document_style/properties/name" description: Filter by document style name (text search). patternProperties: {} description: Filter parameters for document styles. resource_salary: type: object title: Salary Resource properties: cost_normalized: title: Cost Normalized description: The person's cost normalized for comparison across currencies (amount in cents). cost: type: integer title: Cost description: The person's cost in the salary's native currency (amount in cents). person: title: Person description: The person this salary record applies to. currency_default: title: Currency Default description: The organization's default currency code. cost_default: title: Cost Default description: The person's cost converted to the organization's default currency (amount in cents). overhead: type: boolean title: Overhead description: When true, this salary entry is counted as overhead cost rather than direct project cost. exchange_date: type: string title: Exchange Date format: date description: The date used to calculate the exchange rate for currency conversion. holiday_calendar: title: Holiday Calendar description: The associated holiday calendar that determines the person's non-working days. started_on: type: string title: Started On format: date description: Date when this salary record becomes effective. hourly_rate: title: Hourly Rate description: The person's hourly rate in the salary's native currency (amount in cents). hourly_rate_normalized: title: Hourly Rate Normalized description: The hourly rate converted to the organization's normalized currency, in whole currency units. alternating_hours: type: boolean title: Alternating Hours description: Alternating working hours schedule, if the organization has the alternating work hours feature enabled. holiday_calendar_id: title: Holiday Calendar description: The ID of the holiday calendar used for this person's availability calculations. after: type: string title: After format: date description: The date after which this salary record starts being effective (exclusive lower bound for date-range filtering). ended_on: type: string title: Ended On format: date description: The date when this salary record ends. Null if the record is currently active. exchange_rate: type: number title: Exchange Rate description: The exchange rate applied to convert the salary cost to the default currency. currency_normalized: title: Currency Normalized description: The normalized currency code used for cross-currency comparisons. person_id: type: integer title: Person description: ID of the person this salary record applies to. salary_type_id: type: integer title: Salary Type description: ID of the salary type for this record (e.g. hourly, monthly). default_salary: title: Default Salary description: Whether this is the default (active) salary record for the person. currency: type: string title: Currency description: The currency code of this salary record (e.g. USD, EUR). working_hours: type: object title: Working Hours description: The weekly working hours schedule for this salary record. before: type: string title: Before format: date description: The date before which this salary record is effective (exclusive upper bound for date-range filtering). organization: title: Organization description: The organization this salary record belongs to. hourly_rate_default: title: Hourly Rate Default description: The hourly rate converted to the organization's default currency, in whole currency units. note: title: Note description: An optional note or description for this salary record. description: A person's cost rate and working capacity configuration defining hourly cost, daily availability, and overhead rates. _filter_root_dashboard: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_dashboard" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_dashboard" description: Filter schema for `dashboard` list endpoints — pass a single condition or a logical group. _filter_root_team: oneOf: - "$ref": "#/components/schemas/filter_team" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_team" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `team` list endpoints — pass a single condition or a logical group. filter_attachment: type: object title: Filter attachment properties: company_id: oneOf: - "$ref": "#/components/schemas/resource_attachment/properties/company_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_attachment/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_attachment/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_attachment/properties/company_id" eq: "$ref": "#/components/schemas/resource_attachment/properties/company_id" description: Filter using explicit operator syntax. description: Filter by client company. fuzzy_dates: oneOf: - "$ref": "#/components/schemas/resource_attachment/properties/fuzzy_dates" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_attachment/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_attachment/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_attachment/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_attachment/properties/fuzzy_dates" description: Filter using explicit operator syntax. description: Filter by fuzzy date range (relative date expression). fuzzy_people: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_attachment/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_attachment/properties/fuzzy_people" not_contain: "$ref": "#/components/schemas/resource_attachment/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_attachment/properties/fuzzy_people" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_attachment/properties/fuzzy_people" description: Filter by person using fuzzy matching. task_id: oneOf: - "$ref": "#/components/schemas/resource_attachment/properties/task_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_attachment/properties/task_id" contains: "$ref": "#/components/schemas/resource_attachment/properties/task_id" not_eq: "$ref": "#/components/schemas/resource_attachment/properties/task_id" eq: "$ref": "#/components/schemas/resource_attachment/properties/task_id" description: Filter using explicit operator syntax. description: Filter by the associated task. comment_id: oneOf: - "$ref": "#/components/schemas/resource_attachment/properties/comment_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_attachment/properties/comment_id" not_eq: "$ref": "#/components/schemas/resource_attachment/properties/comment_id" not_contain: "$ref": "#/components/schemas/resource_attachment/properties/comment_id" eq: "$ref": "#/components/schemas/resource_attachment/properties/comment_id" description: Filter using explicit operator syntax. description: Filter by the associated comment. id: oneOf: - "$ref": "#/components/schemas/resource_attachment/properties/id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_attachment/properties/id" not_contain: "$ref": "#/components/schemas/resource_attachment/properties/id" eq: "$ref": "#/components/schemas/resource_attachment/properties/id" not_eq: "$ref": "#/components/schemas/resource_attachment/properties/id" description: Filter using explicit operator syntax. description: Filter by attachment ID. full_query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_attachment/properties/full_query" contains: "$ref": "#/components/schemas/resource_attachment/properties/full_query" eq: "$ref": "#/components/schemas/resource_attachment/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_attachment/properties/full_query" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_attachment/properties/full_query" description: Filter by full-text search query. notes_attachment: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_attachment/properties/notes_attachment" not_eq: "$ref": "#/components/schemas/resource_attachment/properties/notes_attachment" contains: "$ref": "#/components/schemas/resource_attachment/properties/notes_attachment" not_contain: "$ref": "#/components/schemas/resource_attachment/properties/notes_attachment" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_attachment/properties/notes_attachment" description: Filter to include only attachments embedded in notes. page_id: oneOf: - "$ref": "#/components/schemas/resource_attachment/properties/page_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_attachment/properties/page_id" eq: "$ref": "#/components/schemas/resource_attachment/properties/page_id" not_eq: "$ref": "#/components/schemas/resource_attachment/properties/page_id" not_contain: "$ref": "#/components/schemas/resource_attachment/properties/page_id" description: Filter using explicit operator syntax. description: Filter by the associated document page. type: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_attachment/properties/type" not_contain: "$ref": "#/components/schemas/resource_attachment/properties/type" contains: "$ref": "#/components/schemas/resource_attachment/properties/type" eq: "$ref": "#/components/schemas/resource_attachment/properties/type" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_attachment/properties/type" description: Filter by file type (image, video, PDF, text, or other). creator_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_attachment/properties/creator_id" eq: "$ref": "#/components/schemas/resource_attachment/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_attachment/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_attachment/properties/creator_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_attachment/properties/creator_id" description: Filter by the person who uploaded the attachment. jump_query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_attachment/properties/jump_query" contains: "$ref": "#/components/schemas/resource_attachment/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_attachment/properties/jump_query" eq: "$ref": "#/components/schemas/resource_attachment/properties/jump_query" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_attachment/properties/jump_query" description: Full-text jump search query for quickly finding resources. project_id: oneOf: - "$ref": "#/components/schemas/resource_attachment/properties/project_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_attachment/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_attachment/properties/project_id" contains: "$ref": "#/components/schemas/resource_attachment/properties/project_id" eq: "$ref": "#/components/schemas/resource_attachment/properties/project_id" description: Filter using explicit operator syntax. description: Filter by the associated project. patternProperties: {} description: Filter parameters for listing attachments. Supports filtering by parent resource (comment, task, deal, page, invoice, expense, purchase order, bill), creator, file type, and upload date. Standard string and ID operators apply. filter_team: type: object title: Filter team properties: name: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_team/properties/name" not_contain: "$ref": "#/components/schemas/resource_team/properties/name" eq: "$ref": "#/components/schemas/resource_team/properties/name" contains: "$ref": "#/components/schemas/resource_team/properties/name" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_team/properties/name" description: Filter by team name (text search). query: oneOf: - "$ref": "#/components/schemas/resource_team/properties/query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_team/properties/query" contains: "$ref": "#/components/schemas/resource_team/properties/query" eq: "$ref": "#/components/schemas/resource_team/properties/query" not_contain: "$ref": "#/components/schemas/resource_team/properties/query" description: Filter using explicit operator syntax. description: Filter by team name (text search). color_id: oneOf: - "$ref": "#/components/schemas/resource_team/properties/color_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_team/properties/color_id" not_contain: "$ref": "#/components/schemas/resource_team/properties/color_id" not_eq: "$ref": "#/components/schemas/resource_team/properties/color_id" contains: "$ref": "#/components/schemas/resource_team/properties/color_id" description: Filter using explicit operator syntax. description: Filter by team color ID. id: oneOf: - "$ref": "#/components/schemas/resource_team/properties/id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_team/properties/id" contains: "$ref": "#/components/schemas/resource_team/properties/id" eq: "$ref": "#/components/schemas/resource_team/properties/id" not_contain: "$ref": "#/components/schemas/resource_team/properties/id" description: Filter using explicit operator syntax. description: Filter by ID. patternProperties: {} description: Filter parameters for listing teams. Supports filtering by name and membership. Standard string and ID operators apply. resource_task_report: type: object title: Task report Resource properties: currency_normalized: title: Currency Normalized description: Whether monetary values are normalized to the default currency. bookable_before: type: string title: Bookable Before format: date description: Filter task report entries to those bookable before this date. type_id: enum: - 1 - 3 type: integer title: Type description: Type id for this task report group. task_list_name: type: string title: Task List Name description: Task list name for this task report group. fuzzy_people: type: integer title: Fuzzy People description: Fuzzy people for this task report group. creator: title: Creator description: Name of the person who created the task. template_id: type: integer title: Template description: ID of the template that tasks in this report group were created from. assignee_report: title: Assignee Report description: Person report dimension record for the assignee. due_date_before: type: string title: Due Date Before format: date description: 'Upper bound date filter: tasks with a due date before this date.' currency: title: Currency description: Currency code used for monetary values in this row. project_report: title: Project Report description: Project report for this task report group. workflow_status_category_id: enum: - 1 - 2 - 3 type: integer title: Workflow Status Category description: Workflow status category id for this task report group. board_name: type: string title: Board Name description: Display name of the task list (board). due_date_new: type: string title: Due Date New format: date description: Due date in a normalized format for grouping. workflow: title: Workflow description: Workflow for this task report group. assignee: title: Assignee description: Name of the assigned person. formulas: type: integer title: Formulas description: Formulas for this task report group. subscriber_id: type: integer title: Subscriber description: Subscriber id for this task report group. fuzzy_dates: type: string title: Fuzzy Dates format: date description: Fuzzy dates for this task report group. project: title: Project description: Project for this task report group. date_range: type: string title: Date Range format: date description: Date range (start date / due date) of the tasks. query: type: string title: Query description: Query for this task report group. person_type: type: integer title: Person Type description: Person type for this task report group. created_at: type: string title: Created At format: date description: Timestamp when the task was created. total_estimate_at_completion: type: number title: Total Estimate At Completion description: Sum of estimate at completion across all records in this task report group. tags: type: string title: Tags description: Tags for this task report group. total_billable_time: type: number title: Total Billable Time description: Sum of billable time across all records in this task report group. id: type: integer title: Id description: Unique identifier for this task report row. folder_status: enum: - 1 - 2 type: integer title: Folder Status description: Folder status for this task report group. total_worked_time: type: number title: Total Worked Time description: Sum of worked time across all records in this task report group. company_report: title: Company Report description: Company report dimension record for the company. company_id: type: integer title: Company description: Company id for this task report group. last_activity_before: type: string title: Last Activity Before format: date description: Return tasks with last activity before this date. start_date_period: title: Start Date Period description: Time period grouping for start date (e.g. week, month, quarter). closed_at: type: string title: Closed At format: date description: Date when the task was closed. closed_at_period: title: Closed At Period description: Time period grouping for closed at (e.g. week, month, quarter). status: enum: - 1 - 2 type: integer title: Status description: Status for this task report group. project_id: type: integer title: Project description: Project id for this task report group. task_created_at: title: Task Created At description: Task created at for this task report group. billable_time: type: integer title: Billable Time description: Total billable time (in minutes) tracked on tasks in this group. organization: title: Organization description: Organization for this task report group. created_at_period: title: Created At Period description: Period label for the created_at date grouping dimension. folder_name: type: string title: Folder Name description: Display name of the project folder. due_date: type: string title: Due Date format: date description: Due date for this task report group. before: type: string title: Before format: date description: The bookable-before date used to scope this report. year: type: string title: Year description: Year grouping for this task report row. last_activity_at: title: Last Activity At description: Timestamp of the most recent activity on this task. public_access: type: boolean title: Public Access description: Public access for this task report group. total_initial_estimate: type: number title: Total Initial Estimate description: Sum of initial estimate across all records in this task report group. repeating: type: integer title: Repeating description: Repeating for this task report group. title: type: string title: Title description: Title for this task report group. task_number: type: string title: Task Number description: Task number for this task report group. task_start_date: title: Task Start Date description: Task start date for this task report group. closed_before: type: string title: Closed Before format: date description: Closed before for this task report group. start_date: type: string title: Start Date format: date description: Start date for this task report group. task_custom_fields: title: Task Custom Fields description: Task custom fields for this task report group. folder_id: type: integer title: Folder description: ID of the project folder containing the tasks. placement: title: Placement description: Placement for this task report group. task_type: enum: - 1 - 2 type: integer title: Task Type description: Task type for this task report group. task: title: Task description: Task for this task report group. board: title: Board description: Name of the task list (board) containing the tasks. after: type: string title: After format: date description: After for this task report group. closed_after: type: string title: Closed After format: date description: 'Lower bound date filter: tasks closed after this date.' board_id: type: integer title: Board description: ID of the task list (board) containing the tasks. project_manager_id: type: integer title: Project Manager description: Project manager id for this task report group. bookable_after: type: string title: Bookable After format: date description: Filter task report entries to those bookable after this date. assignee_id: type: integer title: Assignee description: ID of the assigned person. service_id: type: integer title: Service description: Service id for this task report group. template: type: string title: Template description: Template for this task report group. service: title: Service description: Service for this task report group. task_due_date: title: Task Due Date description: Task due date for this task report group. group: type: string title: Group description: The grouping dimension for this task report row. task_list_status: enum: - 1 - 2 type: integer title: Task List Status description: Task list status for this task report group. due_date_after: type: string title: Due Date After format: date description: Due date after for this task report group. project_type: enum: - 1 - 2 type: integer title: Project Type description: Project type for this task report group. last_actor: title: Last Actor description: Last actor for this task report group. last_activity: type: string title: Last Activity format: date description: Timestamp of the most recent activity on this task. board_status: enum: - 1 - 2 type: integer title: Board Status description: 'Status of the task list (board): open or closed.' parent_task: title: Parent Task description: Parent task for this task report group. subtask: type: boolean title: Subtask description: Subtask for this task report group. task_last_activity_at: title: Task Last Activity At description: Timestamp of the most recent activity on the task associated with this report row. creator_report: title: Creator Report description: Person report dimension record for the creator. report: title: Report description: Report for this task report group. task_list_id: type: integer title: Task List description: Task list id for this task report group. last_actor_report: title: Last Actor Report description: Last actor report for this task report group. week: type: string title: Week description: Week grouping for this task report row. remaining_time: type: integer title: Remaining Time description: Remaining time for this task report group. due_date_period: title: Due Date Period description: Period label for the due_date grouping dimension. jump_query: type: string title: Jump Query description: Jump query for this task report group. last_actor_id: type: integer title: Last Actor description: Last actor id for this task report group. trackable_by_person_id: type: integer title: Trackable By Person description: Filter task report entries to those trackable by the specified person, based on restricted tracking settings. updated_at: type: string title: Updated At format: date description: Updated at for this task report group. task_closed_at: title: Task Closed At description: Task closed at for this task report group. total_remaining_time: type: number title: Total Remaining Time description: Sum of remaining time across all records in this task report group. workflow_status: title: Workflow Status description: Workflow status for this task report group. task_list: title: Task List description: Task list for this task report group. start_date_after: type: string title: Start Date After format: date description: Start date after for this task report group. initial_estimate: type: integer title: Initial Estimate description: Initial estimate for this task report group. total_estimation_offset_time: type: integer title: Total Estimation Offset Time description: Sum of estimation offset time across all records in this task report group. month: type: string title: Month description: Month grouping for this task report row. last_activity_after: type: string title: Last Activity After format: date description: Return tasks with last activity after this date. due_date_on: type: string title: Due Date On format: date description: Exact due date match for filtering. start_date_before: type: string title: Start Date Before format: date description: Start date before for this task report group. currency_default: title: Currency Default description: Whether this row uses the organization default currency. worked_time: type: integer title: Worked Time description: Worked time for this task report group. service_report: title: Service Report description: Service report for this task report group. last_activity_at_period: title: Last Activity At Period description: Time period grouping for last activity date (e.g. week, month, quarter). custom_fields: type: string title: Custom Fields description: Custom field values for tasks in this report group. count: type: integer title: Count description: Number of tasks in this report group. folder: title: Folder description: Name of the project folder containing the tasks. dependency_type: enum: - 1 - 2 - 3 type: integer title: Dependency Type description: Dependency type for this task report group. formula_fields: title: Formula Fields description: Formula fields for this task report group. creator_id: type: integer title: Creator description: ID of the person who created the task. quarter: type: string title: Quarter description: Quarter grouping for this task report row. full_query: type: string title: Full Query description: Full query for this task report group. query_extended: type: string title: Query Extended description: Query extended for this task report group. workflow_id: type: integer title: Workflow description: Workflow id for this task report group. overdue_status: enum: - 1 - 2 type: integer title: Overdue Status description: Overdue status for this task report group. parent_task_id: type: integer title: Parent Task description: Parent task id for this task report group. company: title: Company description: Company for this task report group. workflow_status_id: type: integer title: Workflow Status description: Workflow status id for this task report group. description: An aggregated task report row grouping tasks by configurable dimensions with work metrics, time tracking totals, and status breakdowns. filter_service_type: type: object title: Filter service type properties: name: oneOf: - "$ref": "#/components/schemas/resource_service_type/properties/name" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_type/properties/name" not_eq: "$ref": "#/components/schemas/resource_service_type/properties/name" not_contain: "$ref": "#/components/schemas/resource_service_type/properties/name" eq: "$ref": "#/components/schemas/resource_service_type/properties/name" description: Filter using explicit operator syntax. description: Filter by service type name (exact match). id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_service_type/properties/id" not_eq: "$ref": "#/components/schemas/resource_service_type/properties/id" not_contain: "$ref": "#/components/schemas/resource_service_type/properties/id" contains: "$ref": "#/components/schemas/resource_service_type/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_service_type/properties/id" description: Filter by service type ID. person_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_type/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_service_type/properties/person_id" eq: "$ref": "#/components/schemas/resource_service_type/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_service_type/properties/person_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_service_type/properties/person_id" description: Filter to service types assigned to the specified person. status: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_service_type/properties/status" not_eq: "$ref": "#/components/schemas/resource_service_type/properties/status" not_contain: "$ref": "#/components/schemas/resource_service_type/properties/status" eq: "$ref": "#/components/schemas/resource_service_type/properties/status" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_service_type/properties/status" description: Filter by status (active or archived). query: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_service_type/properties/query" contains: "$ref": "#/components/schemas/resource_service_type/properties/query" not_contain: "$ref": "#/components/schemas/resource_service_type/properties/query" eq: "$ref": "#/components/schemas/resource_service_type/properties/query" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_service_type/properties/query" description: Search service types by name (supports contains, exact, and exclusion operators). patternProperties: {} description: Filter parameters for querying service types. filter_contact_entry: type: object title: Filter contact entry properties: invoice_id: oneOf: - "$ref": "#/components/schemas/resource_contact_entry/properties/invoice_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_contact_entry/properties/invoice_id" eq: "$ref": "#/components/schemas/resource_contact_entry/properties/invoice_id" contains: "$ref": "#/components/schemas/resource_contact_entry/properties/invoice_id" not_eq: "$ref": "#/components/schemas/resource_contact_entry/properties/invoice_id" description: Filter using explicit operator syntax. description: Filter by the associated invoice. subsidiary_id: oneOf: - "$ref": "#/components/schemas/resource_contact_entry/properties/subsidiary_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_contact_entry/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_contact_entry/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_contact_entry/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_contact_entry/properties/subsidiary_id" description: Filter using explicit operator syntax. description: Filter by the associated subsidiary. contactable_type: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_type" not_contain: "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_type" not_eq: "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_type" contains: "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_type" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_type" description: Filter by the type of the contactable resource (person or company). contactable_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_id" contains: "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_id" not_contain: "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_id" not_eq: "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_id" description: Filter by the ID of the contactable resource (person or company). person_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_contact_entry/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_contact_entry/properties/person_id" eq: "$ref": "#/components/schemas/resource_contact_entry/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_contact_entry/properties/person_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_contact_entry/properties/person_id" description: Filter by the associated person. company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_contact_entry/properties/company_id" contains: "$ref": "#/components/schemas/resource_contact_entry/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_contact_entry/properties/company_id" eq: "$ref": "#/components/schemas/resource_contact_entry/properties/company_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_contact_entry/properties/company_id" description: Filter by client company. patternProperties: "^person..*$": title: Person relationship "^company..*$": title: Company relationship "^invoice..*$": title: Invoice relationship "^proposal..*$": title: Proposal relationship "^subsidiary..*$": title: Subsidiary relationship "^contactable..*$": title: Contactable relationship description: Filter parameters for listing contact entries. Supports filtering by contactable type (company or person), contact type, and parent company or person ID. Standard ID operators apply. _filter_root_comment: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_comment" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_comment" description: Filter schema for `comment` list endpoints — pass a single condition or a logical group. _filter_root_event: oneOf: - "$ref": "#/components/schemas/filter_event" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_event" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `event` list endpoints — pass a single condition or a logical group. _filter_root_financial_item_report: oneOf: - "$ref": "#/components/schemas/filter_financial_item_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_financial_item_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `financial_item_report` list endpoints — pass a single condition or a logical group. filter_proposal_report: type: object title: Filter proposal report properties: creator_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_proposal_report/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/creator_id" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/creator_id" description: Named-operator filter for creator ID in proposal reports. - "$ref": "#/components/schemas/resource_proposal_report/properties/creator_id" description: Filters proposal report rows by the creator person ID. sent_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_proposal_report/properties/sent_at" not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/sent_at" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/sent_at" not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/sent_at" description: Named-operator filter for sent date in proposal reports. - "$ref": "#/components/schemas/resource_proposal_report/properties/sent_at" description: Filters proposal report rows by the date the proposal was sent. formulas: oneOf: - "$ref": "#/components/schemas/resource_proposal_report/properties/formulas" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/formulas" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_proposal_report/properties/formulas" description: Named-operator filter for formula field values in proposal reports. description: Filters proposal report rows by custom formula field values. date_signed: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_proposal_report/properties/date_signed" not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/date_signed" not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/date_signed" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/date_signed" description: Named-operator filter for the date signed in proposal reports. - "$ref": "#/components/schemas/resource_proposal_report/properties/date_signed" description: Filters proposal report rows by the date the proposal was signed. tax_amount: oneOf: - "$ref": "#/components/schemas/resource_proposal_report/properties/tax_amount" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_proposal_report/properties/tax_amount" not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/tax_amount" eq: "$ref": "#/components/schemas/resource_proposal_report/properties/tax_amount" not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/tax_amount" description: Named-operator filter for tax amount in proposal reports. description: Filters proposal report rows by the calculated tax amount. status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/status" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/status" not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/status" eq: "$ref": "#/components/schemas/resource_proposal_report/properties/status" description: Named-operator filter for proposal status in proposal reports. - "$ref": "#/components/schemas/resource_proposal_report/properties/status" description: Filters proposal report rows by the proposal status (e.g. draft, sent, accepted). budget_total: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/budget_total" not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/budget_total" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/budget_total" eq: "$ref": "#/components/schemas/resource_proposal_report/properties/budget_total" description: Named-operator filter for the budget total in proposal reports. - "$ref": "#/components/schemas/resource_proposal_report/properties/budget_total" description: Filters proposal report rows by the proposal budget total amount. updated_at: oneOf: - "$ref": "#/components/schemas/resource_proposal_report/properties/updated_at" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/updated_at" eq: "$ref": "#/components/schemas/resource_proposal_report/properties/updated_at" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/updated_at" not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/updated_at" description: Named-operator filter for updated date in proposal reports. description: Filters proposal report rows by the last update date. deal_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_proposal_report/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/deal_id" eq: "$ref": "#/components/schemas/resource_proposal_report/properties/deal_id" description: Named-operator filter for deal ID in proposal reports. - "$ref": "#/components/schemas/resource_proposal_report/properties/deal_id" description: Filters proposal report rows by the associated deal ID. id: oneOf: - "$ref": "#/components/schemas/resource_proposal_report/properties/id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/id" eq: "$ref": "#/components/schemas/resource_proposal_report/properties/id" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/id" description: Named-operator filter for the proposal report entry ID. description: Filters proposal report rows by their report entry ID. link_status: oneOf: - "$ref": "#/components/schemas/resource_proposal_report/properties/link_status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/link_status" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/link_status" eq: "$ref": "#/components/schemas/resource_proposal_report/properties/link_status" not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/link_status" description: Named-operator filter for link status in proposal reports. description: Filters proposal report rows by the proposal public link status. company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/company_id" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/company_id" eq: "$ref": "#/components/schemas/resource_proposal_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/company_id" description: Named-operator filter for company ID in proposal reports. - "$ref": "#/components/schemas/resource_proposal_report/properties/company_id" description: Filters proposal report rows by the associated company ID. status_changed_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/status_changed_at" eq: "$ref": "#/components/schemas/resource_proposal_report/properties/status_changed_at" not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/status_changed_at" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/status_changed_at" description: Named-operator filter for status change date in proposal reports. - "$ref": "#/components/schemas/resource_proposal_report/properties/status_changed_at" description: Filters proposal report rows by the date the proposal status last changed. responsible_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_proposal_report/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/responsible_id" not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/responsible_id" description: Named-operator filter for responsible person ID in proposal reports. - "$ref": "#/components/schemas/resource_proposal_report/properties/responsible_id" description: Filters proposal report rows by the responsible person ID. created_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_proposal_report/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_proposal_report/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_proposal_report/properties/created_at" contains: "$ref": "#/components/schemas/resource_proposal_report/properties/created_at" description: Named-operator filter for creation date in proposal reports. - "$ref": "#/components/schemas/resource_proposal_report/properties/created_at" description: Filters proposal report rows by the proposal creation date. patternProperties: "^deal..*$": title: Deal relationship "^company..*$": title: Company relationship "^creator..*$": title: Creator relationship "^responsible..*$": title: Responsible relationship description: Filter parameters for querying proposal report data. _filter_root_booking: oneOf: - "$ref": "#/components/schemas/filter_booking" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_booking" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `booking` list endpoints — pass a single condition or a logical group. _filter_root_workflow_status: oneOf: - "$ref": "#/components/schemas/filter_workflow_status" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_workflow_status" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `workflow_status` list endpoints — pass a single condition or a logical group. filter_placeholder: type: object title: Filter placeholder properties: project_id: oneOf: - "$ref": "#/components/schemas/resource_placeholder/properties/project_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_placeholder/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_placeholder/properties/project_id" eq: "$ref": "#/components/schemas/resource_placeholder/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_placeholder/properties/project_id" description: Filter using explicit operator syntax. description: Filter by the associated project. category: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_placeholder/properties/category" eq: "$ref": "#/components/schemas/resource_placeholder/properties/category" not_contain: "$ref": "#/components/schemas/resource_placeholder/properties/category" contains: "$ref": "#/components/schemas/resource_placeholder/properties/category" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_placeholder/properties/category" description: Filter by placeholder category. usage_project_id: oneOf: - "$ref": "#/components/schemas/resource_placeholder/properties/usage_project_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_placeholder/properties/usage_project_id" contains: "$ref": "#/components/schemas/resource_placeholder/properties/usage_project_id" not_eq: "$ref": "#/components/schemas/resource_placeholder/properties/usage_project_id" eq: "$ref": "#/components/schemas/resource_placeholder/properties/usage_project_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter placeholders that are used in tasks or todos belonging to the specified project. name: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_placeholder/properties/name" contains: "$ref": "#/components/schemas/resource_placeholder/properties/name" eq: "$ref": "#/components/schemas/resource_placeholder/properties/name" not_eq: "$ref": "#/components/schemas/resource_placeholder/properties/name" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_placeholder/properties/name" description: Filter by name (text search). query: oneOf: - "$ref": "#/components/schemas/resource_placeholder/properties/query" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_placeholder/properties/query" not_contain: "$ref": "#/components/schemas/resource_placeholder/properties/query" eq: "$ref": "#/components/schemas/resource_placeholder/properties/query" not_eq: "$ref": "#/components/schemas/resource_placeholder/properties/query" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter placeholders by name (text search on the name field). type: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_placeholder/properties/type" not_eq: "$ref": "#/components/schemas/resource_placeholder/properties/type" eq: "$ref": "#/components/schemas/resource_placeholder/properties/type" contains: "$ref": "#/components/schemas/resource_placeholder/properties/type" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_placeholder/properties/type" description: Filter by placeholder type. created_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_placeholder/properties/created_at" contains: "$ref": "#/components/schemas/resource_placeholder/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_placeholder/properties/created_at" eq: "$ref": "#/components/schemas/resource_placeholder/properties/created_at" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_placeholder/properties/created_at" description: Filter by creation date range. id: oneOf: - "$ref": "#/components/schemas/resource_placeholder/properties/id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_placeholder/properties/id" not_contain: "$ref": "#/components/schemas/resource_placeholder/properties/id" not_eq: "$ref": "#/components/schemas/resource_placeholder/properties/id" eq: "$ref": "#/components/schemas/resource_placeholder/properties/id" description: Filter using explicit operator syntax. description: Filter by ID. patternProperties: "^project..*$": title: Project relationship description: Filter parameters for resource planning placeholders. filter_payment_reminder_sequence: type: object title: Filter payment reminder sequence properties: default_sequence: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/default_sequence" contains: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/default_sequence" not_eq: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/default_sequence" eq: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/default_sequence" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/default_sequence" description: Filter by default sequence status; when true, includes only the default payment reminder sequence. patternProperties: {} description: Filter parameters for payment reminder sequences. resource_overhead: type: object title: Overhead Resource properties: started_on: type: string title: Started On format: date description: Date when this overhead period starts. internal_work_costs_default: title: Internal Work Costs Default description: The internal work costs default. undertracked_hours: type: number title: Undertracked Hours description: Hours not tracked by employees relative to their scheduled capacity during this period. new_internal_cost_per_hour_normalized: title: New Internal Cost Per Hour Normalized description: The new internal cost per hour normalized. internal_expense_costs: title: Internal Expense Costs description: The total cost of internal expense reports during this overhead period. internal_hours: type: number title: Internal Hours description: Total hours tracked on internal (non-billable) projects during this overhead period. internal_expense_costs_default: title: Internal Expense Costs Default description: The internal expense costs default. overhead_hours: type: number title: Overhead Hours description: Total hours marked as overhead across all project types during this period. capacity: type: number title: Capacity description: The total available work capacity in hours for the period, based on employee schedules. overtracked_costs_normalized: title: Overtracked Costs Normalized description: The overtracked costs in the normalized (display) currency. client_overhead_hours: type: number title: Client Overhead Hours description: Hours tracked on billable client projects that are marked as overhead during this period. currency_normalized: title: Currency Normalized description: The monetary values in this overhead record in the normalized (display) currency. time_off_costs_default: title: Time Off Costs Default description: The time off costs default. subsidiary: title: Subsidiary description: The subsidiary this overhead record is associated with (null for global overheads). recalculating_status: type: object title: Recalculating Status description: The current recalculation status of this overhead, tracking whether bookings and time entries have been processed. recalculated_at: type: string title: Recalculated At format: date-time description: Timestamp when the overhead costs were last recalculated from tracked time and bookings. total_hours: type: number title: Total Hours description: Total hours tracked across all project types during this overhead period. undertracked_costs_default: title: Undertracked Costs Default description: The undertracked costs converted to the organization's default currency. ended_on: type: string title: Ended On format: date description: Date when this overhead period ends, or null if this is the current projection period. time_off_overhead_hours: type: number title: Time Off Overhead Hours description: The time off overhead hours. facility_costs: type: integer title: Facility Costs description: The total facility (office and infrastructure) costs allocated to this overhead period. time_off_costs: title: Time Off Costs description: The total cost of paid time-off hours during this overhead period. client_hours: type: number title: Client Hours description: Total hours tracked on billable client projects during this overhead period. new_internal_cost_per_hour_default: title: New Internal Cost Per Hour Default description: The new internal cost per hour default. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary this overhead record is associated with (null for global overheads). facility_cost_per_hour_normalized: title: Facility Cost Per Hour Normalized description: The facility cost per hour normalized. updated_at: type: string title: Updated At format: date-time description: Timestamp when this overhead record was last updated. internal_expense_costs_normalized: title: Internal Expense Costs Normalized description: The internal expense costs normalized. time_off_hours: type: number title: Time Off Hours description: Total paid time-off hours taken by employees during this overhead period. exchange_rate: type: number title: Exchange Rate description: The exchange rate used to convert costs to the organization's default currency for this period. use_overhead: type: boolean title: Use Overhead description: When true, overhead calculations are enabled and applied to cost rate computations for this subsidiary. undertracked_costs: title: Undertracked Costs description: The cost associated with undertracked hours — when employees tracked less time than their scheduled capacity. uses_averaging: type: boolean title: Uses Averaging description: When true, overhead costs are averaged over multiple past periods rather than using a single period's values. overtracked_costs: title: Overtracked Costs description: The cost associated with overtracked hours — when employees tracked more time than their scheduled capacity. facility_costs_normalized: title: Facility Costs Normalized description: The facility costs in the normalized (display) currency. new_internal_cost_per_hour: title: New Internal Cost Per Hour description: The new internal cost per hour. currency: type: string title: Currency description: The currency of monetary values in this overhead record. internal_work_costs: title: Internal Work Costs description: The total cost of time tracked on internal projects during this overhead period. facility_costs_default: title: Facility Costs Default description: The facility costs converted to the organization's default currency. updater: title: Updater description: The person who last updated this overhead record. facility_costs_breakdown: type: object title: Facility Costs Breakdown description: A breakdown of facility costs by category (e.g. rent, utilities) for this overhead period. time_off_costs_normalized: title: Time Off Costs Normalized description: The time off costs normalized. currency_default: title: Currency Default description: The monetary values in this overhead record converted to the organization's default currency. internal_componentized_costs_normalized: title: Internal Componentized Costs Normalized description: The internal componentized costs normalized. averaging_period: type: integer title: Averaging Period description: The number of past overhead periods used to calculate projected estimates when averaging is enabled. internal_work_costs_normalized: title: Internal Work Costs Normalized description: The internal work costs normalized. internal_componentized_costs_default: title: Internal Componentized Costs Default description: The internal componentized costs default. internal_componentized_costs: title: Internal Componentized Costs description: The total internal costs including work, time-off, and expenses, adjusted for overhead inclusion controls. overtracked_costs_default: title: Overtracked Costs Default description: The overtracked costs converted to the organization's default currency. overhead_controls: type: object title: Overhead Controls description: A set of flags controlling which overhead types (facility, work, time-off, expense, undertime, overtime) are included in cost calculations. organization: title: Organization description: The organization this overhead record belongs to. facility_cost_per_hour_default: title: Facility Cost Per Hour Default description: The facility cost per hour default. overtracked_hours: type: number title: Overtracked Hours description: Hours tracked in excess of the employee's scheduled capacity during this period. facility_cost_per_hour: title: Facility Cost Per Hour description: The facility cost per hour. internal_overhead_hours: type: number title: Internal Overhead Hours description: Hours tracked on internal projects that are marked as overhead during this period. undertracked_costs_normalized: title: Undertracked Costs Normalized description: The undertracked costs in the normalized (display) currency. description: An overhead record representing the internal cost breakdown for a subsidiary over a billing period. resource_organization_membership: type: object title: Organization membership Resource properties: organization_id: type: integer title: Organization description: ID of the organization this membership belongs to. position: type: integer title: Position description: The job title or position of this member within the organization. booking_approvals_filter_id: type: integer title: Booking Approvals Filter description: The booking approvals filter id. quick_start_config: type: string title: Quick Start Config description: Configuration for the quick-start onboarding experience for this member. salary_reports_favorite_filter: title: Salary Reports Favorite Filter description: The salary report filter favorited by this organization membership. tasks_filter_id: type: integer title: Tasks Filter description: ID of the member's default filter for the tasks list view. contacts_favorite_filter: title: Contacts Favorite Filter description: The member's pinned favorite filter for the contacts list view. deal_services_favorite_filter: title: Deal Services Favorite Filter description: The deal services favorite filter. salary_reports_filter_id: type: integer title: Salary Reports Filter description: ID of the saved salary report filter applied by default for this organization membership. budgets_filter_id: type: integer title: Budgets Filter description: ID of the member's default filter for the budgets list view. payments_filter_id: type: integer title: Payments Filter description: ID of the member's default filter for the payments list view. time_entry_reports_favorite_filter: title: Time Entry Reports Favorite Filter description: The pinned (favorite) time entry report filter for this organization membership. email_notifications: type: boolean title: Email Notifications description: Whether this member receives email notifications from the organization. time_tracking_policy: title: Time Tracking Policy description: The time tracking policy applied to this member. tasks_favorite_filter: title: Tasks Favorite Filter description: The member's pinned favorite filter for the tasks list view. booking_approvals_favorite_filter: title: Booking Approvals Favorite Filter description: The saved filter ID for the current user's booking approvals view. user: title: User description: The user account associated with this organization membership. budget_services_filter_id: type: integer title: Budget Services Filter description: The budget services filter id. invoices_favorite_filter: title: Invoices Favorite Filter description: The member's pinned favorite filter for the invoices list view. granular_notification_preferences: type: object title: Granular Notification Preferences description: Granular per-event email notification preferences for this member. updated_at: type: string title: Updated At format: date-time description: Timestamp when this organization membership was last updated. time_entry_reports_filter_id: type: integer title: Time Entry Reports Filter description: The ID of the saved filter applied by default when viewing time entry reports. people_filter_id: type: integer title: People Filter description: ID of the member's default filter for the people list view. expenses_favorite_filter: title: Expenses Favorite Filter description: The member's pinned favorite filter for the expenses list view. internal_budget_services_favorite_filter: title: Internal Budget Services Favorite Filter description: The internal budget services favorite filter. budgets_favorite_filter: title: Budgets Favorite Filter description: The member's pinned favorite filter for the budgets list view. internal_budget_services_filter_id: type: integer title: Internal Budget Services Filter description: The internal budget services filter id. company_time_favorite_filter: title: Company Time Favorite Filter description: The company time favorite filter. bookings_favorite_filter: title: Bookings Favorite Filter description: The member's pinned favorite filter for the bookings list view. contacts_filter_id: type: integer title: Contacts Filter description: ID of the member's default filter for the contacts list view. time_approvals_filter_id: type: integer title: Time Approvals Filter description: The time approvals filter id. time_approvals_favorite_filter: title: Time Approvals Favorite Filter description: The time approvals favorite filter. people_favorite_filter: title: People Favorite Filter description: The member's pinned favorite filter for the people list view. weekly_emails: type: boolean title: Weekly Emails description: Whether this member receives weekly summary emails from the organization. projects_filter_id: type: integer title: Projects Filter description: ID of the member's default filter for the projects list view. employees_favorite_filter: title: Employees Favorite Filter description: The favorite filter saved by this member for the employees section of the organization. docs_favorite_filter: title: Docs Favorite Filter description: The member's pinned favorite filter for the docs list view. companies_filter_id: type: integer title: Companies Filter description: ID of the member's default filter for the companies list view. docs_filter_id: type: integer title: Docs Filter description: ID of the member's default filter for the docs list view. projects_favorite_filter: title: Projects Favorite Filter description: The member's pinned favorite filter for the projects list view. bookings_filter_id: type: integer title: Bookings Filter description: ID of the member's default filter for the bookings list view. tasks_layout_id: type: integer title: Tasks Layout description: ID of the layout preference used for the tasks view by this member. invoices_filter_id: type: integer title: Invoices Filter description: ID of the member's default filter for the invoices list view. expense_approvals_favorite_filter: title: Expense Approvals Favorite Filter description: The expense approvals favorite filter. time_reports_favorite_filter: title: Time Reports Favorite Filter description: The time report filter favorited by this organization membership. deal_services_filter_id: type: integer title: Deal Services Filter description: The deal services filter id. company_time_filter_id: type: integer title: Company Time Filter description: The company time filter id. companies_favorite_filter: title: Companies Favorite Filter description: The member's pinned favorite filter for the companies list view. deals_favorite_filter: title: Deals Favorite Filter description: The member's pinned favorite filter for the deals list view. expense_approvals_filter_id: type: integer title: Expense Approvals Filter description: The expense approvals filter id. deals_filter_id: type: integer title: Deals Filter description: ID of the member's default filter for the deals list view. time_reports_filter_id: type: integer title: Time Reports Filter description: ID of the saved time report filter applied by default for this organization membership. organization: title: Organization description: The organization this membership belongs to. preferences: type: string title: Preferences description: Miscellaneous UI preferences stored for this member. person: title: Person description: The person associated with this organization membership. budget_services_favorite_filter: title: Budget Services Favorite Filter description: The budget services favorite filter. employees_filter_id: type: integer title: Employees Filter description: ID of the default filter this member uses in the employees section of the organization. payments_favorite_filter: title: Payments Favorite Filter description: The member's pinned favorite filter for the payments list view. expenses_filter_id: type: integer title: Expenses Filter description: ID of the member's default filter for the expenses list view. time_reminders: type: boolean title: Time Reminders description: Whether this member receives time tracking reminder notifications. description: User-organization access link. Stores per-user preferences including notification settings, email preferences, default saved filters for each list view (tasks, deals, projects, invoices, expenses, bookings, etc.), time reminder settings, and UI layout preferences. filter_role: type: object title: Filter role properties: inactive_users_count: oneOf: - "$ref": "#/components/schemas/resource_role/properties/inactive_users_count" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_role/properties/inactive_users_count" not_eq: "$ref": "#/components/schemas/resource_role/properties/inactive_users_count" not_contain: "$ref": "#/components/schemas/resource_role/properties/inactive_users_count" eq: "$ref": "#/components/schemas/resource_role/properties/inactive_users_count" description: Object form with operator key. description: Filter by the number of inactive human users assigned this role. active_agents_count: oneOf: - "$ref": "#/components/schemas/resource_role/properties/active_agents_count" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_role/properties/active_agents_count" contains: "$ref": "#/components/schemas/resource_role/properties/active_agents_count" eq: "$ref": "#/components/schemas/resource_role/properties/active_agents_count" not_contain: "$ref": "#/components/schemas/resource_role/properties/active_agents_count" description: Object form with operator key. description: Filter by the number of active agent (bot) users assigned this role. base_role_id: oneOf: - "$ref": "#/components/schemas/resource_role/properties/base_role_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_role/properties/base_role_id" contains: "$ref": "#/components/schemas/resource_role/properties/base_role_id" not_eq: "$ref": "#/components/schemas/resource_role/properties/base_role_id" not_contain: "$ref": "#/components/schemas/resource_role/properties/base_role_id" description: Filter using explicit operator syntax. description: Filter by base role ID. id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_role/properties/id" contains: "$ref": "#/components/schemas/resource_role/properties/id" not_contain: "$ref": "#/components/schemas/resource_role/properties/id" eq: "$ref": "#/components/schemas/resource_role/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_role/properties/id" description: Filter by ID. name: oneOf: - "$ref": "#/components/schemas/resource_role/properties/name" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_role/properties/name" not_contain: "$ref": "#/components/schemas/resource_role/properties/name" contains: "$ref": "#/components/schemas/resource_role/properties/name" not_eq: "$ref": "#/components/schemas/resource_role/properties/name" description: Filter using explicit operator syntax. description: Filter by role name (text search). permissions: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_role/properties/permissions" eq: "$ref": "#/components/schemas/resource_role/properties/permissions" not_contain: "$ref": "#/components/schemas/resource_role/properties/permissions" contains: "$ref": "#/components/schemas/resource_role/properties/permissions" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_role/properties/permissions" description: Filter by permission (text search). inactive_agents_count: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_role/properties/inactive_agents_count" eq: "$ref": "#/components/schemas/resource_role/properties/inactive_agents_count" not_contain: "$ref": "#/components/schemas/resource_role/properties/inactive_agents_count" contains: "$ref": "#/components/schemas/resource_role/properties/inactive_agents_count" description: Object form with operator key. - "$ref": "#/components/schemas/resource_role/properties/inactive_agents_count" description: Filter by the number of inactive agent (bot) users assigned this role. user_type_id: oneOf: - "$ref": "#/components/schemas/resource_role/properties/user_type_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_role/properties/user_type_id" eq: "$ref": "#/components/schemas/resource_role/properties/user_type_id" not_contain: "$ref": "#/components/schemas/resource_role/properties/user_type_id" not_eq: "$ref": "#/components/schemas/resource_role/properties/user_type_id" description: Filter using explicit operator syntax. description: Filter by user type ID. active_users_count: oneOf: - "$ref": "#/components/schemas/resource_role/properties/active_users_count" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_role/properties/active_users_count" not_contain: "$ref": "#/components/schemas/resource_role/properties/active_users_count" contains: "$ref": "#/components/schemas/resource_role/properties/active_users_count" not_eq: "$ref": "#/components/schemas/resource_role/properties/active_users_count" description: Object form with operator key. description: Filter by the number of active human users assigned this role. patternProperties: {} description: Filter parameters for roles. filter_payment_report: type: object title: Filter payment report properties: paid_before: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payment_report/properties/paid_before" not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/paid_before" eq: "$ref": "#/components/schemas/resource_payment_report/properties/paid_before" not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/paid_before" description: Filter operator object for paid before. - "$ref": "#/components/schemas/resource_payment_report/properties/paid_before" description: Filter payment report results by paid before. query: oneOf: - "$ref": "#/components/schemas/resource_payment_report/properties/query" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/query" contains: "$ref": "#/components/schemas/resource_payment_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/query" eq: "$ref": "#/components/schemas/resource_payment_report/properties/query" description: Filter operator object for query. description: Filter payment report results by query. subsidiary_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payment_report/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_payment_report/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/subsidiary_id" description: Filter operator object for subsidiary id. - "$ref": "#/components/schemas/resource_payment_report/properties/subsidiary_id" description: Filter payment report results by subsidiary id. paid_on: oneOf: - "$ref": "#/components/schemas/resource_payment_report/properties/paid_on" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payment_report/properties/paid_on" eq: "$ref": "#/components/schemas/resource_payment_report/properties/paid_on" not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/paid_on" not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/paid_on" description: Filter operator object for paid on. description: Filter payment report results by paid on. company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/company_id" eq: "$ref": "#/components/schemas/resource_payment_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/company_id" contains: "$ref": "#/components/schemas/resource_payment_report/properties/company_id" description: Filter operator object for company id. - "$ref": "#/components/schemas/resource_payment_report/properties/company_id" description: Filter payment report results by company id. written_off_on: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/written_off_on" contains: "$ref": "#/components/schemas/resource_payment_report/properties/written_off_on" eq: "$ref": "#/components/schemas/resource_payment_report/properties/written_off_on" not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/written_off_on" description: Filter operator object for written off on. - "$ref": "#/components/schemas/resource_payment_report/properties/written_off_on" description: Filter payment report results by written off on. project_id: oneOf: - "$ref": "#/components/schemas/resource_payment_report/properties/project_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/project_id" eq: "$ref": "#/components/schemas/resource_payment_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/project_id" contains: "$ref": "#/components/schemas/resource_payment_report/properties/project_id" description: Filter operator object for project id. description: Filter payment report results by project id. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payment_report/properties/id" contains: "$ref": "#/components/schemas/resource_payment_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/id" description: Filter operator object for id. - "$ref": "#/components/schemas/resource_payment_report/properties/id" description: Filter payment report results by id. paid_after: oneOf: - "$ref": "#/components/schemas/resource_payment_report/properties/paid_after" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_payment_report/properties/paid_after" not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/paid_after" contains: "$ref": "#/components/schemas/resource_payment_report/properties/paid_after" not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/paid_after" description: Filter operator object for paid after. description: Filter payment report results by paid after. budget_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/budget_id" contains: "$ref": "#/components/schemas/resource_payment_report/properties/budget_id" eq: "$ref": "#/components/schemas/resource_payment_report/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/budget_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_payment_report/properties/budget_id" description: Filter by the associated budget (deal) ID. invoice_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/invoice_id" eq: "$ref": "#/components/schemas/resource_payment_report/properties/invoice_id" not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/invoice_id" contains: "$ref": "#/components/schemas/resource_payment_report/properties/invoice_id" description: Filter operator object for invoice id. - "$ref": "#/components/schemas/resource_payment_report/properties/invoice_id" description: Filter payment report results by invoice id. amount: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/amount" not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/amount" contains: "$ref": "#/components/schemas/resource_payment_report/properties/amount" eq: "$ref": "#/components/schemas/resource_payment_report/properties/amount" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_payment_report/properties/amount" description: Filter by payment amount range. formulas: oneOf: - "$ref": "#/components/schemas/resource_payment_report/properties/formulas" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_payment_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_payment_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/formulas" not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/formulas" description: Filter operator object for formulas. description: Filter payment report results by formulas. number: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/number" eq: "$ref": "#/components/schemas/resource_payment_report/properties/number" contains: "$ref": "#/components/schemas/resource_payment_report/properties/number" not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/number" description: Filter operator object for number. - "$ref": "#/components/schemas/resource_payment_report/properties/number" description: Filter payment report results by number. external_id: oneOf: - "$ref": "#/components/schemas/resource_payment_report/properties/external_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_payment_report/properties/external_id" contains: "$ref": "#/components/schemas/resource_payment_report/properties/external_id" eq: "$ref": "#/components/schemas/resource_payment_report/properties/external_id" not_eq: "$ref": "#/components/schemas/resource_payment_report/properties/external_id" description: Filter operator object for external id. description: Filter payment report results by external id. patternProperties: "^invoice..*$": title: Invoice relationship description: Available filter parameters for querying aggregated payment report data. resource_expense: type: object title: Expense Resource properties: full_query: type: string title: Full Query description: Full-text search query matching across expense fields. invoiced: type: boolean title: Invoiced description: Whether this expense has been invoiced to the client. service: title: Service description: The budget service this expense is allocated to. service_type: title: Service Type description: The work category for this expense. billable_amount_default: title: Billable Amount Default description: Amount to be billed to the client in the organization default currency. deal_id: type: integer title: Deal description: ID of the budget or deal this expense is charged to. awaiting_approval_from_approver_id: type: integer title: Awaiting Approval From Approver description: ID of the approver this expense is currently awaiting approval from. position: type: integer title: Position description: Position of this expense. jump_query: type: string title: Jump Query description: Jump/quick search query for this expense. approved: title: Approved description: Whether this expense has been approved. external_payment_id: type: string title: External Payment description: Payment ID in external payment system. created_at: type: string title: Created At format: date-time description: Date when the expense was created in the system. quantity_received: type: number title: Quantity Received description: Number of units received (for purchase order expenses). billable_amount_normalized: title: Billable Amount Normalized description: Amount to be billed to the client in the budget currency. creator_id: type: integer title: Creator description: ID of the person who created this expense record. deal_name: title: Deal Name description: Name of the budget this expense is charged to. approval_statuses: title: Approval Statuses description: Per-approver decisions on this expense. person_id: type: integer title: Person description: ID of the person the expense was incurred for. query: type: string title: Query description: Text search query matching expense names and descriptions. vendor: title: Vendor description: The vendor company this expense was paid to. tax_rate_id: type: integer title: Tax Rate description: ID of the tax rate applied to this expense. amount_with_tax_default: title: Amount With Tax Default description: Unit amount including tax in the organization default currency. purchase_order_id: type: integer title: Purchase Order description: ID of the purchase order this expense belongs to. example: 1234567 assigned_approver_id: type: integer title: Assigned Approver description: ID of the person assigned as approver for this expense. billable_amount: type: integer title: Billable Amount description: Amount to be billed to the client in the expense currency. paid_on_after: type: string title: Paid On After format: date description: Earliest date (exclusive) for querying expenses by paid_on. paid_on_before: type: string title: Paid On Before format: date description: Latest date (exclusive) for querying expenses by paid_on. fuzzy_people: type: integer title: Fuzzy People description: Fuzzy people filter for querying expenses. exported_at: type: string title: Exported At format: date-time description: Timestamp when the expense was exported. approver: title: Approver description: The person who approved this expense. recognized_revenue: title: Recognized Revenue description: Expected revenue based on the service's billing type in the expense currency. name: type: string title: Name description: What the expense was for (travel, software, external costs, etc.). attachment_id: type: integer title: Attachment description: ID of the receipt or document attached to this expense. stage_type: enum: - 1 - 2 type: integer title: Stage Type description: Stage type of the budget this expense belongs to. tax_inclusion: type: boolean title: Tax Inclusion description: Whether the amount includes tax or is tax-exclusive. export_integration_type_id: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 9 - 10 - 11 type: integer title: Export Integration Type description: Type of accounting integration used for export. pay_on: type: string title: Pay On format: date description: Due date for payment. amount_default: title: Amount Default description: Unit cost of the expense in the organization default currency. invoice_attribution: title: Invoice Attribution description: The invoice attribution linking this expense to an invoice. attachment: title: Attachment description: Receipt or document attached to this expense. total_amount_normalized: title: Total Amount Normalized description: Total cost (quantity × unit amount) before tax in the budget currency. profit: title: Profit description: Difference between billable amount and total cost in the expense currency. total_amount_with_tax: title: Total Amount With Tax description: Total amount including tax in the expense currency. pay_on_after: type: string title: Pay On After format: date description: Earliest date (exclusive) for querying expenses by pay_on. exchange_rate_normalized: type: number title: Exchange Rate Normalized description: Exchange rate from expense currency to budget currency. approver_id: type: integer title: Approver description: ID of the person who approved this expense. approval_status: enum: - 1 - 2 - 3 - 4 type: integer title: Approval Status description: Overall approval status across all approvers. responsible_id: type: integer title: Responsible description: ID of the person responsible for this expense. exchange_date: type: string title: Exchange Date format: date description: Date used for exchange rate calculation. rejecter: title: Rejecter description: The person who rejected this expense. company_reference_id: type: integer title: Company Reference description: Company reference ID in the external accounting system. deal_project_name: title: Deal Project Name description: Name of the project associated with the expense's budget. allocation_status: enum: - 1 - 2 type: string title: Allocation Status description: Whether this expense has been allocated to a service, or is unallocated (when the expense-without-service feature is enabled). reimbursed_on: type: string title: Reimbursed On format: date description: Date when the expense was reimbursed. deal: title: Deal description: The budget or deal this expense is charged to. total_amount_with_tax_default: title: Total Amount With Tax Default description: Total amount including tax in the organization default currency. service_type_name: title: Service Type Name description: Name of the work category for this expense. currency: type: string title: Currency description: Currency code of the expense. deal_company_name: title: Deal Company Name description: Name of the client company associated with the expense's budget. with_draft: type: boolean title: With Draft description: Whether to include draft expenses in results. markup: type: number title: Markup description: The markup percentage applied on top of the expense cost when billing to the client. date_after: type: string title: Date After format: date description: Earliest date (exclusive) for querying expenses by date. rejected_at: type: string title: Rejected At format: date-time description: Timestamp when the expense was rejected. line_items_count: type: integer title: Line Items Count description: Number of the expense line items on this expense. paid_on: type: string title: Paid On format: date description: Date when the expense was actually paid. section_name: type: string title: Section Name description: Name of the section within the budget where the expense's service is grouped. custom_field_people: title: Custom Field People description: People in person-type custom fields. amount_normalized: title: Amount Normalized description: Unit cost of the expense in the budget currency. reimbursable: type: boolean title: Reimbursable description: Whether this expense is eligible for reimbursement to the person. total_amount_with_tax_normalized: title: Total Amount With Tax Normalized description: Total amount including tax in the budget currency. currency_normalized: title: Currency Normalized description: Budget currency code. exchange_rate: type: number title: Exchange Rate description: Exchange rate from expense currency to organization default currency. export_url: type: string title: Export Url description: URL to view this expense in the external accounting system. id: type: integer title: Id description: Unique identifier of the expense. recognized_revenue_default: title: Recognized Revenue Default description: Expected revenue based on the service's billing type in the organization default currency. total_amount_default: title: Total Amount Default description: Total cost (quantity × unit amount) before tax in the organization default currency. exported: title: Exported description: Whether the expense has been exported to external accounting software. expense_line_items: title: Expense Line Items description: Individual line items if the expense has multiple items. profit_default: title: Profit Default description: Difference between billable amount and total cost in the organization default currency. vendor_id: type: integer title: Vendor description: ID of the vendor company this expense was paid to. company_id: type: integer title: Company description: ID of the client company associated with the budget of this expense. status: enum: - 1 - 2 type: integer title: Status description: Approval status of this expense. project_id: type: integer title: Project description: ID of the project associated with the expense's budget. rejected: title: Rejected description: Whether this expense was rejected during approval. date_before: type: string title: Date Before format: date description: Latest date (exclusive) for querying expenses by date. amount_with_tax: title: Amount With Tax description: Unit amount including tax in the expense currency. amount_with_tax_normalized: title: Amount With Tax Normalized description: Unit amount including tax in the budget currency. export_id: type: string title: Export description: ID in the external accounting system. draft: type: boolean title: Draft description: Whether this expense is still in draft status on the purchase order. profit_normalized: title: Profit Normalized description: Difference between billable amount and total cost in the budget currency. amount: type: integer title: Amount description: Unit cost of the expense in the expense currency. deleted_at: type: string title: Deleted At format: date-time description: Soft-deletion timestamp. custom_field_attachments: title: Custom Field Attachments description: Files in file-type custom fields. reimbursement: enum: - 1 - 2 - 3 type: integer title: Reimbursement description: Reimbursement details for this expense. recognized_revenue_normalized: title: Recognized Revenue Normalized description: Expected revenue based on the service's billing type in the budget currency. purchase_order: title: Purchase Order description: The purchase order this expense belongs to, if any. example: data: type: purchase_orders id: '1234567' currency_default: title: Currency Default description: Organization default currency code. total_amount: title: Total Amount description: Total cost (quantity × unit amount) before tax in the expense currency. quote_type: title: Quote Type description: Quote type identifier for this expense. person: title: Person description: The person the expense was incurred for. fuzzy_dates: type: string title: Fuzzy Dates format: date description: Fuzzy date range filter for querying expenses. custom_fields: type: object title: Custom Fields description: Custom field values. service_type_id: type: integer title: Service Type description: ID of the work category for this expense. invoicing_status: enum: - 1 - 2 - 3 type: integer title: Invoicing Status description: Invoicing status of this expense. invoice_id: type: integer title: Invoice description: ID of the invoice this expense is attributed to. rejected_reason: type: string title: Rejected Reason description: Reason why the expense was rejected. export_status: enum: - 1 - 2 type: integer title: Export Status description: Export status in the external accounting system. organization: title: Organization description: The organization this expense belongs to. quantity: type: number title: Quantity description: Number of units on the expense. creator: title: Creator description: The person who created this expense record. date: type: string title: Date format: date description: Date when the expense was incurred. pay_on_before: type: string title: Pay On Before format: date description: Latest date (exclusive) for querying expenses by pay_on. tax_rate: title: Tax Rate description: The tax rate applied to this expense. service_id: type: integer title: Service description: ID of the budget service this expense is allocated to. approved_at: type: string title: Approved At format: date-time description: Date when the expense was approved. designated_approver_id: type: integer title: Designated Approver description: ID of the person designated as the approver for this expense's budget. service_name: title: Service Name description: Name of the budget service this expense is allocated to. description: A non-labor cost logged against a budget service. Expenses track vendor costs, support approval and reimbursement workflows, and can be invoiced to clients. filter_task_list: type: object title: Filter task list properties: restorable: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_list/properties/restorable" not_eq: "$ref": "#/components/schemas/resource_task_list/properties/restorable" eq: "$ref": "#/components/schemas/resource_task_list/properties/restorable" not_contain: "$ref": "#/components/schemas/resource_task_list/properties/restorable" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_list/properties/restorable" description: Filter to task lists that are archived but whose parent folder is still active (can be restored). folder_id: oneOf: - "$ref": "#/components/schemas/resource_task_list/properties/folder_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_list/properties/folder_id" not_contain: "$ref": "#/components/schemas/resource_task_list/properties/folder_id" eq: "$ref": "#/components/schemas/resource_task_list/properties/folder_id" not_eq: "$ref": "#/components/schemas/resource_task_list/properties/folder_id" description: Filter using explicit operator syntax. description: Filter by folder ID (alias for board_id). status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_list/properties/status" eq: "$ref": "#/components/schemas/resource_task_list/properties/status" not_contain: "$ref": "#/components/schemas/resource_task_list/properties/status" contains: "$ref": "#/components/schemas/resource_task_list/properties/status" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_list/properties/status" description: Filter by task list status (active or archived). id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_list/properties/id" not_eq: "$ref": "#/components/schemas/resource_task_list/properties/id" not_contain: "$ref": "#/components/schemas/resource_task_list/properties/id" eq: "$ref": "#/components/schemas/resource_task_list/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_list/properties/id" description: Filter by task list ID. project_id: oneOf: - "$ref": "#/components/schemas/resource_task_list/properties/project_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_list/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_task_list/properties/project_id" eq: "$ref": "#/components/schemas/resource_task_list/properties/project_id" contains: "$ref": "#/components/schemas/resource_task_list/properties/project_id" description: Filter using explicit operator syntax. description: Filter by project ID. board_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_list/properties/board_id" contains: "$ref": "#/components/schemas/resource_task_list/properties/board_id" not_eq: "$ref": "#/components/schemas/resource_task_list/properties/board_id" eq: "$ref": "#/components/schemas/resource_task_list/properties/board_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_list/properties/board_id" description: Filter by folder (board) ID. query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_list/properties/query" contains: "$ref": "#/components/schemas/resource_task_list/properties/query" eq: "$ref": "#/components/schemas/resource_task_list/properties/query" not_eq: "$ref": "#/components/schemas/resource_task_list/properties/query" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_list/properties/query" description: Filter by task list name (text search). patternProperties: "^board..*$": title: Board relationship "^folder..*$": title: Folder relationship "^project..*$": title: Project relationship description: Filter parameters for listing task lists. Supports filtering by project, board (folder), archived status, and position. Standard ID operators apply. _filter_root_invoice_report: oneOf: - "$ref": "#/components/schemas/filter_invoice_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_invoice_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `invoice_report` list endpoints — pass a single condition or a logical group. filter_survey_response: type: object title: Filter survey response properties: created_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_survey_response/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_survey_response/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_survey_response/properties/created_at" eq: "$ref": "#/components/schemas/resource_survey_response/properties/created_at" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_survey_response/properties/created_at" description: Filter by creation date range. custom_fields: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_survey_response/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_survey_response/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_survey_response/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_survey_response/properties/custom_fields" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_survey_response/properties/custom_fields" description: Filter by custom field values. creator_id: oneOf: - "$ref": "#/components/schemas/resource_survey_response/properties/creator_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_survey_response/properties/creator_id" eq: "$ref": "#/components/schemas/resource_survey_response/properties/creator_id" contains: "$ref": "#/components/schemas/resource_survey_response/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_survey_response/properties/creator_id" description: Filter using explicit operator syntax. description: Filter by the person who submitted the response. id: oneOf: - "$ref": "#/components/schemas/resource_survey_response/properties/id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_survey_response/properties/id" contains: "$ref": "#/components/schemas/resource_survey_response/properties/id" not_contain: "$ref": "#/components/schemas/resource_survey_response/properties/id" not_eq: "$ref": "#/components/schemas/resource_survey_response/properties/id" description: Filter using explicit operator syntax. description: Filter by ID. survey_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_survey_response/properties/survey_id" not_contain: "$ref": "#/components/schemas/resource_survey_response/properties/survey_id" not_eq: "$ref": "#/components/schemas/resource_survey_response/properties/survey_id" eq: "$ref": "#/components/schemas/resource_survey_response/properties/survey_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_survey_response/properties/survey_id" description: Filter by the associated survey. patternProperties: "^survey..*$": title: Survey relationship "^creator..*$": title: Creator relationship description: Filter parameters for listing survey responses. Supports filtering by survey. Standard ID operators apply. resource_price: type: object title: Price Resource properties: unit_id: enum: - 1 - 2 - 3 type: integer title: Unit description: ID of the unit used for this price entry (e.g. hours, days). service_type: title: Service Type description: The service type associated with this price entry. service_type_id: type: integer title: Service Type description: ID of the service type associated with this price entry. estimated_cost_default: title: Estimated Cost Default description: The estimated cost converted to the organization's default currency, in whole currency units. budget_cap_enabled: type: boolean title: Budget Cap Enabled description: When true, the price entry has a budget cap configured for spending limits. custom_field_attachments: title: Custom Field Attachments description: File attachments linked to custom fields on this price entry. expense_tracking_enabled: type: boolean title: Expense Tracking Enabled description: When true, expenses can be tracked against this price entry. currency_normalized: title: Currency Normalized description: Currency-normalized price for reporting purposes. currency: type: string title: Currency description: Currency code for this price (e.g. USD, EUR). markup: type: number title: Markup description: The markup percentage added on top of the cost for this price entry. billing_type_id: enum: - 1 - 2 - 3 - 4 type: integer title: Billing Type description: 'Billing type for services using this price: hourly, daily, fixed-fee, etc.' company: title: Company description: The client company associated with this price entry. organization: title: Organization description: The organization this price entry belongs to. editor_config: type: object title: Editor Config description: Configuration for the rich-text editor associated with this price entry. rate_card_id: type: integer title: Rate Card description: ID of the rate card this price entry belongs to, if any. estimated_cost_normalized: title: Estimated Cost Normalized description: The estimated cost converted to the organization's normalized currency, in whole currency units. rate_card_status: enum: - 1 - 2 type: integer title: Rate Card Status description: The status of the rate card associated with this price entry (active or archived). updater: title: Updater description: The person who last updated this price entry. time_tracking_enabled: type: boolean title: Time Tracking Enabled description: When true, time entries can be tracked against this price entry. custom_fields: type: object title: Custom Fields description: Custom field values for this price entry. rate_card: title: Rate Card description: The rate card this price entry belongs to, if any. discount: type: number title: Discount description: The discount percentage applied to the rate of this price entry. id: type: integer title: Id description: The unique identifier of this price. rate: type: number title: Rate description: Billing rate in the rate card's currency. custom_field_people: title: Custom Field People description: People referenced by custom field values on this price entry. estimated_cost: type: number title: Estimated Cost description: The estimated cost of this price entry in the entry's currency, in whole currency units. name: type: string title: Name description: Display name for this rate card line item (typically the service type name). rate_default: title: Rate Default description: Rate in the organization's default currency. company_id: type: integer title: Company description: ID of the client company associated with this price entry. rate_normalized: title: Rate Normalized description: Rate normalized to a common currency for cross-company comparison. updated_at: type: string title: Updated At format: date-time description: Timestamp when this price entry was last updated. estimated_hours: type: number title: Estimated Hours description: The estimated number of hours for this price entry. quantity: type: number title: Quantity description: The quantity of units for this price entry. currency_default: title: Currency Default description: Price in the organization's default currency. booking_tracking_enabled: type: boolean title: Booking Tracking Enabled description: When true, resource bookings can be tracked against this price entry. description: A rate card line item defining billing type, hourly/daily rate, tracking unit, and default settings for new services. filter_salary: type: object title: Filter salary properties: person_id: oneOf: - "$ref": "#/components/schemas/resource_salary/properties/person_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_salary/properties/person_id" contains: "$ref": "#/components/schemas/resource_salary/properties/person_id" not_eq: "$ref": "#/components/schemas/resource_salary/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_salary/properties/person_id" description: Filter using explicit operator syntax. description: Filter by the associated person. before: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_salary/properties/before" contains: "$ref": "#/components/schemas/resource_salary/properties/before" not_eq: "$ref": "#/components/schemas/resource_salary/properties/before" not_contain: "$ref": "#/components/schemas/resource_salary/properties/before" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_salary/properties/before" description: Filter by before. after: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_salary/properties/after" not_eq: "$ref": "#/components/schemas/resource_salary/properties/after" contains: "$ref": "#/components/schemas/resource_salary/properties/after" not_contain: "$ref": "#/components/schemas/resource_salary/properties/after" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_salary/properties/after" description: Filter by after. patternProperties: {} description: Filter parameters for listing salaries (cost rates and working capacities, called Engagements internally). Supports filtering by person, date range, salary type, and currency. Standard ID and date operators apply. filter_workflow_status: type: object title: Filter workflow status properties: query: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_workflow_status/properties/query" eq: "$ref": "#/components/schemas/resource_workflow_status/properties/query" contains: "$ref": "#/components/schemas/resource_workflow_status/properties/query" not_eq: "$ref": "#/components/schemas/resource_workflow_status/properties/query" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_workflow_status/properties/query" description: Filter by workflow status name using a partial text search. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_workflow_status/properties/id" not_contain: "$ref": "#/components/schemas/resource_workflow_status/properties/id" not_eq: "$ref": "#/components/schemas/resource_workflow_status/properties/id" contains: "$ref": "#/components/schemas/resource_workflow_status/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_workflow_status/properties/id" description: Filter by workflow status ID. name: oneOf: - "$ref": "#/components/schemas/resource_workflow_status/properties/name" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_workflow_status/properties/name" contains: "$ref": "#/components/schemas/resource_workflow_status/properties/name" not_eq: "$ref": "#/components/schemas/resource_workflow_status/properties/name" not_contain: "$ref": "#/components/schemas/resource_workflow_status/properties/name" description: Filter using explicit operator syntax. description: Filter by exact workflow status name. workflow_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_workflow_status/properties/workflow_id" contains: "$ref": "#/components/schemas/resource_workflow_status/properties/workflow_id" not_eq: "$ref": "#/components/schemas/resource_workflow_status/properties/workflow_id" not_contain: "$ref": "#/components/schemas/resource_workflow_status/properties/workflow_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_workflow_status/properties/workflow_id" description: Filter by the associated workflow. category_id: oneOf: - "$ref": "#/components/schemas/resource_workflow_status/properties/category_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_workflow_status/properties/category_id" not_contain: "$ref": "#/components/schemas/resource_workflow_status/properties/category_id" contains: "$ref": "#/components/schemas/resource_workflow_status/properties/category_id" eq: "$ref": "#/components/schemas/resource_workflow_status/properties/category_id" description: Filter using explicit operator syntax. description: Filter by workflow status category (Not Started, Started, or Closed). patternProperties: {} description: Filter parameters for listing workflow statuses. Supports filtering by workflow, category (not_started, started, closed), and position. Standard ID operators apply. _filter_root_einvoice_identity: oneOf: - "$ref": "#/components/schemas/filter_einvoice_identity" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. example: and patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_einvoice_identity" description: Object form allowing multiple filter conditions combined with a logical operator. required: - "$op" example: '0': subsidiary_id: '42' "$op": and description: Root filter object for e-invoice identity resources. Supports combining multiple conditions with logical operators. example: company_id: '89' _filter_root_section: oneOf: - "$ref": "#/components/schemas/filter_section" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_section" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `section` list endpoints — pass a single condition or a logical group. resource_lost_reason: type: object title: Lost reason Resource properties: name: type: string title: Name description: Label text displayed on the deal when marked as lost. archived_at: type: string title: Archived At format: date-time description: Timestamp when this lost reason was archived, or null if active. id: type: integer title: Id description: The unique identifier of this lost reason. organization: title: Organization description: The organization this lost reason belongs to. description: A label explaining why a deal was lost, used for sales pipeline analytics. resource_person_report: type: object title: Person report Resource properties: person_last_name: title: Person Last Name description: The person's last name (denormalized copy for reporting). agent: type: boolean title: Agent description: The AI agent account linked to this person in the report, if this person represents an AI agent. person_last_activity_at: title: Person Last Activity At description: Timestamp of the most recent activity on the person associated with this report row. last_seen_at: type: string title: Last Seen At format: date description: Timestamp when the person last accessed the platform. virtual: type: boolean title: Virtual description: Whether this person is a virtual/placeholder person. person_first_name: title: Person First Name description: The person's first name (denormalized copy for reporting). count: type: integer title: Count description: The count of person records in this report row. bookings_before: type: string title: Bookings Before format: date description: The booking/scheduling window end date for this person. jump_query: type: string title: Jump Query description: Quick-navigation query token for this person. permissions: type: string title: Permissions description: The person's permission level in the organization. approval_policy_id: type: integer title: Approval Policy description: ID of the approval policy assigned to this person. autotracking: type: integer title: Autotracking description: Whether automatic time tracking is enabled for this person. company_id: type: integer title: Company description: ID of the client company this person belongs to. last_activity_at_period: title: Last Activity At Period description: Time period grouping for last activity date (e.g. week, month, quarter). offboarding_status: enum: - not_initiated - in_progress - failed - completed type: string title: Offboarding Status description: The person's offboarding status. query: type: string title: Query description: The full-text search query for this report row. company: title: Company description: The client company this person is associated with. first_name: type: string title: First Name description: The person's first name. person_custom_fields: title: Person Custom Fields description: Custom field values for the person (denormalized copy for reporting). contact_address: title: Contact Address description: The person's contact street address. accessible_project_id: type: integer title: Accessible Project description: ID of a project the person has access to. person_email: title: Person Email description: The person's email address (denormalized copy for reporting). contact_email: title: Contact Email description: The person's contact email address. year: type: string title: Year description: The calendar year of the reporting period. contact_city: title: Contact City description: The person's contact city. contact_website: title: Contact Website description: The person's contact website URL. joined_at_period: title: Joined At Period description: The time period bucket for join date, used when grouping by joined_at. created_at: type: string title: Created At format: date description: Timestamp when the person's account was created. approval_policy: title: Approval Policy description: The approval policy assigned to this person for time or absence approvals. hrm_type_id: enum: - 1 - 2 type: integer title: Hrm Type description: ID of the HRM type/employment category for this person. approval_workflow_id: type: integer title: Approval Workflow description: ID of the approval workflow configuration for this person. contact_zipcode: title: Contact Zipcode description: The person's contact zip/postal code. service_id: type: integer title: Service description: ID of a service this person is assigned to. accessible_deal_id: type: integer title: Accessible Deal description: ID of a deal the person has access to. service_type_id: type: integer title: Service Type description: ID of a service type this person is assigned to. subsidiary: title: Subsidiary description: The subsidiary this person belongs to. fuzzy_people: type: string title: Fuzzy People description: Fuzzy-matched person name tokens for search. currency: title: Currency description: The currency used for monetary values in this report row. organization: title: Organization description: The organization this person belongs to. time_tracking_policy_id: type: integer title: Time Tracking Policy description: ID of the time tracking policy assigned to this person. company_report: title: Company Report description: Aggregated report data for the client company this person belongs to. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary this person belongs to. person_role_id: title: Person Role description: ID of the person's assigned role (denormalized copy for reporting). bookings_after: type: string title: Bookings After format: date description: The booking/scheduling window start date for this person. contact_country: title: Contact Country description: The person's contact country. subscribable_id: type: integer title: Subscribable description: ID of the resource this person is subscribed to. custom_role_id: type: integer title: Custom Role description: ID of the custom role assigned to this person. team: type: integer title: Team description: The team this person belongs to. custom_role: title: Custom Role description: The custom role assigned to this person. person_type: type: string title: Person Type description: The person's type — employee, contractor, client contact, or placeholder. archived_at: type: string title: Archived At format: date description: Timestamp when the person was archived. project_id: type: integer title: Project description: ID of a project the person is associated with. contact_state: title: Contact State description: The person's contact state or region. custom_fields: type: string title: Custom Fields description: Custom field values attached to this person. person: title: Person description: The linked person record for this report row. currency_default: title: Currency Default description: Whether this row uses the organization's default currency. person_status: title: Person Status description: The person's active/inactive status (denormalized copy for reporting). person_active_teams: title: Person Active Teams description: The teams this person is currently active in. quarter: type: string title: Quarter description: The calendar quarter of the reporting period. person_last_seen_at: title: Person Last Seen At description: Timestamp of person's last platform access (denormalized copy for reporting). schedulable: type: boolean title: Schedulable description: Whether this person can be scheduled on bookings. timesheet_submission_disabled: type: boolean title: Timesheet Submission Disabled description: Whether timesheet submission is disabled for this person. role_id: type: integer title: Role description: ID of the role assigned to this person. deactivated_at: type: string title: Deactivated At format: date description: Timestamp when the person was deactivated. group: type: string title: Group description: The dimension/grouping used when this report row is aggregated. accessible_doc_id: type: integer title: Accessible Doc description: ID of a doc the person has access to. fuzzy_dates: type: string title: Fuzzy Dates description: Fuzzy-matched date tokens for this person. project_watching: type: integer title: Project Watching description: Projects the person is watching. person_created_at: title: Person Created At description: Timestamp when the person was created (denormalized copy for reporting). email: type: string title: Email description: The person's login email address. tags: type: string title: Tags description: Tags assigned to the person. id: type: integer title: Id description: The unique identifier of this person report row. last_activity_at: type: string title: Last Activity At format: date description: Timestamp of the most recent activity on this person. title: type: string title: Title description: The person's job title. formula_fields: title: Formula Fields description: Computed/formula field values for this person. manager: title: Manager description: The person's direct manager. person_name: title: Person Name description: The person's full name. two_factor_auth: type: boolean title: Two Factor Auth description: Whether two-factor authentication is enabled for this person. contact_phone: title: Contact Phone description: The person's contact phone number. joined_at: type: string title: Joined At format: date description: The date the person officially joined the organization. deactivated_at_period: title: Deactivated At Period description: The time period bucket for deactivation date, used when grouping by deactivated_at. accessible_filter_id: type: string title: Accessible Filter description: ID of a saved filter the person has access to. holiday_calendar_id: type: integer title: Holiday Calendar description: ID of the holiday calendar assigned to this person. status: enum: - 1 - 2 type: integer title: Status description: The person's active/inactive status. person_joined_at: title: Person Joined At description: The date the person joined (denormalized copy for reporting). person_title: title: Person Title description: The person's job title (denormalized copy for reporting). full_query: type: string title: Full Query description: Full-text search index content for this person. week: type: string title: Week description: The calendar week of the reporting period. manager_id: type: integer title: Manager description: ID of the person's direct manager. type: title: Type description: The resource type identifier for this report row. currency_normalized: title: Currency Normalized description: Whether monetary values in this row are normalized to the base currency. last_name: type: string title: Last Name description: The person's last name. created_at_period: title: Created At Period description: The time period bucket for account creation date, used when grouping by created_at. month: type: string title: Month description: The calendar month of the reporting period. report: title: Report description: Aggregated report metrics for this person. person_deactivated_at: title: Person Deactivated At description: Timestamp when the person was deactivated (denormalized copy for reporting). eligible_replacement_managers: type: integer title: Eligible Replacement Managers description: People who can substitute as manager for this person during absence. subscribable_type: type: string title: Subscribable Type description: Type of the resource this person is subscribed to. manager_report: title: Manager Report description: Aggregated report data for this person's manager. description: An aggregated person report row grouping people by configurable dimensions with utilization, capacity, and cost metrics. _filter_root_deal_report: oneOf: - "$ref": "#/components/schemas/filter_deal_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_deal_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `deal_report` list endpoints — pass a single condition or a logical group. resource_timesheet: type: object title: Timesheet Resource properties: created_at: type: string title: Created At format: date-time description: Timestamp when the timesheet was created. date: type: string title: Date format: date description: The date this timesheet covers. creator_id: type: integer title: Creator description: The ID of the person who created this timesheet. person: title: Person description: The person this timesheet belongs to. creator: title: Creator description: The person who created this timesheet. organization: title: Organization description: The organization this timesheet belongs to. id: title: Id description: Unique identifier for the timesheet. person_id: type: integer title: Person description: The ID of the person this timesheet belongs to. description: A daily aggregate of a person's time entries, serving as the unit of submission in the time approval workflow. _filter_root_payment: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_payment" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_payment" description: Filter schema for `payment` list endpoints — pass a single condition or a logical group. filter_expense: type: object title: Filter expense properties: quantity: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/quantity" not_eq: "$ref": "#/components/schemas/resource_expense/properties/quantity" eq: "$ref": "#/components/schemas/resource_expense/properties/quantity" contains: "$ref": "#/components/schemas/resource_expense/properties/quantity" description: Filter operator object for quantity. - "$ref": "#/components/schemas/resource_expense/properties/quantity" description: Filter expenses by quantity. date_before: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/date_before" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/date_before" contains: "$ref": "#/components/schemas/resource_expense/properties/date_before" not_eq: "$ref": "#/components/schemas/resource_expense/properties/date_before" eq: "$ref": "#/components/schemas/resource_expense/properties/date_before" description: Filter operator object for date_before. description: Filter expenses incurred before this date. deal_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/deal_id" contains: "$ref": "#/components/schemas/resource_expense/properties/deal_id" eq: "$ref": "#/components/schemas/resource_expense/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/deal_id" description: Filter operator object for deal_id. - "$ref": "#/components/schemas/resource_expense/properties/deal_id" description: Filter expenses by budget or deal ID. with_draft: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/with_draft" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/with_draft" not_contain: "$ref": "#/components/schemas/resource_expense/properties/with_draft" eq: "$ref": "#/components/schemas/resource_expense/properties/with_draft" contains: "$ref": "#/components/schemas/resource_expense/properties/with_draft" description: Filter operator object for with_draft. description: Filter expenses by whether drafts are included. tax_rate_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/tax_rate_id" not_eq: "$ref": "#/components/schemas/resource_expense/properties/tax_rate_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/tax_rate_id" eq: "$ref": "#/components/schemas/resource_expense/properties/tax_rate_id" description: Filter operator object for tax_rate_id. - "$ref": "#/components/schemas/resource_expense/properties/tax_rate_id" description: Filter expenses by tax rate ID. person_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/person_id" eq: "$ref": "#/components/schemas/resource_expense/properties/person_id" contains: "$ref": "#/components/schemas/resource_expense/properties/person_id" description: Filter operator object for person_id. - "$ref": "#/components/schemas/resource_expense/properties/person_id" description: Filter expenses by person ID. query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/query" eq: "$ref": "#/components/schemas/resource_expense/properties/query" not_eq: "$ref": "#/components/schemas/resource_expense/properties/query" not_contain: "$ref": "#/components/schemas/resource_expense/properties/query" description: Filter operator object for query. - "$ref": "#/components/schemas/resource_expense/properties/query" description: Text search query matching expense names. paid_on_after: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/paid_on_after" not_eq: "$ref": "#/components/schemas/resource_expense/properties/paid_on_after" eq: "$ref": "#/components/schemas/resource_expense/properties/paid_on_after" contains: "$ref": "#/components/schemas/resource_expense/properties/paid_on_after" description: Filter operator object for paid_on_after. - "$ref": "#/components/schemas/resource_expense/properties/paid_on_after" description: Filter expenses paid after this date. approval_status: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/approval_status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/approval_status" contains: "$ref": "#/components/schemas/resource_expense/properties/approval_status" not_eq: "$ref": "#/components/schemas/resource_expense/properties/approval_status" eq: "$ref": "#/components/schemas/resource_expense/properties/approval_status" description: Filter operator object for approval_status. description: Filter expenses by approval status. recognized_revenue: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/recognized_revenue" eq: "$ref": "#/components/schemas/resource_expense/properties/recognized_revenue" not_eq: "$ref": "#/components/schemas/resource_expense/properties/recognized_revenue" not_contain: "$ref": "#/components/schemas/resource_expense/properties/recognized_revenue" description: Filter operator object for recognized_revenue. - "$ref": "#/components/schemas/resource_expense/properties/recognized_revenue" description: Filter expenses by recognized revenue. fuzzy_dates: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_expense/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_expense/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_expense/properties/fuzzy_dates" description: Filter operator object for fuzzy_dates. - "$ref": "#/components/schemas/resource_expense/properties/fuzzy_dates" description: Filter expenses by fuzzy date range. approved_at: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/approved_at" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/approved_at" not_eq: "$ref": "#/components/schemas/resource_expense/properties/approved_at" eq: "$ref": "#/components/schemas/resource_expense/properties/approved_at" not_contain: "$ref": "#/components/schemas/resource_expense/properties/approved_at" description: Object form with operator key (eq, not_eq, contains, not_contain). description: Filter by the date the expense was approved (`approved_at`). pay_on: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/pay_on" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/pay_on" not_contain: "$ref": "#/components/schemas/resource_expense/properties/pay_on" not_eq: "$ref": "#/components/schemas/resource_expense/properties/pay_on" eq: "$ref": "#/components/schemas/resource_expense/properties/pay_on" description: Filter operator object for pay_on. description: Filter expenses by payment due date. quote_type: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/quote_type" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/quote_type" eq: "$ref": "#/components/schemas/resource_expense/properties/quote_type" not_contain: "$ref": "#/components/schemas/resource_expense/properties/quote_type" not_eq: "$ref": "#/components/schemas/resource_expense/properties/quote_type" description: Filter operator object for quote_type. description: Filter expenses by quote type. pay_on_before: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/pay_on_before" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/pay_on_before" eq: "$ref": "#/components/schemas/resource_expense/properties/pay_on_before" not_contain: "$ref": "#/components/schemas/resource_expense/properties/pay_on_before" contains: "$ref": "#/components/schemas/resource_expense/properties/pay_on_before" description: Filter operator object for pay_on_before. description: Filter expenses with payment due before this date. invoiced: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense/properties/invoiced" contains: "$ref": "#/components/schemas/resource_expense/properties/invoiced" not_contain: "$ref": "#/components/schemas/resource_expense/properties/invoiced" not_eq: "$ref": "#/components/schemas/resource_expense/properties/invoiced" description: Filter operator object for invoiced. - "$ref": "#/components/schemas/resource_expense/properties/invoiced" description: Filter expenses by invoiced status. reimbursed_on: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/reimbursed_on" not_contain: "$ref": "#/components/schemas/resource_expense/properties/reimbursed_on" contains: "$ref": "#/components/schemas/resource_expense/properties/reimbursed_on" eq: "$ref": "#/components/schemas/resource_expense/properties/reimbursed_on" description: Filter operator object for reimbursed_on. - "$ref": "#/components/schemas/resource_expense/properties/reimbursed_on" description: Filter expenses by reimbursed_on date. responsible_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_expense/properties/responsible_id" not_eq: "$ref": "#/components/schemas/resource_expense/properties/responsible_id" description: Filter operator object for responsible_id. - "$ref": "#/components/schemas/resource_expense/properties/responsible_id" description: Filter expenses by responsible person ID. currency: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense/properties/currency" not_contain: "$ref": "#/components/schemas/resource_expense/properties/currency" contains: "$ref": "#/components/schemas/resource_expense/properties/currency" not_eq: "$ref": "#/components/schemas/resource_expense/properties/currency" description: Filter operator object for currency. - "$ref": "#/components/schemas/resource_expense/properties/currency" description: Filter expenses by currency code. stage_type: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/stage_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/stage_type" contains: "$ref": "#/components/schemas/resource_expense/properties/stage_type" eq: "$ref": "#/components/schemas/resource_expense/properties/stage_type" not_eq: "$ref": "#/components/schemas/resource_expense/properties/stage_type" description: Filter operator object for stage_type. description: Filter expenses by budget stage type. service_id: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/service_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense/properties/service_id" contains: "$ref": "#/components/schemas/resource_expense/properties/service_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/service_id" not_eq: "$ref": "#/components/schemas/resource_expense/properties/service_id" description: Filter operator object for service_id. description: Filter expenses by service ID. full_query: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_expense/properties/full_query" eq: "$ref": "#/components/schemas/resource_expense/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_expense/properties/full_query" description: Filter operator object for full_query. - "$ref": "#/components/schemas/resource_expense/properties/full_query" description: Full-text search query across expense fields. name: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/name" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/name" eq: "$ref": "#/components/schemas/resource_expense/properties/name" not_eq: "$ref": "#/components/schemas/resource_expense/properties/name" not_contain: "$ref": "#/components/schemas/resource_expense/properties/name" description: Filter operator object for name. description: Filter expenses by name. section_name: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/section_name" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/section_name" contains: "$ref": "#/components/schemas/resource_expense/properties/section_name" not_contain: "$ref": "#/components/schemas/resource_expense/properties/section_name" eq: "$ref": "#/components/schemas/resource_expense/properties/section_name" description: Filter operator object for section_name. description: Filter expenses by section name. designated_approver_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/designated_approver_id" eq: "$ref": "#/components/schemas/resource_expense/properties/designated_approver_id" not_eq: "$ref": "#/components/schemas/resource_expense/properties/designated_approver_id" contains: "$ref": "#/components/schemas/resource_expense/properties/designated_approver_id" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_expense/properties/designated_approver_id" description: Filter by the designated approver person ID set on the budget the expense belongs to. amount_with_tax: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/amount_with_tax" eq: "$ref": "#/components/schemas/resource_expense/properties/amount_with_tax" contains: "$ref": "#/components/schemas/resource_expense/properties/amount_with_tax" not_eq: "$ref": "#/components/schemas/resource_expense/properties/amount_with_tax" description: Filter operator object for amount_with_tax. - "$ref": "#/components/schemas/resource_expense/properties/amount_with_tax" description: Filter expenses by unit amount including tax. created_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/created_at" contains: "$ref": "#/components/schemas/resource_expense/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_expense/properties/created_at" eq: "$ref": "#/components/schemas/resource_expense/properties/created_at" description: Filter operator object for created_at. - "$ref": "#/components/schemas/resource_expense/properties/created_at" description: Filter expenses by creation date. jump_query: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_expense/properties/jump_query" contains: "$ref": "#/components/schemas/resource_expense/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_expense/properties/jump_query" description: Filter operator object for jump_query. - "$ref": "#/components/schemas/resource_expense/properties/jump_query" description: Jump search query for quick expense lookup. paid_on: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/paid_on" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/paid_on" contains: "$ref": "#/components/schemas/resource_expense/properties/paid_on" not_contain: "$ref": "#/components/schemas/resource_expense/properties/paid_on" eq: "$ref": "#/components/schemas/resource_expense/properties/paid_on" description: Filter operator object for paid_on. description: Filter expenses by paid_on date. billable_amount: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense/properties/billable_amount" not_eq: "$ref": "#/components/schemas/resource_expense/properties/billable_amount" not_contain: "$ref": "#/components/schemas/resource_expense/properties/billable_amount" contains: "$ref": "#/components/schemas/resource_expense/properties/billable_amount" description: Filter operator object for billable_amount. - "$ref": "#/components/schemas/resource_expense/properties/billable_amount" description: Filter expenses by billable amount. paid_on_before: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/paid_on_before" not_eq: "$ref": "#/components/schemas/resource_expense/properties/paid_on_before" contains: "$ref": "#/components/schemas/resource_expense/properties/paid_on_before" eq: "$ref": "#/components/schemas/resource_expense/properties/paid_on_before" description: Filter operator object for paid_on_before. - "$ref": "#/components/schemas/resource_expense/properties/paid_on_before" description: Filter expenses paid before this date. reimbursable: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/reimbursable" not_contain: "$ref": "#/components/schemas/resource_expense/properties/reimbursable" eq: "$ref": "#/components/schemas/resource_expense/properties/reimbursable" contains: "$ref": "#/components/schemas/resource_expense/properties/reimbursable" description: Filter operator object for reimbursable. - "$ref": "#/components/schemas/resource_expense/properties/reimbursable" description: Filter expenses by reimbursable status. export_status: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/export_status" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/export_status" not_contain: "$ref": "#/components/schemas/resource_expense/properties/export_status" eq: "$ref": "#/components/schemas/resource_expense/properties/export_status" contains: "$ref": "#/components/schemas/resource_expense/properties/export_status" description: Filter operator object for export_status. description: Filter expenses by export status. reimbursement: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/reimbursement" eq: "$ref": "#/components/schemas/resource_expense/properties/reimbursement" contains: "$ref": "#/components/schemas/resource_expense/properties/reimbursement" not_contain: "$ref": "#/components/schemas/resource_expense/properties/reimbursement" description: Filter operator object for reimbursement. - "$ref": "#/components/schemas/resource_expense/properties/reimbursement" description: Filter expenses by reimbursement status. profit: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/profit" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/profit" contains: "$ref": "#/components/schemas/resource_expense/properties/profit" eq: "$ref": "#/components/schemas/resource_expense/properties/profit" not_eq: "$ref": "#/components/schemas/resource_expense/properties/profit" description: Filter operator object for profit. description: Filter expenses by profit. date: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/date" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense/properties/date" contains: "$ref": "#/components/schemas/resource_expense/properties/date" not_eq: "$ref": "#/components/schemas/resource_expense/properties/date" not_contain: "$ref": "#/components/schemas/resource_expense/properties/date" description: Filter operator object for date. description: Filter expenses by incurred date. amount: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/amount" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/amount" eq: "$ref": "#/components/schemas/resource_expense/properties/amount" contains: "$ref": "#/components/schemas/resource_expense/properties/amount" not_contain: "$ref": "#/components/schemas/resource_expense/properties/amount" description: Filter operator object for amount. description: Filter expenses by unit amount. awaiting_approval_from_approver_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/awaiting_approval_from_approver_id" contains: "$ref": "#/components/schemas/resource_expense/properties/awaiting_approval_from_approver_id" eq: "$ref": "#/components/schemas/resource_expense/properties/awaiting_approval_from_approver_id" not_eq: "$ref": "#/components/schemas/resource_expense/properties/awaiting_approval_from_approver_id" description: Filter operator object for awaiting_approval_from_approver_id. - "$ref": "#/components/schemas/resource_expense/properties/awaiting_approval_from_approver_id" description: Filter expenses by the approver they are awaiting approval from. custom_fields: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/custom_fields" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_expense/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_expense/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_expense/properties/custom_fields" description: Filter operator object for custom_fields. description: Filter expenses by custom field values. invoice_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense/properties/invoice_id" not_eq: "$ref": "#/components/schemas/resource_expense/properties/invoice_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/invoice_id" contains: "$ref": "#/components/schemas/resource_expense/properties/invoice_id" description: Filter operator object for invoice_id. - "$ref": "#/components/schemas/resource_expense/properties/invoice_id" description: Filter expenses by invoice ID. allocation_status: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense/properties/allocation_status" not_eq: "$ref": "#/components/schemas/resource_expense/properties/allocation_status" contains: "$ref": "#/components/schemas/resource_expense/properties/allocation_status" not_contain: "$ref": "#/components/schemas/resource_expense/properties/allocation_status" description: Object form with operator key (eq, not_eq, contains, not_contain). - "$ref": "#/components/schemas/resource_expense/properties/allocation_status" description: Filter by whether the expense is allocated to a service (allocated) or not linked to any service (unallocated). draft: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/draft" not_contain: "$ref": "#/components/schemas/resource_expense/properties/draft" not_eq: "$ref": "#/components/schemas/resource_expense/properties/draft" eq: "$ref": "#/components/schemas/resource_expense/properties/draft" description: Filter operator object for draft. - "$ref": "#/components/schemas/resource_expense/properties/draft" description: Filter expenses by draft status. fuzzy_people: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/fuzzy_people" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/fuzzy_people" not_eq: "$ref": "#/components/schemas/resource_expense/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_expense/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_expense/properties/fuzzy_people" description: Filter operator object for fuzzy_people. description: Filter expenses by fuzzy people match. date_after: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/date_after" not_contain: "$ref": "#/components/schemas/resource_expense/properties/date_after" eq: "$ref": "#/components/schemas/resource_expense/properties/date_after" not_eq: "$ref": "#/components/schemas/resource_expense/properties/date_after" description: Filter operator object for date_after. - "$ref": "#/components/schemas/resource_expense/properties/date_after" description: Filter expenses incurred after this date. service_type_id: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/service_type_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/service_type_id" contains: "$ref": "#/components/schemas/resource_expense/properties/service_type_id" eq: "$ref": "#/components/schemas/resource_expense/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/service_type_id" description: Filter operator object for service_type_id. description: Filter expenses by service type ID. status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/status" contains: "$ref": "#/components/schemas/resource_expense/properties/status" not_eq: "$ref": "#/components/schemas/resource_expense/properties/status" eq: "$ref": "#/components/schemas/resource_expense/properties/status" description: Filter operator object for status. - "$ref": "#/components/schemas/resource_expense/properties/status" description: Filter expenses by approval status. project_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/project_id" eq: "$ref": "#/components/schemas/resource_expense/properties/project_id" contains: "$ref": "#/components/schemas/resource_expense/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/project_id" description: Filter operator object for project_id. - "$ref": "#/components/schemas/resource_expense/properties/project_id" description: Filter expenses by project ID. approver_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/approver_id" not_eq: "$ref": "#/components/schemas/resource_expense/properties/approver_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/approver_id" eq: "$ref": "#/components/schemas/resource_expense/properties/approver_id" description: Filter operator object for approver_id. - "$ref": "#/components/schemas/resource_expense/properties/approver_id" description: Filter expenses by approver ID. pay_on_after: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/pay_on_after" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense/properties/pay_on_after" contains: "$ref": "#/components/schemas/resource_expense/properties/pay_on_after" not_contain: "$ref": "#/components/schemas/resource_expense/properties/pay_on_after" not_eq: "$ref": "#/components/schemas/resource_expense/properties/pay_on_after" description: Filter operator object for pay_on_after. description: Filter expenses with payment due after this date. creator_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/creator_id" eq: "$ref": "#/components/schemas/resource_expense/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_expense/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/creator_id" description: Filter operator object for creator_id. - "$ref": "#/components/schemas/resource_expense/properties/creator_id" description: Filter expenses by creator ID. vendor_id: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/vendor_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_expense/properties/vendor_id" contains: "$ref": "#/components/schemas/resource_expense/properties/vendor_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/vendor_id" not_eq: "$ref": "#/components/schemas/resource_expense/properties/vendor_id" description: Filter operator object for vendor_id. description: Filter expenses by vendor ID. assigned_approver_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/assigned_approver_id" eq: "$ref": "#/components/schemas/resource_expense/properties/assigned_approver_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/assigned_approver_id" not_eq: "$ref": "#/components/schemas/resource_expense/properties/assigned_approver_id" description: Filter operator object for assigned_approver_id. - "$ref": "#/components/schemas/resource_expense/properties/assigned_approver_id" description: Filter expenses by assigned approver ID. company_id: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/company_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_expense/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_expense/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/company_id" eq: "$ref": "#/components/schemas/resource_expense/properties/company_id" description: Filter operator object for company_id. description: Filter expenses by client company ID. id: oneOf: - "$ref": "#/components/schemas/resource_expense/properties/id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/id" not_contain: "$ref": "#/components/schemas/resource_expense/properties/id" eq: "$ref": "#/components/schemas/resource_expense/properties/id" contains: "$ref": "#/components/schemas/resource_expense/properties/id" description: Filter operator object for id. description: Filter expenses by ID. purchase_order_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_expense/properties/purchase_order_id" contains: "$ref": "#/components/schemas/resource_expense/properties/purchase_order_id" eq: "$ref": "#/components/schemas/resource_expense/properties/purchase_order_id" not_eq: "$ref": "#/components/schemas/resource_expense/properties/purchase_order_id" description: Filter operator object for purchase_order_id. example: eq: - 1234567 - "$ref": "#/components/schemas/resource_expense/properties/purchase_order_id" description: Filter expenses by purchase order ID. example: eq: - 1234567 invoicing_status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_expense/properties/invoicing_status" contains: "$ref": "#/components/schemas/resource_expense/properties/invoicing_status" not_contain: "$ref": "#/components/schemas/resource_expense/properties/invoicing_status" eq: "$ref": "#/components/schemas/resource_expense/properties/invoicing_status" description: Filter operator object for invoicing_status. - "$ref": "#/components/schemas/resource_expense/properties/invoicing_status" description: Filter expenses by invoicing status. patternProperties: "^deal..*$": title: Deal relationship "^budget..*$": title: Budget relationship "^person..*$": title: Person relationship "^vendor..*$": title: Vendor relationship "^approver..*$": title: Approver relationship "^service_type..*$": title: Service type relationship "^purchase_order..*$": title: Purchase order relationship description: Available filter parameters for querying expenses. filter_organization_membership: type: object title: Filter organization membership properties: organization_id: oneOf: - "$ref": "#/components/schemas/resource_organization_membership/properties/organization_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_organization_membership/properties/organization_id" contains: "$ref": "#/components/schemas/resource_organization_membership/properties/organization_id" eq: "$ref": "#/components/schemas/resource_organization_membership/properties/organization_id" not_contain: "$ref": "#/components/schemas/resource_organization_membership/properties/organization_id" description: Filter using explicit operator syntax. description: Filter by the associated organization. patternProperties: {} description: Filter parameters for listing organization memberships. Supports filtering by organization and person. Standard ID operators apply. _filter_root_service: oneOf: - "$ref": "#/components/schemas/filter_service" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_service" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `service` list endpoints — pass a single condition or a logical group. _filter_root_entitlement_report: oneOf: - "$ref": "#/components/schemas/filter_entitlement_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_entitlement_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `entitlement_report` list endpoints — pass a single condition or a logical group. _filter_root_task_report: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_task_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_task_report" description: Filter schema for `task_report` list endpoints — pass a single condition or a logical group. filter_einvoice_configuration: type: object title: Filter einvoice configuration properties: subsidiary_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/subsidiary_id" description: Comparison operators for this filter field. example: eq: '42' - "$ref": "#/components/schemas/resource_einvoice_configuration/properties/subsidiary_id" description: Filter by the ID of the associated subsidiary. example: '42' description: Available filter fields for e-invoice configuration resources. example: subsidiary_id: '42' filter_webhook: type: object title: Filter webhook properties: id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_webhook/properties/id" not_contain: "$ref": "#/components/schemas/resource_webhook/properties/id" contains: "$ref": "#/components/schemas/resource_webhook/properties/id" not_eq: "$ref": "#/components/schemas/resource_webhook/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_webhook/properties/id" description: Filter by webhook ID. type_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_webhook/properties/type_id" contains: "$ref": "#/components/schemas/resource_webhook/properties/type_id" not_eq: "$ref": "#/components/schemas/resource_webhook/properties/type_id" eq: "$ref": "#/components/schemas/resource_webhook/properties/type_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_webhook/properties/type_id" description: Filter by webhook type (webhook or Zapier). state_id: oneOf: - "$ref": "#/components/schemas/resource_webhook/properties/state_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_webhook/properties/state_id" eq: "$ref": "#/components/schemas/resource_webhook/properties/state_id" not_contain: "$ref": "#/components/schemas/resource_webhook/properties/state_id" contains: "$ref": "#/components/schemas/resource_webhook/properties/state_id" description: Filter using explicit operator syntax. description: Filter by webhook delivery state (working, issues, or waiting). event_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_webhook/properties/event_id" eq: "$ref": "#/components/schemas/resource_webhook/properties/event_id" contains: "$ref": "#/components/schemas/resource_webhook/properties/event_id" not_contain: "$ref": "#/components/schemas/resource_webhook/properties/event_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_webhook/properties/event_id" description: Filter by the subscribed event type (e.g. new task, updated invoice). patternProperties: {} description: Filter parameters for listing webhook resources, which send HTTP notifications to external URLs when resource events occur. _filter_root_timer: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_timer" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_timer" description: Filter schema for `timer` list endpoints — pass a single condition or a logical group. resource_einvoice_identity: type: object title: E-invoice Identity Resource properties: company: title: Company description: The company this e-invoice identity belongs to. example: data: type: companies id: '89' created_at: type: string title: Created At format: date-time description: Timestamp when the record was created. example: '2025-03-15T10:30:00.000Z' subsidiary: title: Subsidiary description: The subsidiary this e-invoice identity belongs to. example: data: type: subsidiaries id: '42' buyer_reference: type: string title: Buyer Reference description: A buyer reference code required by some e-invoicing systems (e.g., Spanish FACe) to identify the purchasing entity. example: BUYER-REF-001 dir3_fiscal_code: type: string title: Dir3 Fiscal Code description: The Spanish DIR3 fiscal code identifying the government accounting office. example: A01234567 dir3_receptor_code: type: string title: Dir3 Receptor Code description: The Spanish DIR3 code identifying the receiving authority. example: L01234567 company_id: type: integer title: Company description: ID of the company this e-invoice identity belongs to. Mutually exclusive with subsidiary_id. example: '89' updated_at: type: string title: Updated At format: date-time description: Timestamp when the record was last updated. example: '2025-06-01T14:22:00.000Z' dir3_pagador_code: type: string title: Dir3 Pagador Code description: The Spanish DIR3 code identifying the paying authority. example: P00000010 subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary this e-invoice identity belongs to. Mutually exclusive with company_id. example: '42' peppol_id: type: string title: Peppol Id description: The PEPPOL participant identifier used for routing e-invoices through the PEPPOL network. example: '0088:1234567890123' is_government_entity: type: boolean title: Is Government Entity description: Whether this company is a government entity, which affects the e-invoicing format and routing used. example: false dire_code: type: string title: Dire Code description: The Spanish DIRE (Directorio de Entidades) code for electronic delivery. example: DIR3-EXAMPLE description: Stores e-invoicing routing identifiers — such as PEPPOL ID, Italian SDI code, and Spanish DIR3 codes — needed to send or receive e-invoices. Each identity belongs to **either** a company (the invoice recipient) **or** a subsidiary (the invoice sender), never both. Use `company_id` to set up a client's receiving identity, or `subsidiary_id` to set up your own sending identity. example: id: '567' type: einvoice_identities attributes: peppol_id: '0088:1234567890123' buyer_reference: BUYER-REF-001 dir3_fiscal_code: dir3_pagador_code: dir3_receptor_code: dire_code: is_government_entity: false created_at: '2025-04-10T08:15:00.000Z' updated_at: '2025-04-10T08:15:00.000Z' relationships: company: data: type: companies id: '89' filter_webhook_log: type: object title: Filter webhook log properties: retry_attempt: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_webhook_log/properties/retry_attempt" not_contain: "$ref": "#/components/schemas/resource_webhook_log/properties/retry_attempt" eq: "$ref": "#/components/schemas/resource_webhook_log/properties/retry_attempt" contains: "$ref": "#/components/schemas/resource_webhook_log/properties/retry_attempt" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_webhook_log/properties/retry_attempt" description: Filter by the retry attempt number for failed deliveries. after: oneOf: - "$ref": "#/components/schemas/resource_webhook_log/properties/after" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_webhook_log/properties/after" contains: "$ref": "#/components/schemas/resource_webhook_log/properties/after" not_eq: "$ref": "#/components/schemas/resource_webhook_log/properties/after" not_contain: "$ref": "#/components/schemas/resource_webhook_log/properties/after" description: Filter using explicit operator syntax. description: Filter by after. retry_job_id: oneOf: - "$ref": "#/components/schemas/resource_webhook_log/properties/retry_job_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_webhook_log/properties/retry_job_id" eq: "$ref": "#/components/schemas/resource_webhook_log/properties/retry_job_id" not_eq: "$ref": "#/components/schemas/resource_webhook_log/properties/retry_job_id" not_contain: "$ref": "#/components/schemas/resource_webhook_log/properties/retry_job_id" description: Filter using explicit operator syntax. description: Filter by the background job ID used for scheduling the retry delivery. before: oneOf: - "$ref": "#/components/schemas/resource_webhook_log/properties/before" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_webhook_log/properties/before" eq: "$ref": "#/components/schemas/resource_webhook_log/properties/before" not_contain: "$ref": "#/components/schemas/resource_webhook_log/properties/before" contains: "$ref": "#/components/schemas/resource_webhook_log/properties/before" description: Filter using explicit operator syntax. description: Filter by before. webhook_id: oneOf: - "$ref": "#/components/schemas/resource_webhook_log/properties/webhook_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_webhook_log/properties/webhook_id" contains: "$ref": "#/components/schemas/resource_webhook_log/properties/webhook_id" eq: "$ref": "#/components/schemas/resource_webhook_log/properties/webhook_id" not_contain: "$ref": "#/components/schemas/resource_webhook_log/properties/webhook_id" description: Filter using explicit operator syntax. description: Filter by the associated webhook. id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_webhook_log/properties/id" not_contain: "$ref": "#/components/schemas/resource_webhook_log/properties/id" eq: "$ref": "#/components/schemas/resource_webhook_log/properties/id" contains: "$ref": "#/components/schemas/resource_webhook_log/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_webhook_log/properties/id" description: Filter by webhook log ID. patternProperties: {} description: Filter parameters for listing webhook log resources, which record individual delivery attempts for webhooks. filter_task_dependency: type: object title: Filter task dependency properties: type_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_dependency/properties/type_id" not_contain: "$ref": "#/components/schemas/resource_task_dependency/properties/type_id" not_eq: "$ref": "#/components/schemas/resource_task_dependency/properties/type_id" contains: "$ref": "#/components/schemas/resource_task_dependency/properties/type_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_dependency/properties/type_id" description: Filter by dependency type (blocking, waiting_on, or linked). creator_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_dependency/properties/creator_id" not_contain: "$ref": "#/components/schemas/resource_task_dependency/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_task_dependency/properties/creator_id" contains: "$ref": "#/components/schemas/resource_task_dependency/properties/creator_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_dependency/properties/creator_id" description: Filter by the person who created the dependency. task_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_dependency/properties/task_id" not_eq: "$ref": "#/components/schemas/resource_task_dependency/properties/task_id" not_contain: "$ref": "#/components/schemas/resource_task_dependency/properties/task_id" contains: "$ref": "#/components/schemas/resource_task_dependency/properties/task_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_dependency/properties/task_id" description: Filter by the source task ID in the dependency relationship. deleted_at: oneOf: - "$ref": "#/components/schemas/resource_task_dependency/properties/deleted_at" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_task_dependency/properties/deleted_at" contains: "$ref": "#/components/schemas/resource_task_dependency/properties/deleted_at" not_eq: "$ref": "#/components/schemas/resource_task_dependency/properties/deleted_at" not_contain: "$ref": "#/components/schemas/resource_task_dependency/properties/deleted_at" description: Filter using explicit operator syntax. description: Filter by deletion date range (deleted_at); use to find soft-deleted dependencies. updated_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_dependency/properties/updated_at" not_eq: "$ref": "#/components/schemas/resource_task_dependency/properties/updated_at" eq: "$ref": "#/components/schemas/resource_task_dependency/properties/updated_at" contains: "$ref": "#/components/schemas/resource_task_dependency/properties/updated_at" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_dependency/properties/updated_at" description: Filter by last update date range (updated_at). id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_dependency/properties/id" eq: "$ref": "#/components/schemas/resource_task_dependency/properties/id" not_contain: "$ref": "#/components/schemas/resource_task_dependency/properties/id" not_eq: "$ref": "#/components/schemas/resource_task_dependency/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_dependency/properties/id" description: Filter by dependency ID. updater_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_dependency/properties/updater_id" eq: "$ref": "#/components/schemas/resource_task_dependency/properties/updater_id" not_eq: "$ref": "#/components/schemas/resource_task_dependency/properties/updater_id" not_contain: "$ref": "#/components/schemas/resource_task_dependency/properties/updater_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_dependency/properties/updater_id" description: Filter by the person who last updated the dependency. dependent_task_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_task_dependency/properties/dependent_task_id" not_contain: "$ref": "#/components/schemas/resource_task_dependency/properties/dependent_task_id" eq: "$ref": "#/components/schemas/resource_task_dependency/properties/dependent_task_id" contains: "$ref": "#/components/schemas/resource_task_dependency/properties/dependent_task_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_dependency/properties/dependent_task_id" description: Filter by the dependent task ID (the task that depends on another). project_id: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_task_dependency/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_task_dependency/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_task_dependency/properties/project_id" eq: "$ref": "#/components/schemas/resource_task_dependency/properties/project_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_task_dependency/properties/project_id" description: Filter by project ID (via the associated task). created_at: oneOf: - "$ref": "#/components/schemas/resource_task_dependency/properties/created_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_task_dependency/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_task_dependency/properties/created_at" eq: "$ref": "#/components/schemas/resource_task_dependency/properties/created_at" contains: "$ref": "#/components/schemas/resource_task_dependency/properties/created_at" description: Filter using explicit operator syntax. description: Filter by creation date range (created_at). patternProperties: {} description: Filter parameters for listing task dependencies. Supports filtering by task, dependent task, and dependency type (blocking, waiting_on, linked). Standard ID operators apply. resource_person: type: object title: Person Resource properties: status_emoji: type: string title: Status Emoji description: Emoji shown as the person's current status indicator. manager: title: Manager description: The person's manager. account_id: title: Account description: The organization (account) ID. original_avatar_url: type: string title: Original Avatar Url description: URL of the person's original full-size avatar image. service_type_id: type: integer title: Service Type description: Filter by service type ID — returns people assigned to the specified service types. last_activity_at: type: string title: Last Activity At format: date-time description: Timestamp of the last recorded activity for this person across the platform. subscriber_ids: title: Subscriber Ids description: IDs of people subscribed to follow this person. created_at: type: string title: Created At format: date-time description: Timestamp when this person was created. subscribable_id: type: integer title: Subscribable description: Filter by subscribable ID — returns subscribers of the specified resource. company: title: Company description: The company (client) this person belongs to. holiday_calendar_id: type: integer title: Holiday Calendar description: ID of the holiday calendar assigned to this person for scheduling and time-off calculations. query: type: string title: Query description: Text search filter — matches by full name (exact) or contains partial name. email: type: string title: Email description: The person's email address. approval_policy_id: type: integer title: Approval Policy description: ID of the approval policy assigned to this person for time-off and booking approvals. accessible_doc_id: type: integer title: Accessible Doc description: Filter by accessible doc ID — returns people who have access to the specified document. eligible_replacement_managers: type: integer title: Eligible Replacement Managers description: Filter for people eligible to be replacement managers for the specified person ID. approval_workflow_id: type: integer title: Approval Workflow description: Filter by approval workflow ID — returns people who have approvals in the specified workflow. last_seen_at: type: string title: Last Seen At format: date-time description: Timestamp when this person was last seen active in the application. accessible_deal_id: type: integer title: Accessible Deal description: Filter by accessible deal ID — returns people who have access to the specified deal. archived_at: type: string title: Archived At format: date-time description: Timestamp when this person was archived, or null if not archived. time_off_status_sync: type: boolean title: Time Off Status Sync description: Whether this person's time-off status is synced from an external calendar. project_id: type: integer title: Project description: Filter by project ID — returns people who are members of the specified project. subscribable_type: type: string title: Subscribable Type description: Filter by subscribable type — the resource type to match subscribers against. virtual: type: boolean title: Virtual description: Whether this is a virtual person record. deactivated_at: type: string title: Deactivated At format: date-time description: Timestamp when this person was deactivated, or null if currently active. custom_role_id: type: integer title: Custom Role description: ID of the custom role assigned to this person, if any. bookings_after: type: string title: Bookings After format: date description: Filter by bookings_after date — used with resourcing filters to find people with bookings ending on or after this date. company_id: type: integer title: Company description: Filter by company (client) ID. external_id: type: string title: External description: External identifier for syncing this person with an external system. bookings_before: type: string title: Bookings Before format: date description: Filter by bookings_before date — used with resourcing filters to find people with bookings starting on or before this date. team: type: integer title: Team description: Filter by team ID — returns people who belong to the specified team(s). manager_id: type: integer title: Manager description: ID of the person who is this person's direct manager. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary company this person belongs to, if any. time_unlocked_period_id: type: integer title: Time Unlocked Period description: Period identifier for the time unlock. approval_policy_assignment: title: Approval Policy Assignment description: The approval policy assignment for this person. person_type: type: string title: Person Type description: 'Filter by person type — values: user (can log in), contact (external), placeholder (resource planning), agent.' custom_role: title: Custom Role description: The custom role (permission set) assigned to this person. fuzzy_dates: type: string title: Fuzzy Dates description: Fuzzy date filter for approximate date matching. time_tracking_policy_id: type: integer title: Time Tracking Policy description: ID of the time tracking policy applied to this person. offboarding_status: enum: - not_initiated - in_progress - failed - completed type: string title: Offboarding Status description: 'Current offboarding status: not_initiated, in_progress, or completed.' schedulable: type: boolean title: Schedulable description: Filter for schedulable people — returns employees, contractors, and placeholders who can be booked. is_user: title: Is User description: Whether this person has an associated user account and can log in. service_id: type: integer title: Service description: Filter by service ID — returns people who can track time on the specified service. autotracking: type: boolean title: Autotracking description: Whether automatic time tracking is enabled for this person. custom_field_attachments: title: Custom Field Attachments description: File attachments associated with this person via custom fields. champion: title: Champion description: Whether this person is a champion contact. time_unlocked: type: boolean title: Time Unlocked description: Whether the person's time entries are unlocked for editing outside the normal window. subsidiary: title: Subsidiary description: The subsidiary (workplace) this person is associated with. time_unlocked_on: type: string title: Time Unlocked On format: date description: The specific date on which the time unlock was applied. id: type: integer title: Id description: The unique identifier of the person. agent: type: boolean title: Agent description: The AI agent account linked to this person, if this person represents an AI agent. color_id: type: integer title: Color description: Color identifier used to visually distinguish this person in the UI. tags: type: string title: Tags description: Tags applied to this person. name: title: Name description: The person's full name (first and last combined). title: type: string title: Title description: The person's job title (e.g. CEO, Manager, Developer). sample_data: type: boolean title: Sample Data description: Whether this person was created as part of sample/demo data. custom_field_people: title: Custom Field People description: People referenced in custom field values for this person. timesheet_submission_disabled: type: boolean title: Timesheet Submission Disabled description: Whether timesheet submission is disabled for this person. nickname: type: string title: Nickname description: The person's nickname or preferred display name. accessible_project_id: type: integer title: Accessible Project description: Filter by accessible project ID — returns people who have access to the specified project. last_name: type: string title: Last Name description: The person's last name. contact: type: object title: Contact description: Additional contact data for the person, such as phone numbers and addresses. project_watching: type: integer title: Project Watching description: Filter by project_watching — returns people who are auto-subscribed to the specified project. role_id: type: integer title: Role description: Filter by built-in role type ID. status_expires_at: type: string title: Status Expires At format: date-time description: Timestamp when the current status emoji and text expire. external_sync: type: boolean title: External Sync description: Whether this person is managed by an external sync integration. full_query: type: string title: Full Query description: Full text search filter — matches against name and other indexed fields. time_unlocked_end_date: type: string title: Time Unlocked End Date format: date description: End date of the time unlock window. time_tracking_policy: title: Time Tracking Policy description: The time tracking policy assigned to this person. offboarding_id: type: integer title: Offboarding description: ID of the offboarding process associated with this person's deactivation. invited_at: type: string title: Invited At format: date-time description: Timestamp when the invitation email was sent to this person. jump_query: type: string title: Jump Query description: Quick jump search filter — matches against name for navigation shortcuts. avatar_url: type: string title: Avatar Url description: URL of the person's avatar thumbnail. hrm_type_id: enum: - 1 - 2 type: integer title: Hrm Type description: 'HRM type ID: 1 for employee, 2 for contact. Null for placeholders.' user_id: type: integer title: User description: The ID of the user account linked to this person, if any. two_factor_auth: type: boolean title: Two Factor Auth description: Whether two-factor authentication is enabled for this person's user account. organization: title: Organization description: The organization this person belongs to. granular_notification_preferences: type: object title: Granular Notification Preferences description: Granular notification preferences for this person. joined_at: type: string title: Joined At format: date-time description: Date when this person joined the organization. first_name: type: string title: First Name description: The person's first name. placeholder: type: boolean title: Placeholder description: Whether this person is a placeholder used for resource planning, without a real user account. status_text: type: string title: Status Text description: Short text message shown as the person's current status. tag_list: type: string title: Tag List description: Comma-separated list of tags applied to this person. accessible_filter_id: type: string title: Accessible Filter description: Filter by accessible filter ID — returns people who are members of the specified saved view or filter. time_unlocked_start_date: type: string title: Time Unlocked Start Date format: date description: Start date of the time unlock window. time_unlocked_interval: type: integer title: Time Unlocked Interval description: Number of days in the time unlock interval. fuzzy_people: type: string title: Fuzzy People description: Fuzzy people filter for approximate person name matching. teams: title: Teams description: The teams this person belongs to. availabilities: title: Availabilities description: The person's work availability windows. permissions: type: string title: Permissions description: Filter by permission set — returns people with the specified permission slugs. custom_fields: type: object title: Custom Fields description: Custom field values for this person. status: enum: - 1 - 2 type: integer title: Status description: 'Filter by person status: 1 (active) or 2 (deactivated).' service_types: title: Service Types description: The service types this person delivers. company_name: title: Company Name description: The name of the company this person belongs to. description: A person represents an employee, contractor, contact, or placeholder within the organization. resource_page: type: object title: Page Resource properties: public_uuid: type: string title: Public Uuid description: UUID used in the public sharing URL for this page. status: type: integer title: Status description: The status filter value used when querying pages (active or archived). updated_at: type: string title: Updated At format: date-time description: Timestamp when the page record was last updated. custom_fields: type: object title: Custom Fields description: Custom field values set on this page. Only available on root pages that belong to a project. jump_query: type: string title: Jump Query description: Short query used for jump-to search navigation across pages. creator_name: title: Creator Name description: Display name of the page creator. creator: title: Creator description: The person who created this page. root_page_id: type: integer title: Root Page description: ID of the root Doc page. Null if this page is itself a root Doc. icon_id: type: string title: Icon description: Emoji or icon identifier displayed next to the page title. created_at: type: string title: Created At format: date-time description: Timestamp when the page was created. fuzzy_dates: type: string title: Fuzzy Dates format: date description: Fuzzy date values extracted from page content for search matching. subscriber_ids: title: Subscriber Ids description: IDs of people subscribed to receive updates for this page. fuzzy_people: type: integer title: Fuzzy People description: Person IDs associated with the page for fuzzy search matching. public_access: type: boolean title: Public Access description: Controls whether the page can be viewed publicly without authentication. full_query: type: string title: Full Query description: Full-text search query matching across all page fields including title and body. subscriber_id: type: integer title: Subscriber description: ID of the subscriber (person) watching this page for updates. root_page: title: Root Page description: The root Doc page of the hierarchy this page belongs to. Null for root pages themselves. person_type: type: integer title: Person Type description: Indicates the membership context of the current user (e.g. member or guest). cover_image_url: type: string title: Cover Image Url description: URL of the cover image displayed at the top of the page. body: title: Body description: Rich text body of the page in ProseMirror JSON format. title: type: string title: Title description: Title of the page. project: title: Project description: The project this page is associated with, if any. public: title: Public description: Whether this page is publicly accessible via a shared link. id: type: integer title: Id description: Unique identifier of the page. edited_at: type: string title: Edited At format: date-time description: Timestamp when the page content was last edited. steps: type: array items: description: An individual ProseMirror step applied during collaborative editing. title: Steps description: The ProseMirror steps applied to this page's content during collaborative editing. preferences: type: object title: Preferences description: User-specific display preferences for this page, such as layout settings. version_number: type: integer title: Version Number description: Incremental version counter for the page body, used to detect and prevent conflicting edits. project_name: title: Project Name description: Name of the project this page belongs to. creator_id: type: integer title: Creator description: ID of the person who created this page. query: type: string title: Query description: Search query matched against page title only. parent_page_id: type: integer title: Parent Page description: ID of the parent page in the hierarchy, or null if this is a root page. last_activity_at: type: string title: Last Activity At format: date-time description: Timestamp of the most recent activity on this page. parent_page: title: Parent Page description: The parent page of this page in the hierarchy, if any. attachments: title: Attachments description: Attachments linked to this page. organization: title: Organization description: The organization this page belongs to. position: type: integer title: Position description: The display order position of this page among its siblings. cover_image_meta: type: string title: Cover Image Meta description: Metadata for the cover image, such as dimensions and focal point. project_id: type: integer title: Project description: ID of the project this page belongs to. project_status: enum: - 1 - 2 type: integer title: Project Status description: Status of the project this page belongs to (active or archived). attachment_ids: title: Attachment Ids description: IDs of attachments associated with this page. template: type: string title: Template description: Whether this page was created from a template. template_object: title: Template Object description: The template this page was created from, if any. description: A rich text document page. Root pages are standalone Docs with sharing settings; child pages form a hierarchy within a Doc. filter_placeholder_usage: type: object title: Filter placeholder usage properties: target_id: oneOf: - "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_id" not_contain: "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_id" eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_id" not_eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_id" description: Filter using explicit operator syntax. description: Filter by the target resource ID (the task or todo the placeholder is applied to). project_id: oneOf: - "$ref": "#/components/schemas/resource_placeholder_usage/properties/project_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_placeholder_usage/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/project_id" eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_placeholder_usage/properties/project_id" description: Filter using explicit operator syntax. description: Filter by the associated project (matches usages on tasks or todos within that project). placeholder_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/placeholder_id" contains: "$ref": "#/components/schemas/resource_placeholder_usage/properties/placeholder_id" not_eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/placeholder_id" not_contain: "$ref": "#/components/schemas/resource_placeholder_usage/properties/placeholder_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_placeholder_usage/properties/placeholder_id" description: Filter by the associated placeholder. target_type: oneOf: - "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_type" not_eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_type" eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_type" contains: "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_type" description: Filter using explicit operator syntax. description: Filter by the target resource type (task or todo). task_id: oneOf: - "$ref": "#/components/schemas/resource_placeholder_usage/properties/task_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/task_id" not_contain: "$ref": "#/components/schemas/resource_placeholder_usage/properties/task_id" contains: "$ref": "#/components/schemas/resource_placeholder_usage/properties/task_id" eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/task_id" description: Filter using explicit operator syntax. description: Filter by the associated task. interval_enabled: oneOf: - "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_enabled" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_enabled" not_eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_enabled" contains: "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_enabled" eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_enabled" description: Filter using explicit operator syntax. description: Filter to include only usages where interval offset is enabled. field: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_placeholder_usage/properties/field" eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/field" contains: "$ref": "#/components/schemas/resource_placeholder_usage/properties/field" not_eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/field" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_placeholder_usage/properties/field" description: Filter by the date-offset field used for interval calculation. todo_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/todo_id" not_contain: "$ref": "#/components/schemas/resource_placeholder_usage/properties/todo_id" not_eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/todo_id" contains: "$ref": "#/components/schemas/resource_placeholder_usage/properties/todo_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_placeholder_usage/properties/todo_id" description: Filter by the associated todo. skip_weekends: oneOf: - "$ref": "#/components/schemas/resource_placeholder_usage/properties/skip_weekends" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/skip_weekends" not_contain: "$ref": "#/components/schemas/resource_placeholder_usage/properties/skip_weekends" not_eq: "$ref": "#/components/schemas/resource_placeholder_usage/properties/skip_weekends" contains: "$ref": "#/components/schemas/resource_placeholder_usage/properties/skip_weekends" description: Filter using explicit operator syntax. description: Filter to include only usages where weekends are skipped in interval calculations. patternProperties: {} description: Filter parameters for placeholder usage records. _filter_root_filter: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_filter" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_filter" description: Filter schema for `filter` list endpoints — pass a single condition or a logical group. resource_booking_report: type: object title: Booking report Resource properties: booking_started_on: title: Booking Started On description: Booking started on for this booking report group. deal: title: Deal description: Deal for this booking report group. booking_type: enum: - service - event type: string title: Booking Type description: Booking type for this booking report group. report: title: Report description: Report for this booking report group. booking_canceled_at: title: Booking Canceled At description: Booking canceled at for this booking report group. total_recognized_revenue_default: title: Total Recognized Revenue Default description: Sum of recognized revenue in the organization's default currency across all records in this booking report group. autotracking: type: integer title: Autotracking description: Autotracking for this booking report group. task: title: Task description: Task for this booking report group. budget: title: Budget description: Budget for this booking report group. count: type: integer title: Count description: Number of bookings in this report group. formulas: type: integer title: Formulas description: Formulas for this booking report group. total_base_cost_normalized: title: Total Base Cost Normalized description: Sum of base cost in the normalized currency across all records in this booking report group. average_blended_rate_normalized: title: Average Blended Rate Normalized description: Average blended rate in the normalized currency for this booking report group. service_id: type: integer title: Service description: Service id for this booking report group. total_base_cost_default: title: Total Base Cost Default description: Sum of base cost in the organization's default currency across all records in this booking report group. before: type: string title: Before format: date description: Before for this booking report group. booking: title: Booking description: Booking for this booking report group. custom_fields: type: string title: Custom Fields description: Custom fields for this booking report group. rejected_at: type: string title: Rejected At format: date description: Rejected at for this booking report group. approver_id: type: integer title: Approver description: Approver id for this booking report group. booking_approved_at: title: Booking Approved At description: Booking approved at for this booking report group. absence_type: enum: - time_off - remote_work type: string title: Absence Type description: Absence type for this booking report group. currency: type: string title: Currency description: Currency for this booking report group. total_cost_default: title: Total Cost Default description: Sum of cost in the organization's default currency across all records in this booking report group. company_id: type: integer title: Company description: Company id for this booking report group. service_type_id: type: integer title: Service Type description: Service type id for this booking report group. task_report: title: Task Report description: Task report for this booking report group. average_blended_rate_default: title: Average Blended Rate Default description: Average blended rate in the organization's default currency for this booking report group. person_id: type: integer title: Person description: Person id for this booking report group. canceled_at_period: title: Canceled At Period description: Time period grouping for canceled at (e.g. week, month, quarter). time: type: number title: Time description: Time for this booking report group. project_type: enum: - 1 - 2 type: integer title: Project Type description: Project type for this booking report group. booking_created_at: title: Booking Created At description: Booking created at for this booking report group. ended_on_after: type: string title: Ended On After format: date description: Ended on after for this booking report group. end_date: type: string title: End Date format: date description: End date for this booking report group. billing_type: type: integer title: Billing Type description: Billing type for this booking report group. total_base_cost: title: Total Base Cost description: Sum of base cost across all records in this booking report group. parent_company_id: type: integer title: Parent Company description: ID of the parent company of the company linked to this booking entry, used for hierarchical company filtering. started_on_before: type: string title: Started On Before format: date description: Started on before for this booking report group. currency_normalized: type: string title: Currency Normalized description: Currency in the normalized currency for this booking report group. billing_type_id: enum: - 1 - 2 - 3 - 4 type: integer title: Billing Type description: Billing type id for this booking report group. responsible_report: title: Responsible Report description: Responsible report for this booking report group. booking_ended_on: title: Booking Ended On description: Booking ended on for this booking report group. person: title: Person description: Person for this booking report group. responsible: title: Responsible description: Responsible for this booking report group. total_recognized_revenue: title: Total Recognized Revenue description: Sum of recognized revenue across all records in this booking report group. mandays: type: number title: Mandays description: Mandays for this booking report group. with_draft: type: boolean title: With Draft description: With draft for this booking report group. approved_at: type: string title: Approved At format: date description: Approved at for this booking report group. total_cost: title: Total Cost description: Sum of cost across all records in this booking report group. average_blended_rate: title: Average Blended Rate description: Average blended rate for this booking report group. ended_on_before: type: string title: Ended On Before format: date description: Ended on before for this booking report group. stage_type: enum: - 1 - 2 type: integer title: Stage Type description: Stage type for this booking report group. person_report: title: Person Report description: The person associated with this booking report row. started_on_after: type: string title: Started On After format: date description: Started on after for this booking report group. project_report: title: Project Report description: Project report for this booking report group. canceled_at: type: string title: Canceled At format: date description: Canceled at for this booking report group. approved_at_period: title: Approved At Period description: Time period grouping for approved at (e.g. week, month, quarter). event: title: Event description: Event for this booking report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this booking report group. project_id: type: integer title: Project description: Project id for this booking report group. draft: type: integer title: Draft description: Draft for this booking report group. service_report: title: Service Report description: Service report for this service report group. company: title: Company description: Company for this booking report group. started_on: type: string title: Started On format: date description: Started on for this booking report group. total_recognized_profit_normalized: title: Total Recognized Profit Normalized description: Sum of recognized profit in the normalized currency across all records in this booking report group. organization: title: Organization description: Organization for this booking report group. total_recognized_profit_default: title: Total Recognized Profit Default description: Sum of recognized profit in the organization's default currency across all records in this booking report group. created_at: type: string title: Created At format: date description: Created at for this booking report group. created_at_period: title: Created At Period description: Time period grouping for created at (e.g. week, month, quarter). budget_id: type: integer title: Budget description: Budget id for this booking report group. service: title: Service description: Service for this booking report group. group: type: string title: Group description: The grouping dimension for this booking report row. approval_status: enum: - 1 - 2 - 3 - 5 type: integer title: Approval Status description: Approval status for this booking report group. formula_fields: title: Formula Fields description: Formula fields for this booking report group. booking_rejected_at: title: Booking Rejected At description: Booking rejected at for this booking report group. deal_or_budget_report: title: Deal Or Budget Report description: Report object for the deal or budget associated with this booking entry. tags: type: string title: Tags description: Tags for this booking report group. total_recognized_profit: title: Total Recognized Profit description: Sum of recognized profit across all records in this booking report group. people_custom_fields: type: string title: People Custom Fields description: People custom fields for this booking report group. average_recognized_margin: type: number title: Average Recognized Margin description: Average recognized margin for this booking report group. project: title: Project description: Project for this booking report group. total_recognized_revenue_normalized: title: Total Recognized Revenue Normalized description: Sum of recognized revenue in the normalized currency across all records in this booking report group. rejected_at_period: title: Rejected At Period description: Time period grouping for rejected at (e.g. week, month, quarter). date_period: title: Date Period description: Time period grouping for date (e.g. week, month, quarter). start_date: type: string title: Start Date format: date description: Start date for this booking report group. ended_on: type: string title: Ended On format: date description: Ended on for this booking report group. date_after: type: string title: Date After format: date description: Date after for this booking report group. total_recognized_time: type: number title: Total Recognized Time description: Sum of recognized time across all records in this booking report group. company_report: title: Company Report description: Company report for this booking report group. event_id: type: integer title: Event description: Event id for this booking report group. date_before: type: string title: Date Before format: date description: Date before for this booking report group. after: type: string title: After format: date description: After for this booking report group. date: type: string title: Date format: date description: Date for this booking report group. note: type: string title: Note description: Note for this booking report group. task_id: type: integer title: Task description: Task id for this booking report group. service_type: title: Service Type description: Service type for this booking report group. person_subsidiary_id: type: integer title: Person Subsidiary description: Person subsidiary id for this booking report group. total_cost_normalized: title: Total Cost Normalized description: Sum of cost in the normalized currency across all records in this booking report group. description: An aggregated booking report row grouping scheduled bookings by configurable dimensions with capacity, utilization, and cost metrics. resource_survey_field_option: type: object title: Survey field option Resource properties: survey_field: title: Survey Field description: The survey field this option belongs to. survey_field_id: type: integer title: Survey Field description: ID of the survey field this option belongs to. color_id: type: integer title: Color description: ID of the color associated with this option. custom_field_id: type: integer title: Custom Field description: ID of the survey field this option belongs to. archived: type: boolean title: Archived description: Whether this option has been archived. archived_at: type: string title: Archived At format: date-time description: Timestamp when this option was archived, or null if not archived. organization: title: Organization description: The organization this option belongs to. position: type: integer title: Position description: The display order position of this option within the survey field. name: type: string title: Name description: The display label for this answer option. description: Selectable option for a dropdown or multi-select survey field. Has a label and position for ordering. resource_service_type_assignment: type: object title: Service type assignment Resource properties: id: type: integer title: Id description: The unique identifier of this service type assignment. organization: title: Organization description: The organization this service type assignment belongs to. person_id: type: integer title: Person description: ID of the person assigned to this service type. service_type: title: Service Type description: The service type this assignment belongs to. person: title: Person description: The person assigned to this service type. service_type_id: type: integer title: Service Type description: ID of the service type this assignment belongs to. description: The resource service type assignment. _filter_root_custom_field: oneOf: - "$ref": "#/components/schemas/filter_custom_field" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_custom_field" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `custom_field` list endpoints — pass a single condition or a logical group. _filter_root_custom_field_option: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_custom_field_option" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_custom_field_option" description: Filter schema for `custom_field_option` list endpoints — pass a single condition or a logical group. resource_discussion: type: object title: Discussion Resource properties: subscriber_ids: title: Subscriber Ids description: An array of IDs of people who are subscribed to notifications for this discussion. page_id: type: integer title: Page description: ID of the page this discussion is attached to. created_at: title: Created At description: Timestamp when this discussion was created. page: title: Page description: The page this discussion is attached to. status: enum: - 1 - 2 type: integer title: Status description: The status of this discussion, either active (1) or resolved (2). resolved_at: type: string title: Resolved At format: date-time description: Timestamp when this discussion was marked as resolved, or null if it is still active. id: type: integer title: Id description: The unique identifier of this discussion. excerpt: type: string title: Excerpt description: A short text preview of the first comment or content in this discussion. organization: title: Organization description: The organization this discussion belongs to. updated_at: title: Updated At description: Timestamp when this discussion was last updated. description: A threaded discussion attached to a page, task, or other resource, allowing team members to comment and resolve topics. _filter_root_deal_cost_rate: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_deal_cost_rate" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_deal_cost_rate" description: Filter schema for `deal_cost_rate` list endpoints — pass a single condition or a logical group. resource_approval_policy_assignment: type: object title: Approval policy assignment Resource properties: person: title: Person description: The person this assignment applies to, if the target is a person (for absence approvals). deal: title: Deal description: The budget (deal) this assignment applies to, if the target is a budget. organization: title: Organization description: The organization this approval policy assignment belongs to. approval_policy: title: Approval Policy description: The approval policy assigned to this target. target_type: type: string title: Target Type description: 'The type of target this policy is assigned to: ''Person'' for absence approvals or ''Quote'' for budget approvals.' target_id: type: integer title: Target description: The ID of the target record (person ID or budget ID) this policy is assigned to. description: An approval policy assignment links an approval policy to a specific target (person or budget). _filter_root_time_entry_version: oneOf: - "$ref": "#/components/schemas/filter_time_entry_version" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_time_entry_version" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `time_entry_version` list endpoints — pass a single condition or a logical group. resource_contact_entry: type: object title: Contact entry Resource properties: invoice_template: title: Invoice Template description: The invoice template this contact entry is linked to, for pre-filling invoice contact details. email: type: string title: Email description: The email address of this contact entry. contactable_type: type: string title: Contactable Type description: The type of the associated contactable resource. website: type: string title: Website description: The website URL of this contact entry. contactable_id: type: integer title: Contactable description: The ID of the associated contactable resource. name: type: string title: Name description: The display name on this contact entry. purchase_order: title: Purchase Order description: The purchase order this contact entry is associated with, if applicable. example: data: type: purchase_orders id: '1234567' city: type: string title: City description: The city of this contact entry. billing_email: type: boolean title: Billing Email description: The email address used for billing on this contact entry. purchase_order_id: title: Purchase Order description: ID of the purchase order this contact entry is associated with, if applicable. example: 1234567 address: type: string title: Address description: The street address of this contact entry. company: title: Company description: The company this contact entry belongs to, if the contactable is a company. organization_id: title: Organization description: ID of the organization this contact entry belongs to. invoice_id: type: integer title: Invoice description: ID of the invoice this contact entry is associated with, if applicable. country: type: string title: Country description: The country of this contact entry. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary this contact entry is linked to, if applicable. person_id: type: integer title: Person description: ID of the person this contact entry belongs to, if the contactable is a person. type: type: string title: Type description: The type of this contact entry, indicating the context (e.g. company or person contact). billing_address: type: boolean title: Billing Address description: The billing address associated with this contact entry. organization: title: Organization description: The organization this contact entry belongs to. company_id: type: integer title: Company description: ID of the company this contact entry belongs to, if the contactable is a company. invoice_template_id: title: Invoice Template description: ID of the invoice template this contact entry is linked to. vat: type: string title: Vat description: The VAT number associated with this contact entry. phone: type: string title: Phone description: The phone number of this contact entry. invoice: title: Invoice description: The invoice this contact entry is associated with, if applicable. state: type: string title: State description: The state or province of this contact entry. zipcode: type: string title: Zipcode description: The ZIP or postal code. person: title: Person description: The person this contact entry belongs to, if the contactable is a person. subsidiary: title: Subsidiary description: The subsidiary this contact entry is linked to, if applicable. description: Contact information record (email, phone, website, or postal address) for a company or person. Supports multiple entries per contact with type classification. Billing-specific fields (billing_address, billing_email, VAT) are available for company contacts with financials enabled. _filter_root_approval_policy_assignment: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_approval_policy_assignment" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_approval_policy_assignment" description: Filter schema for `approval_policy_assignment` list endpoints — pass a single condition or a logical group. _filter_root_pulse: oneOf: - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_pulse" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" - "$ref": "#/components/schemas/filter_pulse" description: Filter schema for `pulse` list endpoints — pass a single condition or a logical group. filter_booking: type: object title: Filter booking properties: canceled_at: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/canceled_at" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking/properties/canceled_at" not_eq: "$ref": "#/components/schemas/resource_booking/properties/canceled_at" eq: "$ref": "#/components/schemas/resource_booking/properties/canceled_at" not_contain: "$ref": "#/components/schemas/resource_booking/properties/canceled_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by cancellation date range (canceled_at). event_id: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/event_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking/properties/event_id" contains: "$ref": "#/components/schemas/resource_booking/properties/event_id" not_eq: "$ref": "#/components/schemas/resource_booking/properties/event_id" eq: "$ref": "#/components/schemas/resource_booking/properties/event_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the ID of the absence event category (e.g. vacation, sick leave). person_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_booking/properties/person_id" eq: "$ref": "#/components/schemas/resource_booking/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_booking/properties/person_id" contains: "$ref": "#/components/schemas/resource_booking/properties/person_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/person_id" description: Filter by the booked person. started_on: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/started_on" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking/properties/started_on" not_eq: "$ref": "#/components/schemas/resource_booking/properties/started_on" not_contain: "$ref": "#/components/schemas/resource_booking/properties/started_on" eq: "$ref": "#/components/schemas/resource_booking/properties/started_on" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by booking start date range (started_on). approved_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_booking/properties/approved_at" not_contain: "$ref": "#/components/schemas/resource_booking/properties/approved_at" contains: "$ref": "#/components/schemas/resource_booking/properties/approved_at" eq: "$ref": "#/components/schemas/resource_booking/properties/approved_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/approved_at" description: Filter by approval date range (approved_at). approver_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking/properties/approver_id" not_eq: "$ref": "#/components/schemas/resource_booking/properties/approver_id" contains: "$ref": "#/components/schemas/resource_booking/properties/approver_id" eq: "$ref": "#/components/schemas/resource_booking/properties/approver_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/approver_id" description: Filter by the person who approved the booking. task_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_booking/properties/task_id" eq: "$ref": "#/components/schemas/resource_booking/properties/task_id" contains: "$ref": "#/components/schemas/resource_booking/properties/task_id" not_contain: "$ref": "#/components/schemas/resource_booking/properties/task_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/task_id" description: Filter by the associated task. after: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking/properties/after" eq: "$ref": "#/components/schemas/resource_booking/properties/after" not_eq: "$ref": "#/components/schemas/resource_booking/properties/after" contains: "$ref": "#/components/schemas/resource_booking/properties/after" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/after" description: Filter bookings that overlap with or start after a given date. updated_at: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/updated_at" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking/properties/updated_at" contains: "$ref": "#/components/schemas/resource_booking/properties/updated_at" eq: "$ref": "#/components/schemas/resource_booking/properties/updated_at" not_eq: "$ref": "#/components/schemas/resource_booking/properties/updated_at" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by booking last updated date range (updated_at). budget_id: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/budget_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_booking/properties/budget_id" contains: "$ref": "#/components/schemas/resource_booking/properties/budget_id" not_contain: "$ref": "#/components/schemas/resource_booking/properties/budget_id" eq: "$ref": "#/components/schemas/resource_booking/properties/budget_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the ID of the budget (deal) associated with the booking's service. tags: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/tags" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking/properties/tags" not_eq: "$ref": "#/components/schemas/resource_booking/properties/tags" eq: "$ref": "#/components/schemas/resource_booking/properties/tags" not_contain: "$ref": "#/components/schemas/resource_booking/properties/tags" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by tag. approval_status: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/approval_status" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking/properties/approval_status" contains: "$ref": "#/components/schemas/resource_booking/properties/approval_status" not_contain: "$ref": "#/components/schemas/resource_booking/properties/approval_status" not_eq: "$ref": "#/components/schemas/resource_booking/properties/approval_status" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by approval status. Use eq/not_eq to match a specific approval status value. canceled: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking/properties/canceled" eq: "$ref": "#/components/schemas/resource_booking/properties/canceled" not_eq: "$ref": "#/components/schemas/resource_booking/properties/canceled" contains: "$ref": "#/components/schemas/resource_booking/properties/canceled" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/canceled" description: Filter by whether the booking has been canceled (true = canceled, false = not canceled). id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking/properties/id" not_eq: "$ref": "#/components/schemas/resource_booking/properties/id" contains: "$ref": "#/components/schemas/resource_booking/properties/id" not_contain: "$ref": "#/components/schemas/resource_booking/properties/id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/id" description: Filter by booking ID. status: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/status" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking/properties/status" not_contain: "$ref": "#/components/schemas/resource_booking/properties/status" contains: "$ref": "#/components/schemas/resource_booking/properties/status" not_eq: "$ref": "#/components/schemas/resource_booking/properties/status" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by booking status (e.g. pending, approved, rejected). billing_type_id: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/billing_type_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_booking/properties/billing_type_id" contains: "$ref": "#/components/schemas/resource_booking/properties/billing_type_id" not_contain: "$ref": "#/components/schemas/resource_booking/properties/billing_type_id" eq: "$ref": "#/components/schemas/resource_booking/properties/billing_type_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by billing type. resource_request_id: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/resource_request_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking/properties/resource_request_id" not_eq: "$ref": "#/components/schemas/resource_booking/properties/resource_request_id" not_contain: "$ref": "#/components/schemas/resource_booking/properties/resource_request_id" contains: "$ref": "#/components/schemas/resource_booking/properties/resource_request_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the associated resource request. person_type: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/person_type" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_booking/properties/person_type" contains: "$ref": "#/components/schemas/resource_booking/properties/person_type" not_contain: "$ref": "#/components/schemas/resource_booking/properties/person_type" eq: "$ref": "#/components/schemas/resource_booking/properties/person_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the type of person assigned (e.g. employee, contractor, placeholder). project_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_booking/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_booking/properties/project_id" contains: "$ref": "#/components/schemas/resource_booking/properties/project_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/project_id" description: Filter by the associated project. people_custom_fields: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking/properties/people_custom_fields" contains: "$ref": "#/components/schemas/resource_booking/properties/people_custom_fields" not_contain: "$ref": "#/components/schemas/resource_booking/properties/people_custom_fields" not_eq: "$ref": "#/components/schemas/resource_booking/properties/people_custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/people_custom_fields" description: Filter by custom field values on the booked person. stage_type: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking/properties/stage_type" contains: "$ref": "#/components/schemas/resource_booking/properties/stage_type" eq: "$ref": "#/components/schemas/resource_booking/properties/stage_type" not_eq: "$ref": "#/components/schemas/resource_booking/properties/stage_type" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/stage_type" description: Filter by the stage type of the booking's associated deal. autotracking: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking/properties/autotracking" not_eq: "$ref": "#/components/schemas/resource_booking/properties/autotracking" not_contain: "$ref": "#/components/schemas/resource_booking/properties/autotracking" eq: "$ref": "#/components/schemas/resource_booking/properties/autotracking" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/autotracking" description: Filter by whether the booking uses automatic time tracking. person_subsidiary_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking/properties/person_subsidiary_id" contains: "$ref": "#/components/schemas/resource_booking/properties/person_subsidiary_id" not_eq: "$ref": "#/components/schemas/resource_booking/properties/person_subsidiary_id" eq: "$ref": "#/components/schemas/resource_booking/properties/person_subsidiary_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/person_subsidiary_id" description: Filter by the subsidiary the booked person belongs to. origin_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking/properties/origin_id" not_contain: "$ref": "#/components/schemas/resource_booking/properties/origin_id" contains: "$ref": "#/components/schemas/resource_booking/properties/origin_id" not_eq: "$ref": "#/components/schemas/resource_booking/properties/origin_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/origin_id" description: Filter by the origin booking ID (the source booking this was created from). draft: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/draft" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking/properties/draft" eq: "$ref": "#/components/schemas/resource_booking/properties/draft" not_eq: "$ref": "#/components/schemas/resource_booking/properties/draft" not_contain: "$ref": "#/components/schemas/resource_booking/properties/draft" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by whether the booking is a draft (tentative) or confirmed. note: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_booking/properties/note" contains: "$ref": "#/components/schemas/resource_booking/properties/note" eq: "$ref": "#/components/schemas/resource_booking/properties/note" not_contain: "$ref": "#/components/schemas/resource_booking/properties/note" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/note" description: Filter by booking note text content. with_draft: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking/properties/with_draft" not_contain: "$ref": "#/components/schemas/resource_booking/properties/with_draft" not_eq: "$ref": "#/components/schemas/resource_booking/properties/with_draft" contains: "$ref": "#/components/schemas/resource_booking/properties/with_draft" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/with_draft" description: When true, includes draft (tentative) bookings in results alongside confirmed bookings. custom_fields: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_booking/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_booking/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_booking/properties/custom_fields" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/custom_fields" description: Filter by custom field values. last_activity_at: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking/properties/last_activity_at" not_eq: "$ref": "#/components/schemas/resource_booking/properties/last_activity_at" contains: "$ref": "#/components/schemas/resource_booking/properties/last_activity_at" eq: "$ref": "#/components/schemas/resource_booking/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/last_activity_at" description: Filter by last activity date range (last_activity_at). project_type: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_booking/properties/project_type" not_contain: "$ref": "#/components/schemas/resource_booking/properties/project_type" eq: "$ref": "#/components/schemas/resource_booking/properties/project_type" contains: "$ref": "#/components/schemas/resource_booking/properties/project_type" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/project_type" description: Filter by project type (e.g. billable or internal). ended_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking/properties/ended_on" contains: "$ref": "#/components/schemas/resource_booking/properties/ended_on" not_eq: "$ref": "#/components/schemas/resource_booking/properties/ended_on" not_contain: "$ref": "#/components/schemas/resource_booking/properties/ended_on" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/ended_on" description: Filter by booking end date range (ended_on). rejected_at: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_booking/properties/rejected_at" eq: "$ref": "#/components/schemas/resource_booking/properties/rejected_at" not_eq: "$ref": "#/components/schemas/resource_booking/properties/rejected_at" not_contain: "$ref": "#/components/schemas/resource_booking/properties/rejected_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/rejected_at" description: Filter by rejection date range (rejected_at). booking_type: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/booking_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_booking/properties/booking_type" contains: "$ref": "#/components/schemas/resource_booking/properties/booking_type" not_eq: "$ref": "#/components/schemas/resource_booking/properties/booking_type" eq: "$ref": "#/components/schemas/resource_booking/properties/booking_type" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by booking type — project booking or absence booking. before: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/before" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_booking/properties/before" eq: "$ref": "#/components/schemas/resource_booking/properties/before" not_contain: "$ref": "#/components/schemas/resource_booking/properties/before" contains: "$ref": "#/components/schemas/resource_booking/properties/before" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter bookings that overlap with or end before a given date. created_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_booking/properties/created_at" contains: "$ref": "#/components/schemas/resource_booking/properties/created_at" eq: "$ref": "#/components/schemas/resource_booking/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_booking/properties/created_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_booking/properties/created_at" description: Filter by booking creation date range (created_at). company_id: oneOf: - "$ref": "#/components/schemas/resource_booking/properties/company_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_booking/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_booking/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_booking/properties/company_id" contains: "$ref": "#/components/schemas/resource_booking/properties/company_id" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the client company associated with the booking's service. patternProperties: "^task..*$": title: Task relationship "^event..*$": title: Event relationship "^person..*$": title: Person relationship "^service..*$": title: Service relationship description: Filters bookings (scheduled allocations of people to work or time-off events). filter_price: type: object title: Filter price properties: rate_card_status: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_price/properties/rate_card_status" not_eq: "$ref": "#/components/schemas/resource_price/properties/rate_card_status" not_contain: "$ref": "#/components/schemas/resource_price/properties/rate_card_status" contains: "$ref": "#/components/schemas/resource_price/properties/rate_card_status" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_price/properties/rate_card_status" description: Filter by the status of the associated rate card (active or archived). billing_type_id: oneOf: - "$ref": "#/components/schemas/resource_price/properties/billing_type_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_price/properties/billing_type_id" eq: "$ref": "#/components/schemas/resource_price/properties/billing_type_id" not_contain: "$ref": "#/components/schemas/resource_price/properties/billing_type_id" contains: "$ref": "#/components/schemas/resource_price/properties/billing_type_id" description: Filter using explicit operator syntax. description: Filter by billing type ID. booking_tracking_enabled: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_price/properties/booking_tracking_enabled" not_contain: "$ref": "#/components/schemas/resource_price/properties/booking_tracking_enabled" not_eq: "$ref": "#/components/schemas/resource_price/properties/booking_tracking_enabled" contains: "$ref": "#/components/schemas/resource_price/properties/booking_tracking_enabled" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_price/properties/booking_tracking_enabled" description: Filter to include only price entries where booking tracking is enabled. service_type_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_price/properties/service_type_id" not_eq: "$ref": "#/components/schemas/resource_price/properties/service_type_id" contains: "$ref": "#/components/schemas/resource_price/properties/service_type_id" not_contain: "$ref": "#/components/schemas/resource_price/properties/service_type_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_price/properties/service_type_id" description: Filter by the associated service type. company_id: oneOf: - "$ref": "#/components/schemas/resource_price/properties/company_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_price/properties/company_id" eq: "$ref": "#/components/schemas/resource_price/properties/company_id" contains: "$ref": "#/components/schemas/resource_price/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_price/properties/company_id" description: Filter using explicit operator syntax. description: Filter by client company. expense_tracking_enabled: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_price/properties/expense_tracking_enabled" not_eq: "$ref": "#/components/schemas/resource_price/properties/expense_tracking_enabled" contains: "$ref": "#/components/schemas/resource_price/properties/expense_tracking_enabled" eq: "$ref": "#/components/schemas/resource_price/properties/expense_tracking_enabled" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_price/properties/expense_tracking_enabled" description: Filter to include only price entries where expense tracking is enabled. custom_fields: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_price/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_price/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_price/properties/custom_fields" not_contain: "$ref": "#/components/schemas/resource_price/properties/custom_fields" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_price/properties/custom_fields" description: Filter by custom field values. time_tracking_enabled: oneOf: - "$ref": "#/components/schemas/resource_price/properties/time_tracking_enabled" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_price/properties/time_tracking_enabled" not_contain: "$ref": "#/components/schemas/resource_price/properties/time_tracking_enabled" contains: "$ref": "#/components/schemas/resource_price/properties/time_tracking_enabled" eq: "$ref": "#/components/schemas/resource_price/properties/time_tracking_enabled" description: Filter using explicit operator syntax. description: Filter to include only price entries where time tracking is enabled. unit_id: oneOf: - "$ref": "#/components/schemas/resource_price/properties/unit_id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_price/properties/unit_id" not_contain: "$ref": "#/components/schemas/resource_price/properties/unit_id" not_eq: "$ref": "#/components/schemas/resource_price/properties/unit_id" contains: "$ref": "#/components/schemas/resource_price/properties/unit_id" description: Filter using explicit operator syntax. description: Filter by unit ID. id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_price/properties/id" contains: "$ref": "#/components/schemas/resource_price/properties/id" not_eq: "$ref": "#/components/schemas/resource_price/properties/id" not_contain: "$ref": "#/components/schemas/resource_price/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_price/properties/id" description: Filter by ID. rate_card_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_price/properties/rate_card_id" contains: "$ref": "#/components/schemas/resource_price/properties/rate_card_id" eq: "$ref": "#/components/schemas/resource_price/properties/rate_card_id" not_contain: "$ref": "#/components/schemas/resource_price/properties/rate_card_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_price/properties/rate_card_id" description: Filter by the associated rate card. patternProperties: "^company..*$": title: Company relationship "^rate_card..*$": title: Rate card relationship description: Filter parameters for listing prices (rate card line items). Supports filtering by rate card, service type, company, billing type, and updated date. Standard ID and date operators apply. filter_invoice_report: type: object title: Filter invoice report properties: last_activity_at: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/last_activity_at" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/last_activity_at" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/last_activity_at" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/last_activity_at" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_invoice_report/properties/last_activity_at" description: Filter by last activity date range (`last_activity_at`). delivery_on: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/delivery_on" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/delivery_on" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/delivery_on" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/delivery_on" description: Filter operator object for delivery on. - "$ref": "#/components/schemas/resource_invoice_report/properties/delivery_on" description: Filter invoice report results by delivery on. formulas: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice_report/properties/formulas" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/formulas" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/formulas" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/formulas" description: Filter operator object for formulas. - "$ref": "#/components/schemas/resource_invoice_report/properties/formulas" description: Filter invoice report results by formulas. tags: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/tags" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/tags" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/tags" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/tags" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_invoice_report/properties/tags" description: Filter by tag. export_status: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/export_status" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/export_status" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/export_status" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/export_status" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/export_status" description: Filter operator object for export status. description: Filter invoice report results by export status. paid_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/paid_on" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/paid_on" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/paid_on" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/paid_on" description: Filter operator object for paid on. - "$ref": "#/components/schemas/resource_invoice_report/properties/paid_on" description: Filter invoice report results by paid on. invoice_status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_status" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_status" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_status" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_status" description: Filter operator object for invoice status. - "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_status" description: Filter invoice report results by invoice status. amount_tax: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/amount_tax" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_tax" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_tax" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_tax" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_tax" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by tax amount range. fuzzy_dates: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/fuzzy_dates" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/fuzzy_dates" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/fuzzy_dates" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/fuzzy_dates" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/fuzzy_dates" description: Filter operator object for fuzzy dates. description: Filter invoice report results by fuzzy dates. invoice_state: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_state" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_state" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_state" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_state" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_state" description: Filter operator object for invoice state. description: Filter invoice report results by invoice state. automatically_created: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/automatically_created" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/automatically_created" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/automatically_created" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/automatically_created" description: Filter operator object for automatically created. - "$ref": "#/components/schemas/resource_invoice_report/properties/automatically_created" description: Filter invoice report results by automatically created. custom_fields: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/custom_fields" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/custom_fields" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/custom_fields" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/custom_fields" description: Filter operator object for custom fields. - "$ref": "#/components/schemas/resource_invoice_report/properties/custom_fields" description: Filter invoice report results by custom fields. currency: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/currency" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/currency" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/currency" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/currency" description: Filter operator object for currency. - "$ref": "#/components/schemas/resource_invoice_report/properties/currency" description: Filter invoice report results by currency. company_id: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/company_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/company_id" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/company_id" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/company_id" description: Filter operator object for company id. description: Filter invoice report results by company id. subsidiary_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/subsidiary_id" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/subsidiary_id" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/subsidiary_id" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/subsidiary_id" description: Filter operator object for subsidiary id. - "$ref": "#/components/schemas/resource_invoice_report/properties/subsidiary_id" description: Filter invoice report results by subsidiary id. purchase_order_number: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/purchase_order_number" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/purchase_order_number" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/purchase_order_number" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/purchase_order_number" description: Filter operator object for purchase order number. example: eq: PO-2024-017 - "$ref": "#/components/schemas/resource_invoice_report/properties/purchase_order_number" description: Filter invoice report results by purchase order number. example: eq: PO-2024-017 sent_status: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/sent_status" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/sent_status" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/sent_status" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/sent_status" description: Filter operator object for sent status. - "$ref": "#/components/schemas/resource_invoice_report/properties/sent_status" description: Filter invoice report results by sent status. amount_with_tax: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_with_tax" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_with_tax" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_with_tax" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_with_tax" description: Filter operator object for amount with tax. - "$ref": "#/components/schemas/resource_invoice_report/properties/amount_with_tax" description: Filter invoice report results by amount with tax. pay_on: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/pay_on" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/pay_on" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/pay_on" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/pay_on" description: Filter operator object for pay on. - "$ref": "#/components/schemas/resource_invoice_report/properties/pay_on" description: Filter invoice report results by pay on. subscriber_id: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/subscriber_id" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/subscriber_id" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/subscriber_id" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/subscriber_id" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/subscriber_id" description: Filter operator object for subscriber id. description: Filter invoice report results by subscriber id. payment_status: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/payment_status" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/payment_status" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/payment_status" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/payment_status" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/payment_status" description: Filter operator object for payment status. description: Filter invoice report results by payment status. parent_company_id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/parent_company_id" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/parent_company_id" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/parent_company_id" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/parent_company_id" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_invoice_report/properties/parent_company_id" description: Filter by the parent company of the invoice's company. fiscalization_status: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/fiscalization_status" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/fiscalization_status" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/fiscalization_status" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/fiscalization_status" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/fiscalization_status" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the fiscalization status of the invoice. issuer_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/issuer_id" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/issuer_id" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/issuer_id" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/issuer_id" description: Filter operator object for issuer id. - "$ref": "#/components/schemas/resource_invoice_report/properties/issuer_id" description: Filter invoice report results by issuer id. full_query: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/full_query" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice_report/properties/full_query" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/full_query" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/full_query" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/full_query" description: Filter operator object for full query. description: Filter invoice report results by full query. invoiced_on: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/invoiced_on" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/invoiced_on" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/invoiced_on" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/invoiced_on" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/invoiced_on" description: Filter operator object for invoiced on. description: Filter invoice report results by invoiced on. invoice_aging: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_aging" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_aging" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_aging" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_aging" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_aging" description: Filter operator object for invoice aging. description: Filter invoice report results by invoice aging. amount_credited_with_tax: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/amount_credited_with_tax" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_credited_with_tax" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_credited_with_tax" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_credited_with_tax" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_credited_with_tax" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by the credited amount on the invoice, including tax. amount: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/amount" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/amount" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_invoice_report/properties/amount" description: Filter by the total invoice amount excluding tax. Expressed in the organization's base currency. creator_id: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/creator_id" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/creator_id" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/creator_id" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/creator_id" description: Filter operator object for creator id. - "$ref": "#/components/schemas/resource_invoice_report/properties/creator_id" description: Filter invoice report results by creator id. fuzzy_people: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/fuzzy_people" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/fuzzy_people" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/fuzzy_people" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/fuzzy_people" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/fuzzy_people" description: Filter operator object for fuzzy people. description: Filter invoice report results by fuzzy people. invoicing_method: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/invoicing_method" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/invoicing_method" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/invoicing_method" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/invoicing_method" description: Filter operator object for invoicing method. - "$ref": "#/components/schemas/resource_invoice_report/properties/invoicing_method" description: Filter invoice report results by invoicing method. currency_id: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/currency_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/currency_id" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/currency_id" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/currency_id" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/currency_id" description: Filter operator object for currency id. description: Filter invoice report results by currency id. created_at: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/created_at" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/created_at" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/created_at" description: Filter operator object for created at. - "$ref": "#/components/schemas/resource_invoice_report/properties/created_at" description: Filter invoice report results by created at. amount_credited: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_credited" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_credited" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_credited" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_credited" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_invoice_report/properties/amount_credited" description: Filter by the credited amount on the invoice, excluding tax. parent_invoice_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/parent_invoice_id" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/parent_invoice_id" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/parent_invoice_id" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/parent_invoice_id" description: Filter operator object for parent invoice id. - "$ref": "#/components/schemas/resource_invoice_report/properties/parent_invoice_id" description: Filter invoice report results by parent invoice id. id: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/id" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/id" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/id" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/id" description: Filter operator object for id. description: Filter invoice report results by id. sent_on: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/sent_on" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/sent_on" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/sent_on" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/sent_on" description: Filter operator object for sent on. - "$ref": "#/components/schemas/resource_invoice_report/properties/sent_on" description: Filter invoice report results by sent on. overdue_status: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/overdue_status" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/overdue_status" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/overdue_status" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/overdue_status" description: Filter operator object for overdue status. - "$ref": "#/components/schemas/resource_invoice_report/properties/overdue_status" description: Filter invoice report results by overdue status. deal_id: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/deal_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice_report/properties/deal_id" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/deal_id" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/deal_id" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/deal_id" description: Filter operator object for deal id. description: Filter invoice report results by deal id. number: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/number" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/number" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/number" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/number" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/number" description: Filter operator object for number. description: Filter invoice report results by number. amount_unpaid: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/amount_unpaid" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_unpaid" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_unpaid" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_unpaid" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_unpaid" description: Operator object — supports eq, not_eq, contains, not_contain. description: Filter by unpaid amount range. einvoice_status: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/einvoice_status" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/einvoice_status" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/einvoice_status" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/einvoice_status" description: Operator object — supports eq, not_eq, contains, not_contain. example: eq: delivered - "$ref": "#/components/schemas/resource_invoice_report/properties/einvoice_status" description: Filter by the e-invoice delivery status. example: delivered amount_written_off: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_written_off" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_written_off" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_written_off" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_written_off" description: Filter operator object for amount written off. - "$ref": "#/components/schemas/resource_invoice_report/properties/amount_written_off" description: Filter invoice report results by amount written off. credited: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/credited" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/credited" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/credited" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/credited" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/credited" description: Filter operator object for credited. description: Filter invoice report results by credited. jump_query: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/jump_query" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/jump_query" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/jump_query" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/jump_query" description: Filter operator object for jump query. - "$ref": "#/components/schemas/resource_invoice_report/properties/jump_query" description: Filter invoice report results by jump query. invoice_type: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_type" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_type" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_type" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_type" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_type" description: Filter operator object for invoice type. description: Filter invoice report results by invoice type. status: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/status" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/status" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/status" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/status" description: Filter operator object for status. - "$ref": "#/components/schemas/resource_invoice_report/properties/status" description: Filter invoice report results by status. tax_rates: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/tax_rates" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_invoice_report/properties/tax_rates" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/tax_rates" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/tax_rates" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/tax_rates" description: Filter operator object for tax rates. description: Filter invoice report results by tax rates. payment_terms: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/payment_terms" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice_report/properties/payment_terms" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/payment_terms" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/payment_terms" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/payment_terms" description: Filter operator object for payment terms. description: Filter invoice report results by payment terms. query: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/query" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/query" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/query" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/query" description: Filter operator object for query. - "$ref": "#/components/schemas/resource_invoice_report/properties/query" description: Filter invoice report results by query. responsible_id: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/responsible_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/responsible_id" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/responsible_id" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/responsible_id" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/responsible_id" description: Filter operator object for responsible id. description: Filter invoice report results by responsible id. amount_paid: oneOf: - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_paid" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_paid" contains: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_paid" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/amount_paid" description: Operator object — supports eq, not_eq, contains, not_contain. - "$ref": "#/components/schemas/resource_invoice_report/properties/amount_paid" description: Filter by paid amount range. project_id: oneOf: - "$ref": "#/components/schemas/resource_invoice_report/properties/project_id" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_invoice_report/properties/project_id" eq: "$ref": "#/components/schemas/resource_invoice_report/properties/project_id" not_eq: "$ref": "#/components/schemas/resource_invoice_report/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_invoice_report/properties/project_id" description: Filter operator object for project id. description: Filter invoice report results by project id. patternProperties: "^company..*$": title: Company relationship description: Available filter parameters for querying invoice report records. filter_project_assignment: type: object title: Filter project assignment properties: id: oneOf: - "$ref": "#/components/schemas/resource_project_assignment/properties/id" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_project_assignment/properties/id" contains: "$ref": "#/components/schemas/resource_project_assignment/properties/id" not_eq: "$ref": "#/components/schemas/resource_project_assignment/properties/id" not_contain: "$ref": "#/components/schemas/resource_project_assignment/properties/id" description: Filter using explicit operator syntax. description: Filter by project assignment ID. person_id: oneOf: - "$ref": "#/components/schemas/resource_project_assignment/properties/person_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_assignment/properties/person_id" contains: "$ref": "#/components/schemas/resource_project_assignment/properties/person_id" not_contain: "$ref": "#/components/schemas/resource_project_assignment/properties/person_id" eq: "$ref": "#/components/schemas/resource_project_assignment/properties/person_id" description: Filter using explicit operator syntax. description: Filter by specific person. project_id: oneOf: - "$ref": "#/components/schemas/resource_project_assignment/properties/project_id" - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_project_assignment/properties/project_id" eq: "$ref": "#/components/schemas/resource_project_assignment/properties/project_id" not_contain: "$ref": "#/components/schemas/resource_project_assignment/properties/project_id" contains: "$ref": "#/components/schemas/resource_project_assignment/properties/project_id" description: Filter using explicit operator syntax. description: Filter by the associated project. patternProperties: {} description: Filters project assignments by person or project. filter_workflow: type: object title: Filter workflow properties: name: oneOf: - "$ref": "#/components/schemas/resource_workflow/properties/name" - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_workflow/properties/name" contains: "$ref": "#/components/schemas/resource_workflow/properties/name" not_eq: "$ref": "#/components/schemas/resource_workflow/properties/name" not_contain: "$ref": "#/components/schemas/resource_workflow/properties/name" description: Filter using explicit operator syntax. description: Filter by exact workflow name. query: oneOf: - "$ref": "#/components/schemas/resource_workflow/properties/query" - type: object title: Operation properties: not_contain: "$ref": "#/components/schemas/resource_workflow/properties/query" contains: "$ref": "#/components/schemas/resource_workflow/properties/query" not_eq: "$ref": "#/components/schemas/resource_workflow/properties/query" eq: "$ref": "#/components/schemas/resource_workflow/properties/query" description: Filter using explicit operator syntax. description: Filter by workflow name using a partial text search. archived: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_workflow/properties/archived" not_contain: "$ref": "#/components/schemas/resource_workflow/properties/archived" not_eq: "$ref": "#/components/schemas/resource_workflow/properties/archived" contains: "$ref": "#/components/schemas/resource_workflow/properties/archived" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_workflow/properties/archived" description: Filter to include only archived or non-archived workflows. patternProperties: {} description: Filter parameters for listing workflows. Supports filtering by name and archived status. Standard string operators apply. _filter_root_discussion: oneOf: - "$ref": "#/components/schemas/filter_discussion" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_discussion" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `discussion` list endpoints — pass a single condition or a logical group. resource_entitlement_report: type: object title: Entitlement report Resource properties: currency_default: title: Currency Default description: Financial values expressed in the organization's default currency. formulas: type: integer title: Formulas description: Saved formula definitions applied to generate calculated columns in this report. total_pending_minutes: title: Total Pending Minutes description: Total pending time-off or entitlement time across grouped entries, expressed in minutes. end_date: type: string title: End Date format: date description: The end date of the entitlement period covered by this report row. person: title: Person description: The person this entitlement report row is for. total_used: type: number title: Total Used description: Total used hours — approved absences taken within the entitlement period. total_allocated_minutes: type: integer title: Total Allocated Minutes description: Total allocated minutes for this person in the entitlement period (raw minutes value). start_date_period: title: Start Date Period description: The start date period descriptor used for grouping in time-based reports. total_used_minutes: type: integer title: Total Used Minutes description: Total used minutes (raw minutes value). id: type: integer title: Id description: The unique identifier of this entitlement report row. date: type: string title: Date format: date description: The reporting date for this entitlement row. used: type: number title: Used description: Hours used in this entitlement row's absence category. event: title: Event description: The absence category (event) this report row covers. entitlement: title: Entitlement description: The linked entitlement record this report row is based on. currency_normalized: title: Currency Normalized description: Financial values normalized for cross-currency comparison. allocated: type: number title: Allocated description: Total hours allocated for the absence category in the reporting period. total_available: type: number title: Total Available description: Total available hours remaining (allocated minus used and pending). group: type: string title: Group description: The grouping key for this report row when results are aggregated by a dimension. entitlement_start_date: title: Entitlement Start Date description: The start date of the entitlement record linked to this report row. entitlement_end_date: title: Entitlement End Date description: The end date of the entitlement record linked to this report row. total_available_minutes: type: integer title: Total Available Minutes description: Total available minutes remaining (raw minutes value). person_id: type: integer title: Person description: The ID of the person this entitlement report row is for. total_pending: type: number title: Total Pending description: Total pending time-off or entitlement time across grouped entries, in the configured time unit. report: title: Report description: The parent report record this row belongs to. end_date_period: title: End Date Period description: The end date period descriptor used for grouping in time-based reports. total_allocated: type: number title: Total Allocated description: Total allocated hours for this person across all entitlement records in the period. subsidiary: title: Subsidiary description: The subsidiary associated with this entitlement report row. organization: title: Organization description: The organization this entitlement report row belongs to. people_custom_fields: title: People Custom Fields description: Custom field values from the associated person record included for reporting context. event_id: type: integer title: Event description: The ID of the absence category (event) for this report row. person_report: title: Person Report description: Summary person-level report data rolled up from individual entitlement records. absence_type: enum: - time_off - remote_work type: string title: Absence Type description: The type of absence (e.g. time off, remote work) for this entitlement report row. start_date: type: string title: Start Date format: date description: The start date of the entitlement period covered by this report row. formula_fields: title: Formula Fields description: Custom formula field values computed for this report row. currency: title: Currency description: The currency code of financial values in this report row. count: type: integer title: Count description: Number of entitlement records included in this aggregated report row. description: An aggregated entitlement report row combining a person's time-off allocation, usage, and availability for an absence category over a period. filter_subsidiary: type: object title: Filter subsidiary properties: status: oneOf: - "$ref": "#/components/schemas/resource_subsidiary/properties/status" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_subsidiary/properties/status" not_eq: "$ref": "#/components/schemas/resource_subsidiary/properties/status" not_contain: "$ref": "#/components/schemas/resource_subsidiary/properties/status" eq: "$ref": "#/components/schemas/resource_subsidiary/properties/status" description: Filter using explicit operator syntax. description: Filter by status (active or archived). id: oneOf: - type: object title: Operation properties: not_eq: "$ref": "#/components/schemas/resource_subsidiary/properties/id" contains: "$ref": "#/components/schemas/resource_subsidiary/properties/id" not_contain: "$ref": "#/components/schemas/resource_subsidiary/properties/id" eq: "$ref": "#/components/schemas/resource_subsidiary/properties/id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_subsidiary/properties/id" description: Filter by ID. patternProperties: {} description: Filter parameters for listing subsidiaries (legal entities). Supports filtering by name, archived status, and subsidiary ID. Standard string and ID operators apply. resource_bill: type: object title: Bill Resource properties: total_cost: title: Total Cost description: The total cost of goods or services received in this bill, in the bill's currency. date: type: string title: Date format: date description: The date the bill was issued. total_received_normalized: title: Total Received Normalized description: The total amount received expressed in the normalized (common reporting) currency. currency_default: title: Currency Default description: The currency used for amounts expressed in the organization's default currency. created_at: type: string title: Created At format: date-time description: Timestamp when the bill was created. creator: title: Creator description: The person who created this bill. id: type: integer title: Id description: Unique identifier for the bill. purchase_order: title: Purchase Order description: The purchase order this bill is received against. example: data: type: purchase_orders id: '1234567' attachment: title: Attachment description: The attachment (receipt or document) associated with this bill. organization: title: Organization description: The organization this bill belongs to. currency_normalized: title: Currency Normalized description: The currency used for amounts expressed in the normalized (common reporting) currency. total_cost_default: title: Total Cost Default description: The total cost of this bill expressed in the organization's default currency. total_received: title: Total Received description: The total amount received or recognized from the vendor in the bill's currency. deal: title: Deal description: The budget (deal) this bill is associated with. total_cost_normalized: title: Total Cost Normalized description: The total cost of this bill expressed in the normalized (common reporting) currency. deleted_at: type: string title: Deleted At format: date-time description: Timestamp when the bill was deleted, or null if active. attachment_id: type: integer title: Attachment description: The ID of the attachment associated with this bill. total_received_default: title: Total Received Default description: The total amount received expressed in the organization's default currency. currency: title: Currency description: The currency of the bill amounts. due_date: type: string title: Due Date format: date description: The payment due date for this bill. invoice_number: type: string title: Invoice Number description: The vendor's invoice number or reference code for this bill. purchase_order_id: type: integer title: Purchase Order description: The ID of the purchase order this bill is received against. example: 1234567 description: Receipt record against a purchase order. Tracks the vendor invoice number, date, due date, description, and total amounts received and cost. Links to a deal and has an optional attachment for the vendor invoice document. filter_rate_card: type: object title: Filter rate card properties: company_id: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_rate_card/properties/company_id" not_contain: "$ref": "#/components/schemas/resource_rate_card/properties/company_id" not_eq: "$ref": "#/components/schemas/resource_rate_card/properties/company_id" contains: "$ref": "#/components/schemas/resource_rate_card/properties/company_id" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_rate_card/properties/company_id" description: Filter by client company. name: oneOf: - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_rate_card/properties/name" eq: "$ref": "#/components/schemas/resource_rate_card/properties/name" not_eq: "$ref": "#/components/schemas/resource_rate_card/properties/name" not_contain: "$ref": "#/components/schemas/resource_rate_card/properties/name" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_rate_card/properties/name" description: Filter by name (text search). status: oneOf: - type: object title: Operation properties: eq: "$ref": "#/components/schemas/resource_rate_card/properties/status" not_contain: "$ref": "#/components/schemas/resource_rate_card/properties/status" not_eq: "$ref": "#/components/schemas/resource_rate_card/properties/status" contains: "$ref": "#/components/schemas/resource_rate_card/properties/status" description: Filter using explicit operator syntax. - "$ref": "#/components/schemas/resource_rate_card/properties/status" description: Filter by status (active or archived). created_at: oneOf: - "$ref": "#/components/schemas/resource_rate_card/properties/created_at" - type: object title: Operation properties: contains: "$ref": "#/components/schemas/resource_rate_card/properties/created_at" not_contain: "$ref": "#/components/schemas/resource_rate_card/properties/created_at" not_eq: "$ref": "#/components/schemas/resource_rate_card/properties/created_at" eq: "$ref": "#/components/schemas/resource_rate_card/properties/created_at" description: Filter using explicit operator syntax. description: Filter by creation date range. patternProperties: {} description: Filter parameters for listing rate cards. Supports filtering by company, archived status, and name. Standard string and ID operators apply. resource_line_item_report: type: object title: Line item report Resource properties: total_amount_with_tax: title: Total Amount With Tax description: Sum of amount with tax across all records in this line item report group. currency_default: title: Currency Default description: Currency in the organization's default currency for this line item report group. discount: type: number title: Discount description: Discount for this line item report group. quantity: type: number title: Quantity description: Quantity for this line item report group. tax_rate: type: string title: Tax Rate description: Tax rate for this line item report group. total_amount_normalized: title: Total Amount Normalized description: Sum of amount in the normalized currency across all records in this line item report group. invoice: title: Invoice description: Invoice for this line item report group. total_amount_with_tax_default: title: Total Amount With Tax Default description: Sum of amount with tax in the organization's default currency across all records in this line item report group. total_amount_tax_default: title: Total Amount Tax Default description: Sum of amount tax in the organization's default currency across all records in this line item report group. total_amount: title: Total Amount description: Sum of amount across all records in this line item report group. updater: title: Updater description: Updater for this line item report group. unit_id: type: integer title: Unit description: Unit id for this line item report group. organization: title: Organization description: Organization for this line item report group. service_type: title: Service Type description: Service type for this line item report group. id: type: integer title: Id description: Unique identifier for this line item report row. formula_fields: title: Formula Fields description: Formula fields for this line item report group. invoice_report: title: Invoice Report description: Invoice report for this line item report group. total_amount_default: title: Total Amount Default description: Sum of amount in the organization's default currency across all records in this line item report group. budget: title: Budget description: Budget for this line item report group. creator: title: Creator description: Creator for this line item report group. unit_price_normalized: title: Unit Price Normalized description: Unit price in the normalized currency for this line item report group. invoice_id: type: integer title: Invoice description: Invoice id for this line item report group. group: type: string title: Group description: The grouping dimension for this line item report row. total_amount_tax: title: Total Amount Tax description: Sum of amount tax across all records in this line item report group. company_id: type: integer title: Company description: Company id for this line item report group. currency: type: string title: Currency description: Currency for this line item report group. tax_name: type: string title: Tax Name description: Tax name for this line item report group. currency_normalized: title: Currency Normalized description: Currency in the normalized currency for this line item report group. tax_value: type: number title: Tax Value description: Tax value for this line item report group. report: title: Report description: Report for this line item report group. expense_id: type: integer title: Expense description: Expense id for this line item report group. unit: title: Unit description: Unit for this line item report group. service_id: type: integer title: Service description: Service id for this line item report group. service_type_id: type: integer title: Service Type description: Service type id for this line item report group. total_amount_tax_normalized: title: Total Amount Tax Normalized description: Sum of amount tax in the normalized currency across all records in this line item report group. line_item: title: Line Item description: Line item for this line item report group. unit_price_default: title: Unit Price Default description: Unit price in the organization's default currency for this line item report group. total_amount_with_tax_normalized: title: Total Amount With Tax Normalized description: Sum of amount with tax in the normalized currency across all records in this line item report group. updater_id: type: integer title: Updater description: Updater id for this line item report group. service: title: Service description: Service for this line item report group. company: title: Company description: Company for this line item report group. kpd_code: title: Kpd Code description: Kpd code for this line item report group. example: data: type: kpd_codes id: '42' expense: title: Expense description: Expense for this line item report group. creator_id: type: integer title: Creator description: Creator id for this line item report group. count: type: integer title: Count description: Number of line items in this report group. unit_price: title: Unit Price description: Unit price for this line item report group. description: An aggregated line item report row grouping invoice line items by configurable dimensions with amount metrics. resource_proposal_report: type: object title: Proposal report Resource properties: signed: type: integer title: Signed description: Whether the proposals in this report row have been signed by the client. total_tax_amount: title: Total Tax Amount description: Sum of calculated tax amounts across all proposals in this report row, in the proposal's original currency. average_tax_rate_value: type: number title: Average Tax Rate Value description: Average tax rate percentage applied across proposals in this report row, computed from the tax rate component values. proposal: title: Proposal description: The proposal associated with this report row (populated when grouped by proposal). link_status: enum: - active - inactive type: string title: Link Status description: Public link sharing status of the proposals in this report row. total_budget_total_default: title: Total Budget Total Default description: Sum of all proposal budget totals in this report row, in the organization's default currency. created_at_period: title: Created At Period description: The period label for the proposal creation date when the report is grouped by a creation date interval. currency_normalized: title: Currency Normalized description: Budget total amount normalized to the organization's reporting currency. deal: title: Deal description: The deal associated with the proposals in this report row. creator_report: title: Creator Report description: Nested creator person report data for this report row. total_budget_total: title: Total Budget Total description: Sum of all proposal budget totals in this report row, in the proposal's original currency. status: enum: - draft - sent - accepted - rejected type: string title: Status description: Current lifecycle status of the proposals in this report row (e.g. draft, sent, accepted, declined). formula_fields: title: Formula Fields description: Values of any custom formula fields defined for this report. deal_id: type: integer title: Deal description: ID of the deal associated with the proposals in this report row. date_signed_period: title: Date Signed Period description: The period label for the date signed when the report is grouped by a signing date interval. name: title: Name description: Name of the proposal in this report row (populated when grouped by proposal). company: title: Company description: The associated client company for this report row. status_changed_at: type: string title: Status Changed At format: date description: Timestamp when the proposal status last changed in this report row. group: type: string title: Group description: The grouping dimension used to aggregate proposals into this report row (e.g. company, deal, status). total_tax_amount_normalized: title: Total Tax Amount Normalized description: Sum of calculated tax amounts across all proposals in this report row, normalized to the organization's reporting currency. sent_at: type: string title: Sent At format: date description: Timestamp when the proposals in this report row were sent to the client. subsidiary: title: Subsidiary description: The subsidiary company entity associated with the proposals in this report row. updated_at_period: title: Updated At Period description: The period label for the updated date when the report is grouped by an update date interval. updated_at: type: string title: Updated At format: date description: Timestamp of the most recent update to proposals in this report row. total_tax_amount_default: title: Total Tax Amount Default description: Sum of calculated tax amounts across all proposals in this report row, in the organization's default currency. budget_total: title: Budget Total description: Total budget amount of the proposal in the proposal's original currency. count: type: integer title: Count description: Number of proposals aggregated into this report row. responsible_id: type: integer title: Responsible description: ID of the responsible person for the proposals in this report row. report: title: Report description: The parent report configuration that this report row belongs to. signed_by_email: type: string title: Signed By Email description: Email address of the person who signed the proposal, populated only when the proposal is signed. tax_amount: title: Tax Amount description: Calculated tax amount for the proposals in this report row, based on the applied tax rate. deal_report: title: Deal Report description: Nested deal report data for this report row, including deal-level aggregates and attributes. creator: title: Creator description: The person who created the proposals in this report row. status_changed_at_period: title: Status Changed At Period description: The period label for the status change date when the report is grouped by a status change date interval. responsible: title: Responsible description: The responsible person for the proposals in this report row. creator_id: type: integer title: Creator description: ID of the person who created the proposals in this report row. date_signed: type: string title: Date Signed format: date description: Date the proposal was signed, computed as `status_changed_at` when a signature image is present. total_budget_total_normalized: title: Total Budget Total Normalized description: Sum of all proposal budget totals in this report row, normalized to the organization's reporting currency. currency_default: title: Currency Default description: Budget total amount in the organization's default currency. company_report: title: Company Report description: Nested company report data for this report row, including company-level aggregates and attributes. currency: type: string title: Currency description: Currency code of the proposal amounts in this report row. created_at: type: string title: Created At format: date description: Creation timestamp of the proposals in this report row. responsible_report: title: Responsible Report description: Nested responsible person report data for this report row. sent_at_period: title: Sent At Period description: The period label for the sent date when the report is grouped by a sent date interval. company_id: type: integer title: Company description: ID of the client company associated with proposals in this report row. formulas: type: integer title: Formulas description: Custom formula field definitions applied to this report row. organization: title: Organization description: The organization that owns the proposals in this report row. id: type: integer title: Id description: Unique identifier for this proposal report row. description: A single aggregated row in a proposal report, containing metrics and grouping fields for one or more proposals. resource_new_time_report: type: object title: New time report Resource properties: subsidiary: title: Subsidiary description: Name of the subsidiary (workplace) this row is grouped by. person: title: Person description: Person for this new time report group. people_custom_fields: type: string title: People Custom Fields description: Custom fields on people used for grouping. date_period: title: Date Period description: The date period label for this row (e.g. week, month, quarter range). draft_scheduled_time: type: number title: Draft Scheduled Time description: Total tentative time scheduled on budgets and deals. deal_or_budget_report: title: Deal Or Budget Report description: Report object for the deal or budget associated with this time report entry. bookings_before: type: string title: Bookings Before format: date description: Start date of the booking range used to calculate scheduling metrics. total_draft_scheduled_revenue_default: title: Total Draft Scheduled Revenue Default description: Sum of draft scheduled revenue in the organization's default currency across all records in this new time report group. billable_time: type: number title: Billable Time description: Hours billable to clients. quarter: type: string title: Quarter description: Quarter grouping for this new time report row. day: type: string title: Day description: Day of month this row represents, when grouped by day. budget: title: Budget description: Name of the budget (deal) this row is grouped by. currency: type: string title: Currency description: Currency code for monetary values in this row. event: title: Event description: Name of the absence category (event) this row is grouped by. role_id: type: integer title: Role description: ID of the role this row is grouped by. paid_event_time: type: number title: Paid Event Time description: Total number of hours scheduled on paid time off (i.e. vacation). total_draft_scheduled_revenue: title: Total Draft Scheduled Revenue description: Sum of draft scheduled revenue across all records in this new time report group. scheduled_time: type: number title: Scheduled Time description: Total number of hours scheduled on budgets and deals. total_work_cost_normalized: title: Total Work Cost Normalized description: Total labor cost normalized to a common currency for cross-currency comparison. draft_scheduled_client_time: type: number title: Draft Scheduled Client Time description: Total tentative time scheduled on client budgets and deals. client_time: type: number title: Client Time description: Hours tracked on client projects. role_type: type: string title: Role Type description: The role category of the person linked to this time report entry (e.g., employee, contractor). total_scheduled_revenue_default: title: Total Scheduled Revenue Default description: Total scheduled revenue in the organization default currency. recognized_time: type: number title: Recognized Time description: Recognized time for this new time report group. total_scheduled_cost_normalized: title: Total Scheduled Cost Normalized description: Total scheduled cost normalized to a common currency for cross-currency comparison. before: type: string title: Before format: date description: The report start date (inclusive lower bound of the reporting period). draft_scheduled_internal_time: type: number title: Draft Scheduled Internal Time description: Total tentative time scheduled on internal projects. date: type: string title: Date format: date description: The specific date this row represents, when grouped by day. total_work_cost: title: Total Work Cost description: Total labor cost of tracked time. total_scheduled_revenue_normalized: title: Total Scheduled Revenue Normalized description: Total scheduled revenue normalized to a common currency for cross-currency comparison. draft_scheduled_billable_time: type: number title: Draft Scheduled Billable Time description: Total tentative time scheduled on billable services. total_draft_scheduled_cost_default: title: Total Draft Scheduled Cost Default description: Tentative scheduled cost in the organization default currency. project_type: enum: - 1 - 2 type: integer title: Project Type description: Project type for this new time report group. workload: type: number title: Workload description: Workload per person as a ratio or percentage. project: title: Project description: Project for this new time report group. internal_time: type: number title: Internal Time description: Hours tracked on internal projects. count: type: integer title: Count description: Number of time entries in this row. person_title: title: Person Title description: Person title for this new time report group. service_id: type: integer title: Service description: ID of the service this row is grouped by. total_draft_scheduled_revenue_normalized: title: Total Draft Scheduled Revenue Normalized description: Sum of draft scheduled revenue in the normalized currency across all records in this new time report group. project_report: title: Project Report description: Project report for this new time report group. company: title: Company description: Name of the client company. after: type: string title: After format: date description: The report end date (exclusive upper bound of the reporting period). total_scheduled_revenue: title: Total Scheduled Revenue description: Total scheduled revenue including past and future bookings. total_cost_normalized: title: Total Cost Normalized description: Total cost normalized to a common currency for cross-currency comparison. total_cost: title: Total Cost description: Total cost of tracked time, including work (cost rate) and overhead costs. bookings_after: type: string title: Bookings After format: date description: End date of the booking range used to calculate scheduling metrics. budget_id: type: integer title: Budget description: ID of the budget (deal) this row is grouped by. week: type: string title: Week description: Week number this row represents, when grouped by week. formula_fields: title: Formula Fields description: Custom formula field values computed for this row. currency_default: title: Currency Default description: Monetary values converted to the organization default currency. organization: title: Organization description: Reference to the organization. manager: title: Manager description: The person's manager. service_type: title: Service Type description: Name of the service type this row is grouped by. month: type: string title: Month description: Month number this row represents, when grouped by month. formulas: type: integer title: Formulas description: Formula definitions used to compute derived metrics in this row. budget_tags: type: string title: Budget Tags description: Tags applied to the budget (deal). company_report: title: Company Report description: Reference to the associated company report. holiday_time: type: number title: Holiday Time description: The total time a person was on holiday during the selected reporting period. This time is excluded from their capacity. person_type: enum: - 1 - 2 - 3 - 4 type: integer title: Person Type description: Person type for this new time report group. year: type: string title: Year description: Year this row represents, when grouped by year. total_draft_scheduled_cost_normalized: title: Total Draft Scheduled Cost Normalized description: Sum of draft scheduled cost in the normalized currency across all records in this new time report group. user_capacity: type: number title: User Capacity description: Expected number of worked hours for the user. person_tags: type: string title: Person Tags description: Person tags for this new time report group. total_draft_scheduled_cost: title: Total Draft Scheduled Cost description: Total scheduled cost based on past and future tentative bookings. available_time: type: number title: Available Time description: Expected number of work hours reduced for scheduled absence (i.e. vacation). currency_normalized: type: string title: Currency Normalized description: Monetary values normalized to a common currency for cross-currency comparison. total_work_cost_default: title: Total Work Cost Default description: Total labor cost in the organization default currency. service: title: Service description: Name of the service this row is grouped by. future: type: integer title: Future description: Whether this row includes future scheduled data. event_time: type: number title: Event Time description: Total number of hours scheduled on paid and unpaid time off (i.e. vacation, sick leave, etc.) scheduled_client_time: type: number title: Scheduled Client Time description: Total number of hours scheduled on client budgets and deals. unpaid_event_time: type: number title: Unpaid Event Time description: Total number of hours scheduled on unpaid time off (i.e. exams). company_id: type: integer title: Company description: ID of the client company. person_id: type: integer title: Person description: Person id for this new time report group. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary (workplace) this row is grouped by. service_type_id: type: integer title: Service Type description: ID of the service type this row is grouped by. billing_type: enum: - 1 - 2 - 3 - 4 type: integer title: Billing Type description: Billing type of the service (e.g. fixed, hourly, non-billable). bookings_custom_fields: type: string title: Bookings Custom Fields description: Custom fields on bookings used for grouping or filtering. unapproved_time: type: number title: Unapproved Time description: Hours still waiting for approval. recognized_scheduled_time: type: number title: Recognized Scheduled Time description: Recognized scheduled time for this new time report group. project_id: type: integer title: Project description: Project id for this new time report group. capacity: type: number title: Capacity description: Expected number of worked hours. worked_time: type: number title: Worked Time description: Hours tracked on client and internal projects. scheduled_billable_time: type: number title: Scheduled Billable Time description: Total number of hours scheduled on billable services. person_company: title: Person Company description: Person company for this new time report group. average_cost_rate: title: Average Cost Rate description: The average cost rate is calculated from the cost rate for each day defined in the date filter. scheduled_remote_work_time: type: number title: Scheduled Remote Work Time description: Total number of scheduled remote work hours. average_cost_rate_normalized: title: Average Cost Rate Normalized description: Average cost rate normalized to a common currency for cross-currency comparison. event_id: type: integer title: Event description: ID of the absence category (event) this row is grouped by. report: title: Report description: The saved filter (report view) this row belongs to. scheduled_event_time: type: number title: Scheduled Event Time description: Total number of scheduled hours for absence (time off) events. group: type: string title: Group description: Grouping dimension label for this row. total_scheduled_cost: title: Total Scheduled Cost description: Sum of scheduled cost across all records in this new time report group. total_scheduled_cost_default: title: Total Scheduled Cost Default description: Sum of scheduled cost in the organization's default currency across all records in this new time report group. average_cost_rate_default: title: Average Cost Rate Default description: Average cost rate in the organization default currency. stage_type: enum: - 1 - 2 type: integer title: Stage Type description: The deal stage type for this row. scheduled_internal_time: type: number title: Scheduled Internal Time description: Total number of hours scheduled on internal projects. total_cost_default: title: Total Cost Default description: Total cost in the organization default currency. person_report: title: Person Report description: The person associated with this time report row. description: A time report row aggregating tracked hours by configurable dimensions with utilization, capacity, and overtime calculations. resource_deal_report: type: object title: Deal report Resource properties: total_services_revenue: title: Total Services Revenue description: Sum of services revenue across all deals in this report group. average_actual_rate: title: Average Actual Rate description: Average actual billing rate across deals in this report row, in the deal's budget currency. deal_sales_closed_on: title: Deal Sales Closed On description: Date the deal was closed for sales (won or lost). responsible: title: Responsible description: The person responsible for managing this deal. deal_won_date: title: Deal Won Date description: Date when the deal was marked as won. budget_used: title: Budget Used description: Amount of budget already consumed on the deal. project_type: enum: - 1 - 2 type: integer title: Project Type description: Project type label (e.g. Internal or Client). currency: type: string title: Currency description: Currency code of the deal's budget currency. pipeline: title: Pipeline description: The pipeline this deal belongs to. company_report: title: Company Report description: Related company report for the deal's client. total_projected_revenue: title: Total Projected Revenue description: Sum of projected revenue amounts across all deals in this report group. budgeted_time: type: integer title: Budgeted Time description: Total estimated time budgeted on the deal. probability: type: string title: Probability description: Likelihood of winning this deal as a percentage (100 for won, 0 for lost by default). origin_deal_id: type: integer title: Origin Deal description: ID of the origin deal for this record. days_since_created: type: integer title: Days Since Created description: Average number of days since deals in this group were created. budget_remaining: title: Budget Remaining description: Remaining budget on the deal (budget total minus budget used). subsidiary: title: Subsidiary description: The subsidiary (legal entity) this deal is attributed to. organization: title: Organization description: The organization this deal belongs to. budget_total: title: Budget Total description: Total budget amount on the deal. forecasted_margin: type: number title: Forecasted Margin description: Forecasted profit margin as a percentage. future_budget_used: title: Future Budget Used description: Total future budget used, calculated from resourcing data. forecasted_cost: title: Forecasted Cost description: 'Forecasted cost: current cost plus future cost.' id: type: integer title: Id description: Unique identifier for this deal report row. manually_invoiced: enum: - 1 - 2 type: integer title: Manually Invoiced description: Amount manually marked as invoiced on this deal. services_revenue: title: Services Revenue description: Revenue from services only, excluding revenue from billable expenses. approval_policy_id: type: integer title: Approval Policy description: ID of the approval policy associated with the deal. retainer: type: integer title: Retainer description: When true, deals in this group are retainer deals. deal_sales_status_updated_at: title: Deal Sales Status Updated At description: Timestamp when the deal's sales status was last updated. sales_closed_at: type: string title: Sales Closed At format: date description: Timestamp when the deal was closed (won or lost). total_budget_used: title: Total Budget Used description: Sum of budget used amounts across all deals in this report group. deal_todo_due_date: title: Deal Todo Due Date description: Due date of the next to-do item on the deal. company: title: Company description: Client company associated with the deal. lost_date: type: string title: Lost Date format: date description: Date when the deal was marked as lost. profit_margin: type: number title: Profit Margin description: 'Profit margin as a percentage: profit divided by revenue.' total_services_revenue_default: title: Total Services Revenue Default description: Sum of services revenue in the organization's default currency across all deals in this report group. manual_invoicing_status: type: boolean title: Manual Invoicing Status description: Indicates whether the deal has been manually marked as invoiced. average_rate_default: title: Average Rate Default description: Average billing rate on the deal, in the organization's default currency. won_at: type: string title: Won At format: date description: Timestamp when the deal was marked as won. total_worked_time: type: number title: Total Worked Time description: Sum of worked (tracked) hours across all deals in this report group. unapproved_time: type: integer title: Unapproved Time description: Amount of unapproved time tracked on deals in this report group. recurring_interval_id: enum: - 3 - 2 - 1 - 6 - 5 - 4 type: integer title: Recurring Interval description: ID of the recurring interval type. lost_reason: title: Lost Reason description: The reason why the deal was lost. previous_deal_status: title: Previous Deal Status description: The previous deal status label (stage the deal was in before the current one). deal_status: title: Deal Status description: Current pipeline stage of the deal. previous_probability: type: string title: Previous Probability description: Probability percentage of the deal before the last status change. invoiced_percentage: type: integer title: Invoiced Percentage description: Percentage of the budget total that has been invoiced. estimated_remaining_time: type: integer title: Estimated Remaining Time description: Estimated remaining time to complete the deal. total_services_revenue_normalized: title: Total Services Revenue Normalized description: Sum of services revenue in the normalized currency across all deals in this report group. total_budget_from_services: title: Total Budget From Services description: The total budget value derived from services for deals in this group, in the deal currency. lost_at: type: string title: Lost At format: date description: Timestamp when the deal was marked as lost. average_actual_rate_default: title: Average Actual Rate Default description: Average actual billing rate across deals in this report row, in the organization's default currency. designated_approver: title: Designated Approver description: The person designated as the approver for deals in this group. recurring_starts_on: type: string title: Recurring Starts On format: date description: Date when the deal recurrence starts. total_cost_normalized: title: Total Cost Normalized description: Sum of total costs in the normalized currency across all deals in this report group. time_approval: type: boolean title: Time Approval description: Indicates whether time entries on this deal require approval. recurring: type: boolean title: Recurring description: Indicates whether this deal is a recurring retainer. total_estimated_remaining_time: type: number title: Total Estimated Remaining Time description: Sum of estimated remaining hours across all deals in this report group. needs_closing: type: boolean title: Needs Closing description: Indicates whether the deal requires closing action. last_activity_at_period: title: Last Activity At Period description: Time period grouping for last activity date (e.g. week, month, quarter). date: type: string title: Date format: date description: Report grouping date for time-period dimensions. average_rate: title: Average Rate description: Average billing rate on the deal, in the deal's budget currency. deal_closed_at: title: Deal Closed At description: Date and time when the deal was closed. company_id: type: integer title: Company description: ID of the client company associated with the deal. total_budget_used_default: title: Total Budget Used Default description: Sum of budget used amounts in the organization's default currency across all deals in this report group. owner_report: title: Owner Report description: Related person report data for the deal owner. average_days_in_current_stage: type: integer title: Average Days In Current Stage description: Average number of calendar days deals have spent in their current pipeline stage. total_work_cost: title: Total Work Cost description: Sum of labor (work) costs across all deals in this report group. query: type: string title: Query description: The query parameters applied when generating this report row. created_at: type: string title: Created At format: date description: Date and time the deal record was created. future_cost: title: Future Cost description: Total future cost including service and expense costs, calculated from resourcing data. average_actual_rate_normalized: title: Average Actual Rate Normalized description: Average actual billing rate across deals in this report row, in the normalized common currency. total_profit_normalized: title: Total Profit Normalized description: Sum of profit amounts in the normalized currency across all deals in this report group. delivered_on: type: string title: Delivered On format: date description: Date the deal was delivered to the client. subscriber_id: type: integer title: Subscriber description: ID of the subscriber (person following this deal for notifications). deal_purchase_order_number: title: Deal Purchase Order Number description: Purchase order number provided by the client for this deal. example: PO-2024-017 fuzzy_people: type: integer title: Fuzzy People description: Relative person references (e.g. current_user) used in people-based filters. deal_retainer: title: Deal Retainer description: When true, this deal group represents retainer deals. sales_closed_on: type: string title: Sales Closed On format: date description: Date when the deal was closed (won or lost). deal_average_days_since_created: title: Deal Average Days Since Created description: Average number of calendar days from deal creation to closure (or now if still open). forecasted_budget_used: title: Forecasted Budget Used description: 'Forecasted total budget used: current budget used plus future budget used.' sales_closed_on_period: title: Sales Closed On Period description: Time period grouping for the sales closed-on date (e.g. week, month, quarter). total_budget_from_services_default: title: Total Budget From Services Default description: The total budget value derived from services for deals in this group, in the organization's default currency. contact_id: type: integer title: Contact description: ID of the contact person associated with the deal. total_profit_default: title: Total Profit Default description: Sum of profit amounts in the organization's default currency across all deals in this report group. project_id: type: integer title: Project description: ID of the project associated with this deal. contact_report: title: Contact Report description: Related report for the deal's contact person. forecasted_profit: title: Forecasted Profit description: Forecasted profit amount. creator: title: Creator description: Person who created the deal. status_id: type: integer title: Status description: ID of the current deal status. forecasted_time_usage: type: number title: Forecasted Time Usage description: Forecasted time usage as a percentage of estimated time. discount: type: number title: Discount description: Discount amount or percentage applied to the deal. won_date: type: string title: Won Date format: date description: Time period grouping for the won date (e.g. week, month, quarter). actual_rate: title: Actual Rate description: Actual billing rate achieved on the deal. total_budget_used_normalized: title: Total Budget Used Normalized description: Sum of budget used amounts in the normalized currency across all deals in this report group. total_revenue: title: Total Revenue description: Sum of revenue amounts across all deals in this report group. budget_warning: type: integer title: Budget Warning description: Budget warning flag — indicates whether the deal is approaching or exceeding budget limits. template: type: string title: Template description: Indicates whether this deal was created from a template. average_days_since_created: type: integer title: Average Days Since Created description: Average number of calendar days from deal creation to closure (or now if still open). project_report: title: Project Report description: Related project report data for this deal. project: title: Project description: The project associated with this deal. days_since_last_activity: type: integer title: Days Since Last Activity description: Average number of days since the last activity was recorded on deals in this group. deal_suffix: title: Deal Suffix description: Deal name suffix used for display. sales_closed_at_period: title: Sales Closed At Period description: Time period grouping for the sales closed-at timestamp (e.g. week, month, quarter). pending_invoicing: title: Pending Invoicing description: Amount of money pending invoicing for this deal. total_revenue_default: title: Total Revenue Default description: Sum of revenue amounts in the organization's default currency across all deals in this report group. primary_contact: title: Primary Contact description: The primary contact person for the company linked to deals in this group. count: type: integer title: Count description: Number of deals grouped into this report row. previous_or_current_deal_status_id: type: integer title: Previous Or Current Deal Status description: ID of the previous or current deal status (used for pipeline stage tracking). deal_custom_fields: title: Deal Custom Fields description: Custom field values on the deal. deal_average_days_since_last_activity: title: Deal Average Days Since Last Activity description: Timestamp of the most recent activity on the deal associated with this report row. sales_status_id: enum: - 1 - 2 - 3 - 4 type: integer title: Sales Status description: ID of the current deal sales status (open, won, lost). total_estimated_cost_normalized: title: Total Estimated Cost Normalized description: Sum of estimated costs in the normalized currency across all deals in this report group. number: type: string title: Number description: Unique number identifying this deal. total_budget_total: title: Total Budget Total description: Sum of total approved budget amounts across all deals in this report group. date_period: title: Date Period description: Time period grouping label for the report date dimension. next_occurrence_on: type: string title: Next Occurrence On format: date description: Date when the next recurring occurrence of this deal will be generated. total_profit: title: Total Profit description: Sum of profit amounts across all deals in this report group. total_budget_total_default: title: Total Budget Total Default description: Sum of total approved budget amounts in the organization's default currency across all deals in this report group. deal_client_access: title: Deal Client Access description: Whether the deal is accessible by a specific client user. deal_budget_warning: title: Deal Budget Warning description: Budget warning status of the deal. profit: title: Profit description: 'Profit after all costs: revenue minus service costs and expense costs.' deal_created_at: title: Deal Created At description: Date and time the deal record was created. total_budget_from_services_normalized: title: Total Budget From Services Normalized description: The total budget value derived from services for deals in this group, normalized to the deal currency. total_billable_time: type: number title: Total Billable Time description: Sum of billable hours tracked across all deals in this report group. projected_revenue: title: Projected Revenue description: 'Projected revenue: budget total multiplied by deal probability.' total_cost: title: Total Cost description: Sum of total costs across all deals in this report group. total_work_cost_default: title: Total Work Cost Default description: Sum of labor (work) costs in the organization's default currency across all deals in this report group. deal_average_days_in_current_stage: title: Deal Average Days In Current Stage description: Average number of calendar days deals have spent in their current pipeline stage. last_activity_at: type: string title: Last Activity At format: date description: Timestamp of the most recent activity on this deal. future_booked_time: type: integer title: Future Booked Time description: Number of hours scheduled on this deal in the future (from resourcing). total_expense_default: title: Total Expense Default description: Sum of expense costs in the organization's default currency across all deals in this report group. accessible_by_person: type: integer title: Accessible By Person description: Person who has access to the deal in this report row. total_revenue_normalized: title: Total Revenue Normalized description: Sum of revenue amounts in the normalized currency across all deals in this report group. average_rate_normalized: title: Average Rate Normalized description: Average billing rate on the deal, in the normalized common currency. deal_time_approval: title: Deal Time Approval description: Time entry approval status on the deal. quarter: type: string title: Quarter description: Quarter grouping label for this report row (e.g. Q1 2026). total_estimated_cost: title: Total Estimated Cost description: Sum of estimated costs across all deals in this report group. total_estimated_time: type: number title: Total Estimated Time description: Sum of estimated hours across all deals in this report group. budget_status: enum: - 1 - 2 type: integer title: Budget Status description: Budget health status of the deal — indicates whether spending is within budget thresholds. formula_fields: title: Formula Fields description: Computed values for custom formula fields defined on the report. forecasted_billable_time: type: integer title: Forecasted Billable Time description: 'Forecasted billable time: current billable time plus future scheduled time.' average_days_since_last_activity: type: integer title: Average Days Since Last Activity description: Average number of days since the last activity across deals in this report. jump_query: type: string title: Jump Query description: Condensed query object used for quick navigation to drill-down report views. closed_at: type: string title: Closed At format: date description: Date and time when the deal was closed. deal_sales_closed_at: title: Deal Sales Closed At description: Timestamp when the deal was closed for sales (won or lost). lost_reason_id: type: integer title: Lost Reason description: ID of the reason why the deal was lost. deal_end_date: title: Deal End Date description: End date of the deal. group: type: string title: Group description: The grouping dimension for this report row (e.g. the company, pipeline, or person being grouped by). month: type: string title: Month description: Month grouping label for this report row (e.g. March 2026). type: enum: - 1 - 2 type: integer title: Type description: Type of the deal (e.g. sales, production). estimated_cost: title: Estimated Cost description: Estimated cost to complete the deal. cost: title: Cost description: Total cost on the deal including labor and expenses, in the deal's budget currency. budget_usage: type: number title: Budget Usage description: Budget usage percentage — ratio of budget used to total budget. full_query: type: string title: Full Query description: Full API query object used to generate this report row. future_revenue: title: Future Revenue description: Projected future revenue based on resourcing data. deal_lost_date: title: Deal Lost Date description: Date when the deal was marked as lost. currency_default: title: Currency Default description: Currency code in the organization's default currency. responsible_id: type: integer title: Responsible description: ID of the person responsible for managing this deal. deal_last_activity_at: title: Deal Last Activity At description: Timestamp of the most recent activity on the deal associated with this report row. expenses_billable: title: Expenses Billable description: Total billable expense amount on the deal. color_id: type: integer title: Color description: Color label ID assigned to the deal. estimated_time: type: integer title: Estimated Time description: Total estimated time required to complete the deal's scope. primary_contact_report: title: Primary Contact Report description: Report object for the primary contact person of the company linked to deals in this group. billable_time: type: integer title: Billable Time description: Total billable hours tracked on the deal. parent_company_id: type: integer title: Parent Company description: ID of the parent company of the client linked to deals in this group, used for hierarchical company filtering. needs_invoicing: type: boolean title: Needs Invoicing description: Indicates whether the deal has outstanding amounts pending invoicing. deal_previous_probability: title: Deal Previous Probability description: Previous probability of winning the deal before the last update. deal_type_id: type: integer title: Deal Type description: ID of the deal type (retainer or one-off). draft_invoiced: title: Draft Invoiced description: Total amount invoiced in draft status on the deal. creator_id: type: integer title: Creator description: ID of the person who created the deal. total_cost_default: title: Total Cost Default description: Sum of total costs in the organization's default currency across all deals in this report group. custom_fields: type: string title: Custom Fields description: Custom field values associated with the deal. average_retainer_interval_count: type: integer title: Average Retainer Interval Count description: The average number of interval units per retainer period across grouped deals. deal_retainer_interval: title: Deal Retainer Interval description: The retainer billing interval for deals in this group. deal_number: title: Deal Number description: Unique deal number identifier. currency_normalized: title: Currency Normalized description: Currency code in the normalized common currency. worked_time: type: integer title: Worked Time description: Total worked (tracked) hours for deals in this report group. total_expense: title: Total Expense description: Sum of expense costs across all deals in this report group. pipeline_id: type: integer title: Pipeline description: ID of the pipeline this deal belongs to. invoiced_rate: title: Invoiced Rate description: Invoiced amount divided by worked hours. forecasted_revenue: title: Forecasted Revenue description: Forecasted revenue amount. deal_probability: title: Deal Probability description: Current probability of winning the deal (0–100). contract_id: type: integer title: Contract description: ID of the contract this deal is linked to. deal: title: Deal description: The deal associated with this report row. total_estimated_cost_default: title: Total Estimated Cost Default description: Sum of estimated costs in the organization's default currency across all deals in this report group. todo_due_date: type: string title: Todo Due Date format: date description: Due date for todo items associated with this deal. end_date: type: string title: End Date format: date description: End date of the deal. total_budgeted_time: type: number title: Total Budgeted Time description: Sum of budgeted (estimated) hours across all deals in this report group. total_projected_revenue_default: title: Total Projected Revenue Default description: Sum of projected revenue amounts in the organization's default currency across all deals in this report group. total_projected_revenue_normalized: title: Total Projected Revenue Normalized description: Sum of projected revenue amounts in the normalized currency across all deals in this report group. deal_date: title: Deal Date description: Report grouping date for the deal. total_expense_normalized: title: Total Expense Normalized description: Sum of expense costs in the normalized currency across all deals in this report group. week: type: string title: Week description: Week grouping for this deal report row (e.g. week, month, quarter). total_work_cost_normalized: title: Total Work Cost Normalized description: Sum of labor (work) costs in the normalized currency across all deals in this report group. contact: title: Contact description: Contact person associated with the deal. status: enum: - 1 - 2 type: integer title: Status description: Current status of the deal (e.g. open, won, lost). retainer_interval: enum: - week - two_weeks - month - quarter - half_year - year type: string title: Retainer Interval description: The billing interval for retainer deals in this group. tags: type: string title: Tags description: List of tags applied to the deal. revenue_distribution_type: enum: - default - even - custom type: string title: Revenue Distribution Type description: Revenue recognition method used for this deal. stage_updated_at: type: string title: Stage Updated At format: date description: Timestamp when the pipeline stage was last updated. created_at_period: title: Created At Period description: Time period grouping for the deal creation date. tracking_type_id: type: integer title: Tracking Type description: ID of the tracking type for deals in this report group. creator_report: title: Creator Report description: Related report for the deal creator. deal_status_id: type: integer title: Deal Status description: ID of the current deal status (pipeline stage). stage_updated_at_period: title: Stage Updated At Period description: Time period grouping for the stage updated-at date (e.g. week, month, quarter). work_cost: title: Work Cost description: Labor (work) cost for deals in this report group. year: type: string title: Year description: Year grouping for this deal report row. total_budget_total_normalized: title: Total Budget Total Normalized description: Sum of total approved budget amounts in the normalized currency across all deals in this report group. designated_approver_id: type: integer title: Designated Approver description: ID of the person designated as the approver for deals in this group. report: title: Report description: Related deal report data for this group (self-referential for drill-down). previous_deal_status_id: type: integer title: Previous Deal Status description: ID of the previous deal status. name: type: string title: Name description: Name of the deal. subsidiary_id: type: integer title: Subsidiary description: ID of the subsidiary this deal is attributed to. revenue: title: Revenue description: Total revenue amount for this deal. expense: title: Expense description: Total expense cost on the deal. forecasted_budget_usage: type: number title: Forecasted Budget Usage description: Forecasted budget usage as a percentage. purchase_order_number: type: string title: Purchase Order Number description: The Purchase Order number provided by the client for this deal. example: PO-2024-017 credited: title: Credited description: Whether the deal revenue is credited to the responsible person. days_in_current_stage: type: integer title: Days In Current Stage description: Average number of days deals in this group have been in their current pipeline stage. stage_status_id: enum: - 1 - 2 - 3 - 4 type: integer title: Stage Status description: ID of the current pipeline stage status. fuzzy_dates: type: string title: Fuzzy Dates format: date description: Relative date range expressions (e.g. this_month, last_quarter) used in date filters. recurring_ends_on: type: string title: Recurring Ends On format: date description: Date when the deal recurrence ends. invoiced: title: Invoiced description: Amount of money invoiced to the client from this deal. formulas: type: integer title: Formulas description: Custom formula definitions applied to this report row. description: An aggregated deal report row. Deal reports group deals by configurable dimensions and calculate financial totals, pipeline metrics, and conversion rates. resource_exchange_rate: type: object title: Exchange rate Resource properties: date: type: string title: Date format: date description: The date for which these exchange rates are valid. rates: type: string title: Rates description: An array of currency conversion rates, each with a base currency, target currency, and the corresponding rate value. out_of_date: type: boolean title: Out Of Date description: Whether these exchange rates are flagged as out of date and may not reflect current market rates. description: A set of currency exchange rates for a specific date, used to convert amounts between currencies. filter_organization: type: object title: Filter organization properties: {} patternProperties: {} description: Filter parameters for listing organization resources, which represent the tenant account in Productive. _filter_root_price_report: oneOf: - "$ref": "#/components/schemas/filter_price_report" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_price_report" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `price_report` list endpoints — pass a single condition or a logical group. _filter_root_automatic_invoicing_rule: oneOf: - "$ref": "#/components/schemas/filter_automatic_invoicing_rule" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_automatic_invoicing_rule" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `automatic_invoicing_rule` list endpoints — pass a single condition or a logical group. _filter_root_membership: oneOf: - "$ref": "#/components/schemas/filter_membership" - type: object title: Advanced filters properties: "$op": enum: - or - and type: string description: Logical operator combining conditions in this group. `or` matches records satisfying any condition; `and` requires all conditions to match. patternProperties: "^[0-9]+$": "$ref": "#/components/schemas/_filter_root_membership" description: A logical filter group — combine multiple conditions with the `$op` operator. required: - "$op" description: Filter schema for `membership` list endpoints — pass a single condition or a logical group. parameters: filter_price: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_price" required: false description: Filters sort_tag: in: query name: sort style: form schema: type: array items: type: string title: Sort tag explode: false required: false description: Sort tag filter_page_version: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_page_version" required: false description: Filters filter_purchase_order: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_purchase_order" required: false description: JSON:API `filter` query parameter for the purchase orders collection. Accepts a nested object keyed by field name and operator (`eq`, `not_eq`, `contains`, `not_contain`, `gt`, `lt`, …). filter_entitlement: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_entitlement" required: false description: Filters group_invoice_report: in: query name: group style: form schema: enum: - company - created_at - creator - currency - custom_fields - delivery_on - einvoice_status - fiscalization_status - invoice - invoice_aging - invoice_state - invoice_status - invoice_type - invoiced_on - issuer - last_activity_at - month - organization - overdue_status - paid_on - pay_on - payment_status - quarter - sent_on - sent_status - subsidiary - week - year type: string title: Group invoice report explode: false required: false description: Group invoice report group_time_entry_report: in: query name: group style: form schema: enum: - approval_policy - approver - autotracked - billing_type - budget - company - created_at - creator - custom_fields - date - day - deal_subsidiary - designated_approver - ended_at - intercompany_hours - invoice - invoiced - invoicing_status - jira_issue_id - jira_issue_status - jira_issue_summary - last_activity_at - last_actor - month - organization - overhead - people_custom_fields - person - person_subsidiary - project - project_type_id - quarter - responsible - section_name - service - service_type - stage_type - started_at - status - task - task_list - time_entry - track_method_id - unit_id - week - year type: string title: Group time entry report explode: false required: false description: Group time entry report sort_price: in: query name: sort style: form schema: type: array items: enum: - billing_type_id - "-billing_type_id" - booking_tracking_enabled - "-booking_tracking_enabled" - custom_fields - "-custom_fields" - description - "-description" - discount - "-discount" - estimated_cost - "-estimated_cost" - expense_tracking_enabled - "-expense_tracking_enabled" - markup - "-markup" - name - "-name" - quantity - "-quantity" - rate - "-rate" - service_type - "-service_type" - time_tracking_enabled - "-time_tracking_enabled" - unit_id - "-unit_id" type: string title: Sort price explode: false required: false description: Sort price sort_payment_reminder_sequence: in: query name: sort style: form schema: type: array items: enum: - default_sequence - "-default_sequence" type: string title: Sort payment reminder sequence explode: false required: false description: Sort payment reminder sequence filter_service_type_assignment: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_service_type_assignment" required: false description: Filters filter_bank_account: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_bank_account" required: false description: Filter parameter for querying bank accounts. sort_integration_exporter_configuration: in: query name: sort style: form schema: type: array items: enum: - client_id - "-client_id" - company_type - "-company_type" type: string title: Sort integration exporter configuration explode: false required: false description: The sort integration exporter configuration. sort_integration: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - id - "-id" type: string title: Sort integration explode: false required: false description: Sort integration filter_user: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_user" required: false description: Filters sort_email: in: query name: sort style: form schema: type: array items: type: string title: Sort email explode: false required: false description: Sort email group_price_report: in: query name: group style: form schema: enum: - booking_tracking_enabled - company - currency - expense_tracking_enabled - organization - price - rate_card - rate_card_status - service_type - time_tracking_enabled type: string title: Group price report explode: false required: false description: Group price report sort_timesheet_report: in: query name: sort style: form schema: type: array items: enum: - count - "-count" - friday_capacity - "-friday_capacity" - friday_time - "-friday_time" - monday_capacity - "-monday_capacity" - monday_time - "-monday_time" - person - "-person" - saturday_capacity - "-saturday_capacity" - saturday_time - "-saturday_time" - sunday_capacity - "-sunday_capacity" - sunday_time - "-sunday_time" - thursday_capacity - "-thursday_capacity" - thursday_time - "-thursday_time" - tuesday_capacity - "-tuesday_capacity" - tuesday_time - "-tuesday_time" - wednesday_capacity - "-wednesday_capacity" - wednesday_time - "-wednesday_time" - week - "-week" - week_submission_status - "-week_submission_status" type: string title: Sort timesheet report explode: false required: false description: Sort timesheet report group_deal_funnel_report: in: query name: group style: form schema: enum: - deal_funnel - deal_status - organization - pipeline type: string title: Group deal funnel report explode: false required: false description: Group deal funnel report filter_company_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_company_report" required: false description: Filters sort_board: in: query name: sort style: form schema: type: array items: type: string title: Sort board explode: false required: false description: Sort board filter_survey_response: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_survey_response" required: false description: Filter parameter for querying survey responses. sort_time_entry_version: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" type: string title: Sort time entry version explode: false required: false description: Sort time entry version sort_widget: in: query name: sort style: form schema: type: array items: type: string title: Sort widget explode: false required: false description: Sort widget filter_budget_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_budget_report" required: false description: Filters sort_document_style: in: query name: sort style: form schema: type: array items: type: string title: Sort document style explode: false required: false description: Sort document style filter_proposal_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_proposal_report" required: false description: Filter proposal reports by specific criteria. Accepts a filter object with field-value pairs. filter_payment_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_payment_report" required: false description: Filters filter_section: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_section" required: false description: Filters filter_page_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_page_report" required: false description: Filters filter_service_assignment: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_service_assignment" required: false description: Filters filter_project_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_project_report" required: false description: Filters filter_service_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_service_report" required: false description: Filters filter_booking: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_booking" required: false description: Filters sort_workflow_status: in: query name: sort style: form schema: type: array items: enum: - name - "-name" - position - "-position" type: string title: Sort workflow status explode: false required: false description: Sort workflow status sort_task_list: in: query name: sort style: form schema: type: array items: enum: - board_name - "-board_name" - company_name - "-company_name" - folder_name - "-folder_name" - project_name - "-project_name" type: string title: Sort task list explode: false required: false description: Sort task list sort_project: in: query name: sort style: form schema: type: array items: enum: - company_name - "-company_name" - created_at - "-created_at" - custom_fields - "-custom_fields" - last_activity_at - "-last_activity_at" - name - "-name" - number - "-number" - project_number - "-project_number" type: string title: Sort project explode: false required: false description: Sort project filter_expense: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_expense" required: false description: Filters sort_membership: in: query name: sort style: form schema: type: array items: type: string title: Sort membership explode: false required: false description: Sort membership sort_service_type: in: query name: sort style: form schema: type: array items: type: string title: Sort service type explode: false required: false description: Sort service type sort_page: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - creator_name - "-creator_name" - edited_at - "-edited_at" - id - "-id" - last_activity_at - "-last_activity_at" - project - "-project" - project_name - "-project_name" - title - "-title" - updated_at - "-updated_at" type: string title: Sort page explode: false required: false description: Sort order for page list results. Accepts one or more field names, comma-separated; prefix with `-` for descending. --branch descriptions filter_pulse: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_pulse" required: false description: Filters sort_company: in: query name: sort style: form schema: type: array items: enum: - company_code - "-company_code" - created_at - "-created_at" - custom_fields - "-custom_fields" - last_activity_at - "-last_activity_at" - name - "-name" - parent_company - "-parent_company" type: string title: Sort company explode: false required: false description: Sort company group_new_time_report: in: query name: group style: form schema: enum: - billing_type - budget - company - date - day - event - future - manager - month - organization - people_custom_fields - person - project - quarter - service - service_type - stage_type - subsidiary - week - year type: string title: Group new time report explode: false required: false description: Group new time report filter_task: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_task" required: false description: Filters filter_service: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_service" required: false description: Filter parameter for querying services. sort_line_item_report: in: query name: sort style: form schema: type: array items: enum: - budget - "-budget" - company - "-company" - count - "-count" - creator - "-creator" - expense - "-expense" - invoice - "-invoice" - kpd_code - "-kpd_code" - service - "-service" - tax_rate - "-tax_rate" - total_amount - "-total_amount" - total_amount_tax - "-total_amount_tax" - total_amount_with_tax - "-total_amount_with_tax" - unit_id - "-unit_id" - unit_price - "-unit_price" - updater - "-updater" type: string title: Sort line item report explode: false required: false description: Sort line item report filter_einvoice_identity: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_einvoice_identity" required: false description: Filter parameter for narrowing e-invoice identity results. filter_deal_funnel_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_deal_funnel_report" required: false description: Filters sort_payment: in: query name: sort style: form schema: type: array items: enum: - amount - "-amount" - date - "-date" - invoice_number - "-invoice_number" - note - "-note" - paid_on - "-paid_on" - written_off_on - "-written_off_on" type: string title: Sort payment explode: false required: false description: Sort payment filter_time_entry: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_time_entry" required: false description: Filters filter_tax_rate: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_tax_rate" required: false description: Filters sort_page_report: in: query name: sort style: form schema: type: array items: enum: - count - "-count" - created_at - "-created_at" - creator - "-creator" - custom_fields - "-custom_fields" - edited_at - "-edited_at" - page - "-page" - page_id - "-page_id" - page_last_activity_at - "-page_last_activity_at" - project - "-project" - title - "-title" - updater - "-updater" type: string title: Sort page report explode: false required: false description: Sort page report sort_workflow: in: query name: sort style: form schema: type: array items: enum: - name - "-name" type: string title: Sort workflow explode: false required: false description: Sort workflow filter_line_item: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_line_item" required: false description: Filters sort_proposal_report: in: query name: sort style: form schema: type: array items: enum: - average_tax_rate_value - "-average_tax_rate_value" - company - "-company" - count - "-count" - created_at - "-created_at" - creator - "-creator" - date_signed - "-date_signed" - deal - "-deal" - link_status - "-link_status" - name - "-name" - responsible - "-responsible" - sent_at - "-sent_at" - signed - "-signed" - signed_by_email - "-signed_by_email" - status - "-status" - status_changed_at - "-status_changed_at" - subsidiary - "-subsidiary" - total_budget_total - "-total_budget_total" - total_tax_amount - "-total_tax_amount" - updated_at - "-updated_at" type: string title: Sort proposal report explode: false required: false description: Sort proposal report results by one or more fields. Prefix a field name with a minus sign for descending order. filter_survey_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_survey_report" required: false description: Filters group_entitlement_report: in: query name: group style: form schema: enum: - absence_type - end_date - entitlement - event - organization - people_custom_fields - person - start_date - subsidiary type: string title: Group entitlement report explode: false required: false description: Group entitlement report filter_deleted_item: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_deleted_item" required: false description: Filters group_booking_report: in: query name: group style: form schema: enum: - absence_type - approval_status - approved_at - autotracking - billing_type - booking - budget - canceled_at - company - created_at - custom_fields - date - draft - event - organization - people_custom_fields - person - project - project_type - rejected_at - responsible - service - service_type - stage_type - task type: string title: Group booking report explode: false required: false description: Group booking report filter_new_salary_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_new_salary_report" required: false description: Filters sort_custom_field: in: query name: sort style: form schema: type: array items: type: string title: Sort custom field explode: false required: false description: Sort custom field sort_task_dependency: in: query name: sort style: form schema: type: array items: type: string title: Sort task dependency explode: false required: false description: Sort task dependency filter_invoice: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_invoice" required: false description: Filters group_budget_report: in: query name: group style: form schema: enum: - budget - closed_at - company - contract - created_at - custom_fields - date - deal_type - delivered_on - designated_approver - end_date - last_activity_at - month - next_occurrence_on - organization - origin_deal - primary_contact - project - project_type - purchase_order_number - quarter - recurring - recurring_ends_on - recurring_interval - recurring_starts_on - responsible - revenue_distribution_type - status - subsidiary - tracking_type_id - week - year type: string title: Group budget report explode: false required: false description: Group budget report sort_organization: in: query name: sort style: form schema: type: array items: enum: - name - "-name" type: string title: Sort organization explode: false required: false description: Sort organization filter_attachment: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_attachment" required: false description: Filters filter_page: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_page" required: false description: Filter parameter for querying pages. sort_report_category: in: query name: sort style: form schema: type: array items: type: string title: Sort report category explode: false required: false description: Sort report category sort_resource_request: in: query name: sort style: form schema: type: array items: enum: - booking_method_id - "-booking_method_id" - created_at - "-created_at" - creator - "-creator" - ended_on - "-ended_on" - id - "-id" - percentage - "-percentage" - resolved_at - "-resolved_at" - resolver - "-resolver" - service - "-service" - started_on - "-started_on" - status - "-status" - time - "-time" - total_time - "-total_time" type: string title: Sort resource request explode: false required: false description: Sort order for resource request list results. Accepts field names, comma-separated; prefix with - for descending. filter_session: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_session" required: false description: Filters filter_team: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_team" required: false description: Filters sort_rate_card: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - name - "-name" type: string title: Sort rate card explode: false required: false description: Sort rate card header_organization: in: header name: X-Organization-Id schema: type: string required: true description: Organization ID sort_entitlement_report: in: query name: sort style: form schema: type: array items: enum: - absence_type - "-absence_type" - count - "-count" - end_date - "-end_date" - entitlement - "-entitlement" - entitlement_end_date - "-entitlement_end_date" - entitlement_start_date - "-entitlement_start_date" - event - "-event" - people_custom_fields - "-people_custom_fields" - person - "-person" - start_date - "-start_date" - subsidiary - "-subsidiary" - total_allocated - "-total_allocated" - total_allocated_minutes - "-total_allocated_minutes" - total_available - "-total_available" - total_available_minutes - "-total_available_minutes" - total_pending - "-total_pending" - total_pending_minutes - "-total_pending_minutes" - total_used - "-total_used" - total_used_minutes - "-total_used_minutes" type: string title: Sort entitlement report explode: false required: false description: Sort entitlement report group_page_report: in: query name: group style: form schema: enum: - creator - custom_fields - organization - page - project - updater type: string title: Group page report explode: false required: false description: Group page report sort_proposal: in: query name: sort style: form schema: type: array items: type: string title: Sort proposal explode: false required: false description: Sort order for proposal list results. Accepts one or more field names, comma-separated; prefix with `-` for descending. --branch descriptions filter_booking_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_booking_report" required: false description: Filters filter_time_tracking_policy: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_time_tracking_policy" required: false description: Filter parameter for querying time tracking policies. filter_filter: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_filter" required: false description: Filters sort_invoice: in: query name: sort style: form schema: type: array items: enum: - amount - "-amount" - amount_credited - "-amount_credited" - amount_credited_with_tax - "-amount_credited_with_tax" - amount_paid - "-amount_paid" - amount_tax - "-amount_tax" - amount_with_tax - "-amount_with_tax" - amount_written_off - "-amount_written_off" - company_name - "-company_name" - created_at - "-created_at" - credited - "-credited" - custom_fields - "-custom_fields" - deleted_at - "-deleted_at" - delivery_on - "-delivery_on" - discount - "-discount" - invoiced_on - "-invoiced_on" - last_activity_at - "-last_activity_at" - number - "-number" - pay_on - "-pay_on" - purchase_order_number - "-purchase_order_number" - sent_on - "-sent_on" - subject - "-subject" type: string title: Sort invoice explode: false required: false description: Sort invoice filter_time_entry_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_time_entry_report" required: false description: Filters filter_tag: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_tag" required: false description: Filters filter_membership: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_membership" required: false description: Filters group_payment_report: in: query name: group style: form schema: enum: - company - date - invoice - month - organization - payment - quarter - subsidiary - week - year type: string title: Group payment report explode: false required: false description: Group payment report filter_survey_field_option: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_survey_field_option" required: false description: Filter parameter for querying survey field options. sort_invoice_template: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - id - "-id" type: string title: Sort invoice template explode: false required: false description: Sort order for invoice template list results. Accepts one or more field names, comma-separated; prefix with `-` for descending. --branch descriptions sort_deleted_item: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - location - "-location" - name - "-name" type: string title: Sort deleted item explode: false required: false description: Sort deleted item sort_approval_policy: in: query name: sort style: form schema: type: array items: type: string title: Sort approval policy explode: false required: false description: Sort parameter for ordering approval policies. filter_person: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_person" required: false description: Filters filter_resource_request: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_resource_request" required: false description: Filter parameters for listing resource requests. sort_holiday: in: query name: sort style: form schema: type: array items: type: string title: Sort holiday explode: false required: false description: Sort holiday sort_custom_domain: in: query name: sort style: form schema: type: array items: type: string title: Sort custom domain explode: false required: false description: Sort custom domain group_project_report: in: query name: group style: form schema: enum: - company - created_at - custom_fields - last_activity_at - month - organization - project - project_manager - project_status - project_type - quarter - week - year type: string title: Group project report explode: false required: false description: Group project report sort_automatic_invoicing_rule: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - id - "-id" type: string title: Sort automatic invoicing rule explode: false required: false description: The sort automatic invoicing rule. filter_approval_policy: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_approval_policy" required: false description: Filter parameter for querying approval policies. filter_workflow: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_workflow" required: false description: Filters filter_task_dependency: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_task_dependency" required: false description: Filters sort_survey_report: in: query name: sort style: form schema: type: array items: enum: - count - "-count" - created_at - "-created_at" - creator - "-creator" - project - "-project" - survey - "-survey" - survey_id - "-survey_id" - title - "-title" - updater - "-updater" type: string title: Sort survey report explode: false required: false description: Sort survey report filter_organization: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_organization" required: false description: Filters sort_expense_report: in: query name: sort style: form schema: type: array items: enum: - approval_status - "-approval_status" - approved_at - "-approved_at" - approver - "-approver" - average_profit_margin - "-average_profit_margin" - company - "-company" - count - "-count" - created_at - "-created_at" - creator - "-creator" - custom_fields - "-custom_fields" - date - "-date" - deal - "-deal" - designated_approver - "-designated_approver" - expense - "-expense" - expense_created_at - "-expense_created_at" - expense_date - "-expense_date" - expense_name - "-expense_name" - expense_paid_on - "-expense_paid_on" - expense_pay_on - "-expense_pay_on" - expense_reimbursed_on - "-expense_reimbursed_on" - invoiced - "-invoiced" - invoicing_status - "-invoicing_status" - month - "-month" - name - "-name" - paid_on - "-paid_on" - pay_on - "-pay_on" - person - "-person" - project - "-project" - project_id - "-project_id" - purchase_order - "-purchase_order" - quantity - "-quantity" - quarter - "-quarter" - quote_type - "-quote_type" - reimbursed_on - "-reimbursed_on" - reimbursement - "-reimbursement" - responsible - "-responsible" - section_name - "-section_name" - service - "-service" - service_type - "-service_type" - stage_type - "-stage_type" - status - "-status" - tax_rate_id - "-tax_rate_id" - total_amount - "-total_amount" - total_amount_with_tax - "-total_amount_with_tax" - total_billable_amount - "-total_billable_amount" - total_profit - "-total_profit" - total_recognized_revenue - "-total_recognized_revenue" - total_tax_amount - "-total_tax_amount" - vendor - "-vendor" - week - "-week" - year - "-year" type: string title: Sort expense report explode: false required: false description: Sort expense report sort_invoice_attribution: in: query name: sort style: form schema: type: array items: type: string title: Sort invoice attribution explode: false required: false description: Sort invoice attribution sort_discussion: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - resolved_at - "-resolved_at" - updated_at - "-updated_at" type: string title: Sort discussion explode: false required: false description: Sort discussion sort_task: in: query name: sort style: form schema: type: array items: enum: - assignee_name - "-assignee_name" - billable_time - "-billable_time" - board_name - "-board_name" - board_position - "-board_position" - closed_at - "-closed_at" - company_name - "-company_name" - created_at - "-created_at" - creator_name - "-creator_name" - custom_fields - "-custom_fields" - due_date - "-due_date" - folder_name - "-folder_name" - folder_position - "-folder_position" - id - "-id" - initial_estimate - "-initial_estimate" - last_activity - "-last_activity" - last_activity_at - "-last_activity_at" - last_actor_name - "-last_actor_name" - number - "-number" - placement - "-placement" - project_name - "-project_name" - remaining_time - "-remaining_time" - start_date - "-start_date" - task_list_name - "-task_list_name" - task_list_position - "-task_list_position" - task_number - "-task_number" - title - "-title" - updated_at - "-updated_at" - worked_time - "-worked_time" - workflow_status_name - "-workflow_status_name" - workflow_status_position - "-workflow_status_position" type: string title: Sort task explode: false required: false description: Sort task sort_todo: in: query name: sort style: form schema: type: array items: type: string title: Sort todo explode: false required: false description: Sort todo sort_service_assignment: in: query name: sort style: form schema: type: array items: type: string title: Sort service assignment explode: false required: false description: Sort service assignment filter_invoice_attribution: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_invoice_attribution" required: false description: Filters filter_contact_entry: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_contact_entry" required: false description: Filters filter_webhook: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_webhook" required: false description: Filters filter_task_list: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_task_list" required: false description: Filters sort_webhook_log: in: query name: sort style: form schema: type: array items: type: string title: Sort webhook log explode: false required: false description: Sort webhook log filter_event: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_event" required: false description: Filters group_deal_report: in: query name: group style: form schema: enum: - company - contact - created_at - creator - custom_fields - date - deal - deal_status - designated_approver - last_activity_at - lost_reason - month - organization - pipeline - previous_deal_status - primary_contact - project - quarter - responsible - sales_closed_at - sales_closed_on - sales_status_id - stage_status_id - stage_updated_at - subsidiary - tracking_type_id - week - year type: string title: Group deal report explode: false required: false description: Group deal report sort_price_report: in: query name: sort style: form schema: type: array items: enum: - average_discount - "-average_discount" - average_discount_amount - "-average_discount_amount" - average_discounted_rate - "-average_discounted_rate" - average_estimated_cost - "-average_estimated_cost" - average_markup - "-average_markup" - average_markup_amount - "-average_markup_amount" - average_rate - "-average_rate" - booking_tracking_enabled - "-booking_tracking_enabled" - company - "-company" - count - "-count" - expense_tracking_enabled - "-expense_tracking_enabled" - price - "-price" - price_description - "-price_description" - price_name - "-price_name" - price_quantity - "-price_quantity" - rate_card - "-rate_card" - rate_card_status - "-rate_card_status" - service_type - "-service_type" - time_tracking_enabled - "-time_tracking_enabled" type: string title: Sort price report explode: false required: false description: Sort price report filter_entitlement_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_entitlement_report" required: false description: Filters filter_expense_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_expense_report" required: false description: Filters group_line_item_report: in: query name: group style: form schema: enum: - company - creator - expense - invoice - kpd_code - line_item - organization - service - service_type - unit - updater type: string title: Group line item report explode: false required: false description: Group line item report filter_project_assignment: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_project_assignment" required: false description: Filters sort_contract: in: query name: sort style: form schema: type: array items: type: string title: Sort contract explode: false required: false description: Sort contract filter_lost_reason: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_lost_reason" required: false description: Filters filter_timesheet_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_timesheet_report" required: false description: Filters sort_time_entry: in: query name: sort style: form schema: type: array items: enum: - date - "-date" - deal_name - "-deal_name" - person_name - "-person_name" - service_name - "-service_name" - updated_at - "-updated_at" type: string title: Sort time entry explode: false required: false description: Sort time entry filter_exchange_rate: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_exchange_rate" required: false description: Filters sort_folder: in: query name: sort style: form schema: type: array items: type: string title: Sort folder explode: false required: false description: Sort folders by one or more fields. Prefix a field name with a minus sign for descending order. filter_document_type: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_document_type" required: false description: Filters sort_deal: in: query name: sort style: form schema: type: array items: enum: - billable_time - "-billable_time" - budget_status - "-budget_status" - budget_total - "-budget_total" - budget_used - "-budget_used" - budget_warning - "-budget_warning" - budgeted_time - "-budgeted_time" - budgets_first - "-budgets_first" - client_access - "-client_access" - closed_at - "-closed_at" - company_name - "-company_name" - contact_name - "-contact_name" - cost - "-cost" - created_at - "-created_at" - creator_name - "-creator_name" - custom_fields - "-custom_fields" - date - "-date" - deal_number - "-deal_number" - deal_status - "-deal_status" - deals_first - "-deals_first" - designated_approver - "-designated_approver" - end_date - "-end_date" - estimated_time - "-estimated_time" - expense - "-expense" - expense_approval - "-expense_approval" - invoiced - "-invoiced" - last_activity_at - "-last_activity_at" - name - "-name" - number - "-number" - pending_invoicing - "-pending_invoicing" - probability - "-probability" - profit - "-profit" - profit_margin - "-profit_margin" - project_name - "-project_name" - projected_revenue - "-projected_revenue" - purchase_order_number - "-purchase_order_number" - responsible - "-responsible" - responsible_name - "-responsible_name" - revenue - "-revenue" - sales_status_id - "-sales_status_id" - services_revenue - "-services_revenue" - stage_status - "-stage_status" - suffix - "-suffix" - time_approval - "-time_approval" - time_to_close - "-time_to_close" - todo_due_date - "-todo_due_date" - worked_time - "-worked_time" type: string title: Sort deal explode: false required: false description: Sort deal sort_dashboard: in: query name: sort style: form schema: type: array items: type: string title: Sort dashboard explode: false required: false description: Sort dashboard filter_widget: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_widget" required: false description: Filters sort_tax_rate: in: query name: sort style: form schema: type: array items: enum: - name - "-name" - subsidiary_name - "-subsidiary_name" type: string title: Sort tax rate explode: false required: false description: Sort tax rate sort_organization_membership: in: query name: sort style: form schema: type: array items: type: string title: Sort organization membership explode: false required: false description: Sort organization membership group_survey_report: in: query name: group style: form schema: enum: - creator - organization - project - survey - updater type: string title: Group survey report explode: false required: false description: Group survey report sort_user: in: query name: sort style: form schema: type: array items: type: string title: Sort user explode: false required: false description: Sort user sort_project_report: in: query name: sort style: form schema: type: array items: enum: - average_profit_margin - "-average_profit_margin" - company - "-company" - count - "-count" - created_at - "-created_at" - custom_fields - "-custom_fields" - last_activity_at - "-last_activity_at" - month - "-month" - project - "-project" - project_created_at - "-project_created_at" - project_custom_fields - "-project_custom_fields" - project_last_activity_at - "-project_last_activity_at" - project_manager - "-project_manager" - project_name - "-project_name" - project_number - "-project_number" - project_status - "-project_status" - project_type - "-project_type" - quarter - "-quarter" - total_cost - "-total_cost" - total_estimated_time - "-total_estimated_time" - total_needs_invoicing - "-total_needs_invoicing" - total_pending_invoicing - "-total_pending_invoicing" - total_profit - "-total_profit" - total_projected_revenue - "-total_projected_revenue" - total_revenue - "-total_revenue" - total_worked_time - "-total_worked_time" - week - "-week" - year - "-year" type: string title: Sort project report explode: false required: false description: Sort project report filter_einvoice_configuration: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_einvoice_configuration" required: false description: Filter parameter for narrowing e-invoice configuration results. group_new_salary_report: in: query name: group style: form schema: enum: - date - organization - overhead - people_custom_fields - person - salary - salary_type_id type: string title: Group new salary report explode: false required: false description: Group new salary report sort_overhead: in: query name: sort style: form schema: type: array items: enum: - ended_on - "-ended_on" - started_on - "-started_on" type: string title: Sort overhead explode: false required: false description: Sort overhead sort_timesheet: in: query name: sort style: form schema: type: array items: enum: - date - "-date" - id - "-id" - person_id - "-person_id" type: string title: Sort timesheet explode: false required: false description: Sort order for timesheet list results. Accepts one or more field names, comma-separated; prefix with `-` for descending. --branch descriptions sort_page_version: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - name - "-name" - updated_at - "-updated_at" type: string title: Sort page version explode: false required: false description: Sort page version filter_holiday: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_holiday" required: false description: Filters filter_custom_domain: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_custom_domain" required: false description: Filters sort_person: in: query name: sort style: form schema: type: array items: enum: - autotracking - "-autotracking" - company_name - "-company_name" - custom_fields - "-custom_fields" - custom_role - "-custom_role" - email - "-email" - joined_at - "-joined_at" - last_seen_at - "-last_seen_at" - manager - "-manager" - name - "-name" - role_id - "-role_id" - schedulable - "-schedulable" - subsidiary - "-subsidiary" - title - "-title" - two_factor_auth - "-two_factor_auth" type: string title: Sort person explode: false required: false description: Sort person sort_salary: in: query name: sort style: form schema: type: array items: type: string title: Sort salary explode: false required: false description: Sort salary filter_project: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_project" required: false description: Filters filter_survey: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_survey" required: false description: Filter parameter for querying surveys. sort_service_type_assignment: in: query name: sort style: form schema: type: array items: type: string title: Sort service type assignment explode: false required: false description: Sort service type assignment sort_deal_funnel_report: in: query name: sort style: form schema: type: array items: type: string title: Sort deal funnel report explode: false required: false description: Sort deal funnel report sort_expense: in: query name: sort style: form schema: type: array items: enum: - amount - "-amount" - amount_with_tax - "-amount_with_tax" - billable_amount - "-billable_amount" - created_at - "-created_at" - custom_fields - "-custom_fields" - date - "-date" - deal_company_name - "-deal_company_name" - deal_name - "-deal_name" - deal_project_name - "-deal_project_name" - draft - "-draft" - id - "-id" - name - "-name" - paid_on - "-paid_on" - pay_on - "-pay_on" - profit - "-profit" - recognized_revenue - "-recognized_revenue" - service_name - "-service_name" - service_type_name - "-service_type_name" - tax_rate_id - "-tax_rate_id" type: string title: Sort expense explode: false required: false description: Sort expense group_service_report: in: query name: group style: form schema: enum: - billable - billing_type - booking_tracking_enabled - budget - budget_cap_enabled - budget_custom_fields - budget_status - company - custom_fields - date - deal_custom_fields - deal_status - expense_tracking_enabled - limitation_type - organization - origin_deal - pipeline - project - project_type - recurring - responsible - sales_status - section - section_name - service - service_type - stage_status - stage_type - subsidiary - time_tracking_enabled - unit type: string title: Group service report explode: false required: false description: Group service report filter_webhook_log: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_webhook_log" required: false description: Filters filter_subsidiary: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_subsidiary" required: false description: Filters sort_deal_cost_rate: in: query name: sort style: form schema: type: array items: enum: - rate_cents - "-rate_cents" type: string title: Sort deal cost rate explode: false required: false description: Sort deal cost rate filter_folder: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_folder" required: false description: Filter folders by specific criteria. Accepts a filter object with field-value pairs. sort_survey: in: query name: sort style: form schema: type: array items: enum: - id - "-id" - title - "-title" type: string title: Sort survey explode: false required: false description: Sort order for survey list results. Accepts one or more field names, comma-separated; prefix with `-` for descending. --branch descriptions group_task_report: in: query name: group style: form schema: enum: - assignee - board - closed_at - company - created_at - creator - custom_fields - due_date - folder - last_activity_at - last_actor - month - organization - parent_task - project - quarter - repeating - service - start_date - status - task - task_list - week - workflow - workflow_status - workflow_status_category_id - year type: string title: Group task report explode: false required: false description: Group task report filter_custom_field_option: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_custom_field_option" required: false description: Filters sort_pipeline: in: query name: sort style: form schema: type: array items: type: string title: Sort pipeline explode: false required: false description: Sort pipeline sort_person_report: in: query name: sort style: form schema: type: array items: enum: - approval_policy - "-approval_policy" - autotracking - "-autotracking" - company - "-company" - contact_address - "-contact_address" - contact_city - "-contact_city" - contact_country - "-contact_country" - contact_email - "-contact_email" - contact_phone - "-contact_phone" - contact_state - "-contact_state" - contact_website - "-contact_website" - contact_zipcode - "-contact_zipcode" - count - "-count" - created_at - "-created_at" - custom_fields - "-custom_fields" - custom_role - "-custom_role" - deactivated_at - "-deactivated_at" - joined_at - "-joined_at" - last_activity_at - "-last_activity_at" - manager - "-manager" - month - "-month" - offboarding_status - "-offboarding_status" - person - "-person" - person_active_teams - "-person_active_teams" - person_created_at - "-person_created_at" - person_custom_fields - "-person_custom_fields" - person_deactivated_at - "-person_deactivated_at" - person_email - "-person_email" - person_first_name - "-person_first_name" - person_joined_at - "-person_joined_at" - person_last_activity_at - "-person_last_activity_at" - person_last_name - "-person_last_name" - person_last_seen_at - "-person_last_seen_at" - person_name - "-person_name" - person_role_id - "-person_role_id" - person_status - "-person_status" - person_title - "-person_title" - person_type - "-person_type" - quarter - "-quarter" - role_id - "-role_id" - status - "-status" - subsidiary - "-subsidiary" - type - "-type" - week - "-week" - year - "-year" type: string title: Sort person report explode: false required: false description: Sort person report sort_placeholder_usage: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - field - "-field" - id - "-id" - interval_direction - "-interval_direction" - interval_enabled - "-interval_enabled" - interval_unit - "-interval_unit" - interval_value - "-interval_value" - placeholder_id - "-placeholder_id" - skip_weekends - "-skip_weekends" - target_id - "-target_id" - target_type - "-target_type" - updated_at - "-updated_at" type: string title: Sort placeholder usage explode: false required: false description: Sort order for placeholder usage list results. Accepts one or more field names, comma-separated; prefix with `-` for descending. --branch descriptions sort_webhook: in: query name: sort style: form schema: type: array items: type: string title: Sort webhook explode: false required: false description: Sort webhook sort_pulse: in: query name: sort style: form schema: type: array items: type: string title: Sort pulse explode: false required: false description: Sort pulse filter_placeholder: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_placeholder" required: false description: Filter parameter for querying placeholders. sort_filter: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - creator - "-creator" - description - "-description" - filterable_collection - "-filterable_collection" - last_accessed_at - "-last_accessed_at" - last_pulse_sent_at - "-last_pulse_sent_at" - last_viewed_at - "-last_viewed_at" - name - "-name" - report_category_id - "-report_category_id" - updated_at - "-updated_at" type: string title: Sort filter explode: false required: false description: Sort filter sort_budget_report: in: query name: sort style: form schema: type: array items: enum: - average_actual_rate - "-average_actual_rate" - average_budget_usage - "-average_budget_usage" - average_forecasted_budget_overrun - "-average_forecasted_budget_overrun" - average_forecasted_budget_usage - "-average_forecasted_budget_usage" - average_forecasted_time_usage - "-average_forecasted_time_usage" - average_invoiced_percentage - "-average_invoiced_percentage" - average_invoiced_rate - "-average_invoiced_rate" - average_profit_margin - "-average_profit_margin" - budget - "-budget" - budget_client_access - "-budget_client_access" - budget_closed_at - "-budget_closed_at" - budget_created_at - "-budget_created_at" - budget_custom_fields - "-budget_custom_fields" - budget_date - "-budget_date" - budget_delivered_on - "-budget_delivered_on" - budget_end_date - "-budget_end_date" - budget_last_activity_at - "-budget_last_activity_at" - budget_number - "-budget_number" - budget_purchase_order_number - "-budget_purchase_order_number" - budget_status - "-budget_status" - budget_suffix - "-budget_suffix" - budget_time_approval - "-budget_time_approval" - budget_warning_percentage - "-budget_warning_percentage" - closed_at - "-closed_at" - company - "-company" - contract - "-contract" - count - "-count" - created_at - "-created_at" - custom_fields - "-custom_fields" - date - "-date" - deal_type - "-deal_type" - delivered_on - "-delivered_on" - designated_approver - "-designated_approver" - end_date - "-end_date" - last_activity_at - "-last_activity_at" - month - "-month" - next_occurrence_on - "-next_occurrence_on" - origin_deal - "-origin_deal" - project - "-project" - project_type - "-project_type" - quarter - "-quarter" - recurring - "-recurring" - recurring_ends_on - "-recurring_ends_on" - recurring_interval - "-recurring_interval" - recurring_starts_on - "-recurring_starts_on" - responsible - "-responsible" - status - "-status" - subsidiary - "-subsidiary" - total_billable_time - "-total_billable_time" - total_budget_remaining - "-total_budget_remaining" - total_budget_total - "-total_budget_total" - total_budget_used - "-total_budget_used" - total_budgeted_time - "-total_budgeted_time" - total_cost - "-total_cost" - total_credited - "-total_credited" - total_draft_invoiced - "-total_draft_invoiced" - total_estimated_cost - "-total_estimated_cost" - total_estimated_remaining_time - "-total_estimated_remaining_time" - total_estimated_time - "-total_estimated_time" - total_expense - "-total_expense" - total_expense_billable - "-total_expense_billable" - total_forecasted_billable_time - "-total_forecasted_billable_time" - total_forecasted_budget_overrun - "-total_forecasted_budget_overrun" - total_forecasted_budget_used - "-total_forecasted_budget_used" - total_forecasted_cost - "-total_forecasted_cost" - total_future_booked_time - "-total_future_booked_time" - total_future_budget_used - "-total_future_budget_used" - total_future_cost - "-total_future_cost" - total_invoiced - "-total_invoiced" - total_manually_invoiced - "-total_manually_invoiced" - total_pending_invoicing - "-total_pending_invoicing" - total_profit - "-total_profit" - total_revenue - "-total_revenue" - total_services_revenue - "-total_services_revenue" - total_unapproved_time - "-total_unapproved_time" - total_work_cost - "-total_work_cost" - total_worked_time - "-total_worked_time" - tracking_type_id - "-tracking_type_id" - week - "-week" - year - "-year" type: string title: Sort budget report explode: false required: false description: Sort budget report filter_payment: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_payment" required: false description: Filters group_financial_item_report: in: query name: group style: form schema: enum: - approval_status - billing_type - budget - company - custom_fields - date - deal_status - financial_item - financial_item_type - future - organization - origin_deal - person - project - project_type - responsible - section - service - service_type - stage_status - stage_type - subsidiary type: string title: Group financial item report explode: false required: false description: Group financial item report sort_approval_policy_assignment: in: query name: sort style: form schema: type: array items: type: string title: Sort approval policy assignment explode: false required: false description: Sort parameter for ordering approval policy assignments. sort_entitlement: in: query name: sort style: form schema: type: array items: enum: - end_date - "-end_date" - event - "-event" - person - "-person" - start_date - "-start_date" type: string title: Sort entitlement explode: false required: false description: Sort entitlement sort_team: in: query name: sort style: form schema: type: array items: enum: - name - "-name" type: string title: Sort team explode: false required: false description: Sort team sort_task_report: in: query name: sort style: form schema: type: array items: enum: - assignee - "-assignee" - board - "-board" - closed_at - "-closed_at" - company - "-company" - count - "-count" - created_at - "-created_at" - creator - "-creator" - custom_fields - "-custom_fields" - due_date - "-due_date" - folder - "-folder" - last_activity_at - "-last_activity_at" - last_actor - "-last_actor" - month - "-month" - parent_task - "-parent_task" - placement - "-placement" - project - "-project" - quarter - "-quarter" - service - "-service" - start_date - "-start_date" - status - "-status" - task - "-task" - task_closed_at - "-task_closed_at" - task_created_at - "-task_created_at" - task_custom_fields - "-task_custom_fields" - task_due_date - "-task_due_date" - task_last_activity_at - "-task_last_activity_at" - task_list - "-task_list" - task_number - "-task_number" - task_start_date - "-task_start_date" - title - "-title" - total_billable_time - "-total_billable_time" - total_estimate_at_completion - "-total_estimate_at_completion" - total_estimation_offset_time - "-total_estimation_offset_time" - total_initial_estimate - "-total_initial_estimate" - total_remaining_time - "-total_remaining_time" - total_worked_time - "-total_worked_time" - week - "-week" - workflow - "-workflow" - workflow_status - "-workflow_status" - workflow_status_category_id - "-workflow_status_category_id" - year - "-year" type: string title: Sort task report explode: false required: false description: Sort task report filter_survey_field: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_survey_field" required: false description: Filter parameter for querying survey fields. filter_company: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_company" required: false description: Filters filter_role: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_role" required: false description: Filters group_timesheet_report: in: query name: group style: form schema: enum: - organization - person - week type: string title: Group timesheet report explode: false required: false description: Group timesheet report filter_custom_field_section: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_custom_field_section" required: false description: Filters sort_placeholder: in: query name: sort style: form schema: type: array items: enum: - category - "-category" - id - "-id" - name - "-name" - type - "-type" type: string title: Sort placeholder explode: false required: false description: Sort order for placeholder list results. Accepts one or more field names, comma-separated; prefix with `-` for descending. --branch descriptions filter_person_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_person_report" required: false description: Filters filter_holiday_calendar: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_holiday_calendar" required: false description: Filters sort_timer: in: query name: sort style: form schema: type: array items: enum: - started_at - "-started_at" - stopped_at - "-stopped_at" type: string title: Sort timer explode: false required: false description: Sort timer sort_subsidiary: in: query name: sort style: form schema: type: array items: enum: - name - "-name" type: string title: Sort subsidiary explode: false required: false description: Sort subsidiary sort_time_tracking_policy: in: query name: sort style: form schema: type: array items: enum: - name - "-name" type: string title: Sort time tracking policy explode: false required: false description: The sort time tracking policy. filter_new_time_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_new_time_report" required: false description: Filters sort_comment: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" type: string title: Sort comment explode: false required: false description: Sort comment sort_team_membership: in: query name: sort style: form schema: type: array items: enum: - person_name - "-person_name" type: string title: Sort team membership explode: false required: false description: Sort team membership sort_invoice_report: in: query name: sort style: form schema: type: array items: enum: - automatically_created - "-automatically_created" - average_due_in - "-average_due_in" - average_paid_in - "-average_paid_in" - budget - "-budget" - company - "-company" - company_billing_name - "-company_billing_name" - count - "-count" - created_at - "-created_at" - creator - "-creator" - currency - "-currency" - custom_fields - "-custom_fields" - delivery_on - "-delivery_on" - einvoice_status - "-einvoice_status" - fiscalization_status - "-fiscalization_status" - invoice - "-invoice" - invoice_aging - "-invoice_aging" - invoice_created_at - "-invoice_created_at" - invoice_custom_fields - "-invoice_custom_fields" - invoice_delivery_on - "-invoice_delivery_on" - invoice_discount - "-invoice_discount" - invoice_invoiced_on - "-invoice_invoiced_on" - invoice_last_activity_at - "-invoice_last_activity_at" - invoice_number - "-invoice_number" - invoice_paid_on - "-invoice_paid_on" - invoice_pay_on - "-invoice_pay_on" - invoice_purchase_order_number - "-invoice_purchase_order_number" - invoice_sent_on - "-invoice_sent_on" - invoice_state - "-invoice_state" - invoice_status - "-invoice_status" - invoice_subject - "-invoice_subject" - invoice_type - "-invoice_type" - invoiced_on - "-invoiced_on" - issuer - "-issuer" - last_activity_at - "-last_activity_at" - month - "-month" - overdue_status - "-overdue_status" - paid_on - "-paid_on" - pay_on - "-pay_on" - payment_status - "-payment_status" - project - "-project" - quarter - "-quarter" - sent_on - "-sent_on" - sent_status - "-sent_status" - subsidiary - "-subsidiary" - tax_rates - "-tax_rates" - total_amount - "-total_amount" - total_amount_credited - "-total_amount_credited" - total_amount_credited_with_tax - "-total_amount_credited_with_tax" - total_amount_paid - "-total_amount_paid" - total_amount_tax - "-total_amount_tax" - total_amount_unpaid - "-total_amount_unpaid" - total_amount_with_tax - "-total_amount_with_tax" - total_amount_written_off - "-total_amount_written_off" - week - "-week" - year - "-year" type: string title: Sort invoice report explode: false required: false description: Sort invoice report sort_holiday_calendar: in: query name: sort style: form schema: type: array items: type: string title: Sort holiday calendar explode: false required: false description: Sort holiday calendar filter_comment: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_comment" required: false description: Filters filter_revenue_distribution: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_revenue_distribution" required: false description: Filter parameter for querying revenue distributions. filter_kpd_code: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_kpd_code" required: false description: Filter parameter for narrowing KPD code results. filter_deal: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_deal" required: false description: Filters filter_deal_status: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_deal_status" required: false description: Filters sort_deal_report: in: query name: sort style: form schema: type: array items: enum: - average_actual_rate - "-average_actual_rate" - average_rate - "-average_rate" - average_retainer_interval_count - "-average_retainer_interval_count" - budget_status - "-budget_status" - company - "-company" - contact - "-contact" - count - "-count" - created_at - "-created_at" - creator - "-creator" - custom_fields - "-custom_fields" - date - "-date" - deal - "-deal" - deal_average_days_in_current_stage - "-deal_average_days_in_current_stage" - deal_average_days_since_created - "-deal_average_days_since_created" - deal_average_days_since_last_activity - "-deal_average_days_since_last_activity" - deal_budget_warning - "-deal_budget_warning" - deal_client_access - "-deal_client_access" - deal_closed_at - "-deal_closed_at" - deal_created_at - "-deal_created_at" - deal_custom_fields - "-deal_custom_fields" - deal_date - "-deal_date" - deal_end_date - "-deal_end_date" - deal_last_activity_at - "-deal_last_activity_at" - deal_lost_date - "-deal_lost_date" - deal_number - "-deal_number" - deal_previous_probability - "-deal_previous_probability" - deal_probability - "-deal_probability" - deal_purchase_order_number - "-deal_purchase_order_number" - deal_retainer - "-deal_retainer" - deal_retainer_interval - "-deal_retainer_interval" - deal_sales_closed_at - "-deal_sales_closed_at" - deal_sales_closed_on - "-deal_sales_closed_on" - deal_sales_status_updated_at - "-deal_sales_status_updated_at" - deal_status - "-deal_status" - deal_suffix - "-deal_suffix" - deal_time_approval - "-deal_time_approval" - deal_todo_due_date - "-deal_todo_due_date" - deal_won_date - "-deal_won_date" - designated_approver - "-designated_approver" - last_activity_at - "-last_activity_at" - lost_reason - "-lost_reason" - month - "-month" - pipeline - "-pipeline" - previous_deal_status - "-previous_deal_status" - project - "-project" - quarter - "-quarter" - responsible - "-responsible" - sales_closed_at - "-sales_closed_at" - sales_closed_on - "-sales_closed_on" - sales_status_id - "-sales_status_id" - stage_status_id - "-stage_status_id" - stage_updated_at - "-stage_updated_at" - subsidiary - "-subsidiary" - total_billable_time - "-total_billable_time" - total_budget_from_services - "-total_budget_from_services" - total_budget_total - "-total_budget_total" - total_budget_used - "-total_budget_used" - total_budgeted_time - "-total_budgeted_time" - total_cost - "-total_cost" - total_estimated_cost - "-total_estimated_cost" - total_estimated_remaining_time - "-total_estimated_remaining_time" - total_estimated_time - "-total_estimated_time" - total_expense - "-total_expense" - total_profit - "-total_profit" - total_projected_revenue - "-total_projected_revenue" - total_revenue - "-total_revenue" - total_services_revenue - "-total_services_revenue" - total_work_cost - "-total_work_cost" - total_worked_time - "-total_worked_time" - tracking_type_id - "-tracking_type_id" - week - "-week" - year - "-year" type: string title: Sort deal report explode: false required: false description: Sort deal report filter_payment_reminder_sequence: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_payment_reminder_sequence" required: false description: Filters filter_organization_membership: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_organization_membership" required: false description: Filters filter_einvoice_transaction: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_einvoice_transaction" required: false description: Filter parameter for narrowing e-invoice transaction results. sort_document_type: in: query name: sort style: form schema: type: array items: type: string title: Sort document type explode: false required: false description: Sort document type filter_rate_card: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_rate_card" required: false description: Filters sort_session: in: query name: sort style: form schema: type: array items: enum: - id - "-id" - last_activity_at - "-last_activity_at" type: string title: Sort session explode: false required: false description: Sort session sort_booking: in: query name: sort style: form schema: type: array items: enum: - draft - "-draft" - last_activity_at - "-last_activity_at" - started_on - "-started_on" type: string title: Sort booking explode: false required: false description: Sort booking group_proposal_report: in: query name: group style: form schema: enum: - company - created_at - creator - currency - date_signed - deal - link_status - organization - proposal - responsible - sent_at - signed - status - status_changed_at - subsidiary - updated_at type: string title: Group proposal report explode: false required: false description: Group proposal report results by one or more fields. filter_contract: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_contract" required: false description: Filters sort_line_item: in: query name: sort style: form schema: type: array items: type: string title: Sort line item explode: false required: false description: Sort line item filter_service_type: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_service_type" required: false description: Filters sort_custom_field_option: in: query name: sort style: form schema: type: array items: type: string title: Sort custom field option explode: false required: false description: Sort custom field option filter_integration: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_integration" required: false description: Filters filter_financial_item_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_financial_item_report" required: false description: Filters filter_placeholder_usage: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_placeholder_usage" required: false description: Filter parameter for querying placeholder usages. filter_team_membership: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_team_membership" required: false description: Filters filter_board: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_board" required: false description: Filters filter_email: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_email" required: false description: Filters filter_line_item_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_line_item_report" required: false description: Filters filter_dashboard: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_dashboard" required: false description: Filters filter_notification: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_notification" required: false description: Filters filter_workflow_status: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_workflow_status" required: false description: Filters filter_timesheet: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_timesheet" required: false description: Filter parameter for querying timesheets. filter_proposal: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_proposal" required: false description: Filter parameter for querying proposals. sort_survey_response: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - creator - "-creator" - creator_id - "-creator_id" - custom_fields - "-custom_fields" - id - "-id" - survey_id - "-survey_id" - updated_at - "-updated_at" type: string title: Sort survey response explode: false required: false description: Sort order for survey response list results. Accepts one or more field names, comma-separated; prefix with `-` for descending. --branch descriptions filter_payroll_item_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_payroll_item_report" required: false description: Filters filter_salary: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_salary" required: false description: Filters sort_payment_report: in: query name: sort style: form schema: type: array items: enum: - company - "-company" - count - "-count" - date - "-date" - deal - "-deal" - invoice - "-invoice" - month - "-month" - payment - "-payment" - payment_date - "-payment_date" - payment_external_id - "-payment_external_id" - payment_note - "-payment_note" - payment_paid_on - "-payment_paid_on" - payment_written_off_on - "-payment_written_off_on" - project - "-project" - quarter - "-quarter" - subsidiary - "-subsidiary" - total_amount - "-total_amount" - week - "-week" - year - "-year" type: string title: Sort payment report explode: false required: false description: Sort payment report group_person_report: in: query name: group style: form schema: enum: - approval_policy - autotracking - company - contact_address - contact_city - contact_country - contact_email - contact_phone - contact_state - contact_website - contact_zipcode - created_at - custom_fields - custom_role - deactivated_at - joined_at - last_activity_at - manager - month - offboarding_status - organization - person - quarter - role_id - status - subsidiary - type - week - year type: string title: Group person report explode: false required: false description: Group person report sort_service: in: query name: sort style: form schema: type: array items: enum: - budget - "-budget" - company - "-company" - custom_fields - "-custom_fields" - name - "-name" - project_name - "-project_name" type: string title: Sort service explode: false required: false description: Sort order for service list results. Accepts one or more field names, comma-separated; prefix with `-` for descending. --branch descriptions sort_exchange_rate: in: query name: sort style: form schema: type: array items: enum: - date - "-date" type: string title: Sort exchange rate explode: false required: false description: Sort exchange rate sort_financial_item_report: in: query name: sort style: form schema: type: array items: enum: - approval_status - "-approval_status" - average_blended_rate - "-average_blended_rate" - average_margin - "-average_margin" - average_recognized_margin - "-average_recognized_margin" - billing_type - "-billing_type" - budget - "-budget" - company - "-company" - company_billing_name - "-company_billing_name" - count - "-count" - custom_fields - "-custom_fields" - date - "-date" - deal_status - "-deal_status" - financial_item_date - "-financial_item_date" - financial_item_description - "-financial_item_description" - financial_item_type - "-financial_item_type" - future - "-future" - origin_deal - "-origin_deal" - person - "-person" - project - "-project" - project_type_id - "-project_type_id" - responsible - "-responsible" - section - "-section" - service - "-service" - service_type - "-service_type" - stage_status - "-stage_status" - stage_type - "-stage_type" - subsidiary - "-subsidiary" - total_billable_time - "-total_billable_time" - total_budget_total - "-total_budget_total" - total_budget_used - "-total_budget_used" - total_budgeted_time - "-total_budgeted_time" - total_cost - "-total_cost" - total_credited - "-total_credited" - total_draft_invoiced - "-total_draft_invoiced" - total_estimated_cost - "-total_estimated_cost" - total_estimated_time - "-total_estimated_time" - total_expense_cost - "-total_expense_cost" - total_invoiced - "-total_invoiced" - total_overhead_cost - "-total_overhead_cost" - total_projected_revenue - "-total_projected_revenue" - total_recognized_profit - "-total_recognized_profit" - total_recognized_revenue - "-total_recognized_revenue" - total_recognized_time - "-total_recognized_time" - total_scheduled_cost - "-total_scheduled_cost" - total_scheduled_revenue - "-total_scheduled_revenue" - total_scheduled_time - "-total_scheduled_time" - total_time - "-total_time" - total_time_entry_cost - "-total_time_entry_cost" - total_worked_time - "-total_worked_time" type: string title: Sort financial item report explode: false required: false description: Sort financial item report filter_todo: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_todo" required: false description: Filters filter_timer: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_timer" required: false description: Filters filter_custom_field: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_custom_field" required: false description: Filters sort_contact_entry: in: query name: sort style: form schema: type: array items: type: string title: Sort contact entry explode: false required: false description: Sort contact entry sort_event: in: query name: sort style: form schema: type: array items: type: string title: Sort event explode: false required: false description: Sort event sort_survey_field_option: in: query name: sort style: form schema: type: array items: type: string title: Sort survey field option explode: false required: false description: The sort survey field option. sort_attachment: in: query name: sort style: form schema: type: array items: enum: - id - "-id" type: string title: Sort attachment explode: false required: false description: Sort attachment filter_invoice_template: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_invoice_template" required: false description: Filter parameter for querying invoice templates. filter_document_style: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_document_style" required: false description: Filters sort_payroll_item_report: in: query name: sort style: form schema: type: array items: enum: - company_id - "-company_id" - count - "-count" - custom_fields - "-custom_fields" - date - "-date" - end_date - "-end_date" - payroll_item_id - "-payroll_item_id" - payroll_item_type - "-payroll_item_type" - person - "-person" - person_status - "-person_status" - person_type - "-person_type" - role_id - "-role_id" - salary_id - "-salary_id" - salary_type_id - "-salary_type_id" - start_date - "-start_date" - subsidiary_id - "-subsidiary_id" - total_availability - "-total_availability" - total_capacity - "-total_capacity" - total_cost - "-total_cost" - total_scheduled_time - "-total_scheduled_time" - total_time - "-total_time" - total_time_off_cost - "-total_time_off_cost" - total_time_off_time - "-total_time_off_time" type: string title: Sort payroll item report explode: false required: false description: Sort payroll item report filter_activity: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_activity" required: false description: Filters sort_time_entry_report: in: query name: sort style: form schema: type: array items: enum: - approval_policy - "-approval_policy" - approver - "-approver" - autotracked - "-autotracked" - average_blended_rate - "-average_blended_rate" - average_recognized_margin - "-average_recognized_margin" - billing_type - "-billing_type" - budget - "-budget" - company - "-company" - count - "-count" - created_at - "-created_at" - creator - "-creator" - custom_fields - "-custom_fields" - date - "-date" - day - "-day" - deal_subsidiary - "-deal_subsidiary" - designated_approver - "-designated_approver" - ended_at - "-ended_at" - intercompany_hours - "-intercompany_hours" - invoiced - "-invoiced" - invoicing_status - "-invoicing_status" - jira_issue_id - "-jira_issue_id" - jira_issue_status - "-jira_issue_status" - jira_issue_summary - "-jira_issue_summary" - last_activity_at - "-last_activity_at" - last_actor - "-last_actor" - month - "-month" - overhead - "-overhead" - people_custom_fields - "-people_custom_fields" - person - "-person" - person_subsidiary - "-person_subsidiary" - project - "-project" - project_type_id - "-project_type_id" - quarter - "-quarter" - responsible - "-responsible" - section_name - "-section_name" - service - "-service" - service_type - "-service_type" - stage_type - "-stage_type" - started_at - "-started_at" - status - "-status" - task - "-task" - task_list - "-task_list" - time_entry - "-time_entry" - time_entry_created_at - "-time_entry_created_at" - time_entry_date - "-time_entry_date" - time_entry_ended_at - "-time_entry_ended_at" - time_entry_last_activity_at - "-time_entry_last_activity_at" - time_entry_started_at - "-time_entry_started_at" - total_billable_revenue - "-total_billable_revenue" - total_billable_time - "-total_billable_time" - total_cost - "-total_cost" - total_facility_overhead_cost - "-total_facility_overhead_cost" - total_internal_overhead_cost - "-total_internal_overhead_cost" - total_overhead_cost - "-total_overhead_cost" - total_recognized_profit - "-total_recognized_profit" - total_recognized_revenue - "-total_recognized_revenue" - total_recognized_time - "-total_recognized_time" - total_time - "-total_time" - total_work_cost - "-total_work_cost" - track_method_id - "-track_method_id" - unit_id - "-unit_id" - week - "-week" - year - "-year" type: string title: Sort time entry report explode: false required: false description: Sort time entry report sort_section: in: query name: sort style: form schema: type: array items: type: string title: Sort section explode: false required: false description: Sort section sort_service_report: in: query name: sort style: form schema: type: array items: enum: - average_actual_rate - "-average_actual_rate" - average_budget_usage - "-average_budget_usage" - average_discount - "-average_discount" - average_forecasted_budget_usage - "-average_forecasted_budget_usage" - average_forecasted_time_usage - "-average_forecasted_time_usage" - average_markup - "-average_markup" - average_profit_margin - "-average_profit_margin" - billable - "-billable" - billing_type - "-billing_type" - booking_tracking_enabled - "-booking_tracking_enabled" - budget - "-budget" - budget_cap_enabled - "-budget_cap_enabled" - budget_custom_fields - "-budget_custom_fields" - budget_status - "-budget_status" - company - "-company" - count - "-count" - custom_fields - "-custom_fields" - date - "-date" - deal_custom_fields - "-deal_custom_fields" - deal_status - "-deal_status" - expense_tracking_enabled - "-expense_tracking_enabled" - limitation_type - "-limitation_type" - origin_deal - "-origin_deal" - pipeline - "-pipeline" - project - "-project" - project_type - "-project_type" - responsible - "-responsible" - sales_status_id - "-sales_status_id" - section - "-section" - section_name - "-section_name" - section_position - "-section_position" - service - "-service" - service_billable - "-service_billable" - service_deal_date - "-service_deal_date" - service_description - "-service_description" - service_discount - "-service_discount" - service_markup - "-service_markup" - service_name - "-service_name" - service_position - "-service_position" - service_type - "-service_type" - service_unit - "-service_unit" - stage_status - "-stage_status" - stage_type - "-stage_type" - subsidiary - "-subsidiary" - time_tracking_enabled - "-time_tracking_enabled" - total_billable_time - "-total_billable_time" - total_booked_time - "-total_booked_time" - total_budget_remaining - "-total_budget_remaining" - total_budget_total - "-total_budget_total" - total_budget_used - "-total_budget_used" - total_budgeted_time - "-total_budgeted_time" - total_cost - "-total_cost" - total_discount_amount - "-total_discount_amount" - total_estimated_cost - "-total_estimated_cost" - total_estimated_remaining_time - "-total_estimated_remaining_time" - total_estimated_time - "-total_estimated_time" - total_expense_cost - "-total_expense_cost" - total_forecasted_billable_time - "-total_forecasted_billable_time" - total_forecasted_budget_used - "-total_forecasted_budget_used" - total_future_booked_time - "-total_future_booked_time" - total_future_budget_used - "-total_future_budget_used" - total_left_to_schedule_time - "-total_left_to_schedule_time" - total_markup_amount - "-total_markup_amount" - total_price - "-total_price" - total_profit - "-total_profit" - total_projected_revenue - "-total_projected_revenue" - total_recognized_revenue - "-total_recognized_revenue" - total_remaining_scheduled_time - "-total_remaining_scheduled_time" - total_revenue - "-total_revenue" - total_rolled_over_time - "-total_rolled_over_time" - total_unapproved_time - "-total_unapproved_time" - total_worked_cost - "-total_worked_cost" - total_worked_time - "-total_worked_time" - unit - "-unit" type: string title: Sort service report explode: false required: false description: Sort service report group_company_report: in: query name: group style: form schema: enum: - company - contact_address - contact_city - contact_country - contact_email - contact_phone - contact_state - contact_website - contact_zipcode - created_at - custom_fields - last_activity_at - month - organization - parent_company - quarter - status - subsidiary - week - year type: string title: Group company report explode: false required: false description: Group company report sort_purchase_order: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - deal_id - "-deal_id" - deal_name - "-deal_name" - delivery_on - "-delivery_on" - id - "-id" - issued_on - "-issued_on" - number - "-number" - payment_status_id - "-payment_status_id" - received_on - "-received_on" - sent_on - "-sent_on" - status_id - "-status_id" - total_cost - "-total_cost" - total_cost_with_tax - "-total_cost_with_tax" - total_received - "-total_received" - vendor_id - "-vendor_id" type: string title: Sort purchase order explode: false required: false description: JSON:API `sort` query parameter for the purchase orders collection. Comma-separated list of sort keys — prefix with `-` for descending. sort_project_assignment: in: query name: sort style: form schema: type: array items: type: string title: Sort project assignment explode: false required: false description: Sort project assignment sort_lost_reason: in: query name: sort style: form schema: type: array items: type: string title: Sort lost reason explode: false required: false description: Sort lost reason filter_task_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_task_report" required: false description: Filters sort_custom_field_section: in: query name: sort style: form schema: type: array items: type: string title: Sort custom field section explode: false required: false description: Sort custom field section sort_new_salary_report: in: query name: sort style: form schema: type: array items: enum: - count - "-count" - date - "-date" - engagement_ended_on - "-engagement_ended_on" - engagement_started_on - "-engagement_started_on" - estimated_weekly_hours - "-estimated_weekly_hours" - overhead - "-overhead" - people_custom_fields - "-people_custom_fields" - person - "-person" - salary_id - "-salary_id" - salary_type_id - "-salary_type_id" - time - "-time" - total_annually_cost - "-total_annually_cost" - total_bi_weekly_cost - "-total_bi_weekly_cost" - total_hourly_cost - "-total_hourly_cost" - total_monthly_cost - "-total_monthly_cost" - total_weekly_cost - "-total_weekly_cost" type: string title: Sort new salary report explode: false required: false description: Sort new salary report filter_approval_policy_assignment: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_approval_policy_assignment" required: false description: Filter parameter for querying approval policy assignments. filter_overhead: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_overhead" required: false description: Filters filter_automatic_invoicing_rule: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_automatic_invoicing_rule" required: false description: Filter parameter for querying automatic invoicing rules. sort_notification: in: query name: sort style: form schema: type: array items: type: string title: Sort notification explode: false required: false description: Sort notification filter_report_category: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_report_category" required: false description: Filters filter_integration_exporter_configuration: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_integration_exporter_configuration" required: false description: Filter parameter for querying integration exporter configurations. sort_booking_report: in: query name: sort style: form schema: type: array items: enum: - absence_type - "-absence_type" - approval_status - "-approval_status" - approved_at - "-approved_at" - autotracking - "-autotracking" - average_blended_rate - "-average_blended_rate" - average_recognized_margin - "-average_recognized_margin" - billing_type - "-billing_type" - booking - "-booking" - booking_approved_at - "-booking_approved_at" - booking_canceled_at - "-booking_canceled_at" - booking_created_at - "-booking_created_at" - booking_ended_on - "-booking_ended_on" - booking_rejected_at - "-booking_rejected_at" - booking_started_on - "-booking_started_on" - budget - "-budget" - canceled_at - "-canceled_at" - company - "-company" - count - "-count" - created_at - "-created_at" - custom_fields - "-custom_fields" - date - "-date" - deal - "-deal" - draft - "-draft" - event - "-event" - mandays - "-mandays" - people_custom_fields - "-people_custom_fields" - person - "-person" - project - "-project" - project_type - "-project_type" - rejected_at - "-rejected_at" - responsible - "-responsible" - service - "-service" - service_type - "-service_type" - stage_type - "-stage_type" - task - "-task" - time - "-time" - total_base_cost - "-total_base_cost" - total_cost - "-total_cost" - total_recognized_profit - "-total_recognized_profit" - total_recognized_revenue - "-total_recognized_revenue" - total_recognized_time - "-total_recognized_time" type: string title: Sort booking report explode: false required: false description: Sort booking report filter_time_entry_version: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_time_entry_version" required: false description: Filters sort_new_time_report: in: query name: sort style: form schema: type: array items: enum: - available_time - "-available_time" - average_cost_rate - "-average_cost_rate" - billable_time - "-billable_time" - billing_type - "-billing_type" - bookings_custom_fields - "-bookings_custom_fields" - budget - "-budget" - capacity - "-capacity" - client_time - "-client_time" - company - "-company" - count - "-count" - date - "-date" - day - "-day" - draft_scheduled_billable_time - "-draft_scheduled_billable_time" - draft_scheduled_client_time - "-draft_scheduled_client_time" - draft_scheduled_internal_time - "-draft_scheduled_internal_time" - draft_scheduled_time - "-draft_scheduled_time" - event - "-event" - event_time - "-event_time" - future - "-future" - holiday_time - "-holiday_time" - internal_time - "-internal_time" - manager - "-manager" - month - "-month" - paid_event_time - "-paid_event_time" - people_custom_fields - "-people_custom_fields" - person - "-person" - person_company - "-person_company" - person_title - "-person_title" - person_type - "-person_type" - project - "-project" - quarter - "-quarter" - recognized_scheduled_time - "-recognized_scheduled_time" - recognized_time - "-recognized_time" - scheduled_billable_time - "-scheduled_billable_time" - scheduled_client_time - "-scheduled_client_time" - scheduled_event_time - "-scheduled_event_time" - scheduled_internal_time - "-scheduled_internal_time" - scheduled_remote_work_time - "-scheduled_remote_work_time" - scheduled_time - "-scheduled_time" - service - "-service" - service_type - "-service_type" - stage_type - "-stage_type" - subsidiary - "-subsidiary" - total_cost - "-total_cost" - total_draft_scheduled_cost - "-total_draft_scheduled_cost" - total_draft_scheduled_revenue - "-total_draft_scheduled_revenue" - total_scheduled_cost - "-total_scheduled_cost" - total_scheduled_revenue - "-total_scheduled_revenue" - total_work_cost - "-total_work_cost" - unapproved_time - "-unapproved_time" - unpaid_event_time - "-unpaid_event_time" - week - "-week" - worked_time - "-worked_time" - workload - "-workload" - year - "-year" type: string title: Sort new time report explode: false required: false description: Sort new time report sort_survey_field: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - id - "-id" - name - "-name" - project_id - "-project_id" - survey_id - "-survey_id" - updated_at - "-updated_at" type: string title: Sort survey field explode: false required: false description: Sort order for survey field list results. Accepts one or more field names, comma-separated; prefix with `-` for descending. --branch descriptions filter_deal_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_deal_report" required: false description: Filters filter_pipeline: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_pipeline" required: false description: Filters filter_discussion: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_discussion" required: false description: Filters sort_revenue_distribution: in: query name: sort style: form schema: type: array items: enum: - amount - "-amount" - amount_percent - "-amount_percent" - created_at - "-created_at" - deal - "-deal" - deal_id - "-deal_id" - end_on - "-end_on" - id - "-id" - start_on - "-start_on" type: string title: Sort revenue distribution explode: false required: false description: Sort order for revenue distribution list results. Accepts one or more field names, comma-separated; prefix with `-` for descending. --branch descriptions sort_deal_status: in: query name: sort style: form schema: type: array items: enum: - created_at - "-created_at" - id - "-id" - name - "-name" - pipeline_id - "-pipeline_id" - position - "-position" - status_id - "-status_id" type: string title: Sort deal status explode: false required: false description: Sort deal status sort_role: in: query name: sort style: form schema: type: array items: enum: - active_agents_count - "-active_agents_count" - active_users_count - "-active_users_count" - description - "-description" - inactive_agents_count - "-inactive_agents_count" - inactive_users_count - "-inactive_users_count" - name - "-name" type: string title: Sort role explode: false required: false description: Sort role sort_bank_account: in: query name: sort style: form schema: type: array items: enum: - id - "-id" - name - "-name" type: string title: Sort bank account explode: false required: false description: Sort order for bank account list results. Accepts one or more field names, comma-separated; prefix with `-` for descending. --branch descriptions sort_activity: in: query name: sort style: form schema: type: array items: type: string title: Sort activity explode: false required: false description: Sort activity filter_deal_cost_rate: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_deal_cost_rate" required: false description: Filters group_expense_report: in: query name: group style: form schema: enum: - approval_status - approved_at - approver - company - created_at - creator - custom_fields - date - deal - designated_approver - expense - invoice - invoiced - invoicing_status - month - organization - paid_on - pay_on - person - project - purchase_order - quarter - quote_type - reimbursed_on - reimbursement - responsible - section_name - service - service_type - stage_type - status - tax_rate - vendor - week - year type: string title: Group expense report explode: false required: false description: Group expense report group_payroll_item_report: in: query name: group style: form schema: enum: - booking - company - custom_fields - date - organization - payroll_item - payroll_item_type - person - person_status - person_type - role - salary - salary_type - subsidiary - time_entry type: string title: Group payroll item report explode: false required: false description: Group payroll item report filter_invoice_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_invoice_report" required: false description: Filters filter_price_report: in: query name: filter style: deepObject schema: "$ref": "#/components/schemas/_filter_root_price_report" required: false description: Filters sort_company_report: in: query name: sort style: form schema: type: array items: enum: - company - "-company" - company_billing_name - "-company_billing_name" - company_code - "-company_code" - company_created_at - "-company_created_at" - company_custom_fields - "-company_custom_fields" - company_last_activity_at - "-company_last_activity_at" - company_name - "-company_name" - contact_address - "-contact_address" - contact_city - "-contact_city" - contact_country - "-contact_country" - contact_email - "-contact_email" - contact_phone - "-contact_phone" - contact_state - "-contact_state" - contact_website - "-contact_website" - contact_zipcode - "-contact_zipcode" - count - "-count" - created_at - "-created_at" - custom_fields - "-custom_fields" - last_activity_at - "-last_activity_at" - month - "-month" - parent_company - "-parent_company" - payment_terms - "-payment_terms" - quarter - "-quarter" - status - "-status" - subsidiary - "-subsidiary" - week - "-week" - year - "-year" type: string title: Sort company report explode: false required: false description: Sort company report requestBodies: approval_policy_assignment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: target_type: "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_type" description: Request body for creating or updating an approval policy assignment. discussion: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: excerpt: "$ref": "#/components/schemas/resource_discussion/properties/excerpt" page_id: "$ref": "#/components/schemas/resource_discussion/properties/page_id" description: Request body for creating or updating a discussion. purchase_order_export: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: xero_status_id: type: integer title: Xero Status company_reference_id: type: string title: Company Reference ID description: Payload for exporting a purchase order to a connected Xero accounting integration. webhook: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_webhook/properties/name" type_id: "$ref": "#/components/schemas/resource_webhook/properties/type_id" event_id: "$ref": "#/components/schemas/resource_webhook/properties/event_id" target_url: "$ref": "#/components/schemas/resource_webhook/properties/target_url" custom_headers: "$ref": "#/components/schemas/resource_webhook/properties/custom_headers" description: Request body for creating or updating a webhook. workflow: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_workflow/properties/name" description: Request body for creating or updating a workflow. Specify the name and optional archived_at. Workflow statuses are managed separately via the workflow_statuses endpoint. invoice_attribution: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: amount: "$ref": "#/components/schemas/resource_invoice_attribution/properties/amount" date_to: "$ref": "#/components/schemas/resource_invoice_attribution/properties/date_to" budget_id: "$ref": "#/components/schemas/resource_invoice_attribution/properties/budget_id" date_from: "$ref": "#/components/schemas/resource_invoice_attribution/properties/date_from" invoice_id: "$ref": "#/components/schemas/resource_invoice_attribution/properties/invoice_id" description: Request body for creating or updating an invoice attribution. survey_field_option: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_survey_field_option/properties/name" color_id: "$ref": "#/components/schemas/resource_survey_field_option/properties/color_id" position: "$ref": "#/components/schemas/resource_survey_field_option/properties/position" survey_field_id: "$ref": "#/components/schemas/resource_survey_field_option/properties/survey_field_id" description: Request body for creating or updating a survey field option. Specify the parent survey field, option label, and position. service_assignment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: person_id: "$ref": "#/components/schemas/resource_service_assignment/properties/person_id" service_id: "$ref": "#/components/schemas/resource_service_assignment/properties/service_id" description: Request body for creating or updating a service assignment. time_tracking_policy: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/name" holiday_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/holiday_limit" note_mandatory: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/note_mandatory" task_mandatory: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/task_mandatory" working_day_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/working_day_limit" time_range_mandatory: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/time_range_mandatory" non_working_day_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/non_working_day_limit" full_day_absence_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/full_day_absence_limit" half_day_absence_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/half_day_absence_limit" limited_tracking_message: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/limited_tracking_message" restrict_future_tracking: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/restrict_future_tracking" disabled_tracking_message: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/disabled_tracking_message" restrict_time_entry_overlap: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/restrict_time_entry_overlap" restrict_tracking_over_budget: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/restrict_tracking_over_budget" description: Request body for creating or updating a time tracking policy. role: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_role/properties/name" description: "$ref": "#/components/schemas/resource_role/properties/description" permissions: "$ref": "#/components/schemas/resource_role/properties/permissions" base_role_id: "$ref": "#/components/schemas/resource_role/properties/base_role_id" user_type_id: "$ref": "#/components/schemas/resource_role/properties/user_type_id" person: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: email: "$ref": "#/components/schemas/resource_person/properties/email" title: "$ref": "#/components/schemas/resource_person/properties/title" contact: "$ref": "#/components/schemas/resource_person/properties/contact" role_id: "$ref": "#/components/schemas/resource_person/properties/role_id" virtual: "$ref": "#/components/schemas/resource_person/properties/virtual" nickname: "$ref": "#/components/schemas/resource_person/properties/nickname" tag_list: "$ref": "#/components/schemas/resource_person/properties/tag_list" last_name: "$ref": "#/components/schemas/resource_person/properties/last_name" account_id: "$ref": "#/components/schemas/resource_person/properties/account_id" avatar_url: "$ref": "#/components/schemas/resource_person/properties/avatar_url" company_id: "$ref": "#/components/schemas/resource_person/properties/company_id" first_name: "$ref": "#/components/schemas/resource_person/properties/first_name" manager_id: "$ref": "#/components/schemas/resource_person/properties/manager_id" status_text: "$ref": "#/components/schemas/resource_person/properties/status_text" autotracking: "$ref": "#/components/schemas/resource_person/properties/autotracking" status_emoji: "$ref": "#/components/schemas/resource_person/properties/status_emoji" custom_fields: "$ref": "#/components/schemas/resource_person/properties/custom_fields" subsidiary_id: "$ref": "#/components/schemas/resource_person/properties/subsidiary_id" time_unlocked: "$ref": "#/components/schemas/resource_person/properties/time_unlocked" custom_role_id: "$ref": "#/components/schemas/resource_person/properties/custom_role_id" subscriber_ids: "$ref": "#/components/schemas/resource_person/properties/subscriber_ids" time_unlocked_on: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_on" status_expires_at: "$ref": "#/components/schemas/resource_person/properties/status_expires_at" time_off_status_sync: "$ref": "#/components/schemas/resource_person/properties/time_off_status_sync" time_unlocked_end_date: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_end_date" time_unlocked_interval: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_interval" time_tracking_policy_id: "$ref": "#/components/schemas/resource_person/properties/time_tracking_policy_id" time_unlocked_period_id: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_period_id" time_unlocked_start_date: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_start_date" timesheet_submission_disabled: "$ref": "#/components/schemas/resource_person/properties/timesheet_submission_disabled" granular_notification_preferences: "$ref": "#/components/schemas/resource_person/properties/granular_notification_preferences" description: Request body for creating or updating a person. overhead: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: use_overhead: "$ref": "#/components/schemas/resource_overhead/properties/use_overhead" facility_costs: "$ref": "#/components/schemas/resource_overhead/properties/facility_costs" averaging_period: "$ref": "#/components/schemas/resource_overhead/properties/averaging_period" overhead_controls: "$ref": "#/components/schemas/resource_overhead/properties/overhead_controls" facility_costs_breakdown: "$ref": "#/components/schemas/resource_overhead/properties/facility_costs_breakdown" description: Request body for creating or updating an overhead configuration. approval_workflow: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: event_id: "$ref": "#/components/schemas/resource_approval_workflow/properties/event_id" approver_ids: "$ref": "#/components/schemas/resource_approval_workflow/properties/approver_ids" subscriber_ids: "$ref": "#/components/schemas/resource_approval_workflow/properties/subscriber_ids" target_type_id: "$ref": "#/components/schemas/resource_approval_workflow/properties/target_type_id" approval_policy_id: "$ref": "#/components/schemas/resource_approval_workflow/properties/approval_policy_id" dynamic_approver_ids: "$ref": "#/components/schemas/resource_approval_workflow/properties/dynamic_approver_ids" dynamic_subscriber_ids: "$ref": "#/components/schemas/resource_approval_workflow/properties/dynamic_subscriber_ids" approval_requirement_id: "$ref": "#/components/schemas/resource_approval_workflow/properties/approval_requirement_id" description: Request body for creating or updating an approval workflow. service_type: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_service_type/properties/name" description: Request body for creating or updating a service type. pipeline: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_pipeline/properties/name" icon_id: "$ref": "#/components/schemas/resource_pipeline/properties/icon_id" position: "$ref": "#/components/schemas/resource_pipeline/properties/position" pipeline_type_id: "$ref": "#/components/schemas/resource_pipeline/properties/pipeline_type_id" description: Request body for creating or updating a pipeline. Specify the name, pipeline_type_id (sales or production), position, and optional icon. Deal statuses are managed separately via the deal_statuses endpoint. project_assignment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: watched: "$ref": "#/components/schemas/resource_project_assignment/properties/watched" person_id: "$ref": "#/components/schemas/resource_project_assignment/properties/person_id" subscribe: "$ref": "#/components/schemas/resource_project_assignment/properties/subscribe" project_id: "$ref": "#/components/schemas/resource_project_assignment/properties/project_id" preferences: "$ref": "#/components/schemas/resource_project_assignment/properties/preferences" unsubscribe: "$ref": "#/components/schemas/resource_project_assignment/properties/unsubscribe" docs_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/docs_filter_id" deals_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/deals_filter_id" tasks_layout_id: "$ref": "#/components/schemas/resource_project_assignment/properties/tasks_layout_id" budgets_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/budgets_filter_id" default_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/default_filter_id" invoices_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/invoices_filter_id" description: Request body for creating or updating a project membership (project assignment). project: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_project/properties/name" company_id: "$ref": "#/components/schemas/resource_project/properties/company_id" tag_colors: "$ref": "#/components/schemas/resource_project/properties/tag_colors" preferences: "$ref": "#/components/schemas/resource_project/properties/preferences" workflow_id: "$ref": "#/components/schemas/resource_project/properties/workflow_id" custom_fields: "$ref": "#/components/schemas/resource_project/properties/custom_fields" project_type_id: "$ref": "#/components/schemas/resource_project/properties/project_type_id" project_color_id: "$ref": "#/components/schemas/resource_project/properties/project_color_id" project_manager_id: "$ref": "#/components/schemas/resource_project/properties/project_manager_id" page_custom_fields_ids: "$ref": "#/components/schemas/resource_project/properties/page_custom_fields_ids" task_custom_fields_ids: "$ref": "#/components/schemas/resource_project/properties/task_custom_fields_ids" page_custom_fields_positions: "$ref": "#/components/schemas/resource_project/properties/page_custom_fields_positions" task_custom_fields_positions: "$ref": "#/components/schemas/resource_project/properties/task_custom_fields_positions" description: Request body for creating or updating a project. placeholder: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: icon: "$ref": "#/components/schemas/resource_placeholder/properties/icon" name: "$ref": "#/components/schemas/resource_placeholder/properties/name" type: "$ref": "#/components/schemas/resource_placeholder/properties/type" color: "$ref": "#/components/schemas/resource_placeholder/properties/color" category: "$ref": "#/components/schemas/resource_placeholder/properties/category" project_id: "$ref": "#/components/schemas/resource_placeholder/properties/project_id" description: Request body for creating or updating a placeholder. lost_reason: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_lost_reason/properties/name" description: Request body for creating or updating a lost reason. deal_cost_rate: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: deal_id: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/deal_id" currency: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/currency" person_id: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/person_id" rate_cents: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/rate_cents" description: Request body for creating or updating a deal cost rate. approval_policy: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_approval_policy/properties/name" custom: "$ref": "#/components/schemas/resource_approval_policy/properties/custom" default: "$ref": "#/components/schemas/resource_approval_policy/properties/default" type_id: "$ref": "#/components/schemas/resource_approval_policy/properties/type_id" description: Request body for creating or updating an approval policy. Specify the policy type (time, absence, or expense), the set of approvers, and whether unanimous approval is required. Link to a service or person to scope the policy. document_type: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_document_type/properties/name" note: "$ref": "#/components/schemas/resource_document_type/properties/note" footer: "$ref": "#/components/schemas/resource_document_type/properties/footer" locale: "$ref": "#/components/schemas/resource_document_type/properties/locale" tax1_name: "$ref": "#/components/schemas/resource_document_type/properties/tax1_name" tax2_name: "$ref": "#/components/schemas/resource_document_type/properties/tax2_name" email_data: "$ref": "#/components/schemas/resource_document_type/properties/email_data" tax1_value: "$ref": "#/components/schemas/resource_document_type/properties/tax1_value" tax2_value: "$ref": "#/components/schemas/resource_document_type/properties/tax2_value" dual_currency: "$ref": "#/components/schemas/resource_document_type/properties/dual_currency" email_subject: "$ref": "#/components/schemas/resource_document_type/properties/email_subject" subsidiary_id: "$ref": "#/components/schemas/resource_document_type/properties/subsidiary_id" attachment_ids: "$ref": "#/components/schemas/resource_document_type/properties/attachment_ids" email_template: "$ref": "#/components/schemas/resource_document_type/properties/email_template" filename_schema: "$ref": "#/components/schemas/resource_document_type/properties/filename_schema" exporter_options: "$ref": "#/components/schemas/resource_document_type/properties/exporter_options" template_options: "$ref": "#/components/schemas/resource_document_type/properties/template_options" document_style_id: "$ref": "#/components/schemas/resource_document_type/properties/document_style_id" exportable_type_id: "$ref": "#/components/schemas/resource_document_type/properties/exportable_type_id" document_template_id: "$ref": "#/components/schemas/resource_document_type/properties/document_template_id" description: Request body for creating or updating a document type. holiday_calendar: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_holiday_calendar/properties/name" state: "$ref": "#/components/schemas/resource_holiday_calendar/properties/state" country: "$ref": "#/components/schemas/resource_holiday_calendar/properties/country" autogenerate_holidays: "$ref": "#/components/schemas/resource_holiday_calendar/properties/autogenerate_holidays" description: Request body for creating or updating a holiday calendar. custom_domain: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_custom_domain/properties/name" allow_user_email: "$ref": "#/components/schemas/resource_custom_domain/properties/allow_user_email" email_sender_name: "$ref": "#/components/schemas/resource_custom_domain/properties/email_sender_name" email_sender_address: "$ref": "#/components/schemas/resource_custom_domain/properties/email_sender_address" description: Request body for creating or updating a custom domain. password: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: password: "$ref": "#/components/schemas/resource_password/properties/password" password_confirmation: "$ref": "#/components/schemas/resource_password/properties/password_confirmation" description: Request body for updating a user's password. organization: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_organization/properties/name" addons: "$ref": "#/components/schemas/resource_organization/properties/addons" locale: "$ref": "#/components/schemas/resource_organization/properties/locale" currency: "$ref": "#/components/schemas/resource_organization/properties/currency" due_days: "$ref": "#/components/schemas/resource_organization/properties/due_days" overhead: "$ref": "#/components/schemas/resource_organization/properties/overhead" owner_id: "$ref": "#/components/schemas/resource_organization/properties/owner_id" time_zone: "$ref": "#/components/schemas/resource_organization/properties/time_zone" ai_enabled: "$ref": "#/components/schemas/resource_organization/properties/ai_enabled" avatar_url: "$ref": "#/components/schemas/resource_organization/properties/avatar_url" booked_demo: "$ref": "#/components/schemas/resource_organization/properties/booked_demo" time_locking: "$ref": "#/components/schemas/resource_organization/properties/time_locking" deal_settings: "$ref": "#/components/schemas/resource_organization/properties/deal_settings" email_type_id: "$ref": "#/components/schemas/resource_organization/properties/email_type_id" working_hours: "$ref": "#/components/schemas/resource_organization/properties/working_hours" allow_time_off: "$ref": "#/components/schemas/resource_organization/properties/allow_time_off" date_format_id: "$ref": "#/components/schemas/resource_organization/properties/date_format_id" expense_markup: "$ref": "#/components/schemas/resource_organization/properties/expense_markup" facility_costs: "$ref": "#/components/schemas/resource_organization/properties/facility_costs" time_format_id: "$ref": "#/components/schemas/resource_organization/properties/time_format_id" time_reminders: "$ref": "#/components/schemas/resource_organization/properties/time_reminders" man_day_minutes: "$ref": "#/components/schemas/resource_organization/properties/man_day_minutes" remove_branding: "$ref": "#/components/schemas/resource_organization/properties/remove_branding" time_display_id: "$ref": "#/components/schemas/resource_organization/properties/time_display_id" allow_user_email: "$ref": "#/components/schemas/resource_organization/properties/allow_user_email" email_local_name: "$ref": "#/components/schemas/resource_organization/properties/email_local_name" expense_settings: "$ref": "#/components/schemas/resource_organization/properties/expense_settings" number_format_id: "$ref": "#/components/schemas/resource_organization/properties/number_format_id" overhead_type_id: "$ref": "#/components/schemas/resource_organization/properties/overhead_type_id" time_reminder_at: "$ref": "#/components/schemas/resource_organization/properties/time_reminder_at" time_reminder_id: "$ref": "#/components/schemas/resource_organization/properties/time_reminder_id" decimal_places_id: "$ref": "#/components/schemas/resource_organization/properties/decimal_places_id" email_sender_name: "$ref": "#/components/schemas/resource_organization/properties/email_sender_name" fiscal_year_start: "$ref": "#/components/schemas/resource_organization/properties/fiscal_year_start" week_start_day_id: "$ref": "#/components/schemas/resource_organization/properties/week_start_day_id" currency_format_id: "$ref": "#/components/schemas/resource_organization/properties/currency_format_id" quick_start_config: "$ref": "#/components/schemas/resource_organization/properties/quick_start_config" rounding_method_id: "$ref": "#/components/schemas/resource_organization/properties/rounding_method_id" onboarding_progress: "$ref": "#/components/schemas/resource_organization/properties/onboarding_progress" rounding_interval_id: "$ref": "#/components/schemas/resource_organization/properties/rounding_interval_id" timesheet_submission: "$ref": "#/components/schemas/resource_organization/properties/timesheet_submission" limited_service_types: "$ref": "#/components/schemas/resource_organization/properties/limited_service_types" time_locking_interval: "$ref": "#/components/schemas/resource_organization/properties/time_locking_interval" time_locking_period_id: "$ref": "#/components/schemas/resource_organization/properties/time_locking_period_id" time_locking_reminders: "$ref": "#/components/schemas/resource_organization/properties/time_locking_reminders" time_reminder_condition: "$ref": "#/components/schemas/resource_organization/properties/time_reminder_condition" time_tracking_policy_id: "$ref": "#/components/schemas/resource_organization/properties/time_tracking_policy_id" autotracking_schedule_id: "$ref": "#/components/schemas/resource_organization/properties/autotracking_schedule_id" conflict_resolver_active: "$ref": "#/components/schemas/resource_organization/properties/conflict_resolver_active" facility_costs_breakdown: "$ref": "#/components/schemas/resource_organization/properties/facility_costs_breakdown" numbering_format_settings: "$ref": "#/components/schemas/resource_organization/properties/numbering_format_settings" invoice_rounding_method_id: "$ref": "#/components/schemas/resource_organization/properties/invoice_rounding_method_id" overhead_recalculation_day: "$ref": "#/components/schemas/resource_organization/properties/overhead_recalculation_day" revenue_recognition_type_id: "$ref": "#/components/schemas/resource_organization/properties/revenue_recognition_type_id" financial_month_locking_date: "$ref": "#/components/schemas/resource_organization/properties/financial_month_locking_date" overhead_amortization_period: "$ref": "#/components/schemas/resource_organization/properties/overhead_amortization_period" request_for_resource_enabled: "$ref": "#/components/schemas/resource_organization/properties/request_for_resource_enabled" timesheet_submission_settings: "$ref": "#/components/schemas/resource_organization/properties/timesheet_submission_settings" time_tracking_policies_enabled: "$ref": "#/components/schemas/resource_organization/properties/time_tracking_policies_enabled" timesheet_submission_reminders: "$ref": "#/components/schemas/resource_organization/properties/timesheet_submission_reminders" open_budget_recognition_date_id: "$ref": "#/components/schemas/resource_organization/properties/open_budget_recognition_date_id" overhead_subsidiary_switched_at: "$ref": "#/components/schemas/resource_organization/properties/overhead_subsidiary_switched_at" delivered_budget_recognition_date_id: "$ref": "#/components/schemas/resource_organization/properties/delivered_budget_recognition_date_id" financial_month_locking_partial_edit: "$ref": "#/components/schemas/resource_organization/properties/financial_month_locking_partial_edit" invoice_timesheet_export_configuration: "$ref": "#/components/schemas/resource_organization/properties/invoice_timesheet_export_configuration" description: Request body for creating or updating an organization. custom_field_option: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_custom_field_option/properties/name" color_id: "$ref": "#/components/schemas/resource_custom_field_option/properties/color_id" position: "$ref": "#/components/schemas/resource_custom_field_option/properties/position" custom_field_id: "$ref": "#/components/schemas/resource_custom_field_option/properties/custom_field_id" description: Request body for creating or updating a custom field option. Specify the parent custom field, option name, position, and optional color. task: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: title: "$ref": "#/components/schemas/resource_task/properties/title" private: "$ref": "#/components/schemas/resource_task/properties/private" type_id: "$ref": "#/components/schemas/resource_task/properties/type_id" due_date: "$ref": "#/components/schemas/resource_task/properties/due_date" due_time: "$ref": "#/components/schemas/resource_task/properties/due_time" tag_list: "$ref": "#/components/schemas/resource_task/properties/tag_list" project_id: "$ref": "#/components/schemas/resource_task/properties/project_id" service_id: "$ref": "#/components/schemas/resource_task/properties/service_id" start_date: "$ref": "#/components/schemas/resource_task/properties/start_date" assignee_id: "$ref": "#/components/schemas/resource_task/properties/assignee_id" task_list_id: "$ref": "#/components/schemas/resource_task/properties/task_list_id" custom_fields: "$ref": "#/components/schemas/resource_task/properties/custom_fields" attachment_ids: "$ref": "#/components/schemas/resource_task/properties/attachment_ids" parent_task_id: "$ref": "#/components/schemas/resource_task/properties/parent_task_id" remaining_time: "$ref": "#/components/schemas/resource_task/properties/remaining_time" repeat_on_date: "$ref": "#/components/schemas/resource_task/properties/repeat_on_date" subscriber_ids: "$ref": "#/components/schemas/resource_task/properties/subscriber_ids" skip_reposition: "$ref": "#/components/schemas/resource_task/properties/skip_reposition" initial_estimate: "$ref": "#/components/schemas/resource_task/properties/initial_estimate" repeat_on_weekday: "$ref": "#/components/schemas/resource_task/properties/repeat_on_weekday" repeat_on_interval: "$ref": "#/components/schemas/resource_task/properties/repeat_on_interval" repeat_on_monthday: "$ref": "#/components/schemas/resource_task/properties/repeat_on_monthday" repeat_schedule_id: "$ref": "#/components/schemas/resource_task/properties/repeat_schedule_id" workflow_status_id: "$ref": "#/components/schemas/resource_task/properties/workflow_status_id" description: Request body for creating or updating a task. organization_subscription: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: seats: "$ref": "#/components/schemas/resource_organization_subscription/properties/seats" plan_type: "$ref": "#/components/schemas/resource_organization_subscription/properties/plan_type" plan_cycle: "$ref": "#/components/schemas/resource_organization_subscription/properties/plan_cycle" stripe_token: "$ref": "#/components/schemas/resource_organization_subscription/properties/stripe_token" billing_email: "$ref": "#/components/schemas/resource_organization_subscription/properties/billing_email" product_types: "$ref": "#/components/schemas/resource_organization_subscription/properties/product_types" active_products: "$ref": "#/components/schemas/resource_organization_subscription/properties/active_products" billing_address: "$ref": "#/components/schemas/resource_organization_subscription/properties/billing_address" trial_plan_type: "$ref": "#/components/schemas/resource_organization_subscription/properties/trial_plan_type" trial_product_ids: "$ref": "#/components/schemas/resource_organization_subscription/properties/trial_product_ids" billing_group_seats: "$ref": "#/components/schemas/resource_organization_subscription/properties/billing_group_seats" description: Request body for creating or updating an organization subscription. payment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_payment/properties/note" amount: "$ref": "#/components/schemas/resource_payment/properties/amount" paid_on: "$ref": "#/components/schemas/resource_payment/properties/paid_on" invoice_id: "$ref": "#/components/schemas/resource_payment/properties/invoice_id" written_off_on: "$ref": "#/components/schemas/resource_payment/properties/written_off_on" description: Request body for creating or updating a payment. timesheet: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_timesheet/properties/date" person_id: "$ref": "#/components/schemas/resource_timesheet/properties/person_id" description: Request body for creating or updating a timesheet. organization_membership: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: preferences: "$ref": "#/components/schemas/resource_organization_membership/properties/preferences" weekly_emails: "$ref": "#/components/schemas/resource_organization_membership/properties/weekly_emails" docs_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/docs_filter_id" time_reminders: "$ref": "#/components/schemas/resource_organization_membership/properties/time_reminders" deals_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/deals_filter_id" tasks_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/tasks_filter_id" people_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/people_filter_id" budgets_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/budgets_filter_id" bookings_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/bookings_filter_id" contacts_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/contacts_filter_id" expenses_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/expenses_filter_id" invoices_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/invoices_filter_id" payments_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/payments_filter_id" projects_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/projects_filter_id" quick_start_config: "$ref": "#/components/schemas/resource_organization_membership/properties/quick_start_config" companies_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/companies_filter_id" email_notifications: "$ref": "#/components/schemas/resource_organization_membership/properties/email_notifications" employees_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/employees_filter_id" company_time_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/company_time_filter_id" time_reports_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/time_reports_filter_id" deal_services_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/deal_services_filter_id" salary_reports_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/salary_reports_filter_id" time_approvals_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/time_approvals_filter_id" budget_services_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/budget_services_filter_id" booking_approvals_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/booking_approvals_filter_id" expense_approvals_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/expense_approvals_filter_id" time_entry_reports_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/time_entry_reports_filter_id" granular_notification_preferences: "$ref": "#/components/schemas/resource_organization_membership/properties/granular_notification_preferences" internal_budget_services_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/internal_budget_services_filter_id" description: Request body for creating or updating an organization membership. Links a user and person to an organization. Use to manage user access and configure default filters and notification preferences. service_type_assignment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: person_id: "$ref": "#/components/schemas/resource_service_type_assignment/properties/person_id" service_type_id: "$ref": "#/components/schemas/resource_service_type_assignment/properties/service_type_id" description: Request body for creating or updating a service type assignment. user: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: email: "$ref": "#/components/schemas/resource_user/properties/email" locale: "$ref": "#/components/schemas/resource_user/properties/locale" last_name: "$ref": "#/components/schemas/resource_user/properties/last_name" time_zone: "$ref": "#/components/schemas/resource_user/properties/time_zone" avatar_url: "$ref": "#/components/schemas/resource_user/properties/avatar_url" first_name: "$ref": "#/components/schemas/resource_user/properties/first_name" ical_token: "$ref": "#/components/schemas/resource_user/properties/ical_token" preferences: "$ref": "#/components/schemas/resource_user/properties/preferences" newsletter_consent: "$ref": "#/components/schemas/resource_user/properties/newsletter_consent" default_organization_id: "$ref": "#/components/schemas/resource_user/properties/default_organization_id" account_access_expires_at: "$ref": "#/components/schemas/resource_user/properties/account_access_expires_at" description: Request body for creating or updating a user. survey_response: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: survey_id: "$ref": "#/components/schemas/resource_survey_response/properties/survey_id" custom_fields: "$ref": "#/components/schemas/resource_survey_response/properties/custom_fields" survey_fields: "$ref": "#/components/schemas/resource_survey_response/properties/survey_fields" description: Request body for submitting a survey response. Specify the parent survey and the field values as a hash keyed by survey_field_id. page: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: body: "$ref": "#/components/schemas/resource_page/properties/body" steps: "$ref": "#/components/schemas/resource_page/properties/steps" title: "$ref": "#/components/schemas/resource_page/properties/title" icon_id: "$ref": "#/components/schemas/resource_page/properties/icon_id" position: "$ref": "#/components/schemas/resource_page/properties/position" project_id: "$ref": "#/components/schemas/resource_page/properties/project_id" preferences: "$ref": "#/components/schemas/resource_page/properties/preferences" root_page_id: "$ref": "#/components/schemas/resource_page/properties/root_page_id" custom_fields: "$ref": "#/components/schemas/resource_page/properties/custom_fields" public_access: "$ref": "#/components/schemas/resource_page/properties/public_access" attachment_ids: "$ref": "#/components/schemas/resource_page/properties/attachment_ids" parent_page_id: "$ref": "#/components/schemas/resource_page/properties/parent_page_id" subscriber_ids: "$ref": "#/components/schemas/resource_page/properties/subscriber_ids" version_number: "$ref": "#/components/schemas/resource_page/properties/version_number" cover_image_url: "$ref": "#/components/schemas/resource_page/properties/cover_image_url" cover_image_meta: "$ref": "#/components/schemas/resource_page/properties/cover_image_meta" description: Request body for creating or updating a page. workflow_status: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_workflow_status/properties/name" color_id: "$ref": "#/components/schemas/resource_workflow_status/properties/color_id" position: "$ref": "#/components/schemas/resource_workflow_status/properties/position" category_id: "$ref": "#/components/schemas/resource_workflow_status/properties/category_id" workflow_id: "$ref": "#/components/schemas/resource_workflow_status/properties/workflow_id" description: Request body for creating or updating a workflow status. Specify the parent workflow, name, category (not_started, started, or closed), position, and optional color. invoice_template: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_invoice_template/properties/note" budget_id: "$ref": "#/components/schemas/resource_invoice_template/properties/budget_id" issuer_id: "$ref": "#/components/schemas/resource_invoice_template/properties/issuer_id" custom_fields: "$ref": "#/components/schemas/resource_invoice_template/properties/custom_fields" subsidiary_id: "$ref": "#/components/schemas/resource_invoice_template/properties/subsidiary_id" bank_account_id: "$ref": "#/components/schemas/resource_invoice_template/properties/bank_account_id" document_type_id: "$ref": "#/components/schemas/resource_invoice_template/properties/document_type_id" invoice_due_in_days: "$ref": "#/components/schemas/resource_invoice_template/properties/invoice_due_in_days" bank_account_details: "$ref": "#/components/schemas/resource_invoice_template/properties/bank_account_details" invoice_creation_options: "$ref": "#/components/schemas/resource_invoice_template/properties/invoice_creation_options" description: Request body for creating or updating an invoice template. invoice: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_invoice/properties/note" number: "$ref": "#/components/schemas/resource_invoice/properties/number" pay_on: "$ref": "#/components/schemas/resource_invoice/properties/pay_on" sent_on: "$ref": "#/components/schemas/resource_invoice/properties/sent_on" subject: "$ref": "#/components/schemas/resource_invoice/properties/subject" currency: "$ref": "#/components/schemas/resource_invoice/properties/currency" discount: "$ref": "#/components/schemas/resource_invoice/properties/discount" exported: "$ref": "#/components/schemas/resource_invoice/properties/exported" tag_list: "$ref": "#/components/schemas/resource_invoice/properties/tag_list" export_id: "$ref": "#/components/schemas/resource_invoice/properties/export_id" issuer_id: "$ref": "#/components/schemas/resource_invoice/properties/issuer_id" tax1_name: "$ref": "#/components/schemas/resource_invoice/properties/tax1_name" tax2_name: "$ref": "#/components/schemas/resource_invoice/properties/tax2_name" company_id: "$ref": "#/components/schemas/resource_invoice/properties/company_id" tax1_value: "$ref": "#/components/schemas/resource_invoice/properties/tax1_value" tax2_value: "$ref": "#/components/schemas/resource_invoice/properties/tax2_value" delivery_on: "$ref": "#/components/schemas/resource_invoice/properties/delivery_on" invoiced_on: "$ref": "#/components/schemas/resource_invoice/properties/invoiced_on" attachment_id: "$ref": "#/components/schemas/resource_invoice/properties/attachment_id" custom_fields: "$ref": "#/components/schemas/resource_invoice/properties/custom_fields" subsidiary_id: "$ref": "#/components/schemas/resource_invoice/properties/subsidiary_id" subscriber_ids: "$ref": "#/components/schemas/resource_invoice/properties/subscriber_ids" bank_account_id: "$ref": "#/components/schemas/resource_invoice/properties/bank_account_id" invoice_type_id: "$ref": "#/components/schemas/resource_invoice/properties/invoice_type_id" pay_on_relative: "$ref": "#/components/schemas/resource_invoice/properties/pay_on_relative" creation_options: "$ref": "#/components/schemas/resource_invoice/properties/creation_options" document_type_id: "$ref": "#/components/schemas/resource_invoice/properties/document_type_id" parent_invoice_id: "$ref": "#/components/schemas/resource_invoice/properties/parent_invoice_id" export_invoice_url: "$ref": "#/components/schemas/resource_invoice/properties/export_invoice_url" bank_account_details: "$ref": "#/components/schemas/resource_invoice/properties/bank_account_details" purchase_order_number: "$ref": "#/components/schemas/resource_invoice/properties/purchase_order_number" description: Request body for creating or updating an invoice. payment_reminder_sequence: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/name" default_sequence: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/default_sequence" description: Request body for creating or updating a payment reminder sequence. report_category: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_report_category/properties/name" color_id: "$ref": "#/components/schemas/resource_report_category/properties/color_id" position: "$ref": "#/components/schemas/resource_report_category/properties/position" description: Request body for creating or updating a report category. bank_account: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_bank_account/properties/name" number: "$ref": "#/components/schemas/resource_bank_account/properties/number" currency: "$ref": "#/components/schemas/resource_bank_account/properties/currency" bank_name: "$ref": "#/components/schemas/resource_bank_account/properties/bank_name" swift_code: "$ref": "#/components/schemas/resource_bank_account/properties/swift_code" bank_address: "$ref": "#/components/schemas/resource_bank_account/properties/bank_address" subsidiary_id: "$ref": "#/components/schemas/resource_bank_account/properties/subsidiary_id" description: Request body for creating or updating a bank account. page_version: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_page_version/properties/name" page_id: "$ref": "#/components/schemas/resource_page_version/properties/page_id" restored_from_version_id: "$ref": "#/components/schemas/resource_page_version/properties/restored_from_version_id" description: Request body for creating or updating a page version. Provide the page content (rich text body), title, and optional parent page relationship. Page versions track edit history and support collaborative review via discussions. line_item: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: unit_id: "$ref": "#/components/schemas/resource_line_item/properties/unit_id" discount: "$ref": "#/components/schemas/resource_line_item/properties/discount" position: "$ref": "#/components/schemas/resource_line_item/properties/position" quantity: "$ref": "#/components/schemas/resource_line_item/properties/quantity" tax_name: "$ref": "#/components/schemas/resource_line_item/properties/tax_name" tax_value: "$ref": "#/components/schemas/resource_line_item/properties/tax_value" expense_id: "$ref": "#/components/schemas/resource_line_item/properties/expense_id" invoice_id: "$ref": "#/components/schemas/resource_line_item/properties/invoice_id" service_id: "$ref": "#/components/schemas/resource_line_item/properties/service_id" unit_price: "$ref": "#/components/schemas/resource_line_item/properties/unit_price" kpd_code_id: "$ref": "#/components/schemas/resource_line_item/properties/kpd_code_id" tax_rate_id: "$ref": "#/components/schemas/resource_line_item/properties/tax_rate_id" service_type_id: "$ref": "#/components/schemas/resource_line_item/properties/service_type_id" description: Request body for creating or updating an invoice line item. filter: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_filter/properties/name" hidden: "$ref": "#/components/schemas/resource_filter/properties/hidden" params: "$ref": "#/components/schemas/resource_filter/properties/params" public: "$ref": "#/components/schemas/resource_filter/properties/public" report: "$ref": "#/components/schemas/resource_filter/properties/report" columns: "$ref": "#/components/schemas/resource_filter/properties/columns" sort_by: "$ref": "#/components/schemas/resource_filter/properties/sort_by" type_id: "$ref": "#/components/schemas/resource_filter/properties/type_id" formulas: "$ref": "#/components/schemas/resource_filter/properties/formulas" group_by: "$ref": "#/components/schemas/resource_filter/properties/group_by" settings: "$ref": "#/components/schemas/resource_filter/properties/settings" layout_id: "$ref": "#/components/schemas/resource_filter/properties/layout_id" transpose_by: "$ref": "#/components/schemas/resource_filter/properties/transpose_by" chart_type_id: "$ref": "#/components/schemas/resource_filter/properties/chart_type_id" exchange_date: "$ref": "#/components/schemas/resource_filter/properties/exchange_date" export_params: "$ref": "#/components/schemas/resource_filter/properties/export_params" filterable_id: "$ref": "#/components/schemas/resource_filter/properties/filterable_id" predefined_id: "$ref": "#/components/schemas/resource_filter/properties/predefined_id" column_settings: "$ref": "#/components/schemas/resource_filter/properties/column_settings" filterable_type: "$ref": "#/components/schemas/resource_filter/properties/filterable_type" report_layout_id: "$ref": "#/components/schemas/resource_filter/properties/report_layout_id" exchange_currency: "$ref": "#/components/schemas/resource_filter/properties/exchange_currency" report_category_id: "$ref": "#/components/schemas/resource_filter/properties/report_category_id" filterable_collection: "$ref": "#/components/schemas/resource_filter/properties/filterable_collection" description: Request body for creating or updating a saved view or report. custom_field_section: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_custom_field_section/properties/name" position: "$ref": "#/components/schemas/resource_custom_field_section/properties/position" customizable_type: "$ref": "#/components/schemas/resource_custom_field_section/properties/customizable_type" description: Request body for creating or updating a custom field section. task_dependency: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: task_id: "$ref": "#/components/schemas/resource_task_dependency/properties/task_id" type_id: "$ref": "#/components/schemas/resource_task_dependency/properties/type_id" dependent_task_id: "$ref": "#/components/schemas/resource_task_dependency/properties/dependent_task_id" description: Request body for creating a task dependency. Specify the source task, the dependent task, and the dependency type (blocking, waiting_on, or linked). A reverse dependency is automatically created on the dependent task. widget: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: title: "$ref": "#/components/schemas/resource_widget/properties/title" width: "$ref": "#/components/schemas/resource_widget/properties/width" height: "$ref": "#/components/schemas/resource_widget/properties/height" params: "$ref": "#/components/schemas/resource_widget/properties/params" content: "$ref": "#/components/schemas/resource_widget/properties/content" filter_id: "$ref": "#/components/schemas/resource_widget/properties/filter_id" dashboard_id: "$ref": "#/components/schemas/resource_widget/properties/dashboard_id" row_position: "$ref": "#/components/schemas/resource_widget/properties/row_position" attachment_ids: "$ref": "#/components/schemas/resource_widget/properties/attachment_ids" widget_type_id: "$ref": "#/components/schemas/resource_widget/properties/widget_type_id" column_position: "$ref": "#/components/schemas/resource_widget/properties/column_position" report_layout_id: "$ref": "#/components/schemas/resource_widget/properties/report_layout_id" default_filter_id: "$ref": "#/components/schemas/resource_widget/properties/default_filter_id" description: Request body for creating or updating a widget. holiday: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_holiday/properties/date" name: "$ref": "#/components/schemas/resource_holiday/properties/name" holiday_calendar_id: "$ref": "#/components/schemas/resource_holiday/properties/holiday_calendar_id" description: Request body for creating or updating a holiday. pulse: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: type_id: "$ref": "#/components/schemas/resource_pulse/properties/type_id" version: "$ref": "#/components/schemas/resource_pulse/properties/version" filter_id: "$ref": "#/components/schemas/resource_pulse/properties/filter_id" recipients: "$ref": "#/components/schemas/resource_pulse/properties/recipients" teams_team: "$ref": "#/components/schemas/resource_pulse/properties/teams_team" test_pulse: "$ref": "#/components/schemas/resource_pulse/properties/test_pulse" export_params: "$ref": "#/components/schemas/resource_pulse/properties/export_params" schedule_hour: "$ref": "#/components/schemas/resource_pulse/properties/schedule_hour" skip_if_empty: "$ref": "#/components/schemas/resource_pulse/properties/skip_if_empty" slack_channel: "$ref": "#/components/schemas/resource_pulse/properties/slack_channel" teams_channel: "$ref": "#/components/schemas/resource_pulse/properties/teams_channel" schedule_day_id: "$ref": "#/components/schemas/resource_pulse/properties/schedule_day_id" schedule_frame_id: "$ref": "#/components/schemas/resource_pulse/properties/schedule_frame_id" document_format_id: "$ref": "#/components/schemas/resource_pulse/properties/document_format_id" repeat_schedule_id: "$ref": "#/components/schemas/resource_pulse/properties/repeat_schedule_id" description: Request body for creating or updating a pulse. subsidiary: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_subsidiary/properties/name" facility_costs: "$ref": "#/components/schemas/resource_subsidiary/properties/facility_costs" custom_domain_id: "$ref": "#/components/schemas/resource_subsidiary/properties/custom_domain_id" invoice_logo_url: "$ref": "#/components/schemas/resource_subsidiary/properties/invoice_logo_url" show_delivery_date: "$ref": "#/components/schemas/resource_subsidiary/properties/show_delivery_date" default_tax_rate_id: "$ref": "#/components/schemas/resource_subsidiary/properties/default_tax_rate_id" invoice_number_scope: "$ref": "#/components/schemas/resource_subsidiary/properties/invoice_number_scope" invoice_number_format: "$ref": "#/components/schemas/resource_subsidiary/properties/invoice_number_format" default_bank_account_id: "$ref": "#/components/schemas/resource_subsidiary/properties/default_bank_account_id" default_document_type_id: "$ref": "#/components/schemas/resource_subsidiary/properties/default_document_type_id" facility_costs_breakdown: "$ref": "#/components/schemas/resource_subsidiary/properties/facility_costs_breakdown" description: Request body for creating or updating a subsidiary (legal entity). Specify the name, invoice number format, invoice number scope, and optional branding (logo, document style) and default tax rate and bank account. comment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: body: "$ref": "#/components/schemas/resource_comment/properties/body" draft: "$ref": "#/components/schemas/resource_comment/properties/draft" hidden: "$ref": "#/components/schemas/resource_comment/properties/hidden" deal_id: "$ref": "#/components/schemas/resource_comment/properties/deal_id" task_id: "$ref": "#/components/schemas/resource_comment/properties/task_id" person_id: "$ref": "#/components/schemas/resource_comment/properties/person_id" company_id: "$ref": "#/components/schemas/resource_comment/properties/company_id" invoice_id: "$ref": "#/components/schemas/resource_comment/properties/invoice_id" project_id: "$ref": "#/components/schemas/resource_comment/properties/project_id" proposal_id: "$ref": "#/components/schemas/resource_comment/properties/proposal_id" discussion_id: "$ref": "#/components/schemas/resource_comment/properties/discussion_id" attachment_ids: "$ref": "#/components/schemas/resource_comment/properties/attachment_ids" version_number: "$ref": "#/components/schemas/resource_comment/properties/version_number" purchase_order_id: "$ref": "#/components/schemas/resource_comment/properties/purchase_order_id" resource_request_id: "$ref": "#/components/schemas/resource_comment/properties/resource_request_id" description: Request body for creating or updating a comment. Provide the rich text body (HTML with @mentions), the parent resource relationship (task, deal, person, etc.), and optional draft status. Reactions and pin state are managed via separate actions. purchase_order_copy: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object required: - template_id - deal_id properties: deal_id: "$ref": "#/components/schemas/resource_purchase_order/properties/deal_id" template_id: type: integer title: Template description: Payload for copying an existing purchase order onto a target deal. Requires `template_id` and `deal_id`. custom_field: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_custom_field/properties/name" global: "$ref": "#/components/schemas/resource_custom_field/properties/global" position: "$ref": "#/components/schemas/resource_custom_field/properties/position" required: "$ref": "#/components/schemas/resource_custom_field/properties/required" sensitive: "$ref": "#/components/schemas/resource_custom_field/properties/sensitive" survey_id: "$ref": "#/components/schemas/resource_custom_field/properties/survey_id" project_id: "$ref": "#/components/schemas/resource_custom_field/properties/project_id" section_id: "$ref": "#/components/schemas/resource_custom_field/properties/section_id" data_type_id: "$ref": "#/components/schemas/resource_custom_field/properties/data_type_id" customizable_type: "$ref": "#/components/schemas/resource_custom_field/properties/customizable_type" quick_add_enabled: "$ref": "#/components/schemas/resource_custom_field/properties/quick_add_enabled" formatting_type_id: "$ref": "#/components/schemas/resource_custom_field/properties/formatting_type_id" aggregation_type_id: "$ref": "#/components/schemas/resource_custom_field/properties/aggregation_type_id" show_in_add_edit_views: "$ref": "#/components/schemas/resource_custom_field/properties/show_in_add_edit_views" description: Request body for creating or updating a custom field. Specify the customizable type, data type (data_type_id), name, and optional configuration (required, global, sensitive, show_in_add_edit_views, position, description). Link to a project or section to scope the field. survey_field: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_survey_field/properties/name" position: "$ref": "#/components/schemas/resource_survey_field/properties/position" required: "$ref": "#/components/schemas/resource_survey_field/properties/required" survey_id: "$ref": "#/components/schemas/resource_survey_field/properties/survey_id" data_type_id: "$ref": "#/components/schemas/resource_survey_field/properties/data_type_id" origin_field_id: "$ref": "#/components/schemas/resource_survey_field/properties/origin_field_id" quick_add_enabled: "$ref": "#/components/schemas/resource_survey_field/properties/quick_add_enabled" formatting_type_id: "$ref": "#/components/schemas/resource_survey_field/properties/formatting_type_id" aggregation_type_id: "$ref": "#/components/schemas/resource_survey_field/properties/aggregation_type_id" show_in_add_edit_views: "$ref": "#/components/schemas/resource_survey_field/properties/show_in_add_edit_views" description: Request body for creating or updating a survey field. Specify the survey, field type (data_type_id), label, position, required flag, and optional description. For dropdown fields, add options via the survey_field_options endpoint. company: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: vat: "$ref": "#/components/schemas/resource_company/properties/vat" name: "$ref": "#/components/schemas/resource_company/properties/name" domain: "$ref": "#/components/schemas/resource_company/properties/domain" contact: "$ref": "#/components/schemas/resource_company/properties/contact" due_days: "$ref": "#/components/schemas/resource_company/properties/due_days" settings: "$ref": "#/components/schemas/resource_company/properties/settings" tag_list: "$ref": "#/components/schemas/resource_company/properties/tag_list" avatar_url: "$ref": "#/components/schemas/resource_company/properties/avatar_url" billing_name: "$ref": "#/components/schemas/resource_company/properties/billing_name" company_code: "$ref": "#/components/schemas/resource_company/properties/company_code" custom_fields: "$ref": "#/components/schemas/resource_company/properties/custom_fields" subscriber_ids: "$ref": "#/components/schemas/resource_company/properties/subscriber_ids" default_currency: "$ref": "#/components/schemas/resource_company/properties/default_currency" parent_company_id: "$ref": "#/components/schemas/resource_company/properties/parent_company_id" default_tax_rate_id: "$ref": "#/components/schemas/resource_company/properties/default_tax_rate_id" default_subsidiary_id: "$ref": "#/components/schemas/resource_company/properties/default_subsidiary_id" default_document_type_id: "$ref": "#/components/schemas/resource_company/properties/default_document_type_id" description: Request body for creating or updating a company. integration: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: {} description: Request body for creating or updating an integration. entitlement: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_entitlement/properties/note" end_date: "$ref": "#/components/schemas/resource_entitlement/properties/end_date" event_id: "$ref": "#/components/schemas/resource_entitlement/properties/event_id" allocated: "$ref": "#/components/schemas/resource_entitlement/properties/allocated" person_id: "$ref": "#/components/schemas/resource_entitlement/properties/person_id" start_date: "$ref": "#/components/schemas/resource_entitlement/properties/start_date" description: Request body for creating or updating an entitlement (time-off balance). Specify the person, event (absence category), date range, and allocated days. The used and pending amounts are system-managed based on booking activity. session: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_session/properties/name" device: "$ref": "#/components/schemas/resource_session/properties/device" browser: "$ref": "#/components/schemas/resource_session/properties/browser" platform: "$ref": "#/components/schemas/resource_session/properties/platform" read_only: "$ref": "#/components/schemas/resource_session/properties/read_only" app_version: "$ref": "#/components/schemas/resource_session/properties/app_version" firebase_token: "$ref": "#/components/schemas/resource_session/properties/firebase_token" cordova_device_uid: "$ref": "#/components/schemas/resource_session/properties/cordova_device_uid" cordova_device_model: "$ref": "#/components/schemas/resource_session/properties/cordova_device_model" cordova_device_version: "$ref": "#/components/schemas/resource_session/properties/cordova_device_version" cordova_device_platform: "$ref": "#/components/schemas/resource_session/properties/cordova_device_platform" description: Request body for creating or updating a session. folder: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_folder/properties/name" hidden: "$ref": "#/components/schemas/resource_folder/properties/hidden" position: "$ref": "#/components/schemas/resource_folder/properties/position" project_id: "$ref": "#/components/schemas/resource_folder/properties/project_id" description: The request body for creating or updating a folder. contact_entry: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: vat: "$ref": "#/components/schemas/resource_contact_entry/properties/vat" city: "$ref": "#/components/schemas/resource_contact_entry/properties/city" name: "$ref": "#/components/schemas/resource_contact_entry/properties/name" type: "$ref": "#/components/schemas/resource_contact_entry/properties/type" email: "$ref": "#/components/schemas/resource_contact_entry/properties/email" phone: "$ref": "#/components/schemas/resource_contact_entry/properties/phone" state: "$ref": "#/components/schemas/resource_contact_entry/properties/state" address: "$ref": "#/components/schemas/resource_contact_entry/properties/address" country: "$ref": "#/components/schemas/resource_contact_entry/properties/country" website: "$ref": "#/components/schemas/resource_contact_entry/properties/website" zipcode: "$ref": "#/components/schemas/resource_contact_entry/properties/zipcode" person_id: "$ref": "#/components/schemas/resource_contact_entry/properties/person_id" company_id: "$ref": "#/components/schemas/resource_contact_entry/properties/company_id" invoice_id: "$ref": "#/components/schemas/resource_contact_entry/properties/invoice_id" billing_email: "$ref": "#/components/schemas/resource_contact_entry/properties/billing_email" subsidiary_id: "$ref": "#/components/schemas/resource_contact_entry/properties/subsidiary_id" billing_address: "$ref": "#/components/schemas/resource_contact_entry/properties/billing_address" organization_id: "$ref": "#/components/schemas/resource_contact_entry/properties/organization_id" contactable_type: "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_type" purchase_order_id: "$ref": "#/components/schemas/resource_contact_entry/properties/purchase_order_id" invoice_template_id: "$ref": "#/components/schemas/resource_contact_entry/properties/invoice_template_id" description: Request body for creating or updating a contact entry. Specify the type (email, phone, address, website), the contact fields, and the parent relationship (company or person). Billing fields (billing_address, billing_email, VAT) are available when financials are enabled. expense: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_expense/properties/date" name: "$ref": "#/components/schemas/resource_expense/properties/name" amount: "$ref": "#/components/schemas/resource_expense/properties/amount" markup: "$ref": "#/components/schemas/resource_expense/properties/markup" pay_on: "$ref": "#/components/schemas/resource_expense/properties/pay_on" paid_on: "$ref": "#/components/schemas/resource_expense/properties/paid_on" currency: "$ref": "#/components/schemas/resource_expense/properties/currency" position: "$ref": "#/components/schemas/resource_expense/properties/position" quantity: "$ref": "#/components/schemas/resource_expense/properties/quantity" person_id: "$ref": "#/components/schemas/resource_expense/properties/person_id" vendor_id: "$ref": "#/components/schemas/resource_expense/properties/vendor_id" service_id: "$ref": "#/components/schemas/resource_expense/properties/service_id" tax_rate_id: "$ref": "#/components/schemas/resource_expense/properties/tax_rate_id" reimbursable: "$ref": "#/components/schemas/resource_expense/properties/reimbursable" attachment_id: "$ref": "#/components/schemas/resource_expense/properties/attachment_id" custom_fields: "$ref": "#/components/schemas/resource_expense/properties/custom_fields" reimbursed_on: "$ref": "#/components/schemas/resource_expense/properties/reimbursed_on" tax_inclusion: "$ref": "#/components/schemas/resource_expense/properties/tax_inclusion" billable_amount: "$ref": "#/components/schemas/resource_expense/properties/billable_amount" rejected_reason: "$ref": "#/components/schemas/resource_expense/properties/rejected_reason" purchase_order_id: "$ref": "#/components/schemas/resource_expense/properties/purchase_order_id" description: Request body for creating or updating an expense. task_list: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_task_list/properties/name" board_id: "$ref": "#/components/schemas/resource_task_list/properties/board_id" position: "$ref": "#/components/schemas/resource_task_list/properties/position" folder_id: "$ref": "#/components/schemas/resource_task_list/properties/folder_id" project_id: "$ref": "#/components/schemas/resource_task_list/properties/project_id" description: Request body for creating or updating a task list. Specify the project, optional board (folder), name, position, and placement. Use archived_at to archive the list. integration_exporter_configuration: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: company_id: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/company_id" company_type: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/company_type" datev_client_account_code: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/datev_client_account_code" datev_vendor_account_code: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/datev_vendor_account_code" description: Request body for creating or updating an integration exporter configuration. automatic_invoicing_rule: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: budget_id: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/budget_id" skip_weekends: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/skip_weekends" reference_date: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/reference_date" creation_offset: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/creation_offset" creation_offset_unit: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/creation_offset_unit" description: Request body for creating or updating an automatic invoicing rule. membership: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: deal_id: "$ref": "#/components/schemas/resource_membership/properties/deal_id" page_id: "$ref": "#/components/schemas/resource_membership/properties/page_id" agent_id: "$ref": "#/components/schemas/resource_membership/properties/agent_id" pulse_id: "$ref": "#/components/schemas/resource_membership/properties/pulse_id" filter_id: "$ref": "#/components/schemas/resource_membership/properties/filter_id" survey_id: "$ref": "#/components/schemas/resource_membership/properties/survey_id" project_id: "$ref": "#/components/schemas/resource_membership/properties/project_id" dashboard_id: "$ref": "#/components/schemas/resource_membership/properties/dashboard_id" description: Request body for creating or updating a membership. Specify the person or team, the target resource (project, deal, page, dashboard, filter, or survey), and the access type. Use type_id to set the permission level. booking: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_booking/properties/note" time: "$ref": "#/components/schemas/resource_booking/properties/time" draft: "$ref": "#/components/schemas/resource_booking/properties/draft" task_id: "$ref": "#/components/schemas/resource_booking/properties/task_id" ended_on: "$ref": "#/components/schemas/resource_booking/properties/ended_on" event_id: "$ref": "#/components/schemas/resource_booking/properties/event_id" origin_id: "$ref": "#/components/schemas/resource_booking/properties/origin_id" person_id: "$ref": "#/components/schemas/resource_booking/properties/person_id" percentage: "$ref": "#/components/schemas/resource_booking/properties/percentage" service_id: "$ref": "#/components/schemas/resource_booking/properties/service_id" started_on: "$ref": "#/components/schemas/resource_booking/properties/started_on" total_time: "$ref": "#/components/schemas/resource_booking/properties/total_time" approver_id: "$ref": "#/components/schemas/resource_booking/properties/approver_id" autotracking: "$ref": "#/components/schemas/resource_booking/properties/autotracking" custom_fields: "$ref": "#/components/schemas/resource_booking/properties/custom_fields" attachment_ids: "$ref": "#/components/schemas/resource_booking/properties/attachment_ids" rejected_reason: "$ref": "#/components/schemas/resource_booking/properties/rejected_reason" booking_method_id: "$ref": "#/components/schemas/resource_booking/properties/booking_method_id" resource_request_id: "$ref": "#/components/schemas/resource_booking/properties/resource_request_id" use_salary_currency: "$ref": "#/components/schemas/resource_booking/properties/use_salary_currency" description: Request body for creating or updating a booking. time_entry: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_time_entry/properties/date" note: "$ref": "#/components/schemas/resource_time_entry/properties/note" time: "$ref": "#/components/schemas/resource_time_entry/properties/time" task_id: "$ref": "#/components/schemas/resource_time_entry/properties/task_id" person_id: "$ref": "#/components/schemas/resource_time_entry/properties/person_id" service_id: "$ref": "#/components/schemas/resource_time_entry/properties/service_id" started_at: "$ref": "#/components/schemas/resource_time_entry/properties/started_at" billable_time: "$ref": "#/components/schemas/resource_time_entry/properties/billable_time" jira_issue_id: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id" jira_worklog_id: "$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id" calendar_event_id: "$ref": "#/components/schemas/resource_time_entry/properties/calendar_event_id" jira_issue_status: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status" jira_organization: "$ref": "#/components/schemas/resource_time_entry/properties/jira_organization" jira_issue_summary: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary" use_salary_currency: "$ref": "#/components/schemas/resource_time_entry/properties/use_salary_currency" description: Request body for creating or updating a time entry. timer: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: person_id: "$ref": "#/components/schemas/resource_timer/properties/person_id" service_id: "$ref": "#/components/schemas/resource_timer/properties/service_id" started_at: "$ref": "#/components/schemas/resource_timer/properties/started_at" time_entry_id: "$ref": "#/components/schemas/resource_timer/properties/time_entry_id" description: Request body for creating or updating a timer. deal_status: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_deal_status/properties/name" color_id: "$ref": "#/components/schemas/resource_deal_status/properties/color_id" position: "$ref": "#/components/schemas/resource_deal_status/properties/position" status_id: "$ref": "#/components/schemas/resource_deal_status/properties/status_id" pipeline_id: "$ref": "#/components/schemas/resource_deal_status/properties/pipeline_id" probability: "$ref": "#/components/schemas/resource_deal_status/properties/probability" lost_reason_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/lost_reason_enabled" probability_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/probability_enabled" time_tracking_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/time_tracking_enabled" booking_tracking_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/booking_tracking_enabled" expense_tracking_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/expense_tracking_enabled" description: Request body for creating or updating a deal status. Specify the pipeline, name, position, outcome category (status_id), color, and optional tracking flags for time, expenses, bookings, and probability. document_style: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_document_style/properties/name" styles: "$ref": "#/components/schemas/resource_document_style/properties/styles" attachment_ids: "$ref": "#/components/schemas/resource_document_style/properties/attachment_ids" description: Request body for creating or updating a document style. team: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_team/properties/name" icon_id: "$ref": "#/components/schemas/resource_team/properties/icon_id" color_id: "$ref": "#/components/schemas/resource_team/properties/color_id" description: Request body for creating or updating a team. Specify the team name. Members are managed via the team_memberships endpoint. bill: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_bill/properties/date" due_date: "$ref": "#/components/schemas/resource_bill/properties/due_date" attachment_id: "$ref": "#/components/schemas/resource_bill/properties/attachment_id" invoice_number: "$ref": "#/components/schemas/resource_bill/properties/invoice_number" purchase_order_id: "$ref": "#/components/schemas/resource_bill/properties/purchase_order_id" description: Request body for creating or updating a bill (vendor receipt). Specify the purchase order, date, due date, invoice number, description, currency, and total amounts. Attach a document via the attachment relationship. einvoice_configuration: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: mer_enabled: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/mer_enabled" face_enabled: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/face_enabled" ksef_enabled: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/ksef_enabled" mer_password: type: string title: Mer Password mer_username: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/mer_username" subsidiary_id: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/subsidiary_id" kpd_code_mapping: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/kpd_code_mapping" tax_rate_mapping: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/tax_rate_mapping" xrechnung_enabled: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/xrechnung_enabled" payment_means_type_id: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/payment_means_type_id" include_pdf_attachment: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/include_pdf_attachment" include_timesheet_attachment: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/include_timesheet_attachment" description: Request body for creating or updating an e-invoice configuration. rate_card: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_rate_card/properties/name" company_id: "$ref": "#/components/schemas/resource_rate_card/properties/company_id" description: Request body for creating or updating a rate card. Specify the name and optional company (for client-specific pricing). Prices within the rate card are managed via the prices endpoint. purchase_order: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_purchase_order/properties/note" deal_id: "$ref": "#/components/schemas/resource_purchase_order/properties/deal_id" sent_on: "$ref": "#/components/schemas/resource_purchase_order/properties/sent_on" subject: "$ref": "#/components/schemas/resource_purchase_order/properties/subject" currency: "$ref": "#/components/schemas/resource_purchase_order/properties/currency" issued_on: "$ref": "#/components/schemas/resource_purchase_order/properties/issued_on" status_id: "$ref": "#/components/schemas/resource_purchase_order/properties/status_id" vendor_id: "$ref": "#/components/schemas/resource_purchase_order/properties/vendor_id" delivery_on: "$ref": "#/components/schemas/resource_purchase_order/properties/delivery_on" attachment_id: "$ref": "#/components/schemas/resource_purchase_order/properties/attachment_id" subscriber_ids: "$ref": "#/components/schemas/resource_purchase_order/properties/subscriber_ids" document_type_id: "$ref": "#/components/schemas/resource_purchase_order/properties/document_type_id" description: Request body for creating or updating a purchase order. Specify the vendor company, deal (budget), document type, subject, status, dates, currency, note, and footer. Line items (expenses) are managed via associated bill records. dashboard: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_dashboard/properties/name" person_id: "$ref": "#/components/schemas/resource_dashboard/properties/person_id" is_private: "$ref": "#/components/schemas/resource_dashboard/properties/is_private" project_id: "$ref": "#/components/schemas/resource_dashboard/properties/project_id" subscriber_ids: "$ref": "#/components/schemas/resource_dashboard/properties/subscriber_ids" description: Request body for creating or updating a dashboard. purchase_order_send: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object required: - to - subject - body properties: cc: type: array items: type: string title: CC to: type: array items: type: string title: To bcc: type: array items: type: string title: BCC body: type: string title: Body from: type: string title: From subject: type: string title: Subject attachment_ids: type: array items: type: integer title: Attachment IDs description: Payload for sending a purchase order to the vendor via email. On success the purchase order is marked as sent today. tax_rate: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_tax_rate/properties/name" subsidiary_id: "$ref": "#/components/schemas/resource_tax_rate/properties/subsidiary_id" primary_component_name: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_name" primary_component_value: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_value" secondary_component_name: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_name" secondary_component_value: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_value" description: Request body for creating or updating a tax rate. section: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_section/properties/name" deal_id: "$ref": "#/components/schemas/resource_section/properties/deal_id" position: "$ref": "#/components/schemas/resource_section/properties/position" preferences: "$ref": "#/components/schemas/resource_section/properties/preferences" editor_config: "$ref": "#/components/schemas/resource_section/properties/editor_config" description: Request body for creating or updating a section. deal: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_deal/properties/date" name: "$ref": "#/components/schemas/resource_deal/properties/name" note: "$ref": "#/components/schemas/resource_deal/properties/note" budget: "$ref": "#/components/schemas/resource_deal/properties/budget" color_id: "$ref": "#/components/schemas/resource_deal/properties/color_id" currency: "$ref": "#/components/schemas/resource_deal/properties/currency" end_date: "$ref": "#/components/schemas/resource_deal/properties/end_date" position: "$ref": "#/components/schemas/resource_deal/properties/position" tag_list: "$ref": "#/components/schemas/resource_deal/properties/tag_list" company_id: "$ref": "#/components/schemas/resource_deal/properties/company_id" contact_id: "$ref": "#/components/schemas/resource_deal/properties/contact_id" deal_value: "$ref": "#/components/schemas/resource_deal/properties/deal_value" open_hours: "$ref": "#/components/schemas/resource_deal/properties/open_hours" project_id: "$ref": "#/components/schemas/resource_deal/properties/project_id" probability: "$ref": "#/components/schemas/resource_deal/properties/probability" tax_rate_id: "$ref": "#/components/schemas/resource_deal/properties/tax_rate_id" deal_type_id: "$ref": "#/components/schemas/resource_deal/properties/deal_type_id" delivered_on: "$ref": "#/components/schemas/resource_deal/properties/delivered_on" lost_comment: "$ref": "#/components/schemas/resource_deal/properties/lost_comment" client_access: "$ref": "#/components/schemas/resource_deal/properties/client_access" custom_fields: "$ref": "#/components/schemas/resource_deal/properties/custom_fields" editor_config: "$ref": "#/components/schemas/resource_deal/properties/editor_config" proposal_note: "$ref": "#/components/schemas/resource_deal/properties/proposal_note" subsidiary_id: "$ref": "#/components/schemas/resource_deal/properties/subsidiary_id" time_approval: "$ref": "#/components/schemas/resource_deal/properties/time_approval" budget_warning: "$ref": "#/components/schemas/resource_deal/properties/budget_warning" deal_status_id: "$ref": "#/components/schemas/resource_deal/properties/deal_status_id" lost_reason_id: "$ref": "#/components/schemas/resource_deal/properties/lost_reason_id" origin_deal_id: "$ref": "#/components/schemas/resource_deal/properties/origin_deal_id" responsible_id: "$ref": "#/components/schemas/resource_deal/properties/responsible_id" subscriber_ids: "$ref": "#/components/schemas/resource_deal/properties/subscriber_ids" man_day_minutes: "$ref": "#/components/schemas/resource_deal/properties/man_day_minutes" sales_closed_on: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_on" document_type_id: "$ref": "#/components/schemas/resource_deal/properties/document_type_id" expense_approval: "$ref": "#/components/schemas/resource_deal/properties/expense_approval" tracking_type_id: "$ref": "#/components/schemas/resource_deal/properties/tracking_type_id" deal_value_source: "$ref": "#/components/schemas/resource_deal/properties/deal_value_source" retainer_interval: "$ref": "#/components/schemas/resource_deal/properties/retainer_interval" rounding_method_id: "$ref": "#/components/schemas/resource_deal/properties/rounding_method_id" rounding_interval_id: "$ref": "#/components/schemas/resource_deal/properties/rounding_interval_id" purchase_order_number: "$ref": "#/components/schemas/resource_deal/properties/purchase_order_number" designated_approver_id: "$ref": "#/components/schemas/resource_deal/properties/designated_approver_id" destroy_future_bookings: "$ref": "#/components/schemas/resource_deal/properties/destroy_future_bookings" manual_invoicing_reason: "$ref": "#/components/schemas/resource_deal/properties/manual_invoicing_reason" retainer_interval_count: "$ref": "#/components/schemas/resource_deal/properties/retainer_interval_count" retainer_deal_value_type: "$ref": "#/components/schemas/resource_deal/properties/retainer_deal_value_type" proposal_document_type_id: "$ref": "#/components/schemas/resource_deal/properties/proposal_document_type_id" revenue_distribution_type: "$ref": "#/components/schemas/resource_deal/properties/revenue_distribution_type" manual_invoicing_status_id: "$ref": "#/components/schemas/resource_deal/properties/manual_invoicing_status_id" revenue_distribution_method: "$ref": "#/components/schemas/resource_deal/properties/revenue_distribution_method" validate_expense_when_closing: "$ref": "#/components/schemas/resource_deal/properties/validate_expense_when_closing" service_type_restricted_tracking: "$ref": "#/components/schemas/resource_deal/properties/service_type_restricted_tracking" description: Request body for creating or updating a deal. todo: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: closed: "$ref": "#/components/schemas/resource_todo/properties/closed" deal_id: "$ref": "#/components/schemas/resource_todo/properties/deal_id" task_id: "$ref": "#/components/schemas/resource_todo/properties/task_id" due_date: "$ref": "#/components/schemas/resource_todo/properties/due_date" due_time: "$ref": "#/components/schemas/resource_todo/properties/due_time" position: "$ref": "#/components/schemas/resource_todo/properties/position" assignee_id: "$ref": "#/components/schemas/resource_todo/properties/assignee_id" description: Request body for creating or updating a todo (checklist item). Specify the description, parent resource (task or deal), optional assignee, due date, due time, and position. Set closed_at to mark as complete. send_einvoice: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: format_id: enum: - 1 - 3 - 4 - 5 type: integer title: Format business_process: type: string title: Business Process description: Request body for sending an invoice as an e-invoice. attachment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_attachment/properties/name" size: "$ref": "#/components/schemas/resource_attachment/properties/size" bill_id: "$ref": "#/components/schemas/resource_attachment/properties/bill_id" page_id: "$ref": "#/components/schemas/resource_attachment/properties/page_id" task_id: "$ref": "#/components/schemas/resource_attachment/properties/task_id" temp_url: "$ref": "#/components/schemas/resource_attachment/properties/temp_url" widget_id: "$ref": "#/components/schemas/resource_attachment/properties/widget_id" booking_id: "$ref": "#/components/schemas/resource_attachment/properties/booking_id" comment_id: "$ref": "#/components/schemas/resource_attachment/properties/comment_id" expense_id: "$ref": "#/components/schemas/resource_attachment/properties/expense_id" invoice_id: "$ref": "#/components/schemas/resource_attachment/properties/invoice_id" content_type: "$ref": "#/components/schemas/resource_attachment/properties/content_type" attachable_type: "$ref": "#/components/schemas/resource_attachment/properties/attachable_type" attachment_type: "$ref": "#/components/schemas/resource_attachment/properties/attachment_type" file_updated_at: "$ref": "#/components/schemas/resource_attachment/properties/file_updated_at" document_type_id: "$ref": "#/components/schemas/resource_attachment/properties/document_type_id" document_style_id: "$ref": "#/components/schemas/resource_attachment/properties/document_style_id" purchase_order_id: "$ref": "#/components/schemas/resource_attachment/properties/purchase_order_id" description: Request body for uploading an attachment. Provide the file data and the parent resource relationship (comment, task, deal, page, invoice, expense, purchase order, or bill). Supports direct upload via temp_url workflow. board: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_board/properties/name" hidden: "$ref": "#/components/schemas/resource_board/properties/hidden" position: "$ref": "#/components/schemas/resource_board/properties/position" project_id: "$ref": "#/components/schemas/resource_board/properties/project_id" description: Request body for creating or updating a board (folder). Specify the project, name, position, placement (top or bottom), and optional archived status or hidden flag. event: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_event/properties/name" icon_id: "$ref": "#/components/schemas/resource_event/properties/icon_id" color_id: "$ref": "#/components/schemas/resource_event/properties/color_id" absence_type: "$ref": "#/components/schemas/resource_event/properties/absence_type" event_type_id: "$ref": "#/components/schemas/resource_event/properties/event_type_id" half_day_bookings: "$ref": "#/components/schemas/resource_event/properties/half_day_bookings" limitation_type_id: "$ref": "#/components/schemas/resource_event/properties/limitation_type_id" sync_personal_integrations: "$ref": "#/components/schemas/resource_event/properties/sync_personal_integrations" description: Request body for creating or updating an absence category. einvoice_identity: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: dire_code: "$ref": "#/components/schemas/resource_einvoice_identity/properties/dire_code" peppol_id: "$ref": "#/components/schemas/resource_einvoice_identity/properties/peppol_id" company_id: "$ref": "#/components/schemas/resource_einvoice_identity/properties/company_id" subsidiary_id: "$ref": "#/components/schemas/resource_einvoice_identity/properties/subsidiary_id" buyer_reference: "$ref": "#/components/schemas/resource_einvoice_identity/properties/buyer_reference" dir3_fiscal_code: "$ref": "#/components/schemas/resource_einvoice_identity/properties/dir3_fiscal_code" dir3_pagador_code: "$ref": "#/components/schemas/resource_einvoice_identity/properties/dir3_pagador_code" dir3_receptor_code: "$ref": "#/components/schemas/resource_einvoice_identity/properties/dir3_receptor_code" is_government_entity: "$ref": "#/components/schemas/resource_einvoice_identity/properties/is_government_entity" description: Request body for creating or updating an e-invoice identity. invitation: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: password: "$ref": "#/components/schemas/resource_invitation/properties/password" last_name: "$ref": "#/components/schemas/resource_invitation/properties/last_name" first_name: "$ref": "#/components/schemas/resource_invitation/properties/first_name" newsletter_consent: "$ref": "#/components/schemas/resource_invitation/properties/newsletter_consent" description: Request body for creating or updating an invitation. service: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_service/properties/name" price: "$ref": "#/components/schemas/resource_service/properties/price" markup: "$ref": "#/components/schemas/resource_service/properties/markup" deal_id: "$ref": "#/components/schemas/resource_service/properties/deal_id" unit_id: "$ref": "#/components/schemas/resource_service/properties/unit_id" discount: "$ref": "#/components/schemas/resource_service/properties/discount" position: "$ref": "#/components/schemas/resource_service/properties/position" quantity: "$ref": "#/components/schemas/resource_service/properties/quantity" person_id: "$ref": "#/components/schemas/resource_service/properties/person_id" section_id: "$ref": "#/components/schemas/resource_service/properties/section_id" custom_fields: "$ref": "#/components/schemas/resource_service/properties/custom_fields" editor_config: "$ref": "#/components/schemas/resource_service/properties/editor_config" estimated_cost: "$ref": "#/components/schemas/resource_service/properties/estimated_cost" estimated_time: "$ref": "#/components/schemas/resource_service/properties/estimated_time" billing_type_id: "$ref": "#/components/schemas/resource_service/properties/billing_type_id" limitation_type: "$ref": "#/components/schemas/resource_service/properties/limitation_type" service_type_id: "$ref": "#/components/schemas/resource_service/properties/service_type_id" rolled_over_time: "$ref": "#/components/schemas/resource_service/properties/rolled_over_time" budget_cap_enabled: "$ref": "#/components/schemas/resource_service/properties/budget_cap_enabled" time_tracking_enabled: "$ref": "#/components/schemas/resource_service/properties/time_tracking_enabled" booking_tracking_enabled: "$ref": "#/components/schemas/resource_service/properties/booking_tracking_enabled" expense_tracking_enabled: "$ref": "#/components/schemas/resource_service/properties/expense_tracking_enabled" description: Request body for creating or updating a service. contract: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: ends_on: "$ref": "#/components/schemas/resource_contract/properties/ends_on" interval_id: "$ref": "#/components/schemas/resource_contract/properties/interval_id" template_id: "$ref": "#/components/schemas/resource_contract/properties/template_id" copy_expenses: "$ref": "#/components/schemas/resource_contract/properties/copy_expenses" next_occurrence_on: "$ref": "#/components/schemas/resource_contract/properties/next_occurrence_on" use_rollover_hours: "$ref": "#/components/schemas/resource_contract/properties/use_rollover_hours" copy_purchase_order_number: "$ref": "#/components/schemas/resource_contract/properties/copy_purchase_order_number" description: Request body for creating or updating a contract (recurring retainer). Specify the template deal, interval (monthly, quarterly, etc.), start and end dates, and options for rolling over hours and copying purchase order numbers and expenses. salary: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: cost: "$ref": "#/components/schemas/resource_salary/properties/cost" note: "$ref": "#/components/schemas/resource_salary/properties/note" currency: "$ref": "#/components/schemas/resource_salary/properties/currency" ended_on: "$ref": "#/components/schemas/resource_salary/properties/ended_on" overhead: "$ref": "#/components/schemas/resource_salary/properties/overhead" person_id: "$ref": "#/components/schemas/resource_salary/properties/person_id" started_on: "$ref": "#/components/schemas/resource_salary/properties/started_on" working_hours: "$ref": "#/components/schemas/resource_salary/properties/working_hours" salary_type_id: "$ref": "#/components/schemas/resource_salary/properties/salary_type_id" alternating_hours: "$ref": "#/components/schemas/resource_salary/properties/alternating_hours" holiday_calendar_id: "$ref": "#/components/schemas/resource_salary/properties/holiday_calendar_id" description: Request body for creating or updating a salary (cost rate and working capacity record, called an Engagement internally). Specify the person, start/end dates, hourly cost rate, working hours, salary type, overhead inclusion flag, and optionally a holiday calendar. price: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_price/properties/name" rate: "$ref": "#/components/schemas/resource_price/properties/rate" markup: "$ref": "#/components/schemas/resource_price/properties/markup" unit_id: "$ref": "#/components/schemas/resource_price/properties/unit_id" currency: "$ref": "#/components/schemas/resource_price/properties/currency" discount: "$ref": "#/components/schemas/resource_price/properties/discount" quantity: "$ref": "#/components/schemas/resource_price/properties/quantity" company_id: "$ref": "#/components/schemas/resource_price/properties/company_id" rate_card_id: "$ref": "#/components/schemas/resource_price/properties/rate_card_id" custom_fields: "$ref": "#/components/schemas/resource_price/properties/custom_fields" editor_config: "$ref": "#/components/schemas/resource_price/properties/editor_config" estimated_cost: "$ref": "#/components/schemas/resource_price/properties/estimated_cost" billing_type_id: "$ref": "#/components/schemas/resource_price/properties/billing_type_id" estimated_hours: "$ref": "#/components/schemas/resource_price/properties/estimated_hours" service_type_id: "$ref": "#/components/schemas/resource_price/properties/service_type_id" budget_cap_enabled: "$ref": "#/components/schemas/resource_price/properties/budget_cap_enabled" time_tracking_enabled: "$ref": "#/components/schemas/resource_price/properties/time_tracking_enabled" booking_tracking_enabled: "$ref": "#/components/schemas/resource_price/properties/booking_tracking_enabled" expense_tracking_enabled: "$ref": "#/components/schemas/resource_price/properties/expense_tracking_enabled" description: Request body for creating or updating a price (rate card line item). Specify the rate card, service type, billing type, unit, rate, quantity, and optional tracking defaults (time, bookings, expenses), discount, markup, and budget cap configuration. survey: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: title: "$ref": "#/components/schemas/resource_survey/properties/title" project_id: "$ref": "#/components/schemas/resource_survey/properties/project_id" submission_access: "$ref": "#/components/schemas/resource_survey/properties/submission_access" description: Request body for creating or updating a survey. Specify the project, name, and configuration. Survey fields are managed separately via the survey_fields endpoint. team_membership: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: team_id: "$ref": "#/components/schemas/resource_team_membership/properties/team_id" person_id: "$ref": "#/components/schemas/resource_team_membership/properties/person_id" description: Request body for creating or deleting a team membership. Specify the team and person to add as a member. responses: single_contact_entry: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: vat: "$ref": "#/components/schemas/resource_contact_entry/properties/vat" city: "$ref": "#/components/schemas/resource_contact_entry/properties/city" name: "$ref": "#/components/schemas/resource_contact_entry/properties/name" type: "$ref": "#/components/schemas/resource_contact_entry/properties/type" email: "$ref": "#/components/schemas/resource_contact_entry/properties/email" phone: "$ref": "#/components/schemas/resource_contact_entry/properties/phone" state: "$ref": "#/components/schemas/resource_contact_entry/properties/state" address: "$ref": "#/components/schemas/resource_contact_entry/properties/address" country: "$ref": "#/components/schemas/resource_contact_entry/properties/country" website: "$ref": "#/components/schemas/resource_contact_entry/properties/website" zipcode: "$ref": "#/components/schemas/resource_contact_entry/properties/zipcode" billing_email: "$ref": "#/components/schemas/resource_contact_entry/properties/billing_email" billing_address: "$ref": "#/components/schemas/resource_contact_entry/properties/billing_address" contactable_type: "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_type" relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" purchase_order: "$ref": "#/components/schemas/_single_relationship" invoice_template: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single contact entry collection_session: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_session/properties/name" note: "$ref": "#/components/schemas/resource_session/properties/note" token: "$ref": "#/components/schemas/resource_session/properties/token" device: "$ref": "#/components/schemas/resource_session/properties/device" browser: "$ref": "#/components/schemas/resource_session/properties/browser" last_ip: "$ref": "#/components/schemas/resource_session/properties/last_ip" machine: "$ref": "#/components/schemas/resource_session/properties/machine" user_id: "$ref": "#/components/schemas/resource_session/properties/user_id" location: "$ref": "#/components/schemas/resource_session/properties/location" platform: "$ref": "#/components/schemas/resource_session/properties/platform" read_only: "$ref": "#/components/schemas/resource_session/properties/read_only" agent_avatar: "$ref": "#/components/schemas/resource_session/properties/agent_avatar" single_sign_on: "$ref": "#/components/schemas/resource_session/properties/single_sign_on" agent_last_name: "$ref": "#/components/schemas/resource_session/properties/agent_last_name" two_factor_auth: "$ref": "#/components/schemas/resource_session/properties/two_factor_auth" agent_first_name: "$ref": "#/components/schemas/resource_session/properties/agent_first_name" last_activity_at: "$ref": "#/components/schemas/resource_session/properties/last_activity_at" token_expires_at: "$ref": "#/components/schemas/resource_session/properties/token_expires_at" relationships: type: object properties: user: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection session single_discussion: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: excerpt: "$ref": "#/components/schemas/resource_discussion/properties/excerpt" resolved_at: "$ref": "#/components/schemas/resource_discussion/properties/resolved_at" subscriber_ids: "$ref": "#/components/schemas/resource_discussion/properties/subscriber_ids" relationships: type: object properties: page: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single discussion single_salary: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: cost: "$ref": "#/components/schemas/resource_salary/properties/cost" note: "$ref": "#/components/schemas/resource_salary/properties/note" currency: "$ref": "#/components/schemas/resource_salary/properties/currency" ended_on: "$ref": "#/components/schemas/resource_salary/properties/ended_on" overhead: "$ref": "#/components/schemas/resource_salary/properties/overhead" started_on: "$ref": "#/components/schemas/resource_salary/properties/started_on" hourly_rate: "$ref": "#/components/schemas/resource_salary/properties/hourly_rate" cost_default: "$ref": "#/components/schemas/resource_salary/properties/cost_default" exchange_date: "$ref": "#/components/schemas/resource_salary/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_salary/properties/exchange_rate" working_hours: "$ref": "#/components/schemas/resource_salary/properties/working_hours" default_salary: "$ref": "#/components/schemas/resource_salary/properties/default_salary" salary_type_id: "$ref": "#/components/schemas/resource_salary/properties/salary_type_id" cost_normalized: "$ref": "#/components/schemas/resource_salary/properties/cost_normalized" currency_default: "$ref": "#/components/schemas/resource_salary/properties/currency_default" alternating_hours: "$ref": "#/components/schemas/resource_salary/properties/alternating_hours" currency_normalized: "$ref": "#/components/schemas/resource_salary/properties/currency_normalized" hourly_rate_default: "$ref": "#/components/schemas/resource_salary/properties/hourly_rate_default" hourly_rate_normalized: "$ref": "#/components/schemas/resource_salary/properties/hourly_rate_normalized" relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" holiday_calendar: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single salary collection_user: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: email: "$ref": "#/components/schemas/resource_user/properties/email" flags: "$ref": "#/components/schemas/resource_user/properties/flags" locale: "$ref": "#/components/schemas/resource_user/properties/locale" sysadmin: "$ref": "#/components/schemas/resource_user/properties/sysadmin" last_name: "$ref": "#/components/schemas/resource_user/properties/last_name" time_zone: "$ref": "#/components/schemas/resource_user/properties/time_zone" avatar_url: "$ref": "#/components/schemas/resource_user/properties/avatar_url" first_name: "$ref": "#/components/schemas/resource_user/properties/first_name" ical_token: "$ref": "#/components/schemas/resource_user/properties/ical_token" updated_at: "$ref": "#/components/schemas/resource_user/properties/updated_at" preferences: "$ref": "#/components/schemas/resource_user/properties/preferences" intercom_hash: "$ref": "#/components/schemas/resource_user/properties/intercom_hash" sso_provision: "$ref": "#/components/schemas/resource_user/properties/sso_provision" two_factor_auth: "$ref": "#/components/schemas/resource_user/properties/two_factor_auth" newsletter_consent: "$ref": "#/components/schemas/resource_user/properties/newsletter_consent" sysadmin_permissions: "$ref": "#/components/schemas/resource_user/properties/sysadmin_permissions" newsletter_consent_at: "$ref": "#/components/schemas/resource_user/properties/newsletter_consent_at" default_organization_id: "$ref": "#/components/schemas/resource_user/properties/default_organization_id" account_access_expires_at: "$ref": "#/components/schemas/resource_user/properties/account_access_expires_at" default_organization_slug: "$ref": "#/components/schemas/resource_user/properties/default_organization_slug" relationships: type: object properties: {} meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection user single_custom_field_option: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_custom_field_option/properties/name" color_id: "$ref": "#/components/schemas/resource_custom_field_option/properties/color_id" position: "$ref": "#/components/schemas/resource_custom_field_option/properties/position" archived_at: "$ref": "#/components/schemas/resource_custom_field_option/properties/archived_at" relationships: type: object properties: custom_field: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single custom field option collection_service: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: cost: "$ref": "#/components/schemas/resource_service/properties/cost" name: "$ref": "#/components/schemas/resource_service/properties/name" price: "$ref": "#/components/schemas/resource_service/properties/price" markup: "$ref": "#/components/schemas/resource_service/properties/markup" profit: "$ref": "#/components/schemas/resource_service/properties/profit" revenue: "$ref": "#/components/schemas/resource_service/properties/revenue" unit_id: "$ref": "#/components/schemas/resource_service/properties/unit_id" billable: "$ref": "#/components/schemas/resource_service/properties/billable" currency: "$ref": "#/components/schemas/resource_service/properties/currency" discount: "$ref": "#/components/schemas/resource_service/properties/discount" position: "$ref": "#/components/schemas/resource_service/properties/position" quantity: "$ref": "#/components/schemas/resource_service/properties/quantity" work_cost: "$ref": "#/components/schemas/resource_service/properties/work_cost" deleted_at: "$ref": "#/components/schemas/resource_service/properties/deleted_at" booked_time: "$ref": "#/components/schemas/resource_service/properties/booked_time" budget_used: "$ref": "#/components/schemas/resource_service/properties/budget_used" future_cost: "$ref": "#/components/schemas/resource_service/properties/future_cost" worked_time: "$ref": "#/components/schemas/resource_service/properties/worked_time" budget_total: "$ref": "#/components/schemas/resource_service/properties/budget_total" cost_default: "$ref": "#/components/schemas/resource_service/properties/cost_default" billable_time: "$ref": "#/components/schemas/resource_service/properties/billable_time" budgeted_time: "$ref": "#/components/schemas/resource_service/properties/budgeted_time" custom_fields: "$ref": "#/components/schemas/resource_service/properties/custom_fields" editor_config: "$ref": "#/components/schemas/resource_service/properties/editor_config" markup_amount: "$ref": "#/components/schemas/resource_service/properties/markup_amount" price_default: "$ref": "#/components/schemas/resource_service/properties/price_default" profit_margin: "$ref": "#/components/schemas/resource_service/properties/profit_margin" estimated_cost: "$ref": "#/components/schemas/resource_service/properties/estimated_cost" estimated_time: "$ref": "#/components/schemas/resource_service/properties/estimated_time" expense_amount: "$ref": "#/components/schemas/resource_service/properties/expense_amount" future_revenue: "$ref": "#/components/schemas/resource_service/properties/future_revenue" profit_default: "$ref": "#/components/schemas/resource_service/properties/profit_default" billing_type_id: "$ref": "#/components/schemas/resource_service/properties/billing_type_id" cost_normalized: "$ref": "#/components/schemas/resource_service/properties/cost_normalized" discount_amount: "$ref": "#/components/schemas/resource_service/properties/discount_amount" limitation_type: "$ref": "#/components/schemas/resource_service/properties/limitation_type" revenue_default: "$ref": "#/components/schemas/resource_service/properties/revenue_default" unapproved_time: "$ref": "#/components/schemas/resource_service/properties/unapproved_time" currency_default: "$ref": "#/components/schemas/resource_service/properties/currency_default" price_normalized: "$ref": "#/components/schemas/resource_service/properties/price_normalized" rolled_over_time: "$ref": "#/components/schemas/resource_service/properties/rolled_over_time" origin_service_id: "$ref": "#/components/schemas/resource_service/properties/origin_service_id" profit_normalized: "$ref": "#/components/schemas/resource_service/properties/profit_normalized" projected_revenue: "$ref": "#/components/schemas/resource_service/properties/projected_revenue" work_cost_default: "$ref": "#/components/schemas/resource_service/properties/work_cost_default" budget_cap_enabled: "$ref": "#/components/schemas/resource_service/properties/budget_cap_enabled" future_booked_time: "$ref": "#/components/schemas/resource_service/properties/future_booked_time" future_budget_used: "$ref": "#/components/schemas/resource_service/properties/future_budget_used" initial_service_id: "$ref": "#/components/schemas/resource_service/properties/initial_service_id" revenue_normalized: "$ref": "#/components/schemas/resource_service/properties/revenue_normalized" budget_used_default: "$ref": "#/components/schemas/resource_service/properties/budget_used_default" currency_normalized: "$ref": "#/components/schemas/resource_service/properties/currency_normalized" future_cost_default: "$ref": "#/components/schemas/resource_service/properties/future_cost_default" budget_total_default: "$ref": "#/components/schemas/resource_service/properties/budget_total_default" work_cost_normalized: "$ref": "#/components/schemas/resource_service/properties/work_cost_normalized" markup_amount_default: "$ref": "#/components/schemas/resource_service/properties/markup_amount_default" time_tracking_enabled: "$ref": "#/components/schemas/resource_service/properties/time_tracking_enabled" budget_used_normalized: "$ref": "#/components/schemas/resource_service/properties/budget_used_normalized" estimated_cost_default: "$ref": "#/components/schemas/resource_service/properties/estimated_cost_default" expense_amount_default: "$ref": "#/components/schemas/resource_service/properties/expense_amount_default" future_cost_normalized: "$ref": "#/components/schemas/resource_service/properties/future_cost_normalized" future_revenue_default: "$ref": "#/components/schemas/resource_service/properties/future_revenue_default" budget_total_normalized: "$ref": "#/components/schemas/resource_service/properties/budget_total_normalized" discount_amount_default: "$ref": "#/components/schemas/resource_service/properties/discount_amount_default" expense_billable_amount: "$ref": "#/components/schemas/resource_service/properties/expense_billable_amount" booking_tracking_enabled: "$ref": "#/components/schemas/resource_service/properties/booking_tracking_enabled" expense_tracking_enabled: "$ref": "#/components/schemas/resource_service/properties/expense_tracking_enabled" markup_amount_normalized: "$ref": "#/components/schemas/resource_service/properties/markup_amount_normalized" estimated_cost_normalized: "$ref": "#/components/schemas/resource_service/properties/estimated_cost_normalized" expense_amount_normalized: "$ref": "#/components/schemas/resource_service/properties/expense_amount_normalized" future_revenue_normalized: "$ref": "#/components/schemas/resource_service/properties/future_revenue_normalized" projected_revenue_default: "$ref": "#/components/schemas/resource_service/properties/projected_revenue_default" discount_amount_normalized: "$ref": "#/components/schemas/resource_service/properties/discount_amount_normalized" future_budget_used_default: "$ref": "#/components/schemas/resource_service/properties/future_budget_used_default" projected_revenue_normalized: "$ref": "#/components/schemas/resource_service/properties/projected_revenue_normalized" future_budget_used_normalized: "$ref": "#/components/schemas/resource_service/properties/future_budget_used_normalized" expense_billable_amount_default: "$ref": "#/components/schemas/resource_service/properties/expense_billable_amount_default" expense_billable_amount_normalized: "$ref": "#/components/schemas/resource_service/properties/expense_billable_amount_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" section: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection service single_bill: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_bill/properties/date" currency: "$ref": "#/components/schemas/resource_bill/properties/currency" due_date: "$ref": "#/components/schemas/resource_bill/properties/due_date" created_at: "$ref": "#/components/schemas/resource_bill/properties/created_at" deleted_at: "$ref": "#/components/schemas/resource_bill/properties/deleted_at" total_cost: "$ref": "#/components/schemas/resource_bill/properties/total_cost" invoice_number: "$ref": "#/components/schemas/resource_bill/properties/invoice_number" total_received: "$ref": "#/components/schemas/resource_bill/properties/total_received" currency_default: "$ref": "#/components/schemas/resource_bill/properties/currency_default" total_cost_default: "$ref": "#/components/schemas/resource_bill/properties/total_cost_default" currency_normalized: "$ref": "#/components/schemas/resource_bill/properties/currency_normalized" total_cost_normalized: "$ref": "#/components/schemas/resource_bill/properties/total_cost_normalized" total_received_default: "$ref": "#/components/schemas/resource_bill/properties/total_received_default" total_received_normalized: "$ref": "#/components/schemas/resource_bill/properties/total_received_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" attachment: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" purchase_order: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single bill single_service_type: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_service_type/properties/name" archived_at: "$ref": "#/components/schemas/resource_service_type/properties/archived_at" relationships: type: object properties: assignees: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single service type single_pulse: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: type_id: "$ref": "#/components/schemas/resource_pulse/properties/type_id" recipients: "$ref": "#/components/schemas/resource_pulse/properties/recipients" teams_team: "$ref": "#/components/schemas/resource_pulse/properties/teams_team" test_pulse: "$ref": "#/components/schemas/resource_pulse/properties/test_pulse" export_params: "$ref": "#/components/schemas/resource_pulse/properties/export_params" schedule_hour: "$ref": "#/components/schemas/resource_pulse/properties/schedule_hour" skip_if_empty: "$ref": "#/components/schemas/resource_pulse/properties/skip_if_empty" slack_channel: "$ref": "#/components/schemas/resource_pulse/properties/slack_channel" teams_channel: "$ref": "#/components/schemas/resource_pulse/properties/teams_channel" deactivated_at: "$ref": "#/components/schemas/resource_pulse/properties/deactivated_at" schedule_day_id: "$ref": "#/components/schemas/resource_pulse/properties/schedule_day_id" schedule_frame_id: "$ref": "#/components/schemas/resource_pulse/properties/schedule_frame_id" document_format_id: "$ref": "#/components/schemas/resource_pulse/properties/document_format_id" repeat_schedule_id: "$ref": "#/components/schemas/resource_pulse/properties/repeat_schedule_id" relationships: type: object properties: filter: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" memberships: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single pulse collection_event: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_event/properties/name" icon_id: "$ref": "#/components/schemas/resource_event/properties/icon_id" color_id: "$ref": "#/components/schemas/resource_event/properties/color_id" archived_at: "$ref": "#/components/schemas/resource_event/properties/archived_at" description: "$ref": "#/components/schemas/resource_event/properties/description" absence_type: "$ref": "#/components/schemas/resource_event/properties/absence_type" event_type_id: "$ref": "#/components/schemas/resource_event/properties/event_type_id" half_day_bookings: "$ref": "#/components/schemas/resource_event/properties/half_day_bookings" limitation_type_id: "$ref": "#/components/schemas/resource_event/properties/limitation_type_id" sync_personal_integrations: "$ref": "#/components/schemas/resource_event/properties/sync_personal_integrations" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection event single_role: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_role/properties/name" description: "$ref": "#/components/schemas/resource_role/properties/description" permissions: "$ref": "#/components/schemas/resource_role/properties/permissions" base_role_id: "$ref": "#/components/schemas/resource_role/properties/base_role_id" people_count: "$ref": "#/components/schemas/resource_role/properties/people_count" user_type_id: "$ref": "#/components/schemas/resource_role/properties/user_type_id" editable_by_user: "$ref": "#/components/schemas/resource_role/properties/editable_by_user" active_users_count: "$ref": "#/components/schemas/resource_role/properties/active_users_count" active_agents_count: "$ref": "#/components/schemas/resource_role/properties/active_agents_count" inactive_users_count: "$ref": "#/components/schemas/resource_role/properties/inactive_users_count" resolved_permissions: "$ref": "#/components/schemas/resource_role/properties/resolved_permissions" inactive_agents_count: "$ref": "#/components/schemas/resource_role/properties/inactive_agents_count" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single role collection_einvoice_configuration: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: created_at: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/updated_at" mer_enabled: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/mer_enabled" face_enabled: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/face_enabled" ksef_enabled: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/ksef_enabled" mer_username: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/mer_username" kpd_code_mapping: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/kpd_code_mapping" tax_rate_mapping: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/tax_rate_mapping" xrechnung_enabled: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/xrechnung_enabled" payment_means_type_id: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/payment_means_type_id" include_pdf_attachment: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/include_pdf_attachment" include_timesheet_attachment: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/include_timesheet_attachment" relationships: type: object properties: subsidiary: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Successful response containing a list of e-invoice configuration resources. single_workflow_status: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_workflow_status/properties/name" color_id: "$ref": "#/components/schemas/resource_workflow_status/properties/color_id" position: "$ref": "#/components/schemas/resource_workflow_status/properties/position" category_id: "$ref": "#/components/schemas/resource_workflow_status/properties/category_id" relationships: type: object properties: workflow: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single workflow status single_payment_reminder_sequence: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/name" created_at: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/updated_at" default_sequence: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/default_sequence" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" payment_reminders: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single payment reminder sequence single_service_assignment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: {} relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single service assignment single_user: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: email: "$ref": "#/components/schemas/resource_user/properties/email" flags: "$ref": "#/components/schemas/resource_user/properties/flags" locale: "$ref": "#/components/schemas/resource_user/properties/locale" sysadmin: "$ref": "#/components/schemas/resource_user/properties/sysadmin" last_name: "$ref": "#/components/schemas/resource_user/properties/last_name" time_zone: "$ref": "#/components/schemas/resource_user/properties/time_zone" avatar_url: "$ref": "#/components/schemas/resource_user/properties/avatar_url" first_name: "$ref": "#/components/schemas/resource_user/properties/first_name" ical_token: "$ref": "#/components/schemas/resource_user/properties/ical_token" updated_at: "$ref": "#/components/schemas/resource_user/properties/updated_at" preferences: "$ref": "#/components/schemas/resource_user/properties/preferences" intercom_hash: "$ref": "#/components/schemas/resource_user/properties/intercom_hash" sso_provision: "$ref": "#/components/schemas/resource_user/properties/sso_provision" two_factor_auth: "$ref": "#/components/schemas/resource_user/properties/two_factor_auth" newsletter_consent: "$ref": "#/components/schemas/resource_user/properties/newsletter_consent" sysadmin_permissions: "$ref": "#/components/schemas/resource_user/properties/sysadmin_permissions" newsletter_consent_at: "$ref": "#/components/schemas/resource_user/properties/newsletter_consent_at" default_organization_id: "$ref": "#/components/schemas/resource_user/properties/default_organization_id" account_access_expires_at: "$ref": "#/components/schemas/resource_user/properties/account_access_expires_at" default_organization_slug: "$ref": "#/components/schemas/resource_user/properties/default_organization_slug" relationships: type: object properties: {} meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single user single_filter: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_filter/properties/name" hidden: "$ref": "#/components/schemas/resource_filter/properties/hidden" params: "$ref": "#/components/schemas/resource_filter/properties/params" public: "$ref": "#/components/schemas/resource_filter/properties/public" report: "$ref": "#/components/schemas/resource_filter/properties/report" shared: "$ref": "#/components/schemas/resource_filter/properties/shared" columns: "$ref": "#/components/schemas/resource_filter/properties/columns" default: "$ref": "#/components/schemas/resource_filter/properties/default" sort_by: "$ref": "#/components/schemas/resource_filter/properties/sort_by" type_id: "$ref": "#/components/schemas/resource_filter/properties/type_id" formulas: "$ref": "#/components/schemas/resource_filter/properties/formulas" group_by: "$ref": "#/components/schemas/resource_filter/properties/group_by" settings: "$ref": "#/components/schemas/resource_filter/properties/settings" layout_id: "$ref": "#/components/schemas/resource_filter/properties/layout_id" created_at: "$ref": "#/components/schemas/resource_filter/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_filter/properties/updated_at" original_id: "$ref": "#/components/schemas/resource_filter/properties/original_id" pulse_count: "$ref": "#/components/schemas/resource_filter/properties/pulse_count" transpose_by: "$ref": "#/components/schemas/resource_filter/properties/transpose_by" chart_type_id: "$ref": "#/components/schemas/resource_filter/properties/chart_type_id" exchange_date: "$ref": "#/components/schemas/resource_filter/properties/exchange_date" export_params: "$ref": "#/components/schemas/resource_filter/properties/export_params" filterable_id: "$ref": "#/components/schemas/resource_filter/properties/filterable_id" predefined_id: "$ref": "#/components/schemas/resource_filter/properties/predefined_id" last_viewed_at: "$ref": "#/components/schemas/resource_filter/properties/last_viewed_at" column_settings: "$ref": "#/components/schemas/resource_filter/properties/column_settings" filterable_type: "$ref": "#/components/schemas/resource_filter/properties/filterable_type" report_layout_id: "$ref": "#/components/schemas/resource_filter/properties/report_layout_id" exchange_currency: "$ref": "#/components/schemas/resource_filter/properties/exchange_currency" last_pulse_sent_at: "$ref": "#/components/schemas/resource_filter/properties/last_pulse_sent_at" filterable_collection: "$ref": "#/components/schemas/resource_filter/properties/filterable_collection" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" memberships: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" report_category: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single filter collection_widget: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: title: "$ref": "#/components/schemas/resource_widget/properties/title" width: "$ref": "#/components/schemas/resource_widget/properties/width" height: "$ref": "#/components/schemas/resource_widget/properties/height" content: "$ref": "#/components/schemas/resource_widget/properties/content" row_position: "$ref": "#/components/schemas/resource_widget/properties/row_position" widget_type_id: "$ref": "#/components/schemas/resource_widget/properties/widget_type_id" column_position: "$ref": "#/components/schemas/resource_widget/properties/column_position" relationships: type: object properties: filter: "$ref": "#/components/schemas/_single_relationship" dashboard: "$ref": "#/components/schemas/_single_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection widget collection_company_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: week: "$ref": "#/components/schemas/resource_company_report/properties/week" year: "$ref": "#/components/schemas/resource_company_report/properties/year" count: "$ref": "#/components/schemas/resource_company_report/properties/count" group: "$ref": "#/components/schemas/resource_company_report/properties/group" month: "$ref": "#/components/schemas/resource_company_report/properties/month" status: "$ref": "#/components/schemas/resource_company_report/properties/status" quarter: "$ref": "#/components/schemas/resource_company_report/properties/quarter" currency: "$ref": "#/components/schemas/resource_company_report/properties/currency" contact_city: "$ref": "#/components/schemas/resource_company_report/properties/contact_city" contact_email: "$ref": "#/components/schemas/resource_company_report/properties/contact_email" contact_phone: "$ref": "#/components/schemas/resource_company_report/properties/contact_phone" contact_state: "$ref": "#/components/schemas/resource_company_report/properties/contact_state" custom_fields: "$ref": "#/components/schemas/resource_company_report/properties/custom_fields" payment_terms: "$ref": "#/components/schemas/resource_company_report/properties/payment_terms" formula_fields: "$ref": "#/components/schemas/resource_company_report/properties/formula_fields" contact_address: "$ref": "#/components/schemas/resource_company_report/properties/contact_address" contact_country: "$ref": "#/components/schemas/resource_company_report/properties/contact_country" contact_website: "$ref": "#/components/schemas/resource_company_report/properties/contact_website" contact_zipcode: "$ref": "#/components/schemas/resource_company_report/properties/contact_zipcode" currency_default: "$ref": "#/components/schemas/resource_company_report/properties/currency_default" created_at_period: "$ref": "#/components/schemas/resource_company_report/properties/created_at_period" currency_normalized: "$ref": "#/components/schemas/resource_company_report/properties/currency_normalized" last_activity_at_period: "$ref": "#/components/schemas/resource_company_report/properties/last_activity_at_period" relationships: type: object properties: report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" parent_company: "$ref": "#/components/schemas/_single_relationship" parent_company_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection company report collection_task: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: title: "$ref": "#/components/schemas/resource_task/properties/title" closed: "$ref": "#/components/schemas/resource_task/properties/closed" number: "$ref": "#/components/schemas/resource_task/properties/number" private: "$ref": "#/components/schemas/resource_task/properties/private" type_id: "$ref": "#/components/schemas/resource_task/properties/type_id" due_date: "$ref": "#/components/schemas/resource_task/properties/due_date" due_time: "$ref": "#/components/schemas/resource_task/properties/due_time" tag_list: "$ref": "#/components/schemas/resource_task/properties/tag_list" closed_at: "$ref": "#/components/schemas/resource_task/properties/closed_at" email_key: "$ref": "#/components/schemas/resource_task/properties/email_key" placement: "$ref": "#/components/schemas/resource_task/properties/placement" created_at: "$ref": "#/components/schemas/resource_task/properties/created_at" deleted_at: "$ref": "#/components/schemas/resource_task/properties/deleted_at" start_date: "$ref": "#/components/schemas/resource_task/properties/start_date" todo_count: "$ref": "#/components/schemas/resource_task/properties/todo_count" updated_at: "$ref": "#/components/schemas/resource_task/properties/updated_at" task_number: "$ref": "#/components/schemas/resource_task/properties/task_number" worked_time: "$ref": "#/components/schemas/resource_task/properties/worked_time" billable_time: "$ref": "#/components/schemas/resource_task/properties/billable_time" custom_fields: "$ref": "#/components/schemas/resource_task/properties/custom_fields" subtask_count: "$ref": "#/components/schemas/resource_task/properties/subtask_count" bookings_count: "$ref": "#/components/schemas/resource_task/properties/bookings_count" remaining_time: "$ref": "#/components/schemas/resource_task/properties/remaining_time" repeat_on_date: "$ref": "#/components/schemas/resource_task/properties/repeat_on_date" open_todo_count: "$ref": "#/components/schemas/resource_task/properties/open_todo_count" initial_estimate: "$ref": "#/components/schemas/resource_task/properties/initial_estimate" last_activity_at: "$ref": "#/components/schemas/resource_task/properties/last_activity_at" repeat_origin_id: "$ref": "#/components/schemas/resource_task/properties/repeat_origin_id" repeat_on_weekday: "$ref": "#/components/schemas/resource_task/properties/repeat_on_weekday" subtask_placement: "$ref": "#/components/schemas/resource_task/properties/subtask_placement" todo_assignee_ids: "$ref": "#/components/schemas/resource_task/properties/todo_assignee_ids" creation_method_id: "$ref": "#/components/schemas/resource_task/properties/creation_method_id" open_subtask_count: "$ref": "#/components/schemas/resource_task/properties/open_subtask_count" repeat_on_interval: "$ref": "#/components/schemas/resource_task/properties/repeat_on_interval" repeat_on_monthday: "$ref": "#/components/schemas/resource_task/properties/repeat_on_monthday" repeat_schedule_id: "$ref": "#/components/schemas/resource_task/properties/repeat_schedule_id" task_dependency_count: "$ref": "#/components/schemas/resource_task/properties/task_dependency_count" linked_dependency_count: "$ref": "#/components/schemas/resource_task/properties/linked_dependency_count" blocking_dependency_count: "$ref": "#/components/schemas/resource_task/properties/blocking_dependency_count" waiting_on_dependency_count: "$ref": "#/components/schemas/resource_task/properties/waiting_on_dependency_count" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" assignee: "$ref": "#/components/schemas/_single_relationship" task_list: "$ref": "#/components/schemas/_single_relationship" last_actor: "$ref": "#/components/schemas/_single_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" parent_task: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" repeated_task: "$ref": "#/components/schemas/_single_relationship" template_object: "$ref": "#/components/schemas/_single_relationship" workflow_status: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection task single_service: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: cost: "$ref": "#/components/schemas/resource_service/properties/cost" name: "$ref": "#/components/schemas/resource_service/properties/name" price: "$ref": "#/components/schemas/resource_service/properties/price" markup: "$ref": "#/components/schemas/resource_service/properties/markup" profit: "$ref": "#/components/schemas/resource_service/properties/profit" revenue: "$ref": "#/components/schemas/resource_service/properties/revenue" unit_id: "$ref": "#/components/schemas/resource_service/properties/unit_id" billable: "$ref": "#/components/schemas/resource_service/properties/billable" currency: "$ref": "#/components/schemas/resource_service/properties/currency" discount: "$ref": "#/components/schemas/resource_service/properties/discount" position: "$ref": "#/components/schemas/resource_service/properties/position" quantity: "$ref": "#/components/schemas/resource_service/properties/quantity" work_cost: "$ref": "#/components/schemas/resource_service/properties/work_cost" deleted_at: "$ref": "#/components/schemas/resource_service/properties/deleted_at" booked_time: "$ref": "#/components/schemas/resource_service/properties/booked_time" budget_used: "$ref": "#/components/schemas/resource_service/properties/budget_used" future_cost: "$ref": "#/components/schemas/resource_service/properties/future_cost" worked_time: "$ref": "#/components/schemas/resource_service/properties/worked_time" budget_total: "$ref": "#/components/schemas/resource_service/properties/budget_total" cost_default: "$ref": "#/components/schemas/resource_service/properties/cost_default" billable_time: "$ref": "#/components/schemas/resource_service/properties/billable_time" budgeted_time: "$ref": "#/components/schemas/resource_service/properties/budgeted_time" custom_fields: "$ref": "#/components/schemas/resource_service/properties/custom_fields" editor_config: "$ref": "#/components/schemas/resource_service/properties/editor_config" markup_amount: "$ref": "#/components/schemas/resource_service/properties/markup_amount" price_default: "$ref": "#/components/schemas/resource_service/properties/price_default" profit_margin: "$ref": "#/components/schemas/resource_service/properties/profit_margin" estimated_cost: "$ref": "#/components/schemas/resource_service/properties/estimated_cost" estimated_time: "$ref": "#/components/schemas/resource_service/properties/estimated_time" expense_amount: "$ref": "#/components/schemas/resource_service/properties/expense_amount" future_revenue: "$ref": "#/components/schemas/resource_service/properties/future_revenue" profit_default: "$ref": "#/components/schemas/resource_service/properties/profit_default" billing_type_id: "$ref": "#/components/schemas/resource_service/properties/billing_type_id" cost_normalized: "$ref": "#/components/schemas/resource_service/properties/cost_normalized" discount_amount: "$ref": "#/components/schemas/resource_service/properties/discount_amount" limitation_type: "$ref": "#/components/schemas/resource_service/properties/limitation_type" revenue_default: "$ref": "#/components/schemas/resource_service/properties/revenue_default" unapproved_time: "$ref": "#/components/schemas/resource_service/properties/unapproved_time" currency_default: "$ref": "#/components/schemas/resource_service/properties/currency_default" price_normalized: "$ref": "#/components/schemas/resource_service/properties/price_normalized" rolled_over_time: "$ref": "#/components/schemas/resource_service/properties/rolled_over_time" origin_service_id: "$ref": "#/components/schemas/resource_service/properties/origin_service_id" profit_normalized: "$ref": "#/components/schemas/resource_service/properties/profit_normalized" projected_revenue: "$ref": "#/components/schemas/resource_service/properties/projected_revenue" work_cost_default: "$ref": "#/components/schemas/resource_service/properties/work_cost_default" budget_cap_enabled: "$ref": "#/components/schemas/resource_service/properties/budget_cap_enabled" future_booked_time: "$ref": "#/components/schemas/resource_service/properties/future_booked_time" future_budget_used: "$ref": "#/components/schemas/resource_service/properties/future_budget_used" initial_service_id: "$ref": "#/components/schemas/resource_service/properties/initial_service_id" revenue_normalized: "$ref": "#/components/schemas/resource_service/properties/revenue_normalized" budget_used_default: "$ref": "#/components/schemas/resource_service/properties/budget_used_default" currency_normalized: "$ref": "#/components/schemas/resource_service/properties/currency_normalized" future_cost_default: "$ref": "#/components/schemas/resource_service/properties/future_cost_default" budget_total_default: "$ref": "#/components/schemas/resource_service/properties/budget_total_default" work_cost_normalized: "$ref": "#/components/schemas/resource_service/properties/work_cost_normalized" markup_amount_default: "$ref": "#/components/schemas/resource_service/properties/markup_amount_default" time_tracking_enabled: "$ref": "#/components/schemas/resource_service/properties/time_tracking_enabled" budget_used_normalized: "$ref": "#/components/schemas/resource_service/properties/budget_used_normalized" estimated_cost_default: "$ref": "#/components/schemas/resource_service/properties/estimated_cost_default" expense_amount_default: "$ref": "#/components/schemas/resource_service/properties/expense_amount_default" future_cost_normalized: "$ref": "#/components/schemas/resource_service/properties/future_cost_normalized" future_revenue_default: "$ref": "#/components/schemas/resource_service/properties/future_revenue_default" budget_total_normalized: "$ref": "#/components/schemas/resource_service/properties/budget_total_normalized" discount_amount_default: "$ref": "#/components/schemas/resource_service/properties/discount_amount_default" expense_billable_amount: "$ref": "#/components/schemas/resource_service/properties/expense_billable_amount" booking_tracking_enabled: "$ref": "#/components/schemas/resource_service/properties/booking_tracking_enabled" expense_tracking_enabled: "$ref": "#/components/schemas/resource_service/properties/expense_tracking_enabled" markup_amount_normalized: "$ref": "#/components/schemas/resource_service/properties/markup_amount_normalized" estimated_cost_normalized: "$ref": "#/components/schemas/resource_service/properties/estimated_cost_normalized" expense_amount_normalized: "$ref": "#/components/schemas/resource_service/properties/expense_amount_normalized" future_revenue_normalized: "$ref": "#/components/schemas/resource_service/properties/future_revenue_normalized" projected_revenue_default: "$ref": "#/components/schemas/resource_service/properties/projected_revenue_default" discount_amount_normalized: "$ref": "#/components/schemas/resource_service/properties/discount_amount_normalized" future_budget_used_default: "$ref": "#/components/schemas/resource_service/properties/future_budget_used_default" projected_revenue_normalized: "$ref": "#/components/schemas/resource_service/properties/projected_revenue_normalized" future_budget_used_normalized: "$ref": "#/components/schemas/resource_service/properties/future_budget_used_normalized" expense_billable_amount_default: "$ref": "#/components/schemas/resource_service/properties/expense_billable_amount_default" expense_billable_amount_normalized: "$ref": "#/components/schemas/resource_service/properties/expense_billable_amount_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" section: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single service collection_time_entry: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: cost: "$ref": "#/components/schemas/resource_time_entry/properties/cost" date: "$ref": "#/components/schemas/resource_time_entry/properties/date" note: "$ref": "#/components/schemas/resource_time_entry/properties/note" time: "$ref": "#/components/schemas/resource_time_entry/properties/time" approved: "$ref": "#/components/schemas/resource_time_entry/properties/approved" currency: "$ref": "#/components/schemas/resource_time_entry/properties/currency" invoiced: "$ref": "#/components/schemas/resource_time_entry/properties/invoiced" overhead: "$ref": "#/components/schemas/resource_time_entry/properties/overhead" rejected: "$ref": "#/components/schemas/resource_time_entry/properties/rejected" submitted: "$ref": "#/components/schemas/resource_time_entry/properties/submitted" work_cost: "$ref": "#/components/schemas/resource_time_entry/properties/work_cost" created_at: "$ref": "#/components/schemas/resource_time_entry/properties/created_at" started_at: "$ref": "#/components/schemas/resource_time_entry/properties/started_at" updated_at: "$ref": "#/components/schemas/resource_time_entry/properties/updated_at" approved_at: "$ref": "#/components/schemas/resource_time_entry/properties/approved_at" rejected_at: "$ref": "#/components/schemas/resource_time_entry/properties/rejected_at" cost_default: "$ref": "#/components/schemas/resource_time_entry/properties/cost_default" billable_time: "$ref": "#/components/schemas/resource_time_entry/properties/billable_time" jira_issue_id: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id" overhead_cost: "$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost" cost_normalized: "$ref": "#/components/schemas/resource_time_entry/properties/cost_normalized" jira_worklog_id: "$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id" recognized_time: "$ref": "#/components/schemas/resource_time_entry/properties/recognized_time" rejected_reason: "$ref": "#/components/schemas/resource_time_entry/properties/rejected_reason" track_method_id: "$ref": "#/components/schemas/resource_time_entry/properties/track_method_id" currency_default: "$ref": "#/components/schemas/resource_time_entry/properties/currency_default" last_activity_at: "$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at" timer_started_at: "$ref": "#/components/schemas/resource_time_entry/properties/timer_started_at" timer_stopped_at: "$ref": "#/components/schemas/resource_time_entry/properties/timer_stopped_at" calendar_event_id: "$ref": "#/components/schemas/resource_time_entry/properties/calendar_event_id" jira_issue_status: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status" jira_organization: "$ref": "#/components/schemas/resource_time_entry/properties/jira_organization" work_cost_default: "$ref": "#/components/schemas/resource_time_entry/properties/work_cost_default" jira_issue_summary: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary" currency_normalized: "$ref": "#/components/schemas/resource_time_entry/properties/currency_normalized" work_cost_normalized: "$ref": "#/components/schemas/resource_time_entry/properties/work_cost_normalized" overhead_cost_default: "$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost_default" facility_overhead_cost: "$ref": "#/components/schemas/resource_time_entry/properties/facility_overhead_cost" internal_overhead_cost: "$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost" invoice_attribution_id: "$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id" overhead_cost_normalized: "$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost_normalized" facility_overhead_cost_default: "$ref": "#/components/schemas/resource_time_entry/properties/facility_overhead_cost_default" internal_overhead_cost_default: "$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost_default" facility_overhead_cost_normalized: "$ref": "#/components/schemas/resource_time_entry/properties/facility_overhead_cost_normalized" internal_overhead_cost_normalized: "$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost_normalized" relationships: type: object properties: task: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" approver: "$ref": "#/components/schemas/_single_relationship" rejecter: "$ref": "#/components/schemas/_single_relationship" timesheet: "$ref": "#/components/schemas/_single_relationship" last_actor: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" deal_subsidiary: "$ref": "#/components/schemas/_single_relationship" approval_statuses: "$ref": "#/components/schemas/_collection_relationship" person_subsidiary: "$ref": "#/components/schemas/_single_relationship" invoice_attribution: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection time entry single_revenue_distribution: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: amount: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount" end_on: "$ref": "#/components/schemas/resource_revenue_distribution/properties/end_on" currency: "$ref": "#/components/schemas/resource_revenue_distribution/properties/currency" start_on: "$ref": "#/components/schemas/resource_revenue_distribution/properties/start_on" amount_default: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount_default" amount_percent: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount_percent" currency_default: "$ref": "#/components/schemas/resource_revenue_distribution/properties/currency_default" amount_normalized: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount_normalized" currency_normalized: "$ref": "#/components/schemas/resource_revenue_distribution/properties/currency_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single revenue distribution single_contract: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: ends_on: "$ref": "#/components/schemas/resource_contract/properties/ends_on" starts_on: "$ref": "#/components/schemas/resource_contract/properties/starts_on" interval_id: "$ref": "#/components/schemas/resource_contract/properties/interval_id" copy_expenses: "$ref": "#/components/schemas/resource_contract/properties/copy_expenses" next_occurrence_on: "$ref": "#/components/schemas/resource_contract/properties/next_occurrence_on" use_rollover_hours: "$ref": "#/components/schemas/resource_contract/properties/use_rollover_hours" copy_purchase_order_number: "$ref": "#/components/schemas/resource_contract/properties/copy_purchase_order_number" relationships: type: object properties: template: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single contract collection_document_type: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_document_type/properties/name" note: "$ref": "#/components/schemas/resource_document_type/properties/note" footer: "$ref": "#/components/schemas/resource_document_type/properties/footer" locale: "$ref": "#/components/schemas/resource_document_type/properties/locale" tax1_name: "$ref": "#/components/schemas/resource_document_type/properties/tax1_name" tax2_name: "$ref": "#/components/schemas/resource_document_type/properties/tax2_name" email_data: "$ref": "#/components/schemas/resource_document_type/properties/email_data" tax1_value: "$ref": "#/components/schemas/resource_document_type/properties/tax1_value" tax2_value: "$ref": "#/components/schemas/resource_document_type/properties/tax2_value" archived_at: "$ref": "#/components/schemas/resource_document_type/properties/archived_at" body_template: "$ref": "#/components/schemas/resource_document_type/properties/body_template" dual_currency: "$ref": "#/components/schemas/resource_document_type/properties/dual_currency" email_subject: "$ref": "#/components/schemas/resource_document_type/properties/email_subject" scss_template: "$ref": "#/components/schemas/resource_document_type/properties/scss_template" email_template: "$ref": "#/components/schemas/resource_document_type/properties/email_template" filename_schema: "$ref": "#/components/schemas/resource_document_type/properties/filename_schema" footer_template: "$ref": "#/components/schemas/resource_document_type/properties/footer_template" header_template: "$ref": "#/components/schemas/resource_document_type/properties/header_template" exporter_options: "$ref": "#/components/schemas/resource_document_type/properties/exporter_options" template_options: "$ref": "#/components/schemas/resource_document_type/properties/template_options" exportable_type_id: "$ref": "#/components/schemas/resource_document_type/properties/exportable_type_id" document_template_id: "$ref": "#/components/schemas/resource_document_type/properties/document_template_id" relationships: type: object properties: subsidiary: "$ref": "#/components/schemas/_single_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_style: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection document type collection_placeholder_usage: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: id: "$ref": "#/components/schemas/resource_placeholder_usage/properties/id" field: "$ref": "#/components/schemas/resource_placeholder_usage/properties/field" target_id: "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_id" created_at: "$ref": "#/components/schemas/resource_placeholder_usage/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_placeholder_usage/properties/updated_at" target_type: "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_type" interval_unit: "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_unit" skip_weekends: "$ref": "#/components/schemas/resource_placeholder_usage/properties/skip_weekends" interval_value: "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_value" placeholder_id: "$ref": "#/components/schemas/resource_placeholder_usage/properties/placeholder_id" interval_enabled: "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_enabled" interval_direction: "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_direction" relationships: type: object properties: task: "$ref": "#/components/schemas/_single_relationship" todo: "$ref": "#/components/schemas/_single_relationship" placeholder: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection placeholder usage collection_tax_rate: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_tax_rate/properties/name" archived_at: "$ref": "#/components/schemas/resource_tax_rate/properties/archived_at" primary_component_name: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_name" primary_component_value: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_value" secondary_component_name: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_name" secondary_component_value: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_value" relationships: type: object properties: subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection tax rate collection_approval_policy_assignment: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: target_type: "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_type" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" approval_policy: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection approval policy assignment collection_project: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_project/properties/name" number: "$ref": "#/components/schemas/resource_project/properties/number" template: "$ref": "#/components/schemas/resource_project/properties/template" created_at: "$ref": "#/components/schemas/resource_project/properties/created_at" tag_colors: "$ref": "#/components/schemas/resource_project/properties/tag_colors" archived_at: "$ref": "#/components/schemas/resource_project/properties/archived_at" preferences: "$ref": "#/components/schemas/resource_project/properties/preferences" sample_data: "$ref": "#/components/schemas/resource_project/properties/sample_data" custom_fields: "$ref": "#/components/schemas/resource_project/properties/custom_fields" project_number: "$ref": "#/components/schemas/resource_project/properties/project_number" project_type_id: "$ref": "#/components/schemas/resource_project/properties/project_type_id" last_activity_at: "$ref": "#/components/schemas/resource_project/properties/last_activity_at" project_color_id: "$ref": "#/components/schemas/resource_project/properties/project_color_id" duplication_status: "$ref": "#/components/schemas/resource_project/properties/duplication_status" page_custom_fields_ids: "$ref": "#/components/schemas/resource_project/properties/page_custom_fields_ids" task_custom_fields_ids: "$ref": "#/components/schemas/resource_project/properties/task_custom_fields_ids" page_custom_fields_positions: "$ref": "#/components/schemas/resource_project/properties/page_custom_fields_positions" task_custom_fields_positions: "$ref": "#/components/schemas/resource_project/properties/task_custom_fields_positions" relationships: type: object properties: company: "$ref": "#/components/schemas/_single_relationship" workflow: "$ref": "#/components/schemas/_single_relationship" last_actor: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" project_manager: "$ref": "#/components/schemas/_single_relationship" template_object: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection project single_custom_field: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_custom_field/properties/name" global: "$ref": "#/components/schemas/resource_custom_field/properties/global" position: "$ref": "#/components/schemas/resource_custom_field/properties/position" required: "$ref": "#/components/schemas/resource_custom_field/properties/required" sensitive: "$ref": "#/components/schemas/resource_custom_field/properties/sensitive" created_at: "$ref": "#/components/schemas/resource_custom_field/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_custom_field/properties/updated_at" archived_at: "$ref": "#/components/schemas/resource_custom_field/properties/archived_at" data_type_id: "$ref": "#/components/schemas/resource_custom_field/properties/data_type_id" customizable_type: "$ref": "#/components/schemas/resource_custom_field/properties/customizable_type" quick_add_enabled: "$ref": "#/components/schemas/resource_custom_field/properties/quick_add_enabled" formatting_type_id: "$ref": "#/components/schemas/resource_custom_field/properties/formatting_type_id" aggregation_type_id: "$ref": "#/components/schemas/resource_custom_field/properties/aggregation_type_id" show_in_add_edit_views: "$ref": "#/components/schemas/resource_custom_field/properties/show_in_add_edit_views" relationships: type: object properties: survey: "$ref": "#/components/schemas/_single_relationship" options: "$ref": "#/components/schemas/_collection_relationship" project: "$ref": "#/components/schemas/_single_relationship" section: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single custom field collection_pipeline: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_pipeline/properties/name" icon_id: "$ref": "#/components/schemas/resource_pipeline/properties/icon_id" position: "$ref": "#/components/schemas/resource_pipeline/properties/position" created_at: "$ref": "#/components/schemas/resource_pipeline/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_pipeline/properties/updated_at" pipeline_type_id: "$ref": "#/components/schemas/resource_pipeline/properties/pipeline_type_id" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection pipeline collection_booking_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: time: "$ref": "#/components/schemas/resource_booking_report/properties/time" count: "$ref": "#/components/schemas/resource_booking_report/properties/count" draft: "$ref": "#/components/schemas/resource_booking_report/properties/draft" group: "$ref": "#/components/schemas/resource_booking_report/properties/group" mandays: "$ref": "#/components/schemas/resource_booking_report/properties/mandays" currency: "$ref": "#/components/schemas/resource_booking_report/properties/currency" end_date: "$ref": "#/components/schemas/resource_booking_report/properties/end_date" created_at: "$ref": "#/components/schemas/resource_booking_report/properties/created_at" stage_type: "$ref": "#/components/schemas/resource_booking_report/properties/stage_type" start_date: "$ref": "#/components/schemas/resource_booking_report/properties/start_date" total_cost: "$ref": "#/components/schemas/resource_booking_report/properties/total_cost" approved_at: "$ref": "#/components/schemas/resource_booking_report/properties/approved_at" canceled_at: "$ref": "#/components/schemas/resource_booking_report/properties/canceled_at" date_period: "$ref": "#/components/schemas/resource_booking_report/properties/date_period" rejected_at: "$ref": "#/components/schemas/resource_booking_report/properties/rejected_at" absence_type: "$ref": "#/components/schemas/resource_booking_report/properties/absence_type" autotracking: "$ref": "#/components/schemas/resource_booking_report/properties/autotracking" billing_type: "$ref": "#/components/schemas/resource_booking_report/properties/billing_type" project_type: "$ref": "#/components/schemas/resource_booking_report/properties/project_type" custom_fields: "$ref": "#/components/schemas/resource_booking_report/properties/custom_fields" formula_fields: "$ref": "#/components/schemas/resource_booking_report/properties/formula_fields" approval_status: "$ref": "#/components/schemas/resource_booking_report/properties/approval_status" total_base_cost: "$ref": "#/components/schemas/resource_booking_report/properties/total_base_cost" currency_default: "$ref": "#/components/schemas/resource_booking_report/properties/currency_default" created_at_period: "$ref": "#/components/schemas/resource_booking_report/properties/created_at_period" approved_at_period: "$ref": "#/components/schemas/resource_booking_report/properties/approved_at_period" canceled_at_period: "$ref": "#/components/schemas/resource_booking_report/properties/canceled_at_period" rejected_at_period: "$ref": "#/components/schemas/resource_booking_report/properties/rejected_at_period" total_cost_default: "$ref": "#/components/schemas/resource_booking_report/properties/total_cost_default" currency_normalized: "$ref": "#/components/schemas/resource_booking_report/properties/currency_normalized" average_blended_rate: "$ref": "#/components/schemas/resource_booking_report/properties/average_blended_rate" people_custom_fields: "$ref": "#/components/schemas/resource_booking_report/properties/people_custom_fields" total_cost_normalized: "$ref": "#/components/schemas/resource_booking_report/properties/total_cost_normalized" total_recognized_time: "$ref": "#/components/schemas/resource_booking_report/properties/total_recognized_time" total_base_cost_default: "$ref": "#/components/schemas/resource_booking_report/properties/total_base_cost_default" total_recognized_profit: "$ref": "#/components/schemas/resource_booking_report/properties/total_recognized_profit" total_recognized_revenue: "$ref": "#/components/schemas/resource_booking_report/properties/total_recognized_revenue" average_recognized_margin: "$ref": "#/components/schemas/resource_booking_report/properties/average_recognized_margin" total_base_cost_normalized: "$ref": "#/components/schemas/resource_booking_report/properties/total_base_cost_normalized" average_blended_rate_default: "$ref": "#/components/schemas/resource_booking_report/properties/average_blended_rate_default" average_blended_rate_normalized: "$ref": "#/components/schemas/resource_booking_report/properties/average_blended_rate_normalized" total_recognized_profit_default: "$ref": "#/components/schemas/resource_booking_report/properties/total_recognized_profit_default" total_recognized_revenue_default: "$ref": "#/components/schemas/resource_booking_report/properties/total_recognized_revenue_default" total_recognized_profit_normalized: "$ref": "#/components/schemas/resource_booking_report/properties/total_recognized_profit_normalized" total_recognized_revenue_normalized: "$ref": "#/components/schemas/resource_booking_report/properties/total_recognized_revenue_normalized" relationships: type: object properties: task: "$ref": "#/components/schemas/_single_relationship" event: "$ref": "#/components/schemas/_single_relationship" budget: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" booking: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" task_report: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" person_report: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" project_report: "$ref": "#/components/schemas/_single_relationship" service_report: "$ref": "#/components/schemas/_single_relationship" responsible_report: "$ref": "#/components/schemas/_single_relationship" deal_or_budget_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection booking report collection_person: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: agent: "$ref": "#/components/schemas/resource_person/properties/agent" email: "$ref": "#/components/schemas/resource_person/properties/email" title: "$ref": "#/components/schemas/resource_person/properties/title" contact: "$ref": "#/components/schemas/resource_person/properties/contact" is_user: "$ref": "#/components/schemas/resource_person/properties/is_user" role_id: "$ref": "#/components/schemas/resource_person/properties/role_id" user_id: "$ref": "#/components/schemas/resource_person/properties/user_id" virtual: "$ref": "#/components/schemas/resource_person/properties/virtual" champion: "$ref": "#/components/schemas/resource_person/properties/champion" color_id: "$ref": "#/components/schemas/resource_person/properties/color_id" nickname: "$ref": "#/components/schemas/resource_person/properties/nickname" tag_list: "$ref": "#/components/schemas/resource_person/properties/tag_list" joined_at: "$ref": "#/components/schemas/resource_person/properties/joined_at" last_name: "$ref": "#/components/schemas/resource_person/properties/last_name" avatar_url: "$ref": "#/components/schemas/resource_person/properties/avatar_url" created_at: "$ref": "#/components/schemas/resource_person/properties/created_at" first_name: "$ref": "#/components/schemas/resource_person/properties/first_name" invited_at: "$ref": "#/components/schemas/resource_person/properties/invited_at" archived_at: "$ref": "#/components/schemas/resource_person/properties/archived_at" external_id: "$ref": "#/components/schemas/resource_person/properties/external_id" hrm_type_id: "$ref": "#/components/schemas/resource_person/properties/hrm_type_id" placeholder: "$ref": "#/components/schemas/resource_person/properties/placeholder" sample_data: "$ref": "#/components/schemas/resource_person/properties/sample_data" status_text: "$ref": "#/components/schemas/resource_person/properties/status_text" autotracking: "$ref": "#/components/schemas/resource_person/properties/autotracking" last_seen_at: "$ref": "#/components/schemas/resource_person/properties/last_seen_at" status_emoji: "$ref": "#/components/schemas/resource_person/properties/status_emoji" custom_fields: "$ref": "#/components/schemas/resource_person/properties/custom_fields" external_sync: "$ref": "#/components/schemas/resource_person/properties/external_sync" time_unlocked: "$ref": "#/components/schemas/resource_person/properties/time_unlocked" availabilities: "$ref": "#/components/schemas/resource_person/properties/availabilities" deactivated_at: "$ref": "#/components/schemas/resource_person/properties/deactivated_at" offboarding_id: "$ref": "#/components/schemas/resource_person/properties/offboarding_id" two_factor_auth: "$ref": "#/components/schemas/resource_person/properties/two_factor_auth" last_activity_at: "$ref": "#/components/schemas/resource_person/properties/last_activity_at" time_unlocked_on: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_on" status_expires_at: "$ref": "#/components/schemas/resource_person/properties/status_expires_at" offboarding_status: "$ref": "#/components/schemas/resource_person/properties/offboarding_status" original_avatar_url: "$ref": "#/components/schemas/resource_person/properties/original_avatar_url" time_off_status_sync: "$ref": "#/components/schemas/resource_person/properties/time_off_status_sync" time_unlocked_end_date: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_end_date" time_unlocked_interval: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_interval" time_tracking_policy_id: "$ref": "#/components/schemas/resource_person/properties/time_tracking_policy_id" time_unlocked_period_id: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_period_id" time_unlocked_start_date: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_start_date" timesheet_submission_disabled: "$ref": "#/components/schemas/resource_person/properties/timesheet_submission_disabled" relationships: type: object properties: teams: "$ref": "#/components/schemas/_collection_relationship" company: "$ref": "#/components/schemas/_single_relationship" manager: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" custom_role: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_types: "$ref": "#/components/schemas/_collection_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" time_tracking_policy: "$ref": "#/components/schemas/_single_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" approval_policy_assignment: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection person collection_overhead: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: capacity: "$ref": "#/components/schemas/resource_overhead/properties/capacity" currency: "$ref": "#/components/schemas/resource_overhead/properties/currency" ended_on: "$ref": "#/components/schemas/resource_overhead/properties/ended_on" started_on: "$ref": "#/components/schemas/resource_overhead/properties/started_on" updated_at: "$ref": "#/components/schemas/resource_overhead/properties/updated_at" total_hours: "$ref": "#/components/schemas/resource_overhead/properties/total_hours" client_hours: "$ref": "#/components/schemas/resource_overhead/properties/client_hours" use_overhead: "$ref": "#/components/schemas/resource_overhead/properties/use_overhead" exchange_rate: "$ref": "#/components/schemas/resource_overhead/properties/exchange_rate" facility_costs: "$ref": "#/components/schemas/resource_overhead/properties/facility_costs" internal_hours: "$ref": "#/components/schemas/resource_overhead/properties/internal_hours" overhead_hours: "$ref": "#/components/schemas/resource_overhead/properties/overhead_hours" time_off_costs: "$ref": "#/components/schemas/resource_overhead/properties/time_off_costs" time_off_hours: "$ref": "#/components/schemas/resource_overhead/properties/time_off_hours" uses_averaging: "$ref": "#/components/schemas/resource_overhead/properties/uses_averaging" recalculated_at: "$ref": "#/components/schemas/resource_overhead/properties/recalculated_at" averaging_period: "$ref": "#/components/schemas/resource_overhead/properties/averaging_period" currency_default: "$ref": "#/components/schemas/resource_overhead/properties/currency_default" overhead_controls: "$ref": "#/components/schemas/resource_overhead/properties/overhead_controls" overtracked_costs: "$ref": "#/components/schemas/resource_overhead/properties/overtracked_costs" overtracked_hours: "$ref": "#/components/schemas/resource_overhead/properties/overtracked_hours" undertracked_costs: "$ref": "#/components/schemas/resource_overhead/properties/undertracked_costs" undertracked_hours: "$ref": "#/components/schemas/resource_overhead/properties/undertracked_hours" currency_normalized: "$ref": "#/components/schemas/resource_overhead/properties/currency_normalized" internal_work_costs: "$ref": "#/components/schemas/resource_overhead/properties/internal_work_costs" recalculating_status: "$ref": "#/components/schemas/resource_overhead/properties/recalculating_status" client_overhead_hours: "$ref": "#/components/schemas/resource_overhead/properties/client_overhead_hours" facility_cost_per_hour: "$ref": "#/components/schemas/resource_overhead/properties/facility_cost_per_hour" facility_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/facility_costs_default" internal_expense_costs: "$ref": "#/components/schemas/resource_overhead/properties/internal_expense_costs" time_off_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/time_off_costs_default" internal_overhead_hours: "$ref": "#/components/schemas/resource_overhead/properties/internal_overhead_hours" time_off_overhead_hours: "$ref": "#/components/schemas/resource_overhead/properties/time_off_overhead_hours" facility_costs_breakdown: "$ref": "#/components/schemas/resource_overhead/properties/facility_costs_breakdown" facility_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/facility_costs_normalized" overtracked_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/overtracked_costs_default" time_off_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/time_off_costs_normalized" new_internal_cost_per_hour: "$ref": "#/components/schemas/resource_overhead/properties/new_internal_cost_per_hour" undertracked_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/undertracked_costs_default" internal_work_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/internal_work_costs_default" internal_componentized_costs: "$ref": "#/components/schemas/resource_overhead/properties/internal_componentized_costs" overtracked_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/overtracked_costs_normalized" undertracked_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/undertracked_costs_normalized" facility_cost_per_hour_default: "$ref": "#/components/schemas/resource_overhead/properties/facility_cost_per_hour_default" internal_expense_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/internal_expense_costs_default" internal_work_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/internal_work_costs_normalized" facility_cost_per_hour_normalized: "$ref": "#/components/schemas/resource_overhead/properties/facility_cost_per_hour_normalized" internal_expense_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/internal_expense_costs_normalized" new_internal_cost_per_hour_default: "$ref": "#/components/schemas/resource_overhead/properties/new_internal_cost_per_hour_default" internal_componentized_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/internal_componentized_costs_default" new_internal_cost_per_hour_normalized: "$ref": "#/components/schemas/resource_overhead/properties/new_internal_cost_per_hour_normalized" internal_componentized_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/internal_componentized_costs_normalized" relationships: type: object properties: updater: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection overhead single_time_tracking_policy: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/name" created_at: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/updated_at" archived_at: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/archived_at" holiday_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/holiday_limit" note_mandatory: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/note_mandatory" task_mandatory: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/task_mandatory" working_day_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/working_day_limit" time_range_mandatory: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/time_range_mandatory" assigned_people_count: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/assigned_people_count" non_working_day_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/non_working_day_limit" full_day_absence_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/full_day_absence_limit" half_day_absence_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/half_day_absence_limit" limited_tracking_message: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/limited_tracking_message" restrict_future_tracking: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/restrict_future_tracking" disabled_tracking_message: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/disabled_tracking_message" restrict_time_entry_overlap: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/restrict_time_entry_overlap" restrict_tracking_over_budget: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/restrict_tracking_over_budget" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" last_actor: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single time tracking policy single_password: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: email: "$ref": "#/components/schemas/resource_password/properties/email" first_password: "$ref": "#/components/schemas/resource_password/properties/first_password" relationships: type: object properties: {} meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single password collection_deal_cost_rate: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: currency: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/currency" rate_cents: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/rate_cents" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection deal cost rate single_service_type_assignment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: {} relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single service type assignment collection_integration_exporter_configuration: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: company_type: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/company_type" datev_client_account_code: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/datev_client_account_code" datev_vendor_account_code: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/datev_vendor_account_code" relationships: type: object properties: company: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection integration exporter configuration collection_price_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: count: "$ref": "#/components/schemas/resource_price_report/properties/count" group: "$ref": "#/components/schemas/resource_price_report/properties/group" currency: "$ref": "#/components/schemas/resource_price_report/properties/currency" average_rate: "$ref": "#/components/schemas/resource_price_report/properties/average_rate" average_markup: "$ref": "#/components/schemas/resource_price_report/properties/average_markup" formula_fields: "$ref": "#/components/schemas/resource_price_report/properties/formula_fields" average_discount: "$ref": "#/components/schemas/resource_price_report/properties/average_discount" currency_default: "$ref": "#/components/schemas/resource_price_report/properties/currency_default" rate_card_status: "$ref": "#/components/schemas/resource_price_report/properties/rate_card_status" currency_normalized: "$ref": "#/components/schemas/resource_price_report/properties/currency_normalized" average_rate_default: "$ref": "#/components/schemas/resource_price_report/properties/average_rate_default" average_markup_amount: "$ref": "#/components/schemas/resource_price_report/properties/average_markup_amount" time_tracking_enabled: "$ref": "#/components/schemas/resource_price_report/properties/time_tracking_enabled" average_estimated_cost: "$ref": "#/components/schemas/resource_price_report/properties/average_estimated_cost" average_discount_amount: "$ref": "#/components/schemas/resource_price_report/properties/average_discount_amount" average_discounted_rate: "$ref": "#/components/schemas/resource_price_report/properties/average_discounted_rate" average_rate_normalized: "$ref": "#/components/schemas/resource_price_report/properties/average_rate_normalized" booking_tracking_enabled: "$ref": "#/components/schemas/resource_price_report/properties/booking_tracking_enabled" expense_tracking_enabled: "$ref": "#/components/schemas/resource_price_report/properties/expense_tracking_enabled" average_markup_amount_default: "$ref": "#/components/schemas/resource_price_report/properties/average_markup_amount_default" average_estimated_cost_default: "$ref": "#/components/schemas/resource_price_report/properties/average_estimated_cost_default" average_discount_amount_default: "$ref": "#/components/schemas/resource_price_report/properties/average_discount_amount_default" average_discounted_rate_default: "$ref": "#/components/schemas/resource_price_report/properties/average_discounted_rate_default" average_markup_amount_normalized: "$ref": "#/components/schemas/resource_price_report/properties/average_markup_amount_normalized" average_estimated_cost_normalized: "$ref": "#/components/schemas/resource_price_report/properties/average_estimated_cost_normalized" average_discount_amount_normalized: "$ref": "#/components/schemas/resource_price_report/properties/average_discount_amount_normalized" average_discounted_rate_normalized: "$ref": "#/components/schemas/resource_price_report/properties/average_discounted_rate_normalized" relationships: type: object properties: price: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" rate_card: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection price report single_tag: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_tag/properties/name" color_id: "$ref": "#/components/schemas/resource_tag/properties/color_id" relationships: type: object properties: {} meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single tag collection_invoice_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: week: "$ref": "#/components/schemas/resource_invoice_report/properties/week" year: "$ref": "#/components/schemas/resource_invoice_report/properties/year" count: "$ref": "#/components/schemas/resource_invoice_report/properties/count" group: "$ref": "#/components/schemas/resource_invoice_report/properties/group" month: "$ref": "#/components/schemas/resource_invoice_report/properties/month" quarter: "$ref": "#/components/schemas/resource_invoice_report/properties/quarter" currency: "$ref": "#/components/schemas/resource_invoice_report/properties/currency" tax_rates: "$ref": "#/components/schemas/resource_invoice_report/properties/tax_rates" currency_id: "$ref": "#/components/schemas/resource_invoice_report/properties/currency_id" sent_status: "$ref": "#/components/schemas/resource_invoice_report/properties/sent_status" invoice_type: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_type" total_amount: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount" custom_fields: "$ref": "#/components/schemas/resource_invoice_report/properties/custom_fields" invoice_aging: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_aging" invoice_state: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_state" pay_on_period: "$ref": "#/components/schemas/resource_invoice_report/properties/pay_on_period" average_due_in: "$ref": "#/components/schemas/resource_invoice_report/properties/average_due_in" formula_fields: "$ref": "#/components/schemas/resource_invoice_report/properties/formula_fields" invoice_status: "$ref": "#/components/schemas/resource_invoice_report/properties/invoice_status" overdue_status: "$ref": "#/components/schemas/resource_invoice_report/properties/overdue_status" paid_on_period: "$ref": "#/components/schemas/resource_invoice_report/properties/paid_on_period" payment_status: "$ref": "#/components/schemas/resource_invoice_report/properties/payment_status" sent_on_period: "$ref": "#/components/schemas/resource_invoice_report/properties/sent_on_period" average_paid_in: "$ref": "#/components/schemas/resource_invoice_report/properties/average_paid_in" einvoice_status: "$ref": "#/components/schemas/resource_invoice_report/properties/einvoice_status" currency_default: "$ref": "#/components/schemas/resource_invoice_report/properties/currency_default" invoicing_method: "$ref": "#/components/schemas/resource_invoice_report/properties/invoicing_method" total_amount_tax: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_tax" created_at_period: "$ref": "#/components/schemas/resource_invoice_report/properties/created_at_period" total_amount_paid: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_paid" delivery_on_period: "$ref": "#/components/schemas/resource_invoice_report/properties/delivery_on_period" invoiced_on_period: "$ref": "#/components/schemas/resource_invoice_report/properties/invoiced_on_period" currency_normalized: "$ref": "#/components/schemas/resource_invoice_report/properties/currency_normalized" total_amount_unpaid: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_unpaid" fiscalization_status: "$ref": "#/components/schemas/resource_invoice_report/properties/fiscalization_status" total_amount_default: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_default" automatically_created: "$ref": "#/components/schemas/resource_invoice_report/properties/automatically_created" total_amount_credited: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_credited" total_amount_with_tax: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_with_tax" last_activity_at_period: "$ref": "#/components/schemas/resource_invoice_report/properties/last_activity_at_period" total_amount_normalized: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_normalized" total_amount_tax_default: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_tax_default" total_amount_written_off: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_written_off" total_amount_paid_default: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_paid_default" total_amount_tax_normalized: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_tax_normalized" total_amount_unpaid_default: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_unpaid_default" total_amount_paid_normalized: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_paid_normalized" total_amount_credited_default: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_credited_default" total_amount_with_tax_default: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_with_tax_default" total_amount_credited_with_tax: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_credited_with_tax" total_amount_unpaid_normalized: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_unpaid_normalized" total_amount_credited_normalized: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_credited_normalized" total_amount_with_tax_normalized: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_with_tax_normalized" total_amount_written_off_default: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_written_off_default" total_amount_written_off_normalized: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_written_off_normalized" total_amount_credited_with_tax_default: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_credited_with_tax_default" total_amount_credited_with_tax_normalized: "$ref": "#/components/schemas/resource_invoice_report/properties/total_amount_credited_with_tax_normalized" relationships: type: object properties: issuer: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" issuer_report: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" creator_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection invoice report single_membership: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: options: "$ref": "#/components/schemas/resource_membership/properties/options" type_id: "$ref": "#/components/schemas/resource_membership/properties/type_id" target_type: "$ref": "#/components/schemas/resource_membership/properties/target_type" access_type_id: "$ref": "#/components/schemas/resource_membership/properties/access_type_id" dynamic_group_id: "$ref": "#/components/schemas/resource_membership/properties/dynamic_group_id" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" page: "$ref": "#/components/schemas/_single_relationship" team: "$ref": "#/components/schemas/_single_relationship" agent: "$ref": "#/components/schemas/_single_relationship" filter: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" survey: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" dashboard: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single membership single_rate_card: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_rate_card/properties/name" created_at: "$ref": "#/components/schemas/resource_rate_card/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_rate_card/properties/updated_at" archived_at: "$ref": "#/components/schemas/resource_rate_card/properties/archived_at" prices_count: "$ref": "#/components/schemas/resource_rate_card/properties/prices_count" relationships: type: object properties: company: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single rate card collection_line_item_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: count: "$ref": "#/components/schemas/resource_line_item_report/properties/count" group: "$ref": "#/components/schemas/resource_line_item_report/properties/group" unit_id: "$ref": "#/components/schemas/resource_line_item_report/properties/unit_id" currency: "$ref": "#/components/schemas/resource_line_item_report/properties/currency" discount: "$ref": "#/components/schemas/resource_line_item_report/properties/discount" quantity: "$ref": "#/components/schemas/resource_line_item_report/properties/quantity" tax_rate: "$ref": "#/components/schemas/resource_line_item_report/properties/tax_rate" unit_price: "$ref": "#/components/schemas/resource_line_item_report/properties/unit_price" total_amount: "$ref": "#/components/schemas/resource_line_item_report/properties/total_amount" formula_fields: "$ref": "#/components/schemas/resource_line_item_report/properties/formula_fields" currency_default: "$ref": "#/components/schemas/resource_line_item_report/properties/currency_default" total_amount_tax: "$ref": "#/components/schemas/resource_line_item_report/properties/total_amount_tax" unit_price_default: "$ref": "#/components/schemas/resource_line_item_report/properties/unit_price_default" currency_normalized: "$ref": "#/components/schemas/resource_line_item_report/properties/currency_normalized" total_amount_default: "$ref": "#/components/schemas/resource_line_item_report/properties/total_amount_default" total_amount_with_tax: "$ref": "#/components/schemas/resource_line_item_report/properties/total_amount_with_tax" unit_price_normalized: "$ref": "#/components/schemas/resource_line_item_report/properties/unit_price_normalized" total_amount_normalized: "$ref": "#/components/schemas/resource_line_item_report/properties/total_amount_normalized" total_amount_tax_default: "$ref": "#/components/schemas/resource_line_item_report/properties/total_amount_tax_default" total_amount_tax_normalized: "$ref": "#/components/schemas/resource_line_item_report/properties/total_amount_tax_normalized" total_amount_with_tax_default: "$ref": "#/components/schemas/resource_line_item_report/properties/total_amount_with_tax_default" total_amount_with_tax_normalized: "$ref": "#/components/schemas/resource_line_item_report/properties/total_amount_with_tax_normalized" relationships: type: object properties: report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" expense: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" kpd_code: "$ref": "#/components/schemas/_single_relationship" line_item: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" invoice_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection line item report single_company: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: vat: "$ref": "#/components/schemas/resource_company/properties/vat" name: "$ref": "#/components/schemas/resource_company/properties/name" domain: "$ref": "#/components/schemas/resource_company/properties/domain" contact: "$ref": "#/components/schemas/resource_company/properties/contact" due_days: "$ref": "#/components/schemas/resource_company/properties/due_days" settings: "$ref": "#/components/schemas/resource_company/properties/settings" tag_list: "$ref": "#/components/schemas/resource_company/properties/tag_list" avatar_url: "$ref": "#/components/schemas/resource_company/properties/avatar_url" created_at: "$ref": "#/components/schemas/resource_company/properties/created_at" archived_at: "$ref": "#/components/schemas/resource_company/properties/archived_at" external_id: "$ref": "#/components/schemas/resource_company/properties/external_id" sample_data: "$ref": "#/components/schemas/resource_company/properties/sample_data" billing_name: "$ref": "#/components/schemas/resource_company/properties/billing_name" company_code: "$ref": "#/components/schemas/resource_company/properties/company_code" custom_fields: "$ref": "#/components/schemas/resource_company/properties/custom_fields" external_sync: "$ref": "#/components/schemas/resource_company/properties/external_sync" default_currency: "$ref": "#/components/schemas/resource_company/properties/default_currency" last_activity_at: "$ref": "#/components/schemas/resource_company/properties/last_activity_at" parent_company_id: "$ref": "#/components/schemas/resource_company/properties/parent_company_id" default_tax_rate_id: "$ref": "#/components/schemas/resource_company/properties/default_tax_rate_id" original_avatar_url: "$ref": "#/components/schemas/resource_company/properties/original_avatar_url" projectless_budgets: "$ref": "#/components/schemas/resource_company/properties/projectless_budgets" default_subsidiary_id: "$ref": "#/components/schemas/resource_company/properties/default_subsidiary_id" default_document_type_id: "$ref": "#/components/schemas/resource_company/properties/default_document_type_id" invoice_email_recipients: "$ref": "#/components/schemas/resource_company/properties/invoice_email_recipients" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" parent_company: "$ref": "#/components/schemas/_single_relationship" default_tax_rate: "$ref": "#/components/schemas/_single_relationship" einvoice_identity: "$ref": "#/components/schemas/_single_relationship" default_subsidiary: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" default_document_type: "$ref": "#/components/schemas/_single_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" integration_exporter_configuration: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single company collection_page: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: body: "$ref": "#/components/schemas/resource_page/properties/body" title: "$ref": "#/components/schemas/resource_page/properties/title" public: "$ref": "#/components/schemas/resource_page/properties/public" icon_id: "$ref": "#/components/schemas/resource_page/properties/icon_id" position: "$ref": "#/components/schemas/resource_page/properties/position" edited_at: "$ref": "#/components/schemas/resource_page/properties/edited_at" created_at: "$ref": "#/components/schemas/resource_page/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_page/properties/updated_at" preferences: "$ref": "#/components/schemas/resource_page/properties/preferences" public_uuid: "$ref": "#/components/schemas/resource_page/properties/public_uuid" root_page_id: "$ref": "#/components/schemas/resource_page/properties/root_page_id" custom_fields: "$ref": "#/components/schemas/resource_page/properties/custom_fields" public_access: "$ref": "#/components/schemas/resource_page/properties/public_access" parent_page_id: "$ref": "#/components/schemas/resource_page/properties/parent_page_id" version_number: "$ref": "#/components/schemas/resource_page/properties/version_number" cover_image_url: "$ref": "#/components/schemas/resource_page/properties/cover_image_url" cover_image_meta: "$ref": "#/components/schemas/resource_page/properties/cover_image_meta" last_activity_at: "$ref": "#/components/schemas/resource_page/properties/last_activity_at" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" root_page: "$ref": "#/components/schemas/_single_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" parent_page: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" template_object: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection page collection_service_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: unit: "$ref": "#/components/schemas/resource_service_report/properties/unit" count: "$ref": "#/components/schemas/resource_service_report/properties/count" group: "$ref": "#/components/schemas/resource_service_report/properties/group" billable: "$ref": "#/components/schemas/resource_service_report/properties/billable" currency: "$ref": "#/components/schemas/resource_service_report/properties/currency" recurring: "$ref": "#/components/schemas/resource_service_report/properties/recurring" stage_type: "$ref": "#/components/schemas/resource_service_report/properties/stage_type" total_cost: "$ref": "#/components/schemas/resource_service_report/properties/total_cost" date_period: "$ref": "#/components/schemas/resource_service_report/properties/date_period" total_price: "$ref": "#/components/schemas/resource_service_report/properties/total_price" billing_type: "$ref": "#/components/schemas/resource_service_report/properties/billing_type" project_type: "$ref": "#/components/schemas/resource_service_report/properties/project_type" section_name: "$ref": "#/components/schemas/resource_service_report/properties/section_name" total_profit: "$ref": "#/components/schemas/resource_service_report/properties/total_profit" budget_status: "$ref": "#/components/schemas/resource_service_report/properties/budget_status" custom_fields: "$ref": "#/components/schemas/resource_service_report/properties/custom_fields" total_revenue: "$ref": "#/components/schemas/resource_service_report/properties/total_revenue" average_markup: "$ref": "#/components/schemas/resource_service_report/properties/average_markup" formula_fields: "$ref": "#/components/schemas/resource_service_report/properties/formula_fields" limitation_type: "$ref": "#/components/schemas/resource_service_report/properties/limitation_type" stage_status_id: "$ref": "#/components/schemas/resource_service_report/properties/stage_status_id" average_discount: "$ref": "#/components/schemas/resource_service_report/properties/average_discount" currency_default: "$ref": "#/components/schemas/resource_service_report/properties/currency_default" total_booked_time: "$ref": "#/components/schemas/resource_service_report/properties/total_booked_time" total_budget_used: "$ref": "#/components/schemas/resource_service_report/properties/total_budget_used" total_worked_cost: "$ref": "#/components/schemas/resource_service_report/properties/total_worked_cost" total_worked_time: "$ref": "#/components/schemas/resource_service_report/properties/total_worked_time" budget_cap_enabled: "$ref": "#/components/schemas/resource_service_report/properties/budget_cap_enabled" deal_custom_fields: "$ref": "#/components/schemas/resource_service_report/properties/deal_custom_fields" total_budget_total: "$ref": "#/components/schemas/resource_service_report/properties/total_budget_total" total_cost_default: "$ref": "#/components/schemas/resource_service_report/properties/total_cost_default" total_expense_cost: "$ref": "#/components/schemas/resource_service_report/properties/total_expense_cost" average_actual_rate: "$ref": "#/components/schemas/resource_service_report/properties/average_actual_rate" currency_normalized: "$ref": "#/components/schemas/resource_service_report/properties/currency_normalized" total_billable_time: "$ref": "#/components/schemas/resource_service_report/properties/total_billable_time" total_budgeted_time: "$ref": "#/components/schemas/resource_service_report/properties/total_budgeted_time" total_markup_amount: "$ref": "#/components/schemas/resource_service_report/properties/total_markup_amount" total_price_default: "$ref": "#/components/schemas/resource_service_report/properties/total_price_default" average_budget_usage: "$ref": "#/components/schemas/resource_service_report/properties/average_budget_usage" budget_custom_fields: "$ref": "#/components/schemas/resource_service_report/properties/budget_custom_fields" total_estimated_cost: "$ref": "#/components/schemas/resource_service_report/properties/total_estimated_cost" total_estimated_time: "$ref": "#/components/schemas/resource_service_report/properties/total_estimated_time" total_profit_default: "$ref": "#/components/schemas/resource_service_report/properties/total_profit_default" average_profit_margin: "$ref": "#/components/schemas/resource_service_report/properties/average_profit_margin" time_tracking_enabled: "$ref": "#/components/schemas/resource_service_report/properties/time_tracking_enabled" total_cost_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_cost_normalized" total_discount_amount: "$ref": "#/components/schemas/resource_service_report/properties/total_discount_amount" total_revenue_default: "$ref": "#/components/schemas/resource_service_report/properties/total_revenue_default" total_unapproved_time: "$ref": "#/components/schemas/resource_service_report/properties/total_unapproved_time" total_budget_remaining: "$ref": "#/components/schemas/resource_service_report/properties/total_budget_remaining" total_price_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_price_normalized" total_rolled_over_time: "$ref": "#/components/schemas/resource_service_report/properties/total_rolled_over_time" total_profit_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_profit_normalized" total_projected_revenue: "$ref": "#/components/schemas/resource_service_report/properties/total_projected_revenue" booking_tracking_enabled: "$ref": "#/components/schemas/resource_service_report/properties/booking_tracking_enabled" expense_tracking_enabled: "$ref": "#/components/schemas/resource_service_report/properties/expense_tracking_enabled" total_future_booked_time: "$ref": "#/components/schemas/resource_service_report/properties/total_future_booked_time" total_future_budget_used: "$ref": "#/components/schemas/resource_service_report/properties/total_future_budget_used" total_recognized_revenue: "$ref": "#/components/schemas/resource_service_report/properties/total_recognized_revenue" total_revenue_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_revenue_normalized" total_budget_used_default: "$ref": "#/components/schemas/resource_service_report/properties/total_budget_used_default" total_worked_cost_default: "$ref": "#/components/schemas/resource_service_report/properties/total_worked_cost_default" total_budget_total_default: "$ref": "#/components/schemas/resource_service_report/properties/total_budget_total_default" total_expense_cost_default: "$ref": "#/components/schemas/resource_service_report/properties/total_expense_cost_default" average_actual_rate_default: "$ref": "#/components/schemas/resource_service_report/properties/average_actual_rate_default" total_left_to_schedule_time: "$ref": "#/components/schemas/resource_service_report/properties/total_left_to_schedule_time" total_markup_amount_default: "$ref": "#/components/schemas/resource_service_report/properties/total_markup_amount_default" average_budget_usage_default: "$ref": "#/components/schemas/resource_service_report/properties/average_budget_usage_default" total_budget_used_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_budget_used_normalized" total_estimated_cost_default: "$ref": "#/components/schemas/resource_service_report/properties/total_estimated_cost_default" total_forecasted_budget_used: "$ref": "#/components/schemas/resource_service_report/properties/total_forecasted_budget_used" total_worked_cost_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_worked_cost_normalized" average_forecasted_time_usage: "$ref": "#/components/schemas/resource_service_report/properties/average_forecasted_time_usage" average_profit_margin_default: "$ref": "#/components/schemas/resource_service_report/properties/average_profit_margin_default" total_budget_total_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_budget_total_normalized" total_discount_amount_default: "$ref": "#/components/schemas/resource_service_report/properties/total_discount_amount_default" total_expense_cost_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_expense_cost_normalized" average_actual_rate_normalized: "$ref": "#/components/schemas/resource_service_report/properties/average_actual_rate_normalized" total_budget_remaining_default: "$ref": "#/components/schemas/resource_service_report/properties/total_budget_remaining_default" total_estimated_remaining_time: "$ref": "#/components/schemas/resource_service_report/properties/total_estimated_remaining_time" total_forecasted_billable_time: "$ref": "#/components/schemas/resource_service_report/properties/total_forecasted_billable_time" total_markup_amount_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_markup_amount_normalized" total_remaining_scheduled_time: "$ref": "#/components/schemas/resource_service_report/properties/total_remaining_scheduled_time" average_budget_usage_normalized: "$ref": "#/components/schemas/resource_service_report/properties/average_budget_usage_normalized" average_forecasted_budget_usage: "$ref": "#/components/schemas/resource_service_report/properties/average_forecasted_budget_usage" average_retainer_interval_count: "$ref": "#/components/schemas/resource_service_report/properties/average_retainer_interval_count" total_estimated_cost_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_estimated_cost_normalized" total_projected_revenue_default: "$ref": "#/components/schemas/resource_service_report/properties/total_projected_revenue_default" average_profit_margin_normalized: "$ref": "#/components/schemas/resource_service_report/properties/average_profit_margin_normalized" total_discount_amount_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_discount_amount_normalized" total_future_budget_used_default: "$ref": "#/components/schemas/resource_service_report/properties/total_future_budget_used_default" total_recognized_revenue_default: "$ref": "#/components/schemas/resource_service_report/properties/total_recognized_revenue_default" total_budget_remaining_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_budget_remaining_normalized" total_projected_revenue_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_projected_revenue_normalized" total_future_budget_used_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_future_budget_used_normalized" total_recognized_revenue_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_recognized_revenue_normalized" total_forecasted_budget_used_default: "$ref": "#/components/schemas/resource_service_report/properties/total_forecasted_budget_used_default" average_forecasted_budget_usage_default: "$ref": "#/components/schemas/resource_service_report/properties/average_forecasted_budget_usage_default" total_forecasted_budget_used_normalized: "$ref": "#/components/schemas/resource_service_report/properties/total_forecasted_budget_used_normalized" average_forecasted_budget_usage_normalized: "$ref": "#/components/schemas/resource_service_report/properties/average_forecasted_budget_usage_normalized" relationships: type: object properties: budget: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" section: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" contract: "$ref": "#/components/schemas/_single_relationship" pipeline: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" deal_status: "$ref": "#/components/schemas/_single_relationship" origin_deal: "$ref": "#/components/schemas/_single_relationship" responsible: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" owner_report: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" project_report: "$ref": "#/components/schemas/_single_relationship" origin_deal_report: "$ref": "#/components/schemas/_single_relationship" deal_or_budget_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection service report collection_expense: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_expense/properties/date" name: "$ref": "#/components/schemas/resource_expense/properties/name" draft: "$ref": "#/components/schemas/resource_expense/properties/draft" amount: "$ref": "#/components/schemas/resource_expense/properties/amount" markup: "$ref": "#/components/schemas/resource_expense/properties/markup" pay_on: "$ref": "#/components/schemas/resource_expense/properties/pay_on" profit: "$ref": "#/components/schemas/resource_expense/properties/profit" paid_on: "$ref": "#/components/schemas/resource_expense/properties/paid_on" approved: "$ref": "#/components/schemas/resource_expense/properties/approved" currency: "$ref": "#/components/schemas/resource_expense/properties/currency" exported: "$ref": "#/components/schemas/resource_expense/properties/exported" invoiced: "$ref": "#/components/schemas/resource_expense/properties/invoiced" position: "$ref": "#/components/schemas/resource_expense/properties/position" quantity: "$ref": "#/components/schemas/resource_expense/properties/quantity" rejected: "$ref": "#/components/schemas/resource_expense/properties/rejected" export_id: "$ref": "#/components/schemas/resource_expense/properties/export_id" created_at: "$ref": "#/components/schemas/resource_expense/properties/created_at" deleted_at: "$ref": "#/components/schemas/resource_expense/properties/deleted_at" export_url: "$ref": "#/components/schemas/resource_expense/properties/export_url" approved_at: "$ref": "#/components/schemas/resource_expense/properties/approved_at" exported_at: "$ref": "#/components/schemas/resource_expense/properties/exported_at" rejected_at: "$ref": "#/components/schemas/resource_expense/properties/rejected_at" reimbursable: "$ref": "#/components/schemas/resource_expense/properties/reimbursable" total_amount: "$ref": "#/components/schemas/resource_expense/properties/total_amount" custom_fields: "$ref": "#/components/schemas/resource_expense/properties/custom_fields" exchange_date: "$ref": "#/components/schemas/resource_expense/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_expense/properties/exchange_rate" reimbursed_on: "$ref": "#/components/schemas/resource_expense/properties/reimbursed_on" tax_inclusion: "$ref": "#/components/schemas/resource_expense/properties/tax_inclusion" amount_default: "$ref": "#/components/schemas/resource_expense/properties/amount_default" profit_default: "$ref": "#/components/schemas/resource_expense/properties/profit_default" amount_with_tax: "$ref": "#/components/schemas/resource_expense/properties/amount_with_tax" billable_amount: "$ref": "#/components/schemas/resource_expense/properties/billable_amount" rejected_reason: "$ref": "#/components/schemas/resource_expense/properties/rejected_reason" currency_default: "$ref": "#/components/schemas/resource_expense/properties/currency_default" line_items_count: "$ref": "#/components/schemas/resource_expense/properties/line_items_count" allocation_status: "$ref": "#/components/schemas/resource_expense/properties/allocation_status" amount_normalized: "$ref": "#/components/schemas/resource_expense/properties/amount_normalized" profit_normalized: "$ref": "#/components/schemas/resource_expense/properties/profit_normalized" quantity_received: "$ref": "#/components/schemas/resource_expense/properties/quantity_received" recognized_revenue: "$ref": "#/components/schemas/resource_expense/properties/recognized_revenue" currency_normalized: "$ref": "#/components/schemas/resource_expense/properties/currency_normalized" external_payment_id: "$ref": "#/components/schemas/resource_expense/properties/external_payment_id" company_reference_id: "$ref": "#/components/schemas/resource_expense/properties/company_reference_id" total_amount_default: "$ref": "#/components/schemas/resource_expense/properties/total_amount_default" total_amount_with_tax: "$ref": "#/components/schemas/resource_expense/properties/total_amount_with_tax" amount_with_tax_default: "$ref": "#/components/schemas/resource_expense/properties/amount_with_tax_default" billable_amount_default: "$ref": "#/components/schemas/resource_expense/properties/billable_amount_default" total_amount_normalized: "$ref": "#/components/schemas/resource_expense/properties/total_amount_normalized" exchange_rate_normalized: "$ref": "#/components/schemas/resource_expense/properties/exchange_rate_normalized" amount_with_tax_normalized: "$ref": "#/components/schemas/resource_expense/properties/amount_with_tax_normalized" billable_amount_normalized: "$ref": "#/components/schemas/resource_expense/properties/billable_amount_normalized" export_integration_type_id: "$ref": "#/components/schemas/resource_expense/properties/export_integration_type_id" recognized_revenue_default: "$ref": "#/components/schemas/resource_expense/properties/recognized_revenue_default" recognized_revenue_normalized: "$ref": "#/components/schemas/resource_expense/properties/recognized_revenue_normalized" total_amount_with_tax_default: "$ref": "#/components/schemas/resource_expense/properties/total_amount_with_tax_default" total_amount_with_tax_normalized: "$ref": "#/components/schemas/resource_expense/properties/total_amount_with_tax_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" vendor: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" approver: "$ref": "#/components/schemas/_single_relationship" rejecter: "$ref": "#/components/schemas/_single_relationship" tax_rate: "$ref": "#/components/schemas/_single_relationship" attachment: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" purchase_order: "$ref": "#/components/schemas/_single_relationship" approval_statuses: "$ref": "#/components/schemas/_collection_relationship" expense_line_items: "$ref": "#/components/schemas/_collection_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" invoice_attribution: "$ref": "#/components/schemas/_single_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection expense single_invoice_template: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_invoice_template/properties/note" subject: "$ref": "#/components/schemas/resource_invoice_template/properties/subject" custom_fields: "$ref": "#/components/schemas/resource_invoice_template/properties/custom_fields" invoice_due_in_days: "$ref": "#/components/schemas/resource_invoice_template/properties/invoice_due_in_days" bank_account_details: "$ref": "#/components/schemas/resource_invoice_template/properties/bank_account_details" invoice_creation_options: "$ref": "#/components/schemas/resource_invoice_template/properties/invoice_creation_options" relationships: type: object properties: budget: "$ref": "#/components/schemas/_single_relationship" issuer: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" bank_account: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_type: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single invoice template single_placeholder: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: icon: "$ref": "#/components/schemas/resource_placeholder/properties/icon" name: "$ref": "#/components/schemas/resource_placeholder/properties/name" type: "$ref": "#/components/schemas/resource_placeholder/properties/type" color: "$ref": "#/components/schemas/resource_placeholder/properties/color" category: "$ref": "#/components/schemas/resource_placeholder/properties/category" created_at: "$ref": "#/components/schemas/resource_placeholder/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_placeholder/properties/updated_at" relationships: type: object properties: project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single placeholder collection_team: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_team/properties/name" icon_id: "$ref": "#/components/schemas/resource_team/properties/icon_id" color_id: "$ref": "#/components/schemas/resource_team/properties/color_id" relationships: type: object properties: members: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection team collection_pulse: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: type_id: "$ref": "#/components/schemas/resource_pulse/properties/type_id" recipients: "$ref": "#/components/schemas/resource_pulse/properties/recipients" teams_team: "$ref": "#/components/schemas/resource_pulse/properties/teams_team" test_pulse: "$ref": "#/components/schemas/resource_pulse/properties/test_pulse" export_params: "$ref": "#/components/schemas/resource_pulse/properties/export_params" schedule_hour: "$ref": "#/components/schemas/resource_pulse/properties/schedule_hour" skip_if_empty: "$ref": "#/components/schemas/resource_pulse/properties/skip_if_empty" slack_channel: "$ref": "#/components/schemas/resource_pulse/properties/slack_channel" teams_channel: "$ref": "#/components/schemas/resource_pulse/properties/teams_channel" deactivated_at: "$ref": "#/components/schemas/resource_pulse/properties/deactivated_at" schedule_day_id: "$ref": "#/components/schemas/resource_pulse/properties/schedule_day_id" schedule_frame_id: "$ref": "#/components/schemas/resource_pulse/properties/schedule_frame_id" document_format_id: "$ref": "#/components/schemas/resource_pulse/properties/document_format_id" repeat_schedule_id: "$ref": "#/components/schemas/resource_pulse/properties/repeat_schedule_id" relationships: type: object properties: filter: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" memberships: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection pulse single_approval_policy: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_approval_policy/properties/name" custom: "$ref": "#/components/schemas/resource_approval_policy/properties/custom" default: "$ref": "#/components/schemas/resource_approval_policy/properties/default" type_id: "$ref": "#/components/schemas/resource_approval_policy/properties/type_id" archived_at: "$ref": "#/components/schemas/resource_approval_policy/properties/archived_at" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single approval policy collection_lost_reason: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_lost_reason/properties/name" archived_at: "$ref": "#/components/schemas/resource_lost_reason/properties/archived_at" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection lost reason single_time_entry: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: cost: "$ref": "#/components/schemas/resource_time_entry/properties/cost" date: "$ref": "#/components/schemas/resource_time_entry/properties/date" note: "$ref": "#/components/schemas/resource_time_entry/properties/note" time: "$ref": "#/components/schemas/resource_time_entry/properties/time" approved: "$ref": "#/components/schemas/resource_time_entry/properties/approved" currency: "$ref": "#/components/schemas/resource_time_entry/properties/currency" invoiced: "$ref": "#/components/schemas/resource_time_entry/properties/invoiced" overhead: "$ref": "#/components/schemas/resource_time_entry/properties/overhead" rejected: "$ref": "#/components/schemas/resource_time_entry/properties/rejected" submitted: "$ref": "#/components/schemas/resource_time_entry/properties/submitted" work_cost: "$ref": "#/components/schemas/resource_time_entry/properties/work_cost" created_at: "$ref": "#/components/schemas/resource_time_entry/properties/created_at" started_at: "$ref": "#/components/schemas/resource_time_entry/properties/started_at" updated_at: "$ref": "#/components/schemas/resource_time_entry/properties/updated_at" approved_at: "$ref": "#/components/schemas/resource_time_entry/properties/approved_at" rejected_at: "$ref": "#/components/schemas/resource_time_entry/properties/rejected_at" cost_default: "$ref": "#/components/schemas/resource_time_entry/properties/cost_default" billable_time: "$ref": "#/components/schemas/resource_time_entry/properties/billable_time" jira_issue_id: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id" overhead_cost: "$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost" cost_normalized: "$ref": "#/components/schemas/resource_time_entry/properties/cost_normalized" jira_worklog_id: "$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id" recognized_time: "$ref": "#/components/schemas/resource_time_entry/properties/recognized_time" rejected_reason: "$ref": "#/components/schemas/resource_time_entry/properties/rejected_reason" track_method_id: "$ref": "#/components/schemas/resource_time_entry/properties/track_method_id" currency_default: "$ref": "#/components/schemas/resource_time_entry/properties/currency_default" last_activity_at: "$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at" timer_started_at: "$ref": "#/components/schemas/resource_time_entry/properties/timer_started_at" timer_stopped_at: "$ref": "#/components/schemas/resource_time_entry/properties/timer_stopped_at" calendar_event_id: "$ref": "#/components/schemas/resource_time_entry/properties/calendar_event_id" jira_issue_status: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status" jira_organization: "$ref": "#/components/schemas/resource_time_entry/properties/jira_organization" work_cost_default: "$ref": "#/components/schemas/resource_time_entry/properties/work_cost_default" jira_issue_summary: "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary" currency_normalized: "$ref": "#/components/schemas/resource_time_entry/properties/currency_normalized" work_cost_normalized: "$ref": "#/components/schemas/resource_time_entry/properties/work_cost_normalized" overhead_cost_default: "$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost_default" facility_overhead_cost: "$ref": "#/components/schemas/resource_time_entry/properties/facility_overhead_cost" internal_overhead_cost: "$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost" invoice_attribution_id: "$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id" overhead_cost_normalized: "$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost_normalized" facility_overhead_cost_default: "$ref": "#/components/schemas/resource_time_entry/properties/facility_overhead_cost_default" internal_overhead_cost_default: "$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost_default" facility_overhead_cost_normalized: "$ref": "#/components/schemas/resource_time_entry/properties/facility_overhead_cost_normalized" internal_overhead_cost_normalized: "$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost_normalized" relationships: type: object properties: task: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" approver: "$ref": "#/components/schemas/_single_relationship" rejecter: "$ref": "#/components/schemas/_single_relationship" timesheet: "$ref": "#/components/schemas/_single_relationship" last_actor: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" deal_subsidiary: "$ref": "#/components/schemas/_single_relationship" approval_statuses: "$ref": "#/components/schemas/_collection_relationship" person_subsidiary: "$ref": "#/components/schemas/_single_relationship" invoice_attribution: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single time entry collection_holiday_calendar: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_holiday_calendar/properties/name" state: "$ref": "#/components/schemas/resource_holiday_calendar/properties/state" country: "$ref": "#/components/schemas/resource_holiday_calendar/properties/country" autogenerate_holidays: "$ref": "#/components/schemas/resource_holiday_calendar/properties/autogenerate_holidays" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection holiday calendar collection_survey_field_option: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_survey_field_option/properties/name" color_id: "$ref": "#/components/schemas/resource_survey_field_option/properties/color_id" position: "$ref": "#/components/schemas/resource_survey_field_option/properties/position" archived_at: "$ref": "#/components/schemas/resource_survey_field_option/properties/archived_at" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" survey_field: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection survey field option single_holiday: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_holiday/properties/date" name: "$ref": "#/components/schemas/resource_holiday/properties/name" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" holiday_calendar: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single holiday collection_person_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: type: "$ref": "#/components/schemas/resource_person_report/properties/type" week: "$ref": "#/components/schemas/resource_person_report/properties/week" year: "$ref": "#/components/schemas/resource_person_report/properties/year" count: "$ref": "#/components/schemas/resource_person_report/properties/count" group: "$ref": "#/components/schemas/resource_person_report/properties/group" month: "$ref": "#/components/schemas/resource_person_report/properties/month" status: "$ref": "#/components/schemas/resource_person_report/properties/status" quarter: "$ref": "#/components/schemas/resource_person_report/properties/quarter" role_id: "$ref": "#/components/schemas/resource_person_report/properties/role_id" currency: "$ref": "#/components/schemas/resource_person_report/properties/currency" autotracking: "$ref": "#/components/schemas/resource_person_report/properties/autotracking" contact_city: "$ref": "#/components/schemas/resource_person_report/properties/contact_city" contact_email: "$ref": "#/components/schemas/resource_person_report/properties/contact_email" contact_phone: "$ref": "#/components/schemas/resource_person_report/properties/contact_phone" contact_state: "$ref": "#/components/schemas/resource_person_report/properties/contact_state" custom_fields: "$ref": "#/components/schemas/resource_person_report/properties/custom_fields" formula_fields: "$ref": "#/components/schemas/resource_person_report/properties/formula_fields" contact_address: "$ref": "#/components/schemas/resource_person_report/properties/contact_address" contact_country: "$ref": "#/components/schemas/resource_person_report/properties/contact_country" contact_website: "$ref": "#/components/schemas/resource_person_report/properties/contact_website" contact_zipcode: "$ref": "#/components/schemas/resource_person_report/properties/contact_zipcode" currency_default: "$ref": "#/components/schemas/resource_person_report/properties/currency_default" joined_at_period: "$ref": "#/components/schemas/resource_person_report/properties/joined_at_period" created_at_period: "$ref": "#/components/schemas/resource_person_report/properties/created_at_period" offboarding_status: "$ref": "#/components/schemas/resource_person_report/properties/offboarding_status" currency_normalized: "$ref": "#/components/schemas/resource_person_report/properties/currency_normalized" deactivated_at_period: "$ref": "#/components/schemas/resource_person_report/properties/deactivated_at_period" last_activity_at_period: "$ref": "#/components/schemas/resource_person_report/properties/last_activity_at_period" relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" manager: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" custom_role: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" manager_report: "$ref": "#/components/schemas/_single_relationship" approval_policy: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection person report single_tax_rate: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_tax_rate/properties/name" archived_at: "$ref": "#/components/schemas/resource_tax_rate/properties/archived_at" primary_component_name: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_name" primary_component_value: "$ref": "#/components/schemas/resource_tax_rate/properties/primary_component_value" secondary_component_name: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_name" secondary_component_value: "$ref": "#/components/schemas/resource_tax_rate/properties/secondary_component_value" relationships: type: object properties: subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single tax rate collection_contact_entry: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: vat: "$ref": "#/components/schemas/resource_contact_entry/properties/vat" city: "$ref": "#/components/schemas/resource_contact_entry/properties/city" name: "$ref": "#/components/schemas/resource_contact_entry/properties/name" type: "$ref": "#/components/schemas/resource_contact_entry/properties/type" email: "$ref": "#/components/schemas/resource_contact_entry/properties/email" phone: "$ref": "#/components/schemas/resource_contact_entry/properties/phone" state: "$ref": "#/components/schemas/resource_contact_entry/properties/state" address: "$ref": "#/components/schemas/resource_contact_entry/properties/address" country: "$ref": "#/components/schemas/resource_contact_entry/properties/country" website: "$ref": "#/components/schemas/resource_contact_entry/properties/website" zipcode: "$ref": "#/components/schemas/resource_contact_entry/properties/zipcode" billing_email: "$ref": "#/components/schemas/resource_contact_entry/properties/billing_email" billing_address: "$ref": "#/components/schemas/resource_contact_entry/properties/billing_address" contactable_type: "$ref": "#/components/schemas/resource_contact_entry/properties/contactable_type" relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" purchase_order: "$ref": "#/components/schemas/_single_relationship" invoice_template: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection contact entry collection_subsidiary: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_subsidiary/properties/name" archived_at: "$ref": "#/components/schemas/resource_subsidiary/properties/archived_at" facility_costs: "$ref": "#/components/schemas/resource_subsidiary/properties/facility_costs" invoice_logo_url: "$ref": "#/components/schemas/resource_subsidiary/properties/invoice_logo_url" show_delivery_date: "$ref": "#/components/schemas/resource_subsidiary/properties/show_delivery_date" invoice_number_scope: "$ref": "#/components/schemas/resource_subsidiary/properties/invoice_number_scope" invoice_number_format: "$ref": "#/components/schemas/resource_subsidiary/properties/invoice_number_format" facility_costs_default: "$ref": "#/components/schemas/resource_subsidiary/properties/facility_costs_default" facility_costs_breakdown: "$ref": "#/components/schemas/resource_subsidiary/properties/facility_costs_breakdown" facility_costs_normalized: "$ref": "#/components/schemas/resource_subsidiary/properties/facility_costs_normalized" export_integration_type_id: "$ref": "#/components/schemas/resource_subsidiary/properties/export_integration_type_id" relationships: type: object properties: bill_from: "$ref": "#/components/schemas/_single_relationship" integration: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" custom_domain: "$ref": "#/components/schemas/_single_relationship" default_tax_rate: "$ref": "#/components/schemas/_single_relationship" einvoice_identity: "$ref": "#/components/schemas/_single_relationship" default_bank_account: "$ref": "#/components/schemas/_single_relationship" default_document_type: "$ref": "#/components/schemas/_single_relationship" einvoice_configuration: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection subsidiary collection_dashboard: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_dashboard/properties/name" created_at: "$ref": "#/components/schemas/resource_dashboard/properties/created_at" is_private: "$ref": "#/components/schemas/resource_dashboard/properties/is_private" updated_at: "$ref": "#/components/schemas/resource_dashboard/properties/updated_at" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection dashboard collection_task_list: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_task_list/properties/name" position: "$ref": "#/components/schemas/resource_task_list/properties/position" email_key: "$ref": "#/components/schemas/resource_task_list/properties/email_key" placement: "$ref": "#/components/schemas/resource_task_list/properties/placement" archived_at: "$ref": "#/components/schemas/resource_task_list/properties/archived_at" relationships: type: object properties: board: "$ref": "#/components/schemas/_single_relationship" folder: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection task list collection_deal_status: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_deal_status/properties/name" used: "$ref": "#/components/schemas/resource_deal_status/properties/used" color_id: "$ref": "#/components/schemas/resource_deal_status/properties/color_id" position: "$ref": "#/components/schemas/resource_deal_status/properties/position" status_id: "$ref": "#/components/schemas/resource_deal_status/properties/status_id" archived_at: "$ref": "#/components/schemas/resource_deal_status/properties/archived_at" probability: "$ref": "#/components/schemas/resource_deal_status/properties/probability" lost_reason_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/lost_reason_enabled" probability_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/probability_enabled" time_tracking_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/time_tracking_enabled" booking_tracking_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/booking_tracking_enabled" expense_tracking_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/expense_tracking_enabled" relationships: type: object properties: pipeline: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection deal status single_kpd_code: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: code: "$ref": "#/components/schemas/resource_kpd_code/properties/code" is_kpd: "$ref": "#/components/schemas/resource_kpd_code/properties/is_kpd" kpd_name: "$ref": "#/components/schemas/resource_kpd_code/properties/kpd_name" nkd_name: "$ref": "#/components/schemas/resource_kpd_code/properties/nkd_name" created_at: "$ref": "#/components/schemas/resource_kpd_code/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_kpd_code/properties/updated_at" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Successful response containing a single KPD code resource. single_integration_exporter_configuration: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: company_type: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/company_type" datev_client_account_code: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/datev_client_account_code" datev_vendor_account_code: "$ref": "#/components/schemas/resource_integration_exporter_configuration/properties/datev_vendor_account_code" relationships: type: object properties: company: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single integration exporter configuration collection_survey_response: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: created_at: "$ref": "#/components/schemas/resource_survey_response/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_survey_response/properties/updated_at" survey_fields: "$ref": "#/components/schemas/resource_survey_response/properties/survey_fields" relationships: type: object properties: survey: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection survey response collection_report_category: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_report_category/properties/name" color_id: "$ref": "#/components/schemas/resource_report_category/properties/color_id" position: "$ref": "#/components/schemas/resource_report_category/properties/position" deleted_at: "$ref": "#/components/schemas/resource_report_category/properties/deleted_at" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection report category collection_invoice_attribution: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: amount: "$ref": "#/components/schemas/resource_invoice_attribution/properties/amount" date_to: "$ref": "#/components/schemas/resource_invoice_attribution/properties/date_to" currency: "$ref": "#/components/schemas/resource_invoice_attribution/properties/currency" date_from: "$ref": "#/components/schemas/resource_invoice_attribution/properties/date_from" amount_default: "$ref": "#/components/schemas/resource_invoice_attribution/properties/amount_default" currency_default: "$ref": "#/components/schemas/resource_invoice_attribution/properties/currency_default" amount_normalized: "$ref": "#/components/schemas/resource_invoice_attribution/properties/amount_normalized" currency_normalized: "$ref": "#/components/schemas/resource_invoice_attribution/properties/currency_normalized" relationships: type: object properties: budget: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection invoice attribution single_document_type: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_document_type/properties/name" note: "$ref": "#/components/schemas/resource_document_type/properties/note" footer: "$ref": "#/components/schemas/resource_document_type/properties/footer" locale: "$ref": "#/components/schemas/resource_document_type/properties/locale" tax1_name: "$ref": "#/components/schemas/resource_document_type/properties/tax1_name" tax2_name: "$ref": "#/components/schemas/resource_document_type/properties/tax2_name" email_data: "$ref": "#/components/schemas/resource_document_type/properties/email_data" tax1_value: "$ref": "#/components/schemas/resource_document_type/properties/tax1_value" tax2_value: "$ref": "#/components/schemas/resource_document_type/properties/tax2_value" archived_at: "$ref": "#/components/schemas/resource_document_type/properties/archived_at" body_template: "$ref": "#/components/schemas/resource_document_type/properties/body_template" dual_currency: "$ref": "#/components/schemas/resource_document_type/properties/dual_currency" email_subject: "$ref": "#/components/schemas/resource_document_type/properties/email_subject" scss_template: "$ref": "#/components/schemas/resource_document_type/properties/scss_template" email_template: "$ref": "#/components/schemas/resource_document_type/properties/email_template" filename_schema: "$ref": "#/components/schemas/resource_document_type/properties/filename_schema" footer_template: "$ref": "#/components/schemas/resource_document_type/properties/footer_template" header_template: "$ref": "#/components/schemas/resource_document_type/properties/header_template" exporter_options: "$ref": "#/components/schemas/resource_document_type/properties/exporter_options" template_options: "$ref": "#/components/schemas/resource_document_type/properties/template_options" exportable_type_id: "$ref": "#/components/schemas/resource_document_type/properties/exportable_type_id" document_template_id: "$ref": "#/components/schemas/resource_document_type/properties/document_template_id" relationships: type: object properties: subsidiary: "$ref": "#/components/schemas/_single_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_style: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single document type single_section: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_section/properties/name" position: "$ref": "#/components/schemas/resource_section/properties/position" preferences: "$ref": "#/components/schemas/resource_section/properties/preferences" editor_config: "$ref": "#/components/schemas/resource_section/properties/editor_config" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single section collection_price: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_price/properties/name" rate: "$ref": "#/components/schemas/resource_price/properties/rate" markup: "$ref": "#/components/schemas/resource_price/properties/markup" unit_id: "$ref": "#/components/schemas/resource_price/properties/unit_id" currency: "$ref": "#/components/schemas/resource_price/properties/currency" discount: "$ref": "#/components/schemas/resource_price/properties/discount" quantity: "$ref": "#/components/schemas/resource_price/properties/quantity" updated_at: "$ref": "#/components/schemas/resource_price/properties/updated_at" rate_default: "$ref": "#/components/schemas/resource_price/properties/rate_default" custom_fields: "$ref": "#/components/schemas/resource_price/properties/custom_fields" editor_config: "$ref": "#/components/schemas/resource_price/properties/editor_config" estimated_cost: "$ref": "#/components/schemas/resource_price/properties/estimated_cost" billing_type_id: "$ref": "#/components/schemas/resource_price/properties/billing_type_id" estimated_hours: "$ref": "#/components/schemas/resource_price/properties/estimated_hours" rate_normalized: "$ref": "#/components/schemas/resource_price/properties/rate_normalized" currency_default: "$ref": "#/components/schemas/resource_price/properties/currency_default" budget_cap_enabled: "$ref": "#/components/schemas/resource_price/properties/budget_cap_enabled" currency_normalized: "$ref": "#/components/schemas/resource_price/properties/currency_normalized" time_tracking_enabled: "$ref": "#/components/schemas/resource_price/properties/time_tracking_enabled" estimated_cost_default: "$ref": "#/components/schemas/resource_price/properties/estimated_cost_default" booking_tracking_enabled: "$ref": "#/components/schemas/resource_price/properties/booking_tracking_enabled" expense_tracking_enabled: "$ref": "#/components/schemas/resource_price/properties/expense_tracking_enabled" estimated_cost_normalized: "$ref": "#/components/schemas/resource_price/properties/estimated_cost_normalized" relationships: type: object properties: company: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" rate_card: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection price single_todo: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: closed: "$ref": "#/components/schemas/resource_todo/properties/closed" due_date: "$ref": "#/components/schemas/resource_todo/properties/due_date" due_time: "$ref": "#/components/schemas/resource_todo/properties/due_time" position: "$ref": "#/components/schemas/resource_todo/properties/position" closed_at: "$ref": "#/components/schemas/resource_todo/properties/closed_at" created_at: "$ref": "#/components/schemas/resource_todo/properties/created_at" todoable_type: "$ref": "#/components/schemas/resource_todo/properties/todoable_type" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" task: "$ref": "#/components/schemas/_single_relationship" assignee: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single todo collection_new_time_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: day: "$ref": "#/components/schemas/resource_new_time_report/properties/day" week: "$ref": "#/components/schemas/resource_new_time_report/properties/week" year: "$ref": "#/components/schemas/resource_new_time_report/properties/year" count: "$ref": "#/components/schemas/resource_new_time_report/properties/count" group: "$ref": "#/components/schemas/resource_new_time_report/properties/group" month: "$ref": "#/components/schemas/resource_new_time_report/properties/month" future: "$ref": "#/components/schemas/resource_new_time_report/properties/future" quarter: "$ref": "#/components/schemas/resource_new_time_report/properties/quarter" capacity: "$ref": "#/components/schemas/resource_new_time_report/properties/capacity" currency: "$ref": "#/components/schemas/resource_new_time_report/properties/currency" workload: "$ref": "#/components/schemas/resource_new_time_report/properties/workload" event_time: "$ref": "#/components/schemas/resource_new_time_report/properties/event_time" stage_type: "$ref": "#/components/schemas/resource_new_time_report/properties/stage_type" total_cost: "$ref": "#/components/schemas/resource_new_time_report/properties/total_cost" client_time: "$ref": "#/components/schemas/resource_new_time_report/properties/client_time" date_period: "$ref": "#/components/schemas/resource_new_time_report/properties/date_period" worked_time: "$ref": "#/components/schemas/resource_new_time_report/properties/worked_time" billing_type: "$ref": "#/components/schemas/resource_new_time_report/properties/billing_type" holiday_time: "$ref": "#/components/schemas/resource_new_time_report/properties/holiday_time" billable_time: "$ref": "#/components/schemas/resource_new_time_report/properties/billable_time" internal_time: "$ref": "#/components/schemas/resource_new_time_report/properties/internal_time" user_capacity: "$ref": "#/components/schemas/resource_new_time_report/properties/user_capacity" available_time: "$ref": "#/components/schemas/resource_new_time_report/properties/available_time" formula_fields: "$ref": "#/components/schemas/resource_new_time_report/properties/formula_fields" scheduled_time: "$ref": "#/components/schemas/resource_new_time_report/properties/scheduled_time" paid_event_time: "$ref": "#/components/schemas/resource_new_time_report/properties/paid_event_time" recognized_time: "$ref": "#/components/schemas/resource_new_time_report/properties/recognized_time" total_work_cost: "$ref": "#/components/schemas/resource_new_time_report/properties/total_work_cost" unapproved_time: "$ref": "#/components/schemas/resource_new_time_report/properties/unapproved_time" currency_default: "$ref": "#/components/schemas/resource_new_time_report/properties/currency_default" average_cost_rate: "$ref": "#/components/schemas/resource_new_time_report/properties/average_cost_rate" unpaid_event_time: "$ref": "#/components/schemas/resource_new_time_report/properties/unpaid_event_time" total_cost_default: "$ref": "#/components/schemas/resource_new_time_report/properties/total_cost_default" currency_normalized: "$ref": "#/components/schemas/resource_new_time_report/properties/currency_normalized" draft_scheduled_time: "$ref": "#/components/schemas/resource_new_time_report/properties/draft_scheduled_time" people_custom_fields: "$ref": "#/components/schemas/resource_new_time_report/properties/people_custom_fields" scheduled_event_time: "$ref": "#/components/schemas/resource_new_time_report/properties/scheduled_event_time" total_scheduled_cost: "$ref": "#/components/schemas/resource_new_time_report/properties/total_scheduled_cost" scheduled_client_time: "$ref": "#/components/schemas/resource_new_time_report/properties/scheduled_client_time" total_cost_normalized: "$ref": "#/components/schemas/resource_new_time_report/properties/total_cost_normalized" scheduled_billable_time: "$ref": "#/components/schemas/resource_new_time_report/properties/scheduled_billable_time" scheduled_internal_time: "$ref": "#/components/schemas/resource_new_time_report/properties/scheduled_internal_time" total_scheduled_revenue: "$ref": "#/components/schemas/resource_new_time_report/properties/total_scheduled_revenue" total_work_cost_default: "$ref": "#/components/schemas/resource_new_time_report/properties/total_work_cost_default" average_cost_rate_default: "$ref": "#/components/schemas/resource_new_time_report/properties/average_cost_rate_default" recognized_scheduled_time: "$ref": "#/components/schemas/resource_new_time_report/properties/recognized_scheduled_time" scheduled_remote_work_time: "$ref": "#/components/schemas/resource_new_time_report/properties/scheduled_remote_work_time" total_draft_scheduled_cost: "$ref": "#/components/schemas/resource_new_time_report/properties/total_draft_scheduled_cost" total_work_cost_normalized: "$ref": "#/components/schemas/resource_new_time_report/properties/total_work_cost_normalized" draft_scheduled_client_time: "$ref": "#/components/schemas/resource_new_time_report/properties/draft_scheduled_client_time" average_cost_rate_normalized: "$ref": "#/components/schemas/resource_new_time_report/properties/average_cost_rate_normalized" total_scheduled_cost_default: "$ref": "#/components/schemas/resource_new_time_report/properties/total_scheduled_cost_default" draft_scheduled_billable_time: "$ref": "#/components/schemas/resource_new_time_report/properties/draft_scheduled_billable_time" draft_scheduled_internal_time: "$ref": "#/components/schemas/resource_new_time_report/properties/draft_scheduled_internal_time" total_draft_scheduled_revenue: "$ref": "#/components/schemas/resource_new_time_report/properties/total_draft_scheduled_revenue" total_scheduled_cost_normalized: "$ref": "#/components/schemas/resource_new_time_report/properties/total_scheduled_cost_normalized" total_scheduled_revenue_default: "$ref": "#/components/schemas/resource_new_time_report/properties/total_scheduled_revenue_default" total_draft_scheduled_cost_default: "$ref": "#/components/schemas/resource_new_time_report/properties/total_draft_scheduled_cost_default" total_scheduled_revenue_normalized: "$ref": "#/components/schemas/resource_new_time_report/properties/total_scheduled_revenue_normalized" total_draft_scheduled_cost_normalized: "$ref": "#/components/schemas/resource_new_time_report/properties/total_draft_scheduled_cost_normalized" total_draft_scheduled_revenue_default: "$ref": "#/components/schemas/resource_new_time_report/properties/total_draft_scheduled_revenue_default" total_draft_scheduled_revenue_normalized: "$ref": "#/components/schemas/resource_new_time_report/properties/total_draft_scheduled_revenue_normalized" relationships: type: object properties: event: "$ref": "#/components/schemas/_single_relationship" budget: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" manager: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" person_report: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" project_report: "$ref": "#/components/schemas/_single_relationship" deal_or_budget_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection new time report single_deleted_item: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_deleted_item/properties/name" item_id: "$ref": "#/components/schemas/resource_deleted_item/properties/item_id" private: "$ref": "#/components/schemas/resource_deleted_item/properties/private" location: "$ref": "#/components/schemas/resource_deleted_item/properties/location" item_type: "$ref": "#/components/schemas/resource_deleted_item/properties/item_type" created_at: "$ref": "#/components/schemas/resource_deleted_item/properties/created_at" deleter_id: "$ref": "#/components/schemas/resource_deleted_item/properties/deleter_id" recovered_at: "$ref": "#/components/schemas/resource_deleted_item/properties/recovered_at" relationships: type: object properties: deleter: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single deleted item single_person: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: agent: "$ref": "#/components/schemas/resource_person/properties/agent" email: "$ref": "#/components/schemas/resource_person/properties/email" title: "$ref": "#/components/schemas/resource_person/properties/title" contact: "$ref": "#/components/schemas/resource_person/properties/contact" is_user: "$ref": "#/components/schemas/resource_person/properties/is_user" role_id: "$ref": "#/components/schemas/resource_person/properties/role_id" user_id: "$ref": "#/components/schemas/resource_person/properties/user_id" virtual: "$ref": "#/components/schemas/resource_person/properties/virtual" champion: "$ref": "#/components/schemas/resource_person/properties/champion" color_id: "$ref": "#/components/schemas/resource_person/properties/color_id" nickname: "$ref": "#/components/schemas/resource_person/properties/nickname" tag_list: "$ref": "#/components/schemas/resource_person/properties/tag_list" joined_at: "$ref": "#/components/schemas/resource_person/properties/joined_at" last_name: "$ref": "#/components/schemas/resource_person/properties/last_name" avatar_url: "$ref": "#/components/schemas/resource_person/properties/avatar_url" created_at: "$ref": "#/components/schemas/resource_person/properties/created_at" first_name: "$ref": "#/components/schemas/resource_person/properties/first_name" invited_at: "$ref": "#/components/schemas/resource_person/properties/invited_at" archived_at: "$ref": "#/components/schemas/resource_person/properties/archived_at" external_id: "$ref": "#/components/schemas/resource_person/properties/external_id" hrm_type_id: "$ref": "#/components/schemas/resource_person/properties/hrm_type_id" placeholder: "$ref": "#/components/schemas/resource_person/properties/placeholder" sample_data: "$ref": "#/components/schemas/resource_person/properties/sample_data" status_text: "$ref": "#/components/schemas/resource_person/properties/status_text" autotracking: "$ref": "#/components/schemas/resource_person/properties/autotracking" last_seen_at: "$ref": "#/components/schemas/resource_person/properties/last_seen_at" status_emoji: "$ref": "#/components/schemas/resource_person/properties/status_emoji" custom_fields: "$ref": "#/components/schemas/resource_person/properties/custom_fields" external_sync: "$ref": "#/components/schemas/resource_person/properties/external_sync" time_unlocked: "$ref": "#/components/schemas/resource_person/properties/time_unlocked" availabilities: "$ref": "#/components/schemas/resource_person/properties/availabilities" deactivated_at: "$ref": "#/components/schemas/resource_person/properties/deactivated_at" offboarding_id: "$ref": "#/components/schemas/resource_person/properties/offboarding_id" two_factor_auth: "$ref": "#/components/schemas/resource_person/properties/two_factor_auth" last_activity_at: "$ref": "#/components/schemas/resource_person/properties/last_activity_at" time_unlocked_on: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_on" status_expires_at: "$ref": "#/components/schemas/resource_person/properties/status_expires_at" offboarding_status: "$ref": "#/components/schemas/resource_person/properties/offboarding_status" original_avatar_url: "$ref": "#/components/schemas/resource_person/properties/original_avatar_url" time_off_status_sync: "$ref": "#/components/schemas/resource_person/properties/time_off_status_sync" time_unlocked_end_date: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_end_date" time_unlocked_interval: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_interval" time_tracking_policy_id: "$ref": "#/components/schemas/resource_person/properties/time_tracking_policy_id" time_unlocked_period_id: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_period_id" time_unlocked_start_date: "$ref": "#/components/schemas/resource_person/properties/time_unlocked_start_date" timesheet_submission_disabled: "$ref": "#/components/schemas/resource_person/properties/timesheet_submission_disabled" relationships: type: object properties: teams: "$ref": "#/components/schemas/_collection_relationship" company: "$ref": "#/components/schemas/_single_relationship" manager: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" custom_role: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_types: "$ref": "#/components/schemas/_collection_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" time_tracking_policy: "$ref": "#/components/schemas/_single_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" approval_policy_assignment: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single person collection_deal_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: week: "$ref": "#/components/schemas/resource_deal_report/properties/week" year: "$ref": "#/components/schemas/resource_deal_report/properties/year" count: "$ref": "#/components/schemas/resource_deal_report/properties/count" group: "$ref": "#/components/schemas/resource_deal_report/properties/group" month: "$ref": "#/components/schemas/resource_deal_report/properties/month" quarter: "$ref": "#/components/schemas/resource_deal_report/properties/quarter" currency: "$ref": "#/components/schemas/resource_deal_report/properties/currency" retainer: "$ref": "#/components/schemas/resource_deal_report/properties/retainer" total_cost: "$ref": "#/components/schemas/resource_deal_report/properties/total_cost" date_period: "$ref": "#/components/schemas/resource_deal_report/properties/date_period" probability: "$ref": "#/components/schemas/resource_deal_report/properties/probability" average_rate: "$ref": "#/components/schemas/resource_deal_report/properties/average_rate" total_profit: "$ref": "#/components/schemas/resource_deal_report/properties/total_profit" custom_fields: "$ref": "#/components/schemas/resource_deal_report/properties/custom_fields" total_expense: "$ref": "#/components/schemas/resource_deal_report/properties/total_expense" total_revenue: "$ref": "#/components/schemas/resource_deal_report/properties/total_revenue" formula_fields: "$ref": "#/components/schemas/resource_deal_report/properties/formula_fields" stage_status_id: "$ref": "#/components/schemas/resource_deal_report/properties/stage_status_id" total_work_cost: "$ref": "#/components/schemas/resource_deal_report/properties/total_work_cost" currency_default: "$ref": "#/components/schemas/resource_deal_report/properties/currency_default" tracking_type_id: "$ref": "#/components/schemas/resource_deal_report/properties/tracking_type_id" created_at_period: "$ref": "#/components/schemas/resource_deal_report/properties/created_at_period" retainer_interval: "$ref": "#/components/schemas/resource_deal_report/properties/retainer_interval" total_budget_used: "$ref": "#/components/schemas/resource_deal_report/properties/total_budget_used" total_worked_time: "$ref": "#/components/schemas/resource_deal_report/properties/total_worked_time" total_budget_total: "$ref": "#/components/schemas/resource_deal_report/properties/total_budget_total" total_cost_default: "$ref": "#/components/schemas/resource_deal_report/properties/total_cost_default" average_actual_rate: "$ref": "#/components/schemas/resource_deal_report/properties/average_actual_rate" currency_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/currency_normalized" total_billable_time: "$ref": "#/components/schemas/resource_deal_report/properties/total_billable_time" total_budgeted_time: "$ref": "#/components/schemas/resource_deal_report/properties/total_budgeted_time" average_rate_default: "$ref": "#/components/schemas/resource_deal_report/properties/average_rate_default" previous_probability: "$ref": "#/components/schemas/resource_deal_report/properties/previous_probability" total_estimated_cost: "$ref": "#/components/schemas/resource_deal_report/properties/total_estimated_cost" total_estimated_time: "$ref": "#/components/schemas/resource_deal_report/properties/total_estimated_time" total_profit_default: "$ref": "#/components/schemas/resource_deal_report/properties/total_profit_default" total_cost_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/total_cost_normalized" total_expense_default: "$ref": "#/components/schemas/resource_deal_report/properties/total_expense_default" total_revenue_default: "$ref": "#/components/schemas/resource_deal_report/properties/total_revenue_default" sales_closed_at_period: "$ref": "#/components/schemas/resource_deal_report/properties/sales_closed_at_period" sales_closed_on_period: "$ref": "#/components/schemas/resource_deal_report/properties/sales_closed_on_period" total_services_revenue: "$ref": "#/components/schemas/resource_deal_report/properties/total_services_revenue" average_rate_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/average_rate_normalized" last_activity_at_period: "$ref": "#/components/schemas/resource_deal_report/properties/last_activity_at_period" stage_updated_at_period: "$ref": "#/components/schemas/resource_deal_report/properties/stage_updated_at_period" total_profit_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/total_profit_normalized" total_projected_revenue: "$ref": "#/components/schemas/resource_deal_report/properties/total_projected_revenue" total_work_cost_default: "$ref": "#/components/schemas/resource_deal_report/properties/total_work_cost_default" total_expense_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/total_expense_normalized" total_revenue_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/total_revenue_normalized" total_budget_used_default: "$ref": "#/components/schemas/resource_deal_report/properties/total_budget_used_default" average_days_since_created: "$ref": "#/components/schemas/resource_deal_report/properties/average_days_since_created" total_budget_from_services: "$ref": "#/components/schemas/resource_deal_report/properties/total_budget_from_services" total_budget_total_default: "$ref": "#/components/schemas/resource_deal_report/properties/total_budget_total_default" total_work_cost_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/total_work_cost_normalized" average_actual_rate_default: "$ref": "#/components/schemas/resource_deal_report/properties/average_actual_rate_default" total_budget_used_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/total_budget_used_normalized" total_estimated_cost_default: "$ref": "#/components/schemas/resource_deal_report/properties/total_estimated_cost_default" average_days_in_current_stage: "$ref": "#/components/schemas/resource_deal_report/properties/average_days_in_current_stage" total_budget_total_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/total_budget_total_normalized" average_actual_rate_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/average_actual_rate_normalized" total_estimated_remaining_time: "$ref": "#/components/schemas/resource_deal_report/properties/total_estimated_remaining_time" total_services_revenue_default: "$ref": "#/components/schemas/resource_deal_report/properties/total_services_revenue_default" average_retainer_interval_count: "$ref": "#/components/schemas/resource_deal_report/properties/average_retainer_interval_count" total_estimated_cost_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/total_estimated_cost_normalized" total_projected_revenue_default: "$ref": "#/components/schemas/resource_deal_report/properties/total_projected_revenue_default" average_days_since_last_activity: "$ref": "#/components/schemas/resource_deal_report/properties/average_days_since_last_activity" total_services_revenue_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/total_services_revenue_normalized" total_budget_from_services_default: "$ref": "#/components/schemas/resource_deal_report/properties/total_budget_from_services_default" total_projected_revenue_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/total_projected_revenue_normalized" total_budget_from_services_normalized: "$ref": "#/components/schemas/resource_deal_report/properties/total_budget_from_services_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" contact: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" pipeline: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" deal_status: "$ref": "#/components/schemas/_single_relationship" lost_reason: "$ref": "#/components/schemas/_single_relationship" responsible: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" owner_report: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" contact_report: "$ref": "#/components/schemas/_single_relationship" creator_report: "$ref": "#/components/schemas/_single_relationship" project_report: "$ref": "#/components/schemas/_single_relationship" primary_contact: "$ref": "#/components/schemas/_single_relationship" designated_approver: "$ref": "#/components/schemas/_single_relationship" previous_deal_status: "$ref": "#/components/schemas/_single_relationship" primary_contact_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection deal report single_einvoice_identity: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: dire_code: "$ref": "#/components/schemas/resource_einvoice_identity/properties/dire_code" peppol_id: "$ref": "#/components/schemas/resource_einvoice_identity/properties/peppol_id" created_at: "$ref": "#/components/schemas/resource_einvoice_identity/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_einvoice_identity/properties/updated_at" buyer_reference: "$ref": "#/components/schemas/resource_einvoice_identity/properties/buyer_reference" dir3_fiscal_code: "$ref": "#/components/schemas/resource_einvoice_identity/properties/dir3_fiscal_code" dir3_pagador_code: "$ref": "#/components/schemas/resource_einvoice_identity/properties/dir3_pagador_code" dir3_receptor_code: "$ref": "#/components/schemas/resource_einvoice_identity/properties/dir3_receptor_code" is_government_entity: "$ref": "#/components/schemas/resource_einvoice_identity/properties/is_government_entity" relationships: type: object properties: company: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Successful response containing a single e-invoice identity resource. single_integration: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_integration/properties/name" folders: "$ref": "#/components/schemas/resource_integration/properties/folders" options: "$ref": "#/components/schemas/resource_integration/properties/options" sso_url: "$ref": "#/components/schemas/resource_integration/properties/sso_url" realm_id: "$ref": "#/components/schemas/resource_integration/properties/realm_id" calendars: "$ref": "#/components/schemas/resource_integration/properties/calendars" client_id: "$ref": "#/components/schemas/resource_integration/properties/client_id" all_folders: "$ref": "#/components/schemas/resource_integration/properties/all_folders" request_uri: "$ref": "#/components/schemas/resource_integration/properties/request_uri" account_code: "$ref": "#/components/schemas/resource_integration/properties/account_code" connected_at: "$ref": "#/components/schemas/resource_integration/properties/connected_at" default_item: "$ref": "#/components/schemas/resource_integration/properties/default_item" item_mapping: "$ref": "#/components/schemas/resource_integration/properties/item_mapping" jira_project: "$ref": "#/components/schemas/resource_integration/properties/jira_project" redirect_uri: "$ref": "#/components/schemas/resource_integration/properties/redirect_uri" requested_at: "$ref": "#/components/schemas/resource_integration/properties/requested_at" sage_country: "$ref": "#/components/schemas/resource_integration/properties/sage_country" sso_metadata: "$ref": "#/components/schemas/resource_integration/properties/sso_metadata" exact_country: "$ref": "#/components/schemas/resource_integration/properties/exact_country" export_number: "$ref": "#/components/schemas/resource_integration/properties/export_number" import_number: "$ref": "#/components/schemas/resource_integration/properties/import_number" request_token: "$ref": "#/components/schemas/resource_integration/properties/request_token" slack_options: "$ref": "#/components/schemas/resource_integration/properties/slack_options" deactivated_at: "$ref": "#/components/schemas/resource_integration/properties/deactivated_at" exact_division: "$ref": "#/components/schemas/resource_integration/properties/exact_division" last_synced_at: "$ref": "#/components/schemas/resource_integration/properties/last_synced_at" sso_target_url: "$ref": "#/components/schemas/resource_integration/properties/sso_target_url" xero_reference: "$ref": "#/components/schemas/resource_integration/properties/xero_reference" default_product: "$ref": "#/components/schemas/resource_integration/properties/default_product" exact_divisions: "$ref": "#/components/schemas/resource_integration/properties/exact_divisions" force_sso_login: "$ref": "#/components/schemas/resource_integration/properties/force_sso_login" payments_import: "$ref": "#/components/schemas/resource_integration/properties/payments_import" quickbooks_memo: "$ref": "#/components/schemas/resource_integration/properties/quickbooks_memo" sso_metadata_url: "$ref": "#/components/schemas/resource_integration/properties/sso_metadata_url" tax_rate_mapping: "$ref": "#/components/schemas/resource_integration/properties/tax_rate_mapping" use_expense_sync: "$ref": "#/components/schemas/resource_integration/properties/use_expense_sync" exact_division_id: "$ref": "#/components/schemas/resource_integration/properties/exact_division_id" export_attachment: "$ref": "#/components/schemas/resource_integration/properties/export_attachment" hubspot_pipelines: "$ref": "#/components/schemas/resource_integration/properties/hubspot_pipelines" import_attachment: "$ref": "#/components/schemas/resource_integration/properties/import_attachment" jira_organization: "$ref": "#/components/schemas/resource_integration/properties/jira_organization" twinfield_offices: "$ref": "#/components/schemas/resource_integration/properties/twinfield_offices" hubspot_sync_deals: "$ref": "#/components/schemas/resource_integration/properties/hubspot_sync_deals" sage_business_name: "$ref": "#/components/schemas/resource_integration/properties/sage_business_name" xero_organizations: "$ref": "#/components/schemas/resource_integration/properties/xero_organizations" customer_memo_cf_id: "$ref": "#/components/schemas/resource_integration/properties/customer_memo_cf_id" integration_type_id: "$ref": "#/components/schemas/resource_integration/properties/integration_type_id" sage_default_ledger: "$ref": "#/components/schemas/resource_integration/properties/sage_default_ledger" sage_ledger_mapping: "$ref": "#/components/schemas/resource_integration/properties/sage_ledger_mapping" salesforce_stage_id: "$ref": "#/components/schemas/resource_integration/properties/salesforce_stage_id" use_invoices_export: "$ref": "#/components/schemas/resource_integration/properties/use_invoices_export" account_code_mapping: "$ref": "#/components/schemas/resource_integration/properties/account_code_mapping" exact_default_ledger: "$ref": "#/components/schemas/resource_integration/properties/exact_default_ledger" exact_ledger_mapping: "$ref": "#/components/schemas/resource_integration/properties/exact_ledger_mapping" use_companies_export: "$ref": "#/components/schemas/resource_integration/properties/use_companies_export" use_expenses_in_xero: "$ref": "#/components/schemas/resource_integration/properties/use_expenses_in_xero" xero_organization_id: "$ref": "#/components/schemas/resource_integration/properties/xero_organization_id" calendar_write_status: "$ref": "#/components/schemas/resource_integration/properties/calendar_write_status" exact_default_journal: "$ref": "#/components/schemas/resource_integration/properties/exact_default_journal" exact_ledger_manually: "$ref": "#/components/schemas/resource_integration/properties/exact_ledger_manually" netsuite_default_item: "$ref": "#/components/schemas/resource_integration/properties/netsuite_default_item" netsuite_item_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_item_mapping" sage_intacct_entities: "$ref": "#/components/schemas/resource_integration/properties/sage_intacct_entities" bamboo_workplace_field: "$ref": "#/components/schemas/resource_integration/properties/bamboo_workplace_field" calendar_write_options: "$ref": "#/components/schemas/resource_integration/properties/calendar_write_options" hubspot_stages_mapping: "$ref": "#/components/schemas/resource_integration/properties/hubspot_stages_mapping" xero_expense_status_id: "$ref": "#/components/schemas/resource_integration/properties/xero_expense_status_id" xero_invoice_status_id: "$ref": "#/components/schemas/resource_integration/properties/xero_invoice_status_id" bamboo_enable_time_offs: "$ref": "#/components/schemas/resource_integration/properties/bamboo_enable_time_offs" economic_export_subject: "$ref": "#/components/schemas/resource_integration/properties/economic_export_subject" fortnox_account_mapping: "$ref": "#/components/schemas/resource_integration/properties/fortnox_account_mapping" fortnox_article_mapping: "$ref": "#/components/schemas/resource_integration/properties/fortnox_article_mapping" fortnox_default_account: "$ref": "#/components/schemas/resource_integration/properties/fortnox_default_account" fortnox_default_article: "$ref": "#/components/schemas/resource_integration/properties/fortnox_default_article" bamboo_enable_cost_rates: "$ref": "#/components/schemas/resource_integration/properties/bamboo_enable_cost_rates" bamboo_workplace_mapping: "$ref": "#/components/schemas/resource_integration/properties/bamboo_workplace_mapping" economic_product_mapping: "$ref": "#/components/schemas/resource_integration/properties/economic_product_mapping" netsuite_invoice_form_id: "$ref": "#/components/schemas/resource_integration/properties/netsuite_invoice_form_id" netsuite_project_form_id: "$ref": "#/components/schemas/resource_integration/properties/netsuite_project_form_id" twinfield_default_ledger: "$ref": "#/components/schemas/resource_integration/properties/twinfield_default_ledger" twinfield_ledger_mapping: "$ref": "#/components/schemas/resource_integration/properties/twinfield_ledger_mapping" xero_internal_note_cf_id: "$ref": "#/components/schemas/resource_integration/properties/xero_internal_note_cf_id" export_expense_attachment: "$ref": "#/components/schemas/resource_integration/properties/export_expense_attachment" google_events_write_scope: "$ref": "#/components/schemas/resource_integration/properties/google_events_write_scope" netsuite_attach_timesheet: "$ref": "#/components/schemas/resource_integration/properties/netsuite_attach_timesheet" netsuite_customer_form_id: "$ref": "#/components/schemas/resource_integration/properties/netsuite_customer_form_id" sage_intacct_account_code: "$ref": "#/components/schemas/resource_integration/properties/sage_intacct_account_code" twinfield_default_project: "$ref": "#/components/schemas/resource_integration/properties/twinfield_default_project" twinfield_invoice_destiny: "$ref": "#/components/schemas/resource_integration/properties/twinfield_invoice_destiny" twinfield_project_mapping: "$ref": "#/components/schemas/resource_integration/properties/twinfield_project_mapping" hubspot_default_company_id: "$ref": "#/components/schemas/resource_integration/properties/hubspot_default_company_id" update_invoice_sent_status: "$ref": "#/components/schemas/resource_integration/properties/update_invoice_sent_status" use_purchase_orders_export: "$ref": "#/components/schemas/resource_integration/properties/use_purchase_orders_export" bamboo_custom_field_mapping: "$ref": "#/components/schemas/resource_integration/properties/bamboo_custom_field_mapping" hubspot_default_template_id: "$ref": "#/components/schemas/resource_integration/properties/hubspot_default_template_id" netsuite_invoice_pdf_source: "$ref": "#/components/schemas/resource_integration/properties/netsuite_invoice_pdf_source" sage_intacct_export_project: "$ref": "#/components/schemas/resource_integration/properties/sage_intacct_export_project" salesforce_subsidiary_field: "$ref": "#/components/schemas/resource_integration/properties/salesforce_subsidiary_field" bamboo_default_subsidiary_id: "$ref": "#/components/schemas/resource_integration/properties/bamboo_default_subsidiary_id" expense_account_code_mapping: "$ref": "#/components/schemas/resource_integration/properties/expense_account_code_mapping" export_purchase_order_number: "$ref": "#/components/schemas/resource_integration/properties/export_purchase_order_number" netsuite_credit_note_form_id: "$ref": "#/components/schemas/resource_integration/properties/netsuite_credit_note_form_id" netsuite_sales_order_form_id: "$ref": "#/components/schemas/resource_integration/properties/netsuite_sales_order_form_id" hubspot_default_deal_owner_id: "$ref": "#/components/schemas/resource_integration/properties/hubspot_default_deal_owner_id" hubspot_default_subsidiary_id: "$ref": "#/components/schemas/resource_integration/properties/hubspot_default_subsidiary_id" netsuite_relationship_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_relationship_mapping" sage_intacct_project_category: "$ref": "#/components/schemas/resource_integration/properties/sage_intacct_project_category" salesforce_subsidiary_mapping: "$ref": "#/components/schemas/resource_integration/properties/salesforce_subsidiary_mapping" twinfield_cost_center_mapping: "$ref": "#/components/schemas/resource_integration/properties/twinfield_cost_center_mapping" twinfield_default_cost_center: "$ref": "#/components/schemas/resource_integration/properties/twinfield_default_cost_center" xero_purchase_order_status_id: "$ref": "#/components/schemas/resource_integration/properties/xero_purchase_order_status_id" netsuite_default_subsidiary_id: "$ref": "#/components/schemas/resource_integration/properties/netsuite_default_subsidiary_id" netsuite_invoice_field_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_invoice_field_mapping" netsuite_project_field_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_project_field_mapping" salesforce_project_template_id: "$ref": "#/components/schemas/resource_integration/properties/salesforce_project_template_id" bamboo_enable_user_provisioning: "$ref": "#/components/schemas/resource_integration/properties/bamboo_enable_user_provisioning" netsuite_customer_field_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_customer_field_mapping" netsuite_line_item_field_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_line_item_field_mapping" salesforce_default_subsidiary_id: "$ref": "#/components/schemas/resource_integration/properties/salesforce_default_subsidiary_id" sage_intacct_account_code_mapping: "$ref": "#/components/schemas/resource_integration/properties/sage_intacct_account_code_mapping" salesforce_product_family_mapping: "$ref": "#/components/schemas/resource_integration/properties/salesforce_product_family_mapping" xero_default_expense_account_code: "$ref": "#/components/schemas/resource_integration/properties/xero_default_expense_account_code" netsuite_sales_order_field_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_sales_order_field_mapping" salesforce_default_service_type_id: "$ref": "#/components/schemas/resource_integration/properties/salesforce_default_service_type_id" purchase_order_account_code_mapping: "$ref": "#/components/schemas/resource_integration/properties/purchase_order_account_code_mapping" netsuite_invoice_fixed_value_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_invoice_fixed_value_mapping" netsuite_customer_fixed_value_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_customer_fixed_value_mapping" netsuite_line_item_fixed_value_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_line_item_fixed_value_mapping" quickbooks_default_expense_account_code: "$ref": "#/components/schemas/resource_integration/properties/quickbooks_default_expense_account_code" quickbooks_default_expense_payment_type: "$ref": "#/components/schemas/resource_integration/properties/quickbooks_default_expense_payment_type" xero_default_purchase_order_account_code: "$ref": "#/components/schemas/resource_integration/properties/xero_default_purchase_order_account_code" quickbooks_default_expense_bank_account_code: "$ref": "#/components/schemas/resource_integration/properties/quickbooks_default_expense_bank_account_code" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single integration single_invoice_attribution: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: amount: "$ref": "#/components/schemas/resource_invoice_attribution/properties/amount" date_to: "$ref": "#/components/schemas/resource_invoice_attribution/properties/date_to" currency: "$ref": "#/components/schemas/resource_invoice_attribution/properties/currency" date_from: "$ref": "#/components/schemas/resource_invoice_attribution/properties/date_from" amount_default: "$ref": "#/components/schemas/resource_invoice_attribution/properties/amount_default" currency_default: "$ref": "#/components/schemas/resource_invoice_attribution/properties/currency_default" amount_normalized: "$ref": "#/components/schemas/resource_invoice_attribution/properties/amount_normalized" currency_normalized: "$ref": "#/components/schemas/resource_invoice_attribution/properties/currency_normalized" relationships: type: object properties: budget: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single invoice attribution collection_entitlement_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: count: "$ref": "#/components/schemas/resource_entitlement_report/properties/count" group: "$ref": "#/components/schemas/resource_entitlement_report/properties/group" currency: "$ref": "#/components/schemas/resource_entitlement_report/properties/currency" total_used: "$ref": "#/components/schemas/resource_entitlement_report/properties/total_used" absence_type: "$ref": "#/components/schemas/resource_entitlement_report/properties/absence_type" total_pending: "$ref": "#/components/schemas/resource_entitlement_report/properties/total_pending" formula_fields: "$ref": "#/components/schemas/resource_entitlement_report/properties/formula_fields" end_date_period: "$ref": "#/components/schemas/resource_entitlement_report/properties/end_date_period" total_allocated: "$ref": "#/components/schemas/resource_entitlement_report/properties/total_allocated" total_available: "$ref": "#/components/schemas/resource_entitlement_report/properties/total_available" currency_default: "$ref": "#/components/schemas/resource_entitlement_report/properties/currency_default" start_date_period: "$ref": "#/components/schemas/resource_entitlement_report/properties/start_date_period" total_used_minutes: "$ref": "#/components/schemas/resource_entitlement_report/properties/total_used_minutes" currency_normalized: "$ref": "#/components/schemas/resource_entitlement_report/properties/currency_normalized" people_custom_fields: "$ref": "#/components/schemas/resource_entitlement_report/properties/people_custom_fields" total_pending_minutes: "$ref": "#/components/schemas/resource_entitlement_report/properties/total_pending_minutes" total_allocated_minutes: "$ref": "#/components/schemas/resource_entitlement_report/properties/total_allocated_minutes" total_available_minutes: "$ref": "#/components/schemas/resource_entitlement_report/properties/total_available_minutes" relationships: type: object properties: event: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" entitlement: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" person_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection entitlement report single_task_list: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_task_list/properties/name" position: "$ref": "#/components/schemas/resource_task_list/properties/position" email_key: "$ref": "#/components/schemas/resource_task_list/properties/email_key" placement: "$ref": "#/components/schemas/resource_task_list/properties/placement" archived_at: "$ref": "#/components/schemas/resource_task_list/properties/archived_at" relationships: type: object properties: board: "$ref": "#/components/schemas/_single_relationship" folder: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single task list collection_webhook_log: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: payload: "$ref": "#/components/schemas/resource_webhook_log/properties/payload" created_at: "$ref": "#/components/schemas/resource_webhook_log/properties/created_at" target_url: "$ref": "#/components/schemas/resource_webhook_log/properties/target_url" status_code: "$ref": "#/components/schemas/resource_webhook_log/properties/status_code" retry_job_id: "$ref": "#/components/schemas/resource_webhook_log/properties/retry_job_id" retry_attempt: "$ref": "#/components/schemas/resource_webhook_log/properties/retry_attempt" relationships: type: object properties: webhook: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection webhook log single_organization: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_organization/properties/name" flags: "$ref": "#/components/schemas/resource_organization/properties/flags" addons: "$ref": "#/components/schemas/resource_organization/properties/addons" locale: "$ref": "#/components/schemas/resource_organization/properties/locale" weight: "$ref": "#/components/schemas/resource_organization/properties/weight" metrics: "$ref": "#/components/schemas/resource_organization/properties/metrics" currency: "$ref": "#/components/schemas/resource_organization/properties/currency" due_days: "$ref": "#/components/schemas/resource_organization/properties/due_days" overhead: "$ref": "#/components/schemas/resource_organization/properties/overhead" email_key: "$ref": "#/components/schemas/resource_organization/properties/email_key" time_zone: "$ref": "#/components/schemas/resource_organization/properties/time_zone" ai_enabled: "$ref": "#/components/schemas/resource_organization/properties/ai_enabled" avatar_url: "$ref": "#/components/schemas/resource_organization/properties/avatar_url" erector_id: "$ref": "#/components/schemas/resource_organization/properties/erector_id" booked_demo: "$ref": "#/components/schemas/resource_organization/properties/booked_demo" verified_at: "$ref": "#/components/schemas/resource_organization/properties/verified_at" time_locking: "$ref": "#/components/schemas/resource_organization/properties/time_locking" analytics_uid: "$ref": "#/components/schemas/resource_organization/properties/analytics_uid" billing_email: "$ref": "#/components/schemas/resource_organization/properties/billing_email" deal_settings: "$ref": "#/components/schemas/resource_organization/properties/deal_settings" email_type_id: "$ref": "#/components/schemas/resource_organization/properties/email_type_id" working_hours: "$ref": "#/components/schemas/resource_organization/properties/working_hours" allow_time_off: "$ref": "#/components/schemas/resource_organization/properties/allow_time_off" date_format_id: "$ref": "#/components/schemas/resource_organization/properties/date_format_id" expense_markup: "$ref": "#/components/schemas/resource_organization/properties/expense_markup" facility_costs: "$ref": "#/components/schemas/resource_organization/properties/facility_costs" single_sign_on: "$ref": "#/components/schemas/resource_organization/properties/single_sign_on" time_format_id: "$ref": "#/components/schemas/resource_organization/properties/time_format_id" time_reminders: "$ref": "#/components/schemas/resource_organization/properties/time_reminders" domain_verified: "$ref": "#/components/schemas/resource_organization/properties/domain_verified" man_day_minutes: "$ref": "#/components/schemas/resource_organization/properties/man_day_minutes" remove_branding: "$ref": "#/components/schemas/resource_organization/properties/remove_branding" time_display_id: "$ref": "#/components/schemas/resource_organization/properties/time_display_id" allow_user_email: "$ref": "#/components/schemas/resource_organization/properties/allow_user_email" currency_default: "$ref": "#/components/schemas/resource_organization/properties/currency_default" email_local_name: "$ref": "#/components/schemas/resource_organization/properties/email_local_name" expense_settings: "$ref": "#/components/schemas/resource_organization/properties/expense_settings" financial_months: "$ref": "#/components/schemas/resource_organization/properties/financial_months" invitation_token: "$ref": "#/components/schemas/resource_organization/properties/invitation_token" number_format_id: "$ref": "#/components/schemas/resource_organization/properties/number_format_id" overhead_type_id: "$ref": "#/components/schemas/resource_organization/properties/overhead_type_id" self_attribution: "$ref": "#/components/schemas/resource_organization/properties/self_attribution" subsidiary_count: "$ref": "#/components/schemas/resource_organization/properties/subsidiary_count" time_reminder_at: "$ref": "#/components/schemas/resource_organization/properties/time_reminder_at" time_reminder_id: "$ref": "#/components/schemas/resource_organization/properties/time_reminder_id" decimal_places_id: "$ref": "#/components/schemas/resource_organization/properties/decimal_places_id" email_domain_name: "$ref": "#/components/schemas/resource_organization/properties/email_domain_name" email_sender_name: "$ref": "#/components/schemas/resource_organization/properties/email_sender_name" fiscal_year_start: "$ref": "#/components/schemas/resource_organization/properties/fiscal_year_start" scim_bearer_token: "$ref": "#/components/schemas/resource_organization/properties/scim_bearer_token" week_start_day_id: "$ref": "#/components/schemas/resource_organization/properties/week_start_day_id" currency_format_id: "$ref": "#/components/schemas/resource_organization/properties/currency_format_id" quick_start_config: "$ref": "#/components/schemas/resource_organization/properties/quick_start_config" rounding_method_id: "$ref": "#/components/schemas/resource_organization/properties/rounding_method_id" currency_normalized: "$ref": "#/components/schemas/resource_organization/properties/currency_normalized" onboarding_progress: "$ref": "#/components/schemas/resource_organization/properties/onboarding_progress" original_avatar_url: "$ref": "#/components/schemas/resource_organization/properties/original_avatar_url" force_single_sign_on: "$ref": "#/components/schemas/resource_organization/properties/force_single_sign_on" organization_type_id: "$ref": "#/components/schemas/resource_organization/properties/organization_type_id" rounding_interval_id: "$ref": "#/components/schemas/resource_organization/properties/rounding_interval_id" timesheet_submission: "$ref": "#/components/schemas/resource_organization/properties/timesheet_submission" force_two_factor_auth: "$ref": "#/components/schemas/resource_organization/properties/force_two_factor_auth" limited_service_types: "$ref": "#/components/schemas/resource_organization/properties/limited_service_types" time_locking_interval: "$ref": "#/components/schemas/resource_organization/properties/time_locking_interval" facility_costs_default: "$ref": "#/components/schemas/resource_organization/properties/facility_costs_default" time_locking_period_id: "$ref": "#/components/schemas/resource_organization/properties/time_locking_period_id" time_locking_reminders: "$ref": "#/components/schemas/resource_organization/properties/time_locking_reminders" verification_status_id: "$ref": "#/components/schemas/resource_organization/properties/verification_status_id" sample_data_imported_at: "$ref": "#/components/schemas/resource_organization/properties/sample_data_imported_at" sample_data_reverted_at: "$ref": "#/components/schemas/resource_organization/properties/sample_data_reverted_at" time_reminder_condition: "$ref": "#/components/schemas/resource_organization/properties/time_reminder_condition" time_tracking_policy_id: "$ref": "#/components/schemas/resource_organization/properties/time_tracking_policy_id" autotracking_schedule_id: "$ref": "#/components/schemas/resource_organization/properties/autotracking_schedule_id" conflict_resolver_active: "$ref": "#/components/schemas/resource_organization/properties/conflict_resolver_active" facility_costs_breakdown: "$ref": "#/components/schemas/resource_organization/properties/facility_costs_breakdown" self_attribution_comment: "$ref": "#/components/schemas/resource_organization/properties/self_attribution_comment" exchange_rate_provider_id: "$ref": "#/components/schemas/resource_organization/properties/exchange_rate_provider_id" facility_costs_normalized: "$ref": "#/components/schemas/resource_organization/properties/facility_costs_normalized" numbering_format_settings: "$ref": "#/components/schemas/resource_organization/properties/numbering_format_settings" invoice_rounding_method_id: "$ref": "#/components/schemas/resource_organization/properties/invoice_rounding_method_id" overhead_recalculation_day: "$ref": "#/components/schemas/resource_organization/properties/overhead_recalculation_day" revenue_recognition_type_id: "$ref": "#/components/schemas/resource_organization/properties/revenue_recognition_type_id" financial_month_locking_date: "$ref": "#/components/schemas/resource_organization/properties/financial_month_locking_date" overhead_amortization_period: "$ref": "#/components/schemas/resource_organization/properties/overhead_amortization_period" request_for_resource_enabled: "$ref": "#/components/schemas/resource_organization/properties/request_for_resource_enabled" timesheet_submission_settings: "$ref": "#/components/schemas/resource_organization/properties/timesheet_submission_settings" customer_success_specialist_id: "$ref": "#/components/schemas/resource_organization/properties/customer_success_specialist_id" time_tracking_policies_enabled: "$ref": "#/components/schemas/resource_organization/properties/time_tracking_policies_enabled" timesheet_submission_reminders: "$ref": "#/components/schemas/resource_organization/properties/timesheet_submission_reminders" open_budget_recognition_date_id: "$ref": "#/components/schemas/resource_organization/properties/open_budget_recognition_date_id" overhead_subsidiary_switched_at: "$ref": "#/components/schemas/resource_organization/properties/overhead_subsidiary_switched_at" delivered_budget_recognition_date_id: "$ref": "#/components/schemas/resource_organization/properties/delivered_budget_recognition_date_id" financial_month_locking_partial_edit: "$ref": "#/components/schemas/resource_organization/properties/financial_month_locking_partial_edit" invoice_timesheet_export_configuration: "$ref": "#/components/schemas/resource_organization/properties/invoice_timesheet_export_configuration" relationships: type: object properties: owner: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" organization_subscription: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single organization collection_financial_item_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: count: "$ref": "#/components/schemas/resource_financial_item_report/properties/count" group: "$ref": "#/components/schemas/resource_financial_item_report/properties/group" future: "$ref": "#/components/schemas/resource_financial_item_report/properties/future" currency: "$ref": "#/components/schemas/resource_financial_item_report/properties/currency" stage_type: "$ref": "#/components/schemas/resource_financial_item_report/properties/stage_type" total_cost: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_cost" total_time: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_time" date_period: "$ref": "#/components/schemas/resource_financial_item_report/properties/date_period" stage_status: "$ref": "#/components/schemas/resource_financial_item_report/properties/stage_status" custom_fields: "$ref": "#/components/schemas/resource_financial_item_report/properties/custom_fields" average_margin: "$ref": "#/components/schemas/resource_financial_item_report/properties/average_margin" formula_fields: "$ref": "#/components/schemas/resource_financial_item_report/properties/formula_fields" total_credited: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_credited" total_invoiced: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_invoiced" approval_status: "$ref": "#/components/schemas/resource_financial_item_report/properties/approval_status" billing_type_id: "$ref": "#/components/schemas/resource_financial_item_report/properties/billing_type_id" project_type_id: "$ref": "#/components/schemas/resource_financial_item_report/properties/project_type_id" currency_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/currency_default" financial_item_id: "$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_id" total_budget_used: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_budget_used" total_worked_time: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_worked_time" total_budget_total: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_budget_total" total_cost_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_cost_default" total_expense_cost: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_expense_cost" currency_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/currency_normalized" financial_item_date: "$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_date" financial_item_type: "$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_type" total_billable_time: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_billable_time" total_budgeted_time: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_budgeted_time" total_overhead_cost: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_overhead_cost" average_blended_rate: "$ref": "#/components/schemas/resource_financial_item_report/properties/average_blended_rate" total_draft_invoiced: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_draft_invoiced" total_estimated_cost: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_estimated_cost" total_estimated_time: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_estimated_time" total_scheduled_cost: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_scheduled_cost" total_scheduled_time: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_scheduled_time" total_cost_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_cost_normalized" total_recognized_time: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_recognized_time" total_time_entry_cost: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_time_entry_cost" average_margin_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/average_margin_default" total_credited_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_credited_default" total_invoiced_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_invoiced_default" total_projected_revenue: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_projected_revenue" total_recognized_profit: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_recognized_profit" total_scheduled_revenue: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_scheduled_revenue" total_recognized_revenue: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_recognized_revenue" average_margin_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/average_margin_normalized" average_recognized_margin: "$ref": "#/components/schemas/resource_financial_item_report/properties/average_recognized_margin" total_budget_used_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_budget_used_default" total_credited_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_credited_normalized" total_invoiced_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_invoiced_normalized" financial_item_description: "$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_description" total_budget_total_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_budget_total_default" total_expense_cost_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_expense_cost_default" total_overhead_cost_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_overhead_cost_default" average_blended_rate_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/average_blended_rate_default" total_budget_used_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_budget_used_normalized" total_draft_invoiced_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_draft_invoiced_default" total_estimated_cost_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_estimated_cost_default" total_scheduled_cost_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_scheduled_cost_default" total_budget_total_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_budget_total_normalized" total_expense_cost_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_expense_cost_normalized" total_time_entry_cost_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_time_entry_cost_default" total_overhead_cost_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_overhead_cost_normalized" average_blended_rate_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/average_blended_rate_normalized" total_draft_invoiced_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_draft_invoiced_normalized" total_estimated_cost_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_estimated_cost_normalized" total_projected_revenue_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_projected_revenue_default" total_recognized_profit_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_recognized_profit_default" total_scheduled_cost_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_scheduled_cost_normalized" total_scheduled_revenue_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_scheduled_revenue_default" total_recognized_revenue_default: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_recognized_revenue_default" total_time_entry_cost_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_time_entry_cost_normalized" total_projected_revenue_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_projected_revenue_normalized" total_recognized_profit_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_recognized_profit_normalized" total_scheduled_revenue_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_scheduled_revenue_normalized" total_recognized_revenue_normalized: "$ref": "#/components/schemas/resource_financial_item_report/properties/total_recognized_revenue_normalized" relationships: type: object properties: budget: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" expense: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" section: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" time_entry: "$ref": "#/components/schemas/_single_relationship" deal_status: "$ref": "#/components/schemas/_single_relationship" origin_deal: "$ref": "#/components/schemas/_single_relationship" responsible: "$ref": "#/components/schemas/_single_relationship" booking_item: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" owner_report: "$ref": "#/components/schemas/_single_relationship" revenue_item: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" person_report: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" project_report: "$ref": "#/components/schemas/_single_relationship" service_report: "$ref": "#/components/schemas/_single_relationship" origin_deal_report: "$ref": "#/components/schemas/_single_relationship" invoice_attribution: "$ref": "#/components/schemas/_single_relationship" deal_or_budget_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection financial item report single_pipeline: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_pipeline/properties/name" icon_id: "$ref": "#/components/schemas/resource_pipeline/properties/icon_id" position: "$ref": "#/components/schemas/resource_pipeline/properties/position" created_at: "$ref": "#/components/schemas/resource_pipeline/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_pipeline/properties/updated_at" pipeline_type_id: "$ref": "#/components/schemas/resource_pipeline/properties/pipeline_type_id" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single pipeline collection_rate_card: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_rate_card/properties/name" created_at: "$ref": "#/components/schemas/resource_rate_card/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_rate_card/properties/updated_at" archived_at: "$ref": "#/components/schemas/resource_rate_card/properties/archived_at" prices_count: "$ref": "#/components/schemas/resource_rate_card/properties/prices_count" relationships: type: object properties: company: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection rate card collection_deal: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: cost: "$ref": "#/components/schemas/resource_deal/properties/cost" date: "$ref": "#/components/schemas/resource_deal/properties/date" name: "$ref": "#/components/schemas/resource_deal/properties/name" note: "$ref": "#/components/schemas/resource_deal/properties/note" budget: "$ref": "#/components/schemas/resource_deal/properties/budget" footer: "$ref": "#/components/schemas/resource_deal/properties/footer" number: "$ref": "#/components/schemas/resource_deal/properties/number" profit: "$ref": "#/components/schemas/resource_deal/properties/profit" suffix: "$ref": "#/components/schemas/resource_deal/properties/suffix" expense: "$ref": "#/components/schemas/resource_deal/properties/expense" revenue: "$ref": "#/components/schemas/resource_deal/properties/revenue" color_id: "$ref": "#/components/schemas/resource_deal/properties/color_id" currency: "$ref": "#/components/schemas/resource_deal/properties/currency" discount: "$ref": "#/components/schemas/resource_deal/properties/discount" end_date: "$ref": "#/components/schemas/resource_deal/properties/end_date" invoiced: "$ref": "#/components/schemas/resource_deal/properties/invoiced" position: "$ref": "#/components/schemas/resource_deal/properties/position" tag_list: "$ref": "#/components/schemas/resource_deal/properties/tag_list" closed_at: "$ref": "#/components/schemas/resource_deal/properties/closed_at" email_key: "$ref": "#/components/schemas/resource_deal/properties/email_key" created_at: "$ref": "#/components/schemas/resource_deal/properties/created_at" deal_value: "$ref": "#/components/schemas/resource_deal/properties/deal_value" deleted_at: "$ref": "#/components/schemas/resource_deal/properties/deleted_at" todo_count: "$ref": "#/components/schemas/resource_deal/properties/todo_count" budget_used: "$ref": "#/components/schemas/resource_deal/properties/budget_used" deal_number: "$ref": "#/components/schemas/resource_deal/properties/deal_number" external_id: "$ref": "#/components/schemas/resource_deal/properties/external_id" probability: "$ref": "#/components/schemas/resource_deal/properties/probability" sample_data: "$ref": "#/components/schemas/resource_deal/properties/sample_data" worked_time: "$ref": "#/components/schemas/resource_deal/properties/worked_time" budget_total: "$ref": "#/components/schemas/resource_deal/properties/budget_total" cost_default: "$ref": "#/components/schemas/resource_deal/properties/cost_default" deal_type_id: "$ref": "#/components/schemas/resource_deal/properties/deal_type_id" delivered_on: "$ref": "#/components/schemas/resource_deal/properties/delivered_on" lost_comment: "$ref": "#/components/schemas/resource_deal/properties/lost_comment" billable_time: "$ref": "#/components/schemas/resource_deal/properties/billable_time" budgeted_time: "$ref": "#/components/schemas/resource_deal/properties/budgeted_time" client_access: "$ref": "#/components/schemas/resource_deal/properties/client_access" custom_fields: "$ref": "#/components/schemas/resource_deal/properties/custom_fields" editor_config: "$ref": "#/components/schemas/resource_deal/properties/editor_config" exchange_date: "$ref": "#/components/schemas/resource_deal/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_deal/properties/exchange_rate" external_sync: "$ref": "#/components/schemas/resource_deal/properties/external_sync" profit_margin: "$ref": "#/components/schemas/resource_deal/properties/profit_margin" proposal_note: "$ref": "#/components/schemas/resource_deal/properties/proposal_note" time_approval: "$ref": "#/components/schemas/resource_deal/properties/time_approval" time_to_close: "$ref": "#/components/schemas/resource_deal/properties/time_to_close" todo_due_date: "$ref": "#/components/schemas/resource_deal/properties/todo_due_date" access_to_deal: "$ref": "#/components/schemas/resource_deal/properties/access_to_deal" budget_warning: "$ref": "#/components/schemas/resource_deal/properties/budget_warning" draft_invoiced: "$ref": "#/components/schemas/resource_deal/properties/draft_invoiced" estimated_time: "$ref": "#/components/schemas/resource_deal/properties/estimated_time" origin_deal_id: "$ref": "#/components/schemas/resource_deal/properties/origin_deal_id" profit_default: "$ref": "#/components/schemas/resource_deal/properties/profit_default" amount_credited: "$ref": "#/components/schemas/resource_deal/properties/amount_credited" cost_normalized: "$ref": "#/components/schemas/resource_deal/properties/cost_normalized" expense_default: "$ref": "#/components/schemas/resource_deal/properties/expense_default" man_day_minutes: "$ref": "#/components/schemas/resource_deal/properties/man_day_minutes" proposal_footer: "$ref": "#/components/schemas/resource_deal/properties/proposal_footer" revenue_default: "$ref": "#/components/schemas/resource_deal/properties/revenue_default" sales_closed_at: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_at" sales_closed_on: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_on" currency_default: "$ref": "#/components/schemas/resource_deal/properties/currency_default" deal_value_total: "$ref": "#/components/schemas/resource_deal/properties/deal_value_total" expense_approval: "$ref": "#/components/schemas/resource_deal/properties/expense_approval" invoiced_default: "$ref": "#/components/schemas/resource_deal/properties/invoiced_default" last_activity_at: "$ref": "#/components/schemas/resource_deal/properties/last_activity_at" services_revenue: "$ref": "#/components/schemas/resource_deal/properties/services_revenue" tracking_type_id: "$ref": "#/components/schemas/resource_deal/properties/tracking_type_id" connection_status: "$ref": "#/components/schemas/resource_deal/properties/connection_status" deal_value_source: "$ref": "#/components/schemas/resource_deal/properties/deal_value_source" manually_invoiced: "$ref": "#/components/schemas/resource_deal/properties/manually_invoiced" note_interpolated: "$ref": "#/components/schemas/resource_deal/properties/note_interpolated" pending_invoicing: "$ref": "#/components/schemas/resource_deal/properties/pending_invoicing" profit_normalized: "$ref": "#/components/schemas/resource_deal/properties/profit_normalized" projected_revenue: "$ref": "#/components/schemas/resource_deal/properties/projected_revenue" retainer_interval: "$ref": "#/components/schemas/resource_deal/properties/retainer_interval" days_since_created: "$ref": "#/components/schemas/resource_deal/properties/days_since_created" expense_normalized: "$ref": "#/components/schemas/resource_deal/properties/expense_normalized" revenue_normalized: "$ref": "#/components/schemas/resource_deal/properties/revenue_normalized" rounding_method_id: "$ref": "#/components/schemas/resource_deal/properties/rounding_method_id" budget_used_default: "$ref": "#/components/schemas/resource_deal/properties/budget_used_default" currency_normalized: "$ref": "#/components/schemas/resource_deal/properties/currency_normalized" footer_interpolated: "$ref": "#/components/schemas/resource_deal/properties/footer_interpolated" invoiced_normalized: "$ref": "#/components/schemas/resource_deal/properties/invoiced_normalized" budget_total_default: "$ref": "#/components/schemas/resource_deal/properties/budget_total_default" previous_probability: "$ref": "#/components/schemas/resource_deal/properties/previous_probability" rounding_interval_id: "$ref": "#/components/schemas/resource_deal/properties/rounding_interval_id" days_in_current_stage: "$ref": "#/components/schemas/resource_deal/properties/days_in_current_stage" deal_value_per_period: "$ref": "#/components/schemas/resource_deal/properties/deal_value_per_period" profit_margin_default: "$ref": "#/components/schemas/resource_deal/properties/profit_margin_default" purchase_order_number: "$ref": "#/components/schemas/resource_deal/properties/purchase_order_number" budget_used_normalized: "$ref": "#/components/schemas/resource_deal/properties/budget_used_normalized" draft_invoiced_default: "$ref": "#/components/schemas/resource_deal/properties/draft_invoiced_default" amount_credited_default: "$ref": "#/components/schemas/resource_deal/properties/amount_credited_default" budget_total_normalized: "$ref": "#/components/schemas/resource_deal/properties/budget_total_normalized" retainer_interval_count: "$ref": "#/components/schemas/resource_deal/properties/retainer_interval_count" sales_status_updated_at: "$ref": "#/components/schemas/resource_deal/properties/sales_status_updated_at" days_since_last_activity: "$ref": "#/components/schemas/resource_deal/properties/days_since_last_activity" deal_value_total_default: "$ref": "#/components/schemas/resource_deal/properties/deal_value_total_default" profit_margin_normalized: "$ref": "#/components/schemas/resource_deal/properties/profit_margin_normalized" retainer_deal_value_type: "$ref": "#/components/schemas/resource_deal/properties/retainer_deal_value_type" services_revenue_default: "$ref": "#/components/schemas/resource_deal/properties/services_revenue_default" draft_invoiced_normalized: "$ref": "#/components/schemas/resource_deal/properties/draft_invoiced_normalized" manually_invoiced_default: "$ref": "#/components/schemas/resource_deal/properties/manually_invoiced_default" pending_invoicing_default: "$ref": "#/components/schemas/resource_deal/properties/pending_invoicing_default" projected_revenue_default: "$ref": "#/components/schemas/resource_deal/properties/projected_revenue_default" revenue_distribution_type: "$ref": "#/components/schemas/resource_deal/properties/revenue_distribution_type" amount_credited_normalized: "$ref": "#/components/schemas/resource_deal/properties/amount_credited_normalized" manual_invoicing_status_id: "$ref": "#/components/schemas/resource_deal/properties/manual_invoicing_status_id" proposal_note_interpolated: "$ref": "#/components/schemas/resource_deal/properties/proposal_note_interpolated" deal_value_total_normalized: "$ref": "#/components/schemas/resource_deal/properties/deal_value_total_normalized" revenue_distribution_method: "$ref": "#/components/schemas/resource_deal/properties/revenue_distribution_method" services_revenue_normalized: "$ref": "#/components/schemas/resource_deal/properties/services_revenue_normalized" manually_invoiced_normalized: "$ref": "#/components/schemas/resource_deal/properties/manually_invoiced_normalized" pending_invoicing_normalized: "$ref": "#/components/schemas/resource_deal/properties/pending_invoicing_normalized" projected_revenue_normalized: "$ref": "#/components/schemas/resource_deal/properties/projected_revenue_normalized" proposal_footer_interpolated: "$ref": "#/components/schemas/resource_deal/properties/proposal_footer_interpolated" deal_value_per_period_default: "$ref": "#/components/schemas/resource_deal/properties/deal_value_per_period_default" validate_expense_when_closing: "$ref": "#/components/schemas/resource_deal/properties/validate_expense_when_closing" deal_value_per_period_normalized: "$ref": "#/components/schemas/resource_deal/properties/deal_value_per_period_normalized" service_type_restricted_tracking: "$ref": "#/components/schemas/resource_deal/properties/service_type_restricted_tracking" relationships: type: object properties: company: "$ref": "#/components/schemas/_single_relationship" contact: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" contract: "$ref": "#/components/schemas/_single_relationship" pipeline: "$ref": "#/components/schemas/_single_relationship" tax_rate: "$ref": "#/components/schemas/_single_relationship" template: "$ref": "#/components/schemas/_single_relationship" next_todo: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" deal_status: "$ref": "#/components/schemas/_single_relationship" lost_reason: "$ref": "#/components/schemas/_single_relationship" origin_deal: "$ref": "#/components/schemas/_single_relationship" responsible: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_type: "$ref": "#/components/schemas/_single_relationship" primary_contact: "$ref": "#/components/schemas/_single_relationship" invoice_template: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" designated_approver: "$ref": "#/components/schemas/_single_relationship" proposal_document_type: "$ref": "#/components/schemas/_single_relationship" time_approval_workflow: "$ref": "#/components/schemas/_single_relationship" automatic_invoicing_rule: "$ref": "#/components/schemas/_single_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" expense_approval_workflow: "$ref": "#/components/schemas/_single_relationship" approval_policy_assignment: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection deal collection_task_dependency: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: type_id: "$ref": "#/components/schemas/resource_task_dependency/properties/type_id" relationships: type: object properties: task: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" dependent_task: "$ref": "#/components/schemas/_single_relationship" reverse_dependency: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection task dependency single_organization_subscription: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: seats: "$ref": "#/components/schemas/resource_organization_subscription/properties/seats" balance: "$ref": "#/components/schemas/resource_organization_subscription/properties/balance" discount: "$ref": "#/components/schemas/resource_organization_subscription/properties/discount" card_year: "$ref": "#/components/schemas/resource_organization_subscription/properties/card_year" plan_type: "$ref": "#/components/schemas/resource_organization_subscription/properties/plan_type" card_brand: "$ref": "#/components/schemas/resource_organization_subscription/properties/card_brand" card_last4: "$ref": "#/components/schemas/resource_organization_subscription/properties/card_last4" card_month: "$ref": "#/components/schemas/resource_organization_subscription/properties/card_month" plan_cycle: "$ref": "#/components/schemas/resource_organization_subscription/properties/plan_cycle" plan_price: "$ref": "#/components/schemas/resource_organization_subscription/properties/plan_price" seats_used: "$ref": "#/components/schemas/resource_organization_subscription/properties/seats_used" current_plan: "$ref": "#/components/schemas/resource_organization_subscription/properties/current_plan" billing_email: "$ref": "#/components/schemas/resource_organization_subscription/properties/billing_email" contract_date: "$ref": "#/components/schemas/resource_organization_subscription/properties/contract_date" product_types: "$ref": "#/components/schemas/resource_organization_subscription/properties/product_types" seats_pending: "$ref": "#/components/schemas/resource_organization_subscription/properties/seats_pending" trial_ends_at: "$ref": "#/components/schemas/resource_organization_subscription/properties/trial_ends_at" contract_seats: "$ref": "#/components/schemas/resource_organization_subscription/properties/contract_seats" active_products: "$ref": "#/components/schemas/resource_organization_subscription/properties/active_products" billing_address: "$ref": "#/components/schemas/resource_organization_subscription/properties/billing_address" trial_plan_type: "$ref": "#/components/schemas/resource_organization_subscription/properties/trial_plan_type" current_products: "$ref": "#/components/schemas/resource_organization_subscription/properties/current_products" payment_method_id: "$ref": "#/components/schemas/resource_organization_subscription/properties/payment_method_id" trial_plan_active: "$ref": "#/components/schemas/resource_organization_subscription/properties/trial_plan_active" trial_product_ids: "$ref": "#/components/schemas/resource_organization_subscription/properties/trial_product_ids" contract_min_seats: "$ref": "#/components/schemas/resource_organization_subscription/properties/contract_min_seats" stripe_customer_id: "$ref": "#/components/schemas/resource_organization_subscription/properties/stripe_customer_id" trial_plan_ends_at: "$ref": "#/components/schemas/resource_organization_subscription/properties/trial_plan_ends_at" billing_group_admin: "$ref": "#/components/schemas/resource_organization_subscription/properties/billing_group_admin" billing_group_seats: "$ref": "#/components/schemas/resource_organization_subscription/properties/billing_group_seats" discount_expires_on: "$ref": "#/components/schemas/resource_organization_subscription/properties/discount_expires_on" billing_group_member: "$ref": "#/components/schemas/resource_organization_subscription/properties/billing_group_member" collection_method_id: "$ref": "#/components/schemas/resource_organization_subscription/properties/collection_method_id" grace_period_ends_at: "$ref": "#/components/schemas/resource_organization_subscription/properties/grace_period_ends_at" next_billing_cycle_at: "$ref": "#/components/schemas/resource_organization_subscription/properties/next_billing_cycle_at" subscription_ended_at: "$ref": "#/components/schemas/resource_organization_subscription/properties/subscription_ended_at" subscription_state_id: "$ref": "#/components/schemas/resource_organization_subscription/properties/subscription_state_id" subscription_started_at: "$ref": "#/components/schemas/resource_organization_subscription/properties/subscription_started_at" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" billing_group_owner: "$ref": "#/components/schemas/_single_relationship" billing_group_members: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single organization subscription collection_deal_funnel_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: count: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/count" group: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/group" currency: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/currency" lost_count: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/lost_count" formula_fields: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/formula_fields" currency_default: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/currency_default" total_budget_total: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/total_budget_total" currency_normalized: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/currency_normalized" total_projected_revenue: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/total_projected_revenue" total_budget_total_default: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/total_budget_total_default" total_budget_total_normalized: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/total_budget_total_normalized" total_projected_revenue_default: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/total_projected_revenue_default" total_projected_revenue_normalized: "$ref": "#/components/schemas/resource_deal_funnel_report/properties/total_projected_revenue_normalized" relationships: type: object properties: report: "$ref": "#/components/schemas/_single_relationship" pipeline: "$ref": "#/components/schemas/_single_relationship" deal_status: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection deal funnel report single_proposal: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_proposal/properties/date" name: "$ref": "#/components/schemas/resource_proposal/properties/name" note: "$ref": "#/components/schemas/resource_proposal/properties/note" footer: "$ref": "#/components/schemas/resource_proposal/properties/footer" signed: "$ref": "#/components/schemas/resource_proposal/properties/signed" status: "$ref": "#/components/schemas/resource_proposal/properties/status" sent_at: "$ref": "#/components/schemas/resource_proposal/properties/sent_at" currency: "$ref": "#/components/schemas/resource_proposal/properties/currency" end_date: "$ref": "#/components/schemas/resource_proposal/properties/end_date" created_at: "$ref": "#/components/schemas/resource_proposal/properties/created_at" disclaimer: "$ref": "#/components/schemas/resource_proposal/properties/disclaimer" link_status: "$ref": "#/components/schemas/resource_proposal/properties/link_status" public_uuid: "$ref": "#/components/schemas/resource_proposal/properties/public_uuid" budget_total: "$ref": "#/components/schemas/resource_proposal/properties/budget_total" audit_pdf_url: "$ref": "#/components/schemas/resource_proposal/properties/audit_pdf_url" custom_fields: "$ref": "#/components/schemas/resource_proposal/properties/custom_fields" exchange_date: "$ref": "#/components/schemas/resource_proposal/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_proposal/properties/exchange_rate" responder_name: "$ref": "#/components/schemas/resource_proposal/properties/responder_name" responder_email: "$ref": "#/components/schemas/resource_proposal/properties/responder_email" currency_default: "$ref": "#/components/schemas/resource_proposal/properties/currency_default" original_pdf_url: "$ref": "#/components/schemas/resource_proposal/properties/original_pdf_url" note_interpolated: "$ref": "#/components/schemas/resource_proposal/properties/note_interpolated" status_changed_at: "$ref": "#/components/schemas/resource_proposal/properties/status_changed_at" disclaimer_enabled: "$ref": "#/components/schemas/resource_proposal/properties/disclaimer_enabled" currency_normalized: "$ref": "#/components/schemas/resource_proposal/properties/currency_normalized" footer_interpolated: "$ref": "#/components/schemas/resource_proposal/properties/footer_interpolated" budget_total_default: "$ref": "#/components/schemas/resource_proposal/properties/budget_total_default" purchase_order_number: "$ref": "#/components/schemas/resource_proposal/properties/purchase_order_number" budget_total_normalized: "$ref": "#/components/schemas/resource_proposal/properties/budget_total_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" client: "$ref": "#/components/schemas/_single_relationship" contact: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" tax_rate: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" proposal_to: "$ref": "#/components/schemas/_single_relationship" responsible: "$ref": "#/components/schemas/_single_relationship" deal_creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_type: "$ref": "#/components/schemas/_single_relationship" proposal_from: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single proposal single_placeholder_usage: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: id: "$ref": "#/components/schemas/resource_placeholder_usage/properties/id" field: "$ref": "#/components/schemas/resource_placeholder_usage/properties/field" target_id: "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_id" created_at: "$ref": "#/components/schemas/resource_placeholder_usage/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_placeholder_usage/properties/updated_at" target_type: "$ref": "#/components/schemas/resource_placeholder_usage/properties/target_type" interval_unit: "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_unit" skip_weekends: "$ref": "#/components/schemas/resource_placeholder_usage/properties/skip_weekends" interval_value: "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_value" placeholder_id: "$ref": "#/components/schemas/resource_placeholder_usage/properties/placeholder_id" interval_enabled: "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_enabled" interval_direction: "$ref": "#/components/schemas/resource_placeholder_usage/properties/interval_direction" relationships: type: object properties: task: "$ref": "#/components/schemas/_single_relationship" todo: "$ref": "#/components/schemas/_single_relationship" placeholder: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single placeholder usage collection_proposal_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: count: "$ref": "#/components/schemas/resource_proposal_report/properties/count" group: "$ref": "#/components/schemas/resource_proposal_report/properties/group" signed: "$ref": "#/components/schemas/resource_proposal_report/properties/signed" status: "$ref": "#/components/schemas/resource_proposal_report/properties/status" currency: "$ref": "#/components/schemas/resource_proposal_report/properties/currency" link_status: "$ref": "#/components/schemas/resource_proposal_report/properties/link_status" formula_fields: "$ref": "#/components/schemas/resource_proposal_report/properties/formula_fields" sent_at_period: "$ref": "#/components/schemas/resource_proposal_report/properties/sent_at_period" signed_by_email: "$ref": "#/components/schemas/resource_proposal_report/properties/signed_by_email" currency_default: "$ref": "#/components/schemas/resource_proposal_report/properties/currency_default" total_tax_amount: "$ref": "#/components/schemas/resource_proposal_report/properties/total_tax_amount" created_at_period: "$ref": "#/components/schemas/resource_proposal_report/properties/created_at_period" updated_at_period: "$ref": "#/components/schemas/resource_proposal_report/properties/updated_at_period" date_signed_period: "$ref": "#/components/schemas/resource_proposal_report/properties/date_signed_period" total_budget_total: "$ref": "#/components/schemas/resource_proposal_report/properties/total_budget_total" currency_normalized: "$ref": "#/components/schemas/resource_proposal_report/properties/currency_normalized" average_tax_rate_value: "$ref": "#/components/schemas/resource_proposal_report/properties/average_tax_rate_value" status_changed_at_period: "$ref": "#/components/schemas/resource_proposal_report/properties/status_changed_at_period" total_tax_amount_default: "$ref": "#/components/schemas/resource_proposal_report/properties/total_tax_amount_default" total_budget_total_default: "$ref": "#/components/schemas/resource_proposal_report/properties/total_budget_total_default" total_tax_amount_normalized: "$ref": "#/components/schemas/resource_proposal_report/properties/total_tax_amount_normalized" total_budget_total_normalized: "$ref": "#/components/schemas/resource_proposal_report/properties/total_budget_total_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" proposal: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" deal_report: "$ref": "#/components/schemas/_single_relationship" responsible: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" creator_report: "$ref": "#/components/schemas/_single_relationship" responsible_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: A paginated collection of proposal report resources. collection_bank_account: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_bank_account/properties/name" number: "$ref": "#/components/schemas/resource_bank_account/properties/number" currency: "$ref": "#/components/schemas/resource_bank_account/properties/currency" bank_name: "$ref": "#/components/schemas/resource_bank_account/properties/bank_name" swift_code: "$ref": "#/components/schemas/resource_bank_account/properties/swift_code" archived_at: "$ref": "#/components/schemas/resource_bank_account/properties/archived_at" bank_address: "$ref": "#/components/schemas/resource_bank_account/properties/bank_address" relationships: type: object properties: subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection bank account collection_new_salary_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: time: "$ref": "#/components/schemas/resource_new_salary_report/properties/time" count: "$ref": "#/components/schemas/resource_new_salary_report/properties/count" group: "$ref": "#/components/schemas/resource_new_salary_report/properties/group" capacity: "$ref": "#/components/schemas/resource_new_salary_report/properties/capacity" currency: "$ref": "#/components/schemas/resource_new_salary_report/properties/currency" overhead: "$ref": "#/components/schemas/resource_new_salary_report/properties/overhead" work_days: "$ref": "#/components/schemas/resource_new_salary_report/properties/work_days" date_period: "$ref": "#/components/schemas/resource_new_salary_report/properties/date_period" formula_fields: "$ref": "#/components/schemas/resource_new_salary_report/properties/formula_fields" salary_type_id: "$ref": "#/components/schemas/resource_new_salary_report/properties/salary_type_id" end_date_period: "$ref": "#/components/schemas/resource_new_salary_report/properties/end_date_period" currency_default: "$ref": "#/components/schemas/resource_new_salary_report/properties/currency_default" start_date_period: "$ref": "#/components/schemas/resource_new_salary_report/properties/start_date_period" total_hourly_cost: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_hourly_cost" total_period_cost: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_period_cost" total_weekly_cost: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_weekly_cost" total_monthly_cost: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_monthly_cost" currency_normalized: "$ref": "#/components/schemas/resource_new_salary_report/properties/currency_normalized" total_annually_cost: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_annually_cost" people_custom_fields: "$ref": "#/components/schemas/resource_new_salary_report/properties/people_custom_fields" total_bi_weekly_cost: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_bi_weekly_cost" total_hourly_cost_default: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_hourly_cost_default" total_period_cost_default: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_period_cost_default" total_weekly_cost_default: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_weekly_cost_default" total_monthly_cost_default: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_monthly_cost_default" total_annually_cost_default: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_annually_cost_default" total_bi_weekly_cost_default: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_bi_weekly_cost_default" total_estimated_weekly_hours: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_estimated_weekly_hours" total_hourly_cost_normalized: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_hourly_cost_normalized" total_overhead_cost_per_hour: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_overhead_cost_per_hour" total_period_cost_normalized: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_period_cost_normalized" total_weekly_cost_normalized: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_weekly_cost_normalized" total_monthly_cost_normalized: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_monthly_cost_normalized" total_annually_cost_normalized: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_annually_cost_normalized" total_bi_weekly_cost_normalized: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_bi_weekly_cost_normalized" total_overhead_cost_per_hour_default: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_overhead_cost_per_hour_default" total_overhead_cost_per_hour_normalized: "$ref": "#/components/schemas/resource_new_salary_report/properties/total_overhead_cost_per_hour_normalized" relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" salary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" person_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection new salary report collection_task_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: week: "$ref": "#/components/schemas/resource_task_report/properties/week" year: "$ref": "#/components/schemas/resource_task_report/properties/year" count: "$ref": "#/components/schemas/resource_task_report/properties/count" group: "$ref": "#/components/schemas/resource_task_report/properties/group" month: "$ref": "#/components/schemas/resource_task_report/properties/month" status: "$ref": "#/components/schemas/resource_task_report/properties/status" quarter: "$ref": "#/components/schemas/resource_task_report/properties/quarter" currency: "$ref": "#/components/schemas/resource_task_report/properties/currency" repeating: "$ref": "#/components/schemas/resource_task_report/properties/repeating" custom_fields: "$ref": "#/components/schemas/resource_task_report/properties/custom_fields" formula_fields: "$ref": "#/components/schemas/resource_task_report/properties/formula_fields" due_date_period: "$ref": "#/components/schemas/resource_task_report/properties/due_date_period" closed_at_period: "$ref": "#/components/schemas/resource_task_report/properties/closed_at_period" currency_default: "$ref": "#/components/schemas/resource_task_report/properties/currency_default" created_at_period: "$ref": "#/components/schemas/resource_task_report/properties/created_at_period" start_date_period: "$ref": "#/components/schemas/resource_task_report/properties/start_date_period" total_worked_time: "$ref": "#/components/schemas/resource_task_report/properties/total_worked_time" currency_normalized: "$ref": "#/components/schemas/resource_task_report/properties/currency_normalized" total_billable_time: "$ref": "#/components/schemas/resource_task_report/properties/total_billable_time" total_remaining_time: "$ref": "#/components/schemas/resource_task_report/properties/total_remaining_time" total_initial_estimate: "$ref": "#/components/schemas/resource_task_report/properties/total_initial_estimate" last_activity_at_period: "$ref": "#/components/schemas/resource_task_report/properties/last_activity_at_period" workflow_status_category_id: "$ref": "#/components/schemas/resource_task_report/properties/workflow_status_category_id" total_estimate_at_completion: "$ref": "#/components/schemas/resource_task_report/properties/total_estimate_at_completion" total_estimation_offset_time: "$ref": "#/components/schemas/resource_task_report/properties/total_estimation_offset_time" relationships: type: object properties: task: "$ref": "#/components/schemas/_single_relationship" board: "$ref": "#/components/schemas/_single_relationship" folder: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" assignee: "$ref": "#/components/schemas/_single_relationship" workflow: "$ref": "#/components/schemas/_single_relationship" task_list: "$ref": "#/components/schemas/_single_relationship" last_actor: "$ref": "#/components/schemas/_single_relationship" parent_task: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" creator_report: "$ref": "#/components/schemas/_single_relationship" project_report: "$ref": "#/components/schemas/_single_relationship" assignee_report: "$ref": "#/components/schemas/_single_relationship" workflow_status: "$ref": "#/components/schemas/_single_relationship" last_actor_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection task report single_team: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_team/properties/name" icon_id: "$ref": "#/components/schemas/resource_team/properties/icon_id" color_id: "$ref": "#/components/schemas/resource_team/properties/color_id" relationships: type: object properties: members: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single team collection_document_style: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_document_style/properties/name" styles: "$ref": "#/components/schemas/resource_document_style/properties/styles" relationships: type: object properties: attachments: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection document style single_payment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_payment/properties/note" amount: "$ref": "#/components/schemas/resource_payment/properties/amount" paid_on: "$ref": "#/components/schemas/resource_payment/properties/paid_on" currency: "$ref": "#/components/schemas/resource_payment/properties/currency" external_id: "$ref": "#/components/schemas/resource_payment/properties/external_id" amount_default: "$ref": "#/components/schemas/resource_payment/properties/amount_default" written_off_on: "$ref": "#/components/schemas/resource_payment/properties/written_off_on" currency_default: "$ref": "#/components/schemas/resource_payment/properties/currency_default" amount_normalized: "$ref": "#/components/schemas/resource_payment/properties/amount_normalized" currency_normalized: "$ref": "#/components/schemas/resource_payment/properties/currency_normalized" relationships: type: object properties: invoice: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single payment single_purchase_order: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_purchase_order/properties/note" footer: "$ref": "#/components/schemas/resource_purchase_order/properties/footer" number: "$ref": "#/components/schemas/resource_purchase_order/properties/number" sent_on: "$ref": "#/components/schemas/resource_purchase_order/properties/sent_on" subject: "$ref": "#/components/schemas/resource_purchase_order/properties/subject" currency: "$ref": "#/components/schemas/resource_purchase_order/properties/currency" exported: "$ref": "#/components/schemas/resource_purchase_order/properties/exported" email_key: "$ref": "#/components/schemas/resource_purchase_order/properties/email_key" export_id: "$ref": "#/components/schemas/resource_purchase_order/properties/export_id" issued_on: "$ref": "#/components/schemas/resource_purchase_order/properties/issued_on" status_id: "$ref": "#/components/schemas/resource_purchase_order/properties/status_id" created_at: "$ref": "#/components/schemas/resource_purchase_order/properties/created_at" export_url: "$ref": "#/components/schemas/resource_purchase_order/properties/export_url" total_cost: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost" delivery_on: "$ref": "#/components/schemas/resource_purchase_order/properties/delivery_on" exported_at: "$ref": "#/components/schemas/resource_purchase_order/properties/exported_at" received_on: "$ref": "#/components/schemas/resource_purchase_order/properties/received_on" exchange_date: "$ref": "#/components/schemas/resource_purchase_order/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_purchase_order/properties/exchange_rate" total_received: "$ref": "#/components/schemas/resource_purchase_order/properties/total_received" currency_default: "$ref": "#/components/schemas/resource_purchase_order/properties/currency_default" note_interpolated: "$ref": "#/components/schemas/resource_purchase_order/properties/note_interpolated" payment_status_id: "$ref": "#/components/schemas/resource_purchase_order/properties/payment_status_id" total_cost_default: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_default" currency_normalized: "$ref": "#/components/schemas/resource_purchase_order/properties/currency_normalized" footer_interpolated: "$ref": "#/components/schemas/resource_purchase_order/properties/footer_interpolated" total_cost_with_tax: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_with_tax" total_cost_normalized: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_normalized" total_received_default: "$ref": "#/components/schemas/resource_purchase_order/properties/total_received_default" total_received_normalized: "$ref": "#/components/schemas/resource_purchase_order/properties/total_received_normalized" export_integration_type_id: "$ref": "#/components/schemas/resource_purchase_order/properties/export_integration_type_id" total_cost_with_tax_default: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_with_tax_default" total_cost_with_tax_normalized: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_with_tax_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" vendor: "$ref": "#/components/schemas/_single_relationship" bill_to: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" bill_from: "$ref": "#/components/schemas/_single_relationship" attachment: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_type: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single purchase order single_invitation: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: email: "$ref": "#/components/schemas/resource_invitation/properties/email" last_name: "$ref": "#/components/schemas/resource_invitation/properties/last_name" time_zone: "$ref": "#/components/schemas/resource_invitation/properties/time_zone" first_name: "$ref": "#/components/schemas/resource_invitation/properties/first_name" relationships: type: object properties: {} meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single invitation single_dashboard: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_dashboard/properties/name" created_at: "$ref": "#/components/schemas/resource_dashboard/properties/created_at" is_private: "$ref": "#/components/schemas/resource_dashboard/properties/is_private" updated_at: "$ref": "#/components/schemas/resource_dashboard/properties/updated_at" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single dashboard collection_folder: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_folder/properties/name" hidden: "$ref": "#/components/schemas/resource_folder/properties/hidden" position: "$ref": "#/components/schemas/resource_folder/properties/position" placement: "$ref": "#/components/schemas/resource_folder/properties/placement" archived_at: "$ref": "#/components/schemas/resource_folder/properties/archived_at" relationships: type: object properties: project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: A paginated collection of folder resources. single_board: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_board/properties/name" hidden: "$ref": "#/components/schemas/resource_board/properties/hidden" position: "$ref": "#/components/schemas/resource_board/properties/position" placement: "$ref": "#/components/schemas/resource_board/properties/placement" archived_at: "$ref": "#/components/schemas/resource_board/properties/archived_at" relationships: type: object properties: project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single board single_time_entry_version: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: event: "$ref": "#/components/schemas/resource_time_entry_version/properties/event" item_id: "$ref": "#/components/schemas/resource_time_entry_version/properties/item_id" changeset: "$ref": "#/components/schemas/resource_time_entry_version/properties/changeset" item_name: "$ref": "#/components/schemas/resource_time_entry_version/properties/item_name" item_type: "$ref": "#/components/schemas/resource_time_entry_version/properties/item_type" created_at: "$ref": "#/components/schemas/resource_time_entry_version/properties/created_at" object_changes: "$ref": "#/components/schemas/resource_time_entry_version/properties/object_changes" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single time entry version single_approval_workflow: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: target_type_id: "$ref": "#/components/schemas/resource_approval_workflow/properties/target_type_id" dynamic_approver_ids: "$ref": "#/components/schemas/resource_approval_workflow/properties/dynamic_approver_ids" dynamic_subscriber_ids: "$ref": "#/components/schemas/resource_approval_workflow/properties/dynamic_subscriber_ids" approval_requirement_id: "$ref": "#/components/schemas/resource_approval_workflow/properties/approval_requirement_id" relationships: type: object properties: event: "$ref": "#/components/schemas/_single_relationship" approvers: "$ref": "#/components/schemas/_collection_relationship" subscribers: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" approval_policy: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single approval workflow collection_membership: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: options: "$ref": "#/components/schemas/resource_membership/properties/options" type_id: "$ref": "#/components/schemas/resource_membership/properties/type_id" target_type: "$ref": "#/components/schemas/resource_membership/properties/target_type" access_type_id: "$ref": "#/components/schemas/resource_membership/properties/access_type_id" dynamic_group_id: "$ref": "#/components/schemas/resource_membership/properties/dynamic_group_id" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" page: "$ref": "#/components/schemas/_single_relationship" team: "$ref": "#/components/schemas/_single_relationship" agent: "$ref": "#/components/schemas/_single_relationship" filter: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" survey: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" dashboard: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection membership single_notification: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: read: "$ref": "#/components/schemas/resource_notification/properties/read" title: "$ref": "#/components/schemas/resource_notification/properties/title" excerpt: "$ref": "#/components/schemas/resource_notification/properties/excerpt" mention: "$ref": "#/components/schemas/resource_notification/properties/mention" root_id: "$ref": "#/components/schemas/resource_notification/properties/root_id" changeset: "$ref": "#/components/schemas/resource_notification/properties/changeset" dismissed: "$ref": "#/components/schemas/resource_notification/properties/dismissed" important: "$ref": "#/components/schemas/resource_notification/properties/important" parent_id: "$ref": "#/components/schemas/resource_notification/properties/parent_id" root_type: "$ref": "#/components/schemas/resource_notification/properties/root_type" target_id: "$ref": "#/components/schemas/resource_notification/properties/target_id" parent_type: "$ref": "#/components/schemas/resource_notification/properties/parent_type" target_type: "$ref": "#/components/schemas/resource_notification/properties/target_type" parent_title: "$ref": "#/components/schemas/resource_notification/properties/parent_title" target_label: "$ref": "#/components/schemas/resource_notification/properties/target_label" target_title: "$ref": "#/components/schemas/resource_notification/properties/target_title" last_action_at: "$ref": "#/components/schemas/resource_notification/properties/last_action_at" made_by_automation: "$ref": "#/components/schemas/resource_notification/properties/made_by_automation" new_activities_count: "$ref": "#/components/schemas/resource_notification/properties/new_activities_count" first_unread_activity_id: "$ref": "#/components/schemas/resource_notification/properties/first_unread_activity_id" relationships: type: object properties: actor: "$ref": "#/components/schemas/_single_relationship" owner: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single notification collection_timesheet: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_timesheet/properties/date" created_at: "$ref": "#/components/schemas/resource_timesheet/properties/created_at" relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection timesheet collection_revenue_distribution: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: amount: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount" end_on: "$ref": "#/components/schemas/resource_revenue_distribution/properties/end_on" currency: "$ref": "#/components/schemas/resource_revenue_distribution/properties/currency" start_on: "$ref": "#/components/schemas/resource_revenue_distribution/properties/start_on" amount_default: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount_default" amount_percent: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount_percent" currency_default: "$ref": "#/components/schemas/resource_revenue_distribution/properties/currency_default" amount_normalized: "$ref": "#/components/schemas/resource_revenue_distribution/properties/amount_normalized" currency_normalized: "$ref": "#/components/schemas/resource_revenue_distribution/properties/currency_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection revenue distribution collection_custom_field_section: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_custom_field_section/properties/name" position: "$ref": "#/components/schemas/resource_custom_field_section/properties/position" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection custom field section single_project_assignment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: watched: "$ref": "#/components/schemas/resource_project_assignment/properties/watched" created_at: "$ref": "#/components/schemas/resource_project_assignment/properties/created_at" preferences: "$ref": "#/components/schemas/resource_project_assignment/properties/preferences" docs_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/docs_filter_id" deals_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/deals_filter_id" tasks_layout_id: "$ref": "#/components/schemas/resource_project_assignment/properties/tasks_layout_id" budgets_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/budgets_filter_id" default_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/default_filter_id" invoices_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/invoices_filter_id" relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" favorite_filter: "$ref": "#/components/schemas/_single_relationship" docs_favorite_filter: "$ref": "#/components/schemas/_single_relationship" deals_favorite_filter: "$ref": "#/components/schemas/_single_relationship" budgets_favorite_filter: "$ref": "#/components/schemas/_single_relationship" invoices_favorite_filter: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single project assignment collection_page_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: count: "$ref": "#/components/schemas/resource_page_report/properties/count" group: "$ref": "#/components/schemas/resource_page_report/properties/group" title: "$ref": "#/components/schemas/resource_page_report/properties/title" currency: "$ref": "#/components/schemas/resource_page_report/properties/currency" edited_at: "$ref": "#/components/schemas/resource_page_report/properties/edited_at" created_at: "$ref": "#/components/schemas/resource_page_report/properties/created_at" custom_fields: "$ref": "#/components/schemas/resource_page_report/properties/custom_fields" formula_fields: "$ref": "#/components/schemas/resource_page_report/properties/formula_fields" currency_default: "$ref": "#/components/schemas/resource_page_report/properties/currency_default" last_activity_at: "$ref": "#/components/schemas/resource_page_report/properties/last_activity_at" currency_normalized: "$ref": "#/components/schemas/resource_page_report/properties/currency_normalized" relationships: type: object properties: page: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection page report collection_salary: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: cost: "$ref": "#/components/schemas/resource_salary/properties/cost" note: "$ref": "#/components/schemas/resource_salary/properties/note" currency: "$ref": "#/components/schemas/resource_salary/properties/currency" ended_on: "$ref": "#/components/schemas/resource_salary/properties/ended_on" overhead: "$ref": "#/components/schemas/resource_salary/properties/overhead" started_on: "$ref": "#/components/schemas/resource_salary/properties/started_on" hourly_rate: "$ref": "#/components/schemas/resource_salary/properties/hourly_rate" cost_default: "$ref": "#/components/schemas/resource_salary/properties/cost_default" exchange_date: "$ref": "#/components/schemas/resource_salary/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_salary/properties/exchange_rate" working_hours: "$ref": "#/components/schemas/resource_salary/properties/working_hours" default_salary: "$ref": "#/components/schemas/resource_salary/properties/default_salary" salary_type_id: "$ref": "#/components/schemas/resource_salary/properties/salary_type_id" cost_normalized: "$ref": "#/components/schemas/resource_salary/properties/cost_normalized" currency_default: "$ref": "#/components/schemas/resource_salary/properties/currency_default" alternating_hours: "$ref": "#/components/schemas/resource_salary/properties/alternating_hours" currency_normalized: "$ref": "#/components/schemas/resource_salary/properties/currency_normalized" hourly_rate_default: "$ref": "#/components/schemas/resource_salary/properties/hourly_rate_default" hourly_rate_normalized: "$ref": "#/components/schemas/resource_salary/properties/hourly_rate_normalized" relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" holiday_calendar: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection salary collection_service_type: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_service_type/properties/name" archived_at: "$ref": "#/components/schemas/resource_service_type/properties/archived_at" relationships: type: object properties: assignees: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection service type collection_tag: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_tag/properties/name" color_id: "$ref": "#/components/schemas/resource_tag/properties/color_id" relationships: type: object properties: {} meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection tag single_widget: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: title: "$ref": "#/components/schemas/resource_widget/properties/title" width: "$ref": "#/components/schemas/resource_widget/properties/width" height: "$ref": "#/components/schemas/resource_widget/properties/height" content: "$ref": "#/components/schemas/resource_widget/properties/content" row_position: "$ref": "#/components/schemas/resource_widget/properties/row_position" widget_type_id: "$ref": "#/components/schemas/resource_widget/properties/widget_type_id" column_position: "$ref": "#/components/schemas/resource_widget/properties/column_position" relationships: type: object properties: filter: "$ref": "#/components/schemas/_single_relationship" dashboard: "$ref": "#/components/schemas/_single_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single widget collection_automatic_invoicing_rule: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: skip_weekends: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/skip_weekends" reference_date: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/reference_date" creation_offset: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/creation_offset" next_invoice_date: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/next_invoice_date" creation_offset_unit: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/creation_offset_unit" relationships: type: object properties: budget: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection automatic invoicing rule collection_integration: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_integration/properties/name" folders: "$ref": "#/components/schemas/resource_integration/properties/folders" options: "$ref": "#/components/schemas/resource_integration/properties/options" sso_url: "$ref": "#/components/schemas/resource_integration/properties/sso_url" realm_id: "$ref": "#/components/schemas/resource_integration/properties/realm_id" calendars: "$ref": "#/components/schemas/resource_integration/properties/calendars" client_id: "$ref": "#/components/schemas/resource_integration/properties/client_id" all_folders: "$ref": "#/components/schemas/resource_integration/properties/all_folders" request_uri: "$ref": "#/components/schemas/resource_integration/properties/request_uri" account_code: "$ref": "#/components/schemas/resource_integration/properties/account_code" connected_at: "$ref": "#/components/schemas/resource_integration/properties/connected_at" default_item: "$ref": "#/components/schemas/resource_integration/properties/default_item" item_mapping: "$ref": "#/components/schemas/resource_integration/properties/item_mapping" jira_project: "$ref": "#/components/schemas/resource_integration/properties/jira_project" redirect_uri: "$ref": "#/components/schemas/resource_integration/properties/redirect_uri" requested_at: "$ref": "#/components/schemas/resource_integration/properties/requested_at" sage_country: "$ref": "#/components/schemas/resource_integration/properties/sage_country" sso_metadata: "$ref": "#/components/schemas/resource_integration/properties/sso_metadata" exact_country: "$ref": "#/components/schemas/resource_integration/properties/exact_country" export_number: "$ref": "#/components/schemas/resource_integration/properties/export_number" import_number: "$ref": "#/components/schemas/resource_integration/properties/import_number" request_token: "$ref": "#/components/schemas/resource_integration/properties/request_token" slack_options: "$ref": "#/components/schemas/resource_integration/properties/slack_options" deactivated_at: "$ref": "#/components/schemas/resource_integration/properties/deactivated_at" exact_division: "$ref": "#/components/schemas/resource_integration/properties/exact_division" last_synced_at: "$ref": "#/components/schemas/resource_integration/properties/last_synced_at" sso_target_url: "$ref": "#/components/schemas/resource_integration/properties/sso_target_url" xero_reference: "$ref": "#/components/schemas/resource_integration/properties/xero_reference" default_product: "$ref": "#/components/schemas/resource_integration/properties/default_product" exact_divisions: "$ref": "#/components/schemas/resource_integration/properties/exact_divisions" force_sso_login: "$ref": "#/components/schemas/resource_integration/properties/force_sso_login" payments_import: "$ref": "#/components/schemas/resource_integration/properties/payments_import" quickbooks_memo: "$ref": "#/components/schemas/resource_integration/properties/quickbooks_memo" sso_metadata_url: "$ref": "#/components/schemas/resource_integration/properties/sso_metadata_url" tax_rate_mapping: "$ref": "#/components/schemas/resource_integration/properties/tax_rate_mapping" use_expense_sync: "$ref": "#/components/schemas/resource_integration/properties/use_expense_sync" exact_division_id: "$ref": "#/components/schemas/resource_integration/properties/exact_division_id" export_attachment: "$ref": "#/components/schemas/resource_integration/properties/export_attachment" hubspot_pipelines: "$ref": "#/components/schemas/resource_integration/properties/hubspot_pipelines" import_attachment: "$ref": "#/components/schemas/resource_integration/properties/import_attachment" jira_organization: "$ref": "#/components/schemas/resource_integration/properties/jira_organization" twinfield_offices: "$ref": "#/components/schemas/resource_integration/properties/twinfield_offices" hubspot_sync_deals: "$ref": "#/components/schemas/resource_integration/properties/hubspot_sync_deals" sage_business_name: "$ref": "#/components/schemas/resource_integration/properties/sage_business_name" xero_organizations: "$ref": "#/components/schemas/resource_integration/properties/xero_organizations" customer_memo_cf_id: "$ref": "#/components/schemas/resource_integration/properties/customer_memo_cf_id" integration_type_id: "$ref": "#/components/schemas/resource_integration/properties/integration_type_id" sage_default_ledger: "$ref": "#/components/schemas/resource_integration/properties/sage_default_ledger" sage_ledger_mapping: "$ref": "#/components/schemas/resource_integration/properties/sage_ledger_mapping" salesforce_stage_id: "$ref": "#/components/schemas/resource_integration/properties/salesforce_stage_id" use_invoices_export: "$ref": "#/components/schemas/resource_integration/properties/use_invoices_export" account_code_mapping: "$ref": "#/components/schemas/resource_integration/properties/account_code_mapping" exact_default_ledger: "$ref": "#/components/schemas/resource_integration/properties/exact_default_ledger" exact_ledger_mapping: "$ref": "#/components/schemas/resource_integration/properties/exact_ledger_mapping" use_companies_export: "$ref": "#/components/schemas/resource_integration/properties/use_companies_export" use_expenses_in_xero: "$ref": "#/components/schemas/resource_integration/properties/use_expenses_in_xero" xero_organization_id: "$ref": "#/components/schemas/resource_integration/properties/xero_organization_id" calendar_write_status: "$ref": "#/components/schemas/resource_integration/properties/calendar_write_status" exact_default_journal: "$ref": "#/components/schemas/resource_integration/properties/exact_default_journal" exact_ledger_manually: "$ref": "#/components/schemas/resource_integration/properties/exact_ledger_manually" netsuite_default_item: "$ref": "#/components/schemas/resource_integration/properties/netsuite_default_item" netsuite_item_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_item_mapping" sage_intacct_entities: "$ref": "#/components/schemas/resource_integration/properties/sage_intacct_entities" bamboo_workplace_field: "$ref": "#/components/schemas/resource_integration/properties/bamboo_workplace_field" calendar_write_options: "$ref": "#/components/schemas/resource_integration/properties/calendar_write_options" hubspot_stages_mapping: "$ref": "#/components/schemas/resource_integration/properties/hubspot_stages_mapping" xero_expense_status_id: "$ref": "#/components/schemas/resource_integration/properties/xero_expense_status_id" xero_invoice_status_id: "$ref": "#/components/schemas/resource_integration/properties/xero_invoice_status_id" bamboo_enable_time_offs: "$ref": "#/components/schemas/resource_integration/properties/bamboo_enable_time_offs" economic_export_subject: "$ref": "#/components/schemas/resource_integration/properties/economic_export_subject" fortnox_account_mapping: "$ref": "#/components/schemas/resource_integration/properties/fortnox_account_mapping" fortnox_article_mapping: "$ref": "#/components/schemas/resource_integration/properties/fortnox_article_mapping" fortnox_default_account: "$ref": "#/components/schemas/resource_integration/properties/fortnox_default_account" fortnox_default_article: "$ref": "#/components/schemas/resource_integration/properties/fortnox_default_article" bamboo_enable_cost_rates: "$ref": "#/components/schemas/resource_integration/properties/bamboo_enable_cost_rates" bamboo_workplace_mapping: "$ref": "#/components/schemas/resource_integration/properties/bamboo_workplace_mapping" economic_product_mapping: "$ref": "#/components/schemas/resource_integration/properties/economic_product_mapping" netsuite_invoice_form_id: "$ref": "#/components/schemas/resource_integration/properties/netsuite_invoice_form_id" netsuite_project_form_id: "$ref": "#/components/schemas/resource_integration/properties/netsuite_project_form_id" twinfield_default_ledger: "$ref": "#/components/schemas/resource_integration/properties/twinfield_default_ledger" twinfield_ledger_mapping: "$ref": "#/components/schemas/resource_integration/properties/twinfield_ledger_mapping" xero_internal_note_cf_id: "$ref": "#/components/schemas/resource_integration/properties/xero_internal_note_cf_id" export_expense_attachment: "$ref": "#/components/schemas/resource_integration/properties/export_expense_attachment" google_events_write_scope: "$ref": "#/components/schemas/resource_integration/properties/google_events_write_scope" netsuite_attach_timesheet: "$ref": "#/components/schemas/resource_integration/properties/netsuite_attach_timesheet" netsuite_customer_form_id: "$ref": "#/components/schemas/resource_integration/properties/netsuite_customer_form_id" sage_intacct_account_code: "$ref": "#/components/schemas/resource_integration/properties/sage_intacct_account_code" twinfield_default_project: "$ref": "#/components/schemas/resource_integration/properties/twinfield_default_project" twinfield_invoice_destiny: "$ref": "#/components/schemas/resource_integration/properties/twinfield_invoice_destiny" twinfield_project_mapping: "$ref": "#/components/schemas/resource_integration/properties/twinfield_project_mapping" hubspot_default_company_id: "$ref": "#/components/schemas/resource_integration/properties/hubspot_default_company_id" update_invoice_sent_status: "$ref": "#/components/schemas/resource_integration/properties/update_invoice_sent_status" use_purchase_orders_export: "$ref": "#/components/schemas/resource_integration/properties/use_purchase_orders_export" bamboo_custom_field_mapping: "$ref": "#/components/schemas/resource_integration/properties/bamboo_custom_field_mapping" hubspot_default_template_id: "$ref": "#/components/schemas/resource_integration/properties/hubspot_default_template_id" netsuite_invoice_pdf_source: "$ref": "#/components/schemas/resource_integration/properties/netsuite_invoice_pdf_source" sage_intacct_export_project: "$ref": "#/components/schemas/resource_integration/properties/sage_intacct_export_project" salesforce_subsidiary_field: "$ref": "#/components/schemas/resource_integration/properties/salesforce_subsidiary_field" bamboo_default_subsidiary_id: "$ref": "#/components/schemas/resource_integration/properties/bamboo_default_subsidiary_id" expense_account_code_mapping: "$ref": "#/components/schemas/resource_integration/properties/expense_account_code_mapping" export_purchase_order_number: "$ref": "#/components/schemas/resource_integration/properties/export_purchase_order_number" netsuite_credit_note_form_id: "$ref": "#/components/schemas/resource_integration/properties/netsuite_credit_note_form_id" netsuite_sales_order_form_id: "$ref": "#/components/schemas/resource_integration/properties/netsuite_sales_order_form_id" hubspot_default_deal_owner_id: "$ref": "#/components/schemas/resource_integration/properties/hubspot_default_deal_owner_id" hubspot_default_subsidiary_id: "$ref": "#/components/schemas/resource_integration/properties/hubspot_default_subsidiary_id" netsuite_relationship_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_relationship_mapping" sage_intacct_project_category: "$ref": "#/components/schemas/resource_integration/properties/sage_intacct_project_category" salesforce_subsidiary_mapping: "$ref": "#/components/schemas/resource_integration/properties/salesforce_subsidiary_mapping" twinfield_cost_center_mapping: "$ref": "#/components/schemas/resource_integration/properties/twinfield_cost_center_mapping" twinfield_default_cost_center: "$ref": "#/components/schemas/resource_integration/properties/twinfield_default_cost_center" xero_purchase_order_status_id: "$ref": "#/components/schemas/resource_integration/properties/xero_purchase_order_status_id" netsuite_default_subsidiary_id: "$ref": "#/components/schemas/resource_integration/properties/netsuite_default_subsidiary_id" netsuite_invoice_field_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_invoice_field_mapping" netsuite_project_field_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_project_field_mapping" salesforce_project_template_id: "$ref": "#/components/schemas/resource_integration/properties/salesforce_project_template_id" bamboo_enable_user_provisioning: "$ref": "#/components/schemas/resource_integration/properties/bamboo_enable_user_provisioning" netsuite_customer_field_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_customer_field_mapping" netsuite_line_item_field_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_line_item_field_mapping" salesforce_default_subsidiary_id: "$ref": "#/components/schemas/resource_integration/properties/salesforce_default_subsidiary_id" sage_intacct_account_code_mapping: "$ref": "#/components/schemas/resource_integration/properties/sage_intacct_account_code_mapping" salesforce_product_family_mapping: "$ref": "#/components/schemas/resource_integration/properties/salesforce_product_family_mapping" xero_default_expense_account_code: "$ref": "#/components/schemas/resource_integration/properties/xero_default_expense_account_code" netsuite_sales_order_field_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_sales_order_field_mapping" salesforce_default_service_type_id: "$ref": "#/components/schemas/resource_integration/properties/salesforce_default_service_type_id" purchase_order_account_code_mapping: "$ref": "#/components/schemas/resource_integration/properties/purchase_order_account_code_mapping" netsuite_invoice_fixed_value_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_invoice_fixed_value_mapping" netsuite_customer_fixed_value_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_customer_fixed_value_mapping" netsuite_line_item_fixed_value_mapping: "$ref": "#/components/schemas/resource_integration/properties/netsuite_line_item_fixed_value_mapping" quickbooks_default_expense_account_code: "$ref": "#/components/schemas/resource_integration/properties/quickbooks_default_expense_account_code" quickbooks_default_expense_payment_type: "$ref": "#/components/schemas/resource_integration/properties/quickbooks_default_expense_payment_type" xero_default_purchase_order_account_code: "$ref": "#/components/schemas/resource_integration/properties/xero_default_purchase_order_account_code" quickbooks_default_expense_bank_account_code: "$ref": "#/components/schemas/resource_integration/properties/quickbooks_default_expense_bank_account_code" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection integration single_bank_account: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_bank_account/properties/name" number: "$ref": "#/components/schemas/resource_bank_account/properties/number" currency: "$ref": "#/components/schemas/resource_bank_account/properties/currency" bank_name: "$ref": "#/components/schemas/resource_bank_account/properties/bank_name" swift_code: "$ref": "#/components/schemas/resource_bank_account/properties/swift_code" archived_at: "$ref": "#/components/schemas/resource_bank_account/properties/archived_at" bank_address: "$ref": "#/components/schemas/resource_bank_account/properties/bank_address" relationships: type: object properties: subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single bank account collection_organization_membership: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: position: "$ref": "#/components/schemas/resource_organization_membership/properties/position" updated_at: "$ref": "#/components/schemas/resource_organization_membership/properties/updated_at" preferences: "$ref": "#/components/schemas/resource_organization_membership/properties/preferences" weekly_emails: "$ref": "#/components/schemas/resource_organization_membership/properties/weekly_emails" docs_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/docs_filter_id" time_reminders: "$ref": "#/components/schemas/resource_organization_membership/properties/time_reminders" deals_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/deals_filter_id" tasks_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/tasks_filter_id" tasks_layout_id: "$ref": "#/components/schemas/resource_organization_membership/properties/tasks_layout_id" people_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/people_filter_id" budgets_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/budgets_filter_id" bookings_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/bookings_filter_id" contacts_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/contacts_filter_id" expenses_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/expenses_filter_id" invoices_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/invoices_filter_id" payments_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/payments_filter_id" projects_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/projects_filter_id" quick_start_config: "$ref": "#/components/schemas/resource_organization_membership/properties/quick_start_config" companies_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/companies_filter_id" email_notifications: "$ref": "#/components/schemas/resource_organization_membership/properties/email_notifications" employees_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/employees_filter_id" company_time_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/company_time_filter_id" time_reports_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/time_reports_filter_id" deal_services_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/deal_services_filter_id" salary_reports_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/salary_reports_filter_id" time_approvals_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/time_approvals_filter_id" budget_services_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/budget_services_filter_id" booking_approvals_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/booking_approvals_filter_id" expense_approvals_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/expense_approvals_filter_id" time_entry_reports_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/time_entry_reports_filter_id" granular_notification_preferences: "$ref": "#/components/schemas/resource_organization_membership/properties/granular_notification_preferences" internal_budget_services_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/internal_budget_services_filter_id" relationships: type: object properties: user: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" docs_favorite_filter: "$ref": "#/components/schemas/_single_relationship" time_tracking_policy: "$ref": "#/components/schemas/_single_relationship" deals_favorite_filter: "$ref": "#/components/schemas/_single_relationship" tasks_favorite_filter: "$ref": "#/components/schemas/_single_relationship" people_favorite_filter: "$ref": "#/components/schemas/_single_relationship" budgets_favorite_filter: "$ref": "#/components/schemas/_single_relationship" bookings_favorite_filter: "$ref": "#/components/schemas/_single_relationship" contacts_favorite_filter: "$ref": "#/components/schemas/_single_relationship" expenses_favorite_filter: "$ref": "#/components/schemas/_single_relationship" invoices_favorite_filter: "$ref": "#/components/schemas/_single_relationship" payments_favorite_filter: "$ref": "#/components/schemas/_single_relationship" projects_favorite_filter: "$ref": "#/components/schemas/_single_relationship" companies_favorite_filter: "$ref": "#/components/schemas/_single_relationship" employees_favorite_filter: "$ref": "#/components/schemas/_single_relationship" company_time_favorite_filter: "$ref": "#/components/schemas/_single_relationship" time_reports_favorite_filter: "$ref": "#/components/schemas/_single_relationship" deal_services_favorite_filter: "$ref": "#/components/schemas/_single_relationship" salary_reports_favorite_filter: "$ref": "#/components/schemas/_single_relationship" time_approvals_favorite_filter: "$ref": "#/components/schemas/_single_relationship" budget_services_favorite_filter: "$ref": "#/components/schemas/_single_relationship" booking_approvals_favorite_filter: "$ref": "#/components/schemas/_single_relationship" expense_approvals_favorite_filter: "$ref": "#/components/schemas/_single_relationship" time_entry_reports_favorite_filter: "$ref": "#/components/schemas/_single_relationship" internal_budget_services_favorite_filter: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection organization membership collection_custom_field_option: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_custom_field_option/properties/name" color_id: "$ref": "#/components/schemas/resource_custom_field_option/properties/color_id" position: "$ref": "#/components/schemas/resource_custom_field_option/properties/position" archived_at: "$ref": "#/components/schemas/resource_custom_field_option/properties/archived_at" relationships: type: object properties: custom_field: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection custom field option single_timer: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: person_id: "$ref": "#/components/schemas/resource_timer/properties/person_id" started_at: "$ref": "#/components/schemas/resource_timer/properties/started_at" stopped_at: "$ref": "#/components/schemas/resource_timer/properties/stopped_at" total_time: "$ref": "#/components/schemas/resource_timer/properties/total_time" relationships: type: object properties: time_entry: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single timer collection_activity: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: event: "$ref": "#/components/schemas/resource_activity/properties/event" deal_id: "$ref": "#/components/schemas/resource_activity/properties/deal_id" item_id: "$ref": "#/components/schemas/resource_activity/properties/item_id" page_id: "$ref": "#/components/schemas/resource_activity/properties/page_id" root_id: "$ref": "#/components/schemas/resource_activity/properties/root_id" task_id: "$ref": "#/components/schemas/resource_activity/properties/task_id" changeset: "$ref": "#/components/schemas/resource_activity/properties/changeset" item_name: "$ref": "#/components/schemas/resource_activity/properties/item_name" item_type: "$ref": "#/components/schemas/resource_activity/properties/item_type" parent_id: "$ref": "#/components/schemas/resource_activity/properties/parent_id" person_id: "$ref": "#/components/schemas/resource_activity/properties/person_id" root_name: "$ref": "#/components/schemas/resource_activity/properties/root_name" root_type: "$ref": "#/components/schemas/resource_activity/properties/root_type" booking_id: "$ref": "#/components/schemas/resource_activity/properties/booking_id" company_id: "$ref": "#/components/schemas/resource_activity/properties/company_id" created_at: "$ref": "#/components/schemas/resource_activity/properties/created_at" invoice_id: "$ref": "#/components/schemas/resource_activity/properties/invoice_id" parent_name: "$ref": "#/components/schemas/resource_activity/properties/parent_name" parent_type: "$ref": "#/components/schemas/resource_activity/properties/parent_type" discussion_id: "$ref": "#/components/schemas/resource_activity/properties/discussion_id" engagement_id: "$ref": "#/components/schemas/resource_activity/properties/engagement_id" deal_is_budget: "$ref": "#/components/schemas/resource_activity/properties/deal_is_budget" item_deleted_at: "$ref": "#/components/schemas/resource_activity/properties/item_deleted_at" root_deleted_at: "$ref": "#/components/schemas/resource_activity/properties/root_deleted_at" parent_deleted_at: "$ref": "#/components/schemas/resource_activity/properties/parent_deleted_at" purchase_order_id: "$ref": "#/components/schemas/resource_activity/properties/purchase_order_id" made_by_automation: "$ref": "#/components/schemas/resource_activity/properties/made_by_automation" relationships: type: object properties: role: "$ref": "#/components/schemas/_single_relationship" email: "$ref": "#/components/schemas/_single_relationship" comment: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" attachment: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection activity single_project: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_project/properties/name" number: "$ref": "#/components/schemas/resource_project/properties/number" template: "$ref": "#/components/schemas/resource_project/properties/template" created_at: "$ref": "#/components/schemas/resource_project/properties/created_at" tag_colors: "$ref": "#/components/schemas/resource_project/properties/tag_colors" archived_at: "$ref": "#/components/schemas/resource_project/properties/archived_at" preferences: "$ref": "#/components/schemas/resource_project/properties/preferences" sample_data: "$ref": "#/components/schemas/resource_project/properties/sample_data" custom_fields: "$ref": "#/components/schemas/resource_project/properties/custom_fields" project_number: "$ref": "#/components/schemas/resource_project/properties/project_number" project_type_id: "$ref": "#/components/schemas/resource_project/properties/project_type_id" last_activity_at: "$ref": "#/components/schemas/resource_project/properties/last_activity_at" project_color_id: "$ref": "#/components/schemas/resource_project/properties/project_color_id" duplication_status: "$ref": "#/components/schemas/resource_project/properties/duplication_status" page_custom_fields_ids: "$ref": "#/components/schemas/resource_project/properties/page_custom_fields_ids" task_custom_fields_ids: "$ref": "#/components/schemas/resource_project/properties/task_custom_fields_ids" page_custom_fields_positions: "$ref": "#/components/schemas/resource_project/properties/page_custom_fields_positions" task_custom_fields_positions: "$ref": "#/components/schemas/resource_project/properties/task_custom_fields_positions" relationships: type: object properties: company: "$ref": "#/components/schemas/_single_relationship" workflow: "$ref": "#/components/schemas/_single_relationship" last_actor: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" project_manager: "$ref": "#/components/schemas/_single_relationship" template_object: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single project collection_holiday: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_holiday/properties/date" name: "$ref": "#/components/schemas/resource_holiday/properties/name" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" holiday_calendar: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection holiday single_team_membership: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: {} relationships: type: object properties: team: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single team membership collection_workflow: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_workflow/properties/name" archived_at: "$ref": "#/components/schemas/resource_workflow/properties/archived_at" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" workflow_statuses: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection workflow single_survey: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: title: "$ref": "#/components/schemas/resource_survey/properties/title" created_at: "$ref": "#/components/schemas/resource_survey/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_survey/properties/updated_at" public_uuid: "$ref": "#/components/schemas/resource_survey/properties/public_uuid" submission_access: "$ref": "#/components/schemas/resource_survey/properties/submission_access" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single survey single_custom_field_section: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_custom_field_section/properties/name" position: "$ref": "#/components/schemas/resource_custom_field_section/properties/position" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single custom field section collection_deleted_item: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_deleted_item/properties/name" item_id: "$ref": "#/components/schemas/resource_deleted_item/properties/item_id" private: "$ref": "#/components/schemas/resource_deleted_item/properties/private" location: "$ref": "#/components/schemas/resource_deleted_item/properties/location" item_type: "$ref": "#/components/schemas/resource_deleted_item/properties/item_type" created_at: "$ref": "#/components/schemas/resource_deleted_item/properties/created_at" deleter_id: "$ref": "#/components/schemas/resource_deleted_item/properties/deleter_id" recovered_at: "$ref": "#/components/schemas/resource_deleted_item/properties/recovered_at" relationships: type: object properties: deleter: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection deleted item single_report_category: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_report_category/properties/name" color_id: "$ref": "#/components/schemas/resource_report_category/properties/color_id" position: "$ref": "#/components/schemas/resource_report_category/properties/position" deleted_at: "$ref": "#/components/schemas/resource_report_category/properties/deleted_at" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single report category collection_payment: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_payment/properties/note" amount: "$ref": "#/components/schemas/resource_payment/properties/amount" paid_on: "$ref": "#/components/schemas/resource_payment/properties/paid_on" currency: "$ref": "#/components/schemas/resource_payment/properties/currency" external_id: "$ref": "#/components/schemas/resource_payment/properties/external_id" amount_default: "$ref": "#/components/schemas/resource_payment/properties/amount_default" written_off_on: "$ref": "#/components/schemas/resource_payment/properties/written_off_on" currency_default: "$ref": "#/components/schemas/resource_payment/properties/currency_default" amount_normalized: "$ref": "#/components/schemas/resource_payment/properties/amount_normalized" currency_normalized: "$ref": "#/components/schemas/resource_payment/properties/currency_normalized" relationships: type: object properties: invoice: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection payment single_expense: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_expense/properties/date" name: "$ref": "#/components/schemas/resource_expense/properties/name" draft: "$ref": "#/components/schemas/resource_expense/properties/draft" amount: "$ref": "#/components/schemas/resource_expense/properties/amount" markup: "$ref": "#/components/schemas/resource_expense/properties/markup" pay_on: "$ref": "#/components/schemas/resource_expense/properties/pay_on" profit: "$ref": "#/components/schemas/resource_expense/properties/profit" paid_on: "$ref": "#/components/schemas/resource_expense/properties/paid_on" approved: "$ref": "#/components/schemas/resource_expense/properties/approved" currency: "$ref": "#/components/schemas/resource_expense/properties/currency" exported: "$ref": "#/components/schemas/resource_expense/properties/exported" invoiced: "$ref": "#/components/schemas/resource_expense/properties/invoiced" position: "$ref": "#/components/schemas/resource_expense/properties/position" quantity: "$ref": "#/components/schemas/resource_expense/properties/quantity" rejected: "$ref": "#/components/schemas/resource_expense/properties/rejected" export_id: "$ref": "#/components/schemas/resource_expense/properties/export_id" created_at: "$ref": "#/components/schemas/resource_expense/properties/created_at" deleted_at: "$ref": "#/components/schemas/resource_expense/properties/deleted_at" export_url: "$ref": "#/components/schemas/resource_expense/properties/export_url" approved_at: "$ref": "#/components/schemas/resource_expense/properties/approved_at" exported_at: "$ref": "#/components/schemas/resource_expense/properties/exported_at" rejected_at: "$ref": "#/components/schemas/resource_expense/properties/rejected_at" reimbursable: "$ref": "#/components/schemas/resource_expense/properties/reimbursable" total_amount: "$ref": "#/components/schemas/resource_expense/properties/total_amount" custom_fields: "$ref": "#/components/schemas/resource_expense/properties/custom_fields" exchange_date: "$ref": "#/components/schemas/resource_expense/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_expense/properties/exchange_rate" reimbursed_on: "$ref": "#/components/schemas/resource_expense/properties/reimbursed_on" tax_inclusion: "$ref": "#/components/schemas/resource_expense/properties/tax_inclusion" amount_default: "$ref": "#/components/schemas/resource_expense/properties/amount_default" profit_default: "$ref": "#/components/schemas/resource_expense/properties/profit_default" amount_with_tax: "$ref": "#/components/schemas/resource_expense/properties/amount_with_tax" billable_amount: "$ref": "#/components/schemas/resource_expense/properties/billable_amount" rejected_reason: "$ref": "#/components/schemas/resource_expense/properties/rejected_reason" currency_default: "$ref": "#/components/schemas/resource_expense/properties/currency_default" line_items_count: "$ref": "#/components/schemas/resource_expense/properties/line_items_count" allocation_status: "$ref": "#/components/schemas/resource_expense/properties/allocation_status" amount_normalized: "$ref": "#/components/schemas/resource_expense/properties/amount_normalized" profit_normalized: "$ref": "#/components/schemas/resource_expense/properties/profit_normalized" quantity_received: "$ref": "#/components/schemas/resource_expense/properties/quantity_received" recognized_revenue: "$ref": "#/components/schemas/resource_expense/properties/recognized_revenue" currency_normalized: "$ref": "#/components/schemas/resource_expense/properties/currency_normalized" external_payment_id: "$ref": "#/components/schemas/resource_expense/properties/external_payment_id" company_reference_id: "$ref": "#/components/schemas/resource_expense/properties/company_reference_id" total_amount_default: "$ref": "#/components/schemas/resource_expense/properties/total_amount_default" total_amount_with_tax: "$ref": "#/components/schemas/resource_expense/properties/total_amount_with_tax" amount_with_tax_default: "$ref": "#/components/schemas/resource_expense/properties/amount_with_tax_default" billable_amount_default: "$ref": "#/components/schemas/resource_expense/properties/billable_amount_default" total_amount_normalized: "$ref": "#/components/schemas/resource_expense/properties/total_amount_normalized" exchange_rate_normalized: "$ref": "#/components/schemas/resource_expense/properties/exchange_rate_normalized" amount_with_tax_normalized: "$ref": "#/components/schemas/resource_expense/properties/amount_with_tax_normalized" billable_amount_normalized: "$ref": "#/components/schemas/resource_expense/properties/billable_amount_normalized" export_integration_type_id: "$ref": "#/components/schemas/resource_expense/properties/export_integration_type_id" recognized_revenue_default: "$ref": "#/components/schemas/resource_expense/properties/recognized_revenue_default" recognized_revenue_normalized: "$ref": "#/components/schemas/resource_expense/properties/recognized_revenue_normalized" total_amount_with_tax_default: "$ref": "#/components/schemas/resource_expense/properties/total_amount_with_tax_default" total_amount_with_tax_normalized: "$ref": "#/components/schemas/resource_expense/properties/total_amount_with_tax_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" vendor: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" approver: "$ref": "#/components/schemas/_single_relationship" rejecter: "$ref": "#/components/schemas/_single_relationship" tax_rate: "$ref": "#/components/schemas/_single_relationship" attachment: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" purchase_order: "$ref": "#/components/schemas/_single_relationship" approval_statuses: "$ref": "#/components/schemas/_collection_relationship" expense_line_items: "$ref": "#/components/schemas/_collection_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" invoice_attribution: "$ref": "#/components/schemas/_single_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Expenses. single_timesheet: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_timesheet/properties/date" created_at: "$ref": "#/components/schemas/resource_timesheet/properties/created_at" relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single timesheet collection_placeholder: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: icon: "$ref": "#/components/schemas/resource_placeholder/properties/icon" name: "$ref": "#/components/schemas/resource_placeholder/properties/name" type: "$ref": "#/components/schemas/resource_placeholder/properties/type" color: "$ref": "#/components/schemas/resource_placeholder/properties/color" category: "$ref": "#/components/schemas/resource_placeholder/properties/category" created_at: "$ref": "#/components/schemas/resource_placeholder/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_placeholder/properties/updated_at" relationships: type: object properties: project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection placeholder single_resource_request: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_resource_request/properties/note" time: "$ref": "#/components/schemas/resource_resource_request/properties/time" title: "$ref": "#/components/schemas/resource_resource_request/properties/title" fields: "$ref": "#/components/schemas/resource_resource_request/properties/fields" status: "$ref": "#/components/schemas/resource_resource_request/properties/status" currency: "$ref": "#/components/schemas/resource_resource_request/properties/currency" ended_on: "$ref": "#/components/schemas/resource_resource_request/properties/ended_on" created_at: "$ref": "#/components/schemas/resource_resource_request/properties/created_at" percentage: "$ref": "#/components/schemas/resource_resource_request/properties/percentage" started_on: "$ref": "#/components/schemas/resource_resource_request/properties/started_on" total_time: "$ref": "#/components/schemas/resource_resource_request/properties/total_time" canceled_at: "$ref": "#/components/schemas/resource_resource_request/properties/canceled_at" resolved_at: "$ref": "#/components/schemas/resource_resource_request/properties/resolved_at" custom_fields: "$ref": "#/components/schemas/resource_resource_request/properties/custom_fields" exchange_date: "$ref": "#/components/schemas/resource_resource_request/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_resource_request/properties/exchange_rate" time_to_close: "$ref": "#/components/schemas/resource_resource_request/properties/time_to_close" rejected_reason: "$ref": "#/components/schemas/resource_resource_request/properties/rejected_reason" currency_default: "$ref": "#/components/schemas/resource_resource_request/properties/currency_default" booking_method_id: "$ref": "#/components/schemas/resource_resource_request/properties/booking_method_id" max_cost_per_hour: "$ref": "#/components/schemas/resource_resource_request/properties/max_cost_per_hour" currency_normalized: "$ref": "#/components/schemas/resource_resource_request/properties/currency_normalized" exchange_rate_normalized: "$ref": "#/components/schemas/resource_resource_request/properties/exchange_rate_normalized" max_cost_per_hour_default: "$ref": "#/components/schemas/resource_resource_request/properties/max_cost_per_hour_default" max_cost_per_hour_normalized: "$ref": "#/components/schemas/resource_resource_request/properties/max_cost_per_hour_normalized" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" resolver: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: A single resource request response. single_survey_field: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_survey_field/properties/name" global: "$ref": "#/components/schemas/resource_survey_field/properties/global" position: "$ref": "#/components/schemas/resource_survey_field/properties/position" required: "$ref": "#/components/schemas/resource_survey_field/properties/required" sensitive: "$ref": "#/components/schemas/resource_survey_field/properties/sensitive" created_at: "$ref": "#/components/schemas/resource_survey_field/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_survey_field/properties/updated_at" archived_at: "$ref": "#/components/schemas/resource_survey_field/properties/archived_at" data_type_id: "$ref": "#/components/schemas/resource_survey_field/properties/data_type_id" customizable_type: "$ref": "#/components/schemas/resource_survey_field/properties/customizable_type" quick_add_enabled: "$ref": "#/components/schemas/resource_survey_field/properties/quick_add_enabled" formatting_type_id: "$ref": "#/components/schemas/resource_survey_field/properties/formatting_type_id" aggregation_type_id: "$ref": "#/components/schemas/resource_survey_field/properties/aggregation_type_id" show_in_add_edit_views: "$ref": "#/components/schemas/resource_survey_field/properties/show_in_add_edit_views" relationships: type: object properties: survey: "$ref": "#/components/schemas/_single_relationship" options: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" origin_field: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single survey field collection_contract: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: ends_on: "$ref": "#/components/schemas/resource_contract/properties/ends_on" starts_on: "$ref": "#/components/schemas/resource_contract/properties/starts_on" interval_id: "$ref": "#/components/schemas/resource_contract/properties/interval_id" copy_expenses: "$ref": "#/components/schemas/resource_contract/properties/copy_expenses" next_occurrence_on: "$ref": "#/components/schemas/resource_contract/properties/next_occurrence_on" use_rollover_hours: "$ref": "#/components/schemas/resource_contract/properties/use_rollover_hours" copy_purchase_order_number: "$ref": "#/components/schemas/resource_contract/properties/copy_purchase_order_number" relationships: type: object properties: template: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection contract collection_service_assignment: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: {} relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection service assignment collection_comment: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: body: "$ref": "#/components/schemas/resource_comment/properties/body" draft: "$ref": "#/components/schemas/resource_comment/properties/draft" hidden: "$ref": "#/components/schemas/resource_comment/properties/hidden" edited_at: "$ref": "#/components/schemas/resource_comment/properties/edited_at" pinned_at: "$ref": "#/components/schemas/resource_comment/properties/pinned_at" reactions: "$ref": "#/components/schemas/resource_comment/properties/reactions" created_at: "$ref": "#/components/schemas/resource_comment/properties/created_at" deleted_at: "$ref": "#/components/schemas/resource_comment/properties/deleted_at" updated_at: "$ref": "#/components/schemas/resource_comment/properties/updated_at" version_number: "$ref": "#/components/schemas/resource_comment/properties/version_number" commentable_type: "$ref": "#/components/schemas/resource_comment/properties/commentable_type" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" task: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" pinned_by: "$ref": "#/components/schemas/_single_relationship" discussion: "$ref": "#/components/schemas/_single_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" purchase_order: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection comment single_page: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: body: "$ref": "#/components/schemas/resource_page/properties/body" title: "$ref": "#/components/schemas/resource_page/properties/title" public: "$ref": "#/components/schemas/resource_page/properties/public" icon_id: "$ref": "#/components/schemas/resource_page/properties/icon_id" position: "$ref": "#/components/schemas/resource_page/properties/position" edited_at: "$ref": "#/components/schemas/resource_page/properties/edited_at" created_at: "$ref": "#/components/schemas/resource_page/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_page/properties/updated_at" preferences: "$ref": "#/components/schemas/resource_page/properties/preferences" public_uuid: "$ref": "#/components/schemas/resource_page/properties/public_uuid" root_page_id: "$ref": "#/components/schemas/resource_page/properties/root_page_id" custom_fields: "$ref": "#/components/schemas/resource_page/properties/custom_fields" public_access: "$ref": "#/components/schemas/resource_page/properties/public_access" parent_page_id: "$ref": "#/components/schemas/resource_page/properties/parent_page_id" version_number: "$ref": "#/components/schemas/resource_page/properties/version_number" cover_image_url: "$ref": "#/components/schemas/resource_page/properties/cover_image_url" cover_image_meta: "$ref": "#/components/schemas/resource_page/properties/cover_image_meta" last_activity_at: "$ref": "#/components/schemas/resource_page/properties/last_activity_at" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" root_page: "$ref": "#/components/schemas/_single_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" parent_page: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" template_object: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single page single_comment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: body: "$ref": "#/components/schemas/resource_comment/properties/body" draft: "$ref": "#/components/schemas/resource_comment/properties/draft" hidden: "$ref": "#/components/schemas/resource_comment/properties/hidden" edited_at: "$ref": "#/components/schemas/resource_comment/properties/edited_at" pinned_at: "$ref": "#/components/schemas/resource_comment/properties/pinned_at" reactions: "$ref": "#/components/schemas/resource_comment/properties/reactions" created_at: "$ref": "#/components/schemas/resource_comment/properties/created_at" deleted_at: "$ref": "#/components/schemas/resource_comment/properties/deleted_at" updated_at: "$ref": "#/components/schemas/resource_comment/properties/updated_at" version_number: "$ref": "#/components/schemas/resource_comment/properties/version_number" commentable_type: "$ref": "#/components/schemas/resource_comment/properties/commentable_type" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" task: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" pinned_by: "$ref": "#/components/schemas/_single_relationship" discussion: "$ref": "#/components/schemas/_single_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" purchase_order: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single comment collection_page_version: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_page_version/properties/name" created_at: "$ref": "#/components/schemas/resource_page_version/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_page_version/properties/updated_at" body_snapshot: "$ref": "#/components/schemas/resource_page_version/properties/body_snapshot" title_snapshot: "$ref": "#/components/schemas/resource_page_version/properties/title_snapshot" prosemirror_steps: "$ref": "#/components/schemas/resource_page_version/properties/prosemirror_steps" restored_from_version_id: "$ref": "#/components/schemas/resource_page_version/properties/restored_from_version_id" relationships: type: object properties: page: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection page version single_event: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_event/properties/name" icon_id: "$ref": "#/components/schemas/resource_event/properties/icon_id" color_id: "$ref": "#/components/schemas/resource_event/properties/color_id" archived_at: "$ref": "#/components/schemas/resource_event/properties/archived_at" description: "$ref": "#/components/schemas/resource_event/properties/description" absence_type: "$ref": "#/components/schemas/resource_event/properties/absence_type" event_type_id: "$ref": "#/components/schemas/resource_event/properties/event_type_id" half_day_bookings: "$ref": "#/components/schemas/resource_event/properties/half_day_bookings" limitation_type_id: "$ref": "#/components/schemas/resource_event/properties/limitation_type_id" sync_personal_integrations: "$ref": "#/components/schemas/resource_event/properties/sync_personal_integrations" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single event single_subsidiary: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_subsidiary/properties/name" archived_at: "$ref": "#/components/schemas/resource_subsidiary/properties/archived_at" facility_costs: "$ref": "#/components/schemas/resource_subsidiary/properties/facility_costs" invoice_logo_url: "$ref": "#/components/schemas/resource_subsidiary/properties/invoice_logo_url" show_delivery_date: "$ref": "#/components/schemas/resource_subsidiary/properties/show_delivery_date" invoice_number_scope: "$ref": "#/components/schemas/resource_subsidiary/properties/invoice_number_scope" invoice_number_format: "$ref": "#/components/schemas/resource_subsidiary/properties/invoice_number_format" facility_costs_default: "$ref": "#/components/schemas/resource_subsidiary/properties/facility_costs_default" facility_costs_breakdown: "$ref": "#/components/schemas/resource_subsidiary/properties/facility_costs_breakdown" facility_costs_normalized: "$ref": "#/components/schemas/resource_subsidiary/properties/facility_costs_normalized" export_integration_type_id: "$ref": "#/components/schemas/resource_subsidiary/properties/export_integration_type_id" relationships: type: object properties: bill_from: "$ref": "#/components/schemas/_single_relationship" integration: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" custom_domain: "$ref": "#/components/schemas/_single_relationship" default_tax_rate: "$ref": "#/components/schemas/_single_relationship" einvoice_identity: "$ref": "#/components/schemas/_single_relationship" default_bank_account: "$ref": "#/components/schemas/_single_relationship" default_document_type: "$ref": "#/components/schemas/_single_relationship" einvoice_configuration: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single subsidiary collection_invoice_template: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_invoice_template/properties/note" subject: "$ref": "#/components/schemas/resource_invoice_template/properties/subject" custom_fields: "$ref": "#/components/schemas/resource_invoice_template/properties/custom_fields" invoice_due_in_days: "$ref": "#/components/schemas/resource_invoice_template/properties/invoice_due_in_days" bank_account_details: "$ref": "#/components/schemas/resource_invoice_template/properties/bank_account_details" invoice_creation_options: "$ref": "#/components/schemas/resource_invoice_template/properties/invoice_creation_options" relationships: type: object properties: budget: "$ref": "#/components/schemas/_single_relationship" issuer: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" bank_account: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_type: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection invoice template collection_team_membership: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: {} relationships: type: object properties: team: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection team membership collection_time_tracking_policy: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/name" created_at: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/updated_at" archived_at: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/archived_at" holiday_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/holiday_limit" note_mandatory: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/note_mandatory" task_mandatory: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/task_mandatory" working_day_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/working_day_limit" time_range_mandatory: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/time_range_mandatory" assigned_people_count: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/assigned_people_count" non_working_day_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/non_working_day_limit" full_day_absence_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/full_day_absence_limit" half_day_absence_limit: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/half_day_absence_limit" limited_tracking_message: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/limited_tracking_message" restrict_future_tracking: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/restrict_future_tracking" disabled_tracking_message: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/disabled_tracking_message" restrict_time_entry_overlap: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/restrict_time_entry_overlap" restrict_tracking_over_budget: "$ref": "#/components/schemas/resource_time_tracking_policy/properties/restrict_tracking_over_budget" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" last_actor: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection time tracking policy single_holiday_calendar: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_holiday_calendar/properties/name" state: "$ref": "#/components/schemas/resource_holiday_calendar/properties/state" country: "$ref": "#/components/schemas/resource_holiday_calendar/properties/country" autogenerate_holidays: "$ref": "#/components/schemas/resource_holiday_calendar/properties/autogenerate_holidays" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single holiday calendar collection_einvoice_identity: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: dire_code: "$ref": "#/components/schemas/resource_einvoice_identity/properties/dire_code" peppol_id: "$ref": "#/components/schemas/resource_einvoice_identity/properties/peppol_id" created_at: "$ref": "#/components/schemas/resource_einvoice_identity/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_einvoice_identity/properties/updated_at" buyer_reference: "$ref": "#/components/schemas/resource_einvoice_identity/properties/buyer_reference" dir3_fiscal_code: "$ref": "#/components/schemas/resource_einvoice_identity/properties/dir3_fiscal_code" dir3_pagador_code: "$ref": "#/components/schemas/resource_einvoice_identity/properties/dir3_pagador_code" dir3_receptor_code: "$ref": "#/components/schemas/resource_einvoice_identity/properties/dir3_receptor_code" is_government_entity: "$ref": "#/components/schemas/resource_einvoice_identity/properties/is_government_entity" relationships: type: object properties: company: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Successful response containing a list of e-invoice identity resources. single_workflow: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_workflow/properties/name" archived_at: "$ref": "#/components/schemas/resource_workflow/properties/archived_at" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" workflow_statuses: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single workflow single_session: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_session/properties/name" note: "$ref": "#/components/schemas/resource_session/properties/note" token: "$ref": "#/components/schemas/resource_session/properties/token" device: "$ref": "#/components/schemas/resource_session/properties/device" browser: "$ref": "#/components/schemas/resource_session/properties/browser" last_ip: "$ref": "#/components/schemas/resource_session/properties/last_ip" machine: "$ref": "#/components/schemas/resource_session/properties/machine" user_id: "$ref": "#/components/schemas/resource_session/properties/user_id" location: "$ref": "#/components/schemas/resource_session/properties/location" platform: "$ref": "#/components/schemas/resource_session/properties/platform" read_only: "$ref": "#/components/schemas/resource_session/properties/read_only" agent_avatar: "$ref": "#/components/schemas/resource_session/properties/agent_avatar" single_sign_on: "$ref": "#/components/schemas/resource_session/properties/single_sign_on" agent_last_name: "$ref": "#/components/schemas/resource_session/properties/agent_last_name" two_factor_auth: "$ref": "#/components/schemas/resource_session/properties/two_factor_auth" agent_first_name: "$ref": "#/components/schemas/resource_session/properties/agent_first_name" last_activity_at: "$ref": "#/components/schemas/resource_session/properties/last_activity_at" token_expires_at: "$ref": "#/components/schemas/resource_session/properties/token_expires_at" relationships: type: object properties: user: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single session collection_todo: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: closed: "$ref": "#/components/schemas/resource_todo/properties/closed" due_date: "$ref": "#/components/schemas/resource_todo/properties/due_date" due_time: "$ref": "#/components/schemas/resource_todo/properties/due_time" position: "$ref": "#/components/schemas/resource_todo/properties/position" closed_at: "$ref": "#/components/schemas/resource_todo/properties/closed_at" created_at: "$ref": "#/components/schemas/resource_todo/properties/created_at" todoable_type: "$ref": "#/components/schemas/resource_todo/properties/todoable_type" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" task: "$ref": "#/components/schemas/_single_relationship" assignee: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection todo collection_survey_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: count: "$ref": "#/components/schemas/resource_survey_report/properties/count" group: "$ref": "#/components/schemas/resource_survey_report/properties/group" title: "$ref": "#/components/schemas/resource_survey_report/properties/title" currency: "$ref": "#/components/schemas/resource_survey_report/properties/currency" created_at: "$ref": "#/components/schemas/resource_survey_report/properties/created_at" formula_fields: "$ref": "#/components/schemas/resource_survey_report/properties/formula_fields" currency_default: "$ref": "#/components/schemas/resource_survey_report/properties/currency_default" currency_normalized: "$ref": "#/components/schemas/resource_survey_report/properties/currency_normalized" relationships: type: object properties: report: "$ref": "#/components/schemas/_single_relationship" survey: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection survey report single_activity: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: event: "$ref": "#/components/schemas/resource_activity/properties/event" deal_id: "$ref": "#/components/schemas/resource_activity/properties/deal_id" item_id: "$ref": "#/components/schemas/resource_activity/properties/item_id" page_id: "$ref": "#/components/schemas/resource_activity/properties/page_id" root_id: "$ref": "#/components/schemas/resource_activity/properties/root_id" task_id: "$ref": "#/components/schemas/resource_activity/properties/task_id" changeset: "$ref": "#/components/schemas/resource_activity/properties/changeset" item_name: "$ref": "#/components/schemas/resource_activity/properties/item_name" item_type: "$ref": "#/components/schemas/resource_activity/properties/item_type" parent_id: "$ref": "#/components/schemas/resource_activity/properties/parent_id" person_id: "$ref": "#/components/schemas/resource_activity/properties/person_id" root_name: "$ref": "#/components/schemas/resource_activity/properties/root_name" root_type: "$ref": "#/components/schemas/resource_activity/properties/root_type" booking_id: "$ref": "#/components/schemas/resource_activity/properties/booking_id" company_id: "$ref": "#/components/schemas/resource_activity/properties/company_id" created_at: "$ref": "#/components/schemas/resource_activity/properties/created_at" invoice_id: "$ref": "#/components/schemas/resource_activity/properties/invoice_id" parent_name: "$ref": "#/components/schemas/resource_activity/properties/parent_name" parent_type: "$ref": "#/components/schemas/resource_activity/properties/parent_type" discussion_id: "$ref": "#/components/schemas/resource_activity/properties/discussion_id" engagement_id: "$ref": "#/components/schemas/resource_activity/properties/engagement_id" deal_is_budget: "$ref": "#/components/schemas/resource_activity/properties/deal_is_budget" item_deleted_at: "$ref": "#/components/schemas/resource_activity/properties/item_deleted_at" root_deleted_at: "$ref": "#/components/schemas/resource_activity/properties/root_deleted_at" parent_deleted_at: "$ref": "#/components/schemas/resource_activity/properties/parent_deleted_at" purchase_order_id: "$ref": "#/components/schemas/resource_activity/properties/purchase_order_id" made_by_automation: "$ref": "#/components/schemas/resource_activity/properties/made_by_automation" relationships: type: object properties: role: "$ref": "#/components/schemas/_single_relationship" email: "$ref": "#/components/schemas/_single_relationship" comment: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" attachment: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single activity collection_discussion: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: excerpt: "$ref": "#/components/schemas/resource_discussion/properties/excerpt" resolved_at: "$ref": "#/components/schemas/resource_discussion/properties/resolved_at" subscriber_ids: "$ref": "#/components/schemas/resource_discussion/properties/subscriber_ids" relationships: type: object properties: page: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection discussion collection_project_assignment: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: watched: "$ref": "#/components/schemas/resource_project_assignment/properties/watched" created_at: "$ref": "#/components/schemas/resource_project_assignment/properties/created_at" preferences: "$ref": "#/components/schemas/resource_project_assignment/properties/preferences" docs_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/docs_filter_id" deals_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/deals_filter_id" tasks_layout_id: "$ref": "#/components/schemas/resource_project_assignment/properties/tasks_layout_id" budgets_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/budgets_filter_id" default_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/default_filter_id" invoices_filter_id: "$ref": "#/components/schemas/resource_project_assignment/properties/invoices_filter_id" relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" favorite_filter: "$ref": "#/components/schemas/_single_relationship" docs_favorite_filter: "$ref": "#/components/schemas/_single_relationship" deals_favorite_filter: "$ref": "#/components/schemas/_single_relationship" budgets_favorite_filter: "$ref": "#/components/schemas/_single_relationship" invoices_favorite_filter: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection project assignment single_webhook: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_webhook/properties/name" test: "$ref": "#/components/schemas/resource_webhook/properties/test" type_id: "$ref": "#/components/schemas/resource_webhook/properties/type_id" event_id: "$ref": "#/components/schemas/resource_webhook/properties/event_id" state_id: "$ref": "#/components/schemas/resource_webhook/properties/state_id" target_url: "$ref": "#/components/schemas/resource_webhook/properties/target_url" custom_headers: "$ref": "#/components/schemas/resource_webhook/properties/custom_headers" deactivated_at: "$ref": "#/components/schemas/resource_webhook/properties/deactivated_at" retry_attempts: "$ref": "#/components/schemas/resource_webhook/properties/retry_attempts" signature_token: "$ref": "#/components/schemas/resource_webhook/properties/signature_token" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single webhook collection_expense_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: week: "$ref": "#/components/schemas/resource_expense_report/properties/week" year: "$ref": "#/components/schemas/resource_expense_report/properties/year" count: "$ref": "#/components/schemas/resource_expense_report/properties/count" group: "$ref": "#/components/schemas/resource_expense_report/properties/group" month: "$ref": "#/components/schemas/resource_expense_report/properties/month" status: "$ref": "#/components/schemas/resource_expense_report/properties/status" quarter: "$ref": "#/components/schemas/resource_expense_report/properties/quarter" currency: "$ref": "#/components/schemas/resource_expense_report/properties/currency" invoiced: "$ref": "#/components/schemas/resource_expense_report/properties/invoiced" quantity: "$ref": "#/components/schemas/resource_expense_report/properties/quantity" project_id: "$ref": "#/components/schemas/resource_expense_report/properties/project_id" quote_type: "$ref": "#/components/schemas/resource_expense_report/properties/quote_type" stage_type: "$ref": "#/components/schemas/resource_expense_report/properties/stage_type" date_period: "$ref": "#/components/schemas/resource_expense_report/properties/date_period" section_name: "$ref": "#/components/schemas/resource_expense_report/properties/section_name" total_amount: "$ref": "#/components/schemas/resource_expense_report/properties/total_amount" total_profit: "$ref": "#/components/schemas/resource_expense_report/properties/total_profit" custom_fields: "$ref": "#/components/schemas/resource_expense_report/properties/custom_fields" pay_on_period: "$ref": "#/components/schemas/resource_expense_report/properties/pay_on_period" reimbursement: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursement" formula_fields: "$ref": "#/components/schemas/resource_expense_report/properties/formula_fields" paid_on_period: "$ref": "#/components/schemas/resource_expense_report/properties/paid_on_period" approval_status: "$ref": "#/components/schemas/resource_expense_report/properties/approval_status" currency_default: "$ref": "#/components/schemas/resource_expense_report/properties/currency_default" invoicing_status: "$ref": "#/components/schemas/resource_expense_report/properties/invoicing_status" total_tax_amount: "$ref": "#/components/schemas/resource_expense_report/properties/total_tax_amount" created_at_period: "$ref": "#/components/schemas/resource_expense_report/properties/created_at_period" approved_at_period: "$ref": "#/components/schemas/resource_expense_report/properties/approved_at_period" currency_normalized: "$ref": "#/components/schemas/resource_expense_report/properties/currency_normalized" reimbursed_on_period: "$ref": "#/components/schemas/resource_expense_report/properties/reimbursed_on_period" total_amount_default: "$ref": "#/components/schemas/resource_expense_report/properties/total_amount_default" total_profit_default: "$ref": "#/components/schemas/resource_expense_report/properties/total_profit_default" average_profit_margin: "$ref": "#/components/schemas/resource_expense_report/properties/average_profit_margin" total_amount_with_tax: "$ref": "#/components/schemas/resource_expense_report/properties/total_amount_with_tax" total_billable_amount: "$ref": "#/components/schemas/resource_expense_report/properties/total_billable_amount" total_amount_normalized: "$ref": "#/components/schemas/resource_expense_report/properties/total_amount_normalized" total_profit_normalized: "$ref": "#/components/schemas/resource_expense_report/properties/total_profit_normalized" total_recognized_revenue: "$ref": "#/components/schemas/resource_expense_report/properties/total_recognized_revenue" total_tax_amount_default: "$ref": "#/components/schemas/resource_expense_report/properties/total_tax_amount_default" total_tax_amount_normalized: "$ref": "#/components/schemas/resource_expense_report/properties/total_tax_amount_normalized" average_profit_margin_default: "$ref": "#/components/schemas/resource_expense_report/properties/average_profit_margin_default" total_amount_with_tax_default: "$ref": "#/components/schemas/resource_expense_report/properties/total_amount_with_tax_default" total_billable_amount_default: "$ref": "#/components/schemas/resource_expense_report/properties/total_billable_amount_default" average_profit_margin_normalized: "$ref": "#/components/schemas/resource_expense_report/properties/average_profit_margin_normalized" total_amount_with_tax_normalized: "$ref": "#/components/schemas/resource_expense_report/properties/total_amount_with_tax_normalized" total_billable_amount_normalized: "$ref": "#/components/schemas/resource_expense_report/properties/total_billable_amount_normalized" total_recognized_revenue_default: "$ref": "#/components/schemas/resource_expense_report/properties/total_recognized_revenue_default" total_recognized_revenue_normalized: "$ref": "#/components/schemas/resource_expense_report/properties/total_recognized_revenue_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" vendor: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" expense: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" approver: "$ref": "#/components/schemas/_single_relationship" tax_rate: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" person_report: "$ref": "#/components/schemas/_single_relationship" vendor_report: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" project_report: "$ref": "#/components/schemas/_single_relationship" purchase_order: "$ref": "#/components/schemas/_single_relationship" designated_approver: "$ref": "#/components/schemas/_single_relationship" deal_or_budget_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection expense report single_custom_domain: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_custom_domain/properties/name" mailgun_mx: "$ref": "#/components/schemas/resource_custom_domain/properties/mailgun_mx" mailgun_spf: "$ref": "#/components/schemas/resource_custom_domain/properties/mailgun_spf" verified_at: "$ref": "#/components/schemas/resource_custom_domain/properties/verified_at" mailgun_dkim: "$ref": "#/components/schemas/resource_custom_domain/properties/mailgun_dkim" allow_user_email: "$ref": "#/components/schemas/resource_custom_domain/properties/allow_user_email" email_sender_name: "$ref": "#/components/schemas/resource_custom_domain/properties/email_sender_name" email_sender_address: "$ref": "#/components/schemas/resource_custom_domain/properties/email_sender_address" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" subsidiaries: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single custom domain single_survey_response: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: created_at: "$ref": "#/components/schemas/resource_survey_response/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_survey_response/properties/updated_at" survey_fields: "$ref": "#/components/schemas/resource_survey_response/properties/survey_fields" relationships: type: object properties: survey: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single survey response collection_project_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: week: "$ref": "#/components/schemas/resource_project_report/properties/week" year: "$ref": "#/components/schemas/resource_project_report/properties/year" count: "$ref": "#/components/schemas/resource_project_report/properties/count" group: "$ref": "#/components/schemas/resource_project_report/properties/group" month: "$ref": "#/components/schemas/resource_project_report/properties/month" quarter: "$ref": "#/components/schemas/resource_project_report/properties/quarter" currency: "$ref": "#/components/schemas/resource_project_report/properties/currency" total_cost: "$ref": "#/components/schemas/resource_project_report/properties/total_cost" project_type: "$ref": "#/components/schemas/resource_project_report/properties/project_type" total_profit: "$ref": "#/components/schemas/resource_project_report/properties/total_profit" custom_fields: "$ref": "#/components/schemas/resource_project_report/properties/custom_fields" total_revenue: "$ref": "#/components/schemas/resource_project_report/properties/total_revenue" formula_fields: "$ref": "#/components/schemas/resource_project_report/properties/formula_fields" project_status: "$ref": "#/components/schemas/resource_project_report/properties/project_status" currency_default: "$ref": "#/components/schemas/resource_project_report/properties/currency_default" created_at_period: "$ref": "#/components/schemas/resource_project_report/properties/created_at_period" total_worked_time: "$ref": "#/components/schemas/resource_project_report/properties/total_worked_time" total_cost_default: "$ref": "#/components/schemas/resource_project_report/properties/total_cost_default" currency_normalized: "$ref": "#/components/schemas/resource_project_report/properties/currency_normalized" total_estimated_time: "$ref": "#/components/schemas/resource_project_report/properties/total_estimated_time" total_profit_default: "$ref": "#/components/schemas/resource_project_report/properties/total_profit_default" average_profit_margin: "$ref": "#/components/schemas/resource_project_report/properties/average_profit_margin" total_cost_normalized: "$ref": "#/components/schemas/resource_project_report/properties/total_cost_normalized" total_needs_invoicing: "$ref": "#/components/schemas/resource_project_report/properties/total_needs_invoicing" total_revenue_default: "$ref": "#/components/schemas/resource_project_report/properties/total_revenue_default" last_activity_at_period: "$ref": "#/components/schemas/resource_project_report/properties/last_activity_at_period" total_pending_invoicing: "$ref": "#/components/schemas/resource_project_report/properties/total_pending_invoicing" total_profit_normalized: "$ref": "#/components/schemas/resource_project_report/properties/total_profit_normalized" total_projected_revenue: "$ref": "#/components/schemas/resource_project_report/properties/total_projected_revenue" total_revenue_normalized: "$ref": "#/components/schemas/resource_project_report/properties/total_revenue_normalized" average_profit_margin_default: "$ref": "#/components/schemas/resource_project_report/properties/average_profit_margin_default" total_needs_invoicing_default: "$ref": "#/components/schemas/resource_project_report/properties/total_needs_invoicing_default" total_pending_invoicing_default: "$ref": "#/components/schemas/resource_project_report/properties/total_pending_invoicing_default" total_projected_revenue_default: "$ref": "#/components/schemas/resource_project_report/properties/total_projected_revenue_default" average_profit_margin_normalized: "$ref": "#/components/schemas/resource_project_report/properties/average_profit_margin_normalized" total_needs_invoicing_normalized: "$ref": "#/components/schemas/resource_project_report/properties/total_needs_invoicing_normalized" total_pending_invoicing_normalized: "$ref": "#/components/schemas/resource_project_report/properties/total_pending_invoicing_normalized" total_projected_revenue_normalized: "$ref": "#/components/schemas/resource_project_report/properties/total_projected_revenue_normalized" relationships: type: object properties: report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" project_manager: "$ref": "#/components/schemas/_single_relationship" project_manager_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection project report collection_organization: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_organization/properties/name" flags: "$ref": "#/components/schemas/resource_organization/properties/flags" addons: "$ref": "#/components/schemas/resource_organization/properties/addons" locale: "$ref": "#/components/schemas/resource_organization/properties/locale" weight: "$ref": "#/components/schemas/resource_organization/properties/weight" metrics: "$ref": "#/components/schemas/resource_organization/properties/metrics" currency: "$ref": "#/components/schemas/resource_organization/properties/currency" due_days: "$ref": "#/components/schemas/resource_organization/properties/due_days" overhead: "$ref": "#/components/schemas/resource_organization/properties/overhead" email_key: "$ref": "#/components/schemas/resource_organization/properties/email_key" time_zone: "$ref": "#/components/schemas/resource_organization/properties/time_zone" ai_enabled: "$ref": "#/components/schemas/resource_organization/properties/ai_enabled" avatar_url: "$ref": "#/components/schemas/resource_organization/properties/avatar_url" erector_id: "$ref": "#/components/schemas/resource_organization/properties/erector_id" booked_demo: "$ref": "#/components/schemas/resource_organization/properties/booked_demo" verified_at: "$ref": "#/components/schemas/resource_organization/properties/verified_at" time_locking: "$ref": "#/components/schemas/resource_organization/properties/time_locking" analytics_uid: "$ref": "#/components/schemas/resource_organization/properties/analytics_uid" billing_email: "$ref": "#/components/schemas/resource_organization/properties/billing_email" deal_settings: "$ref": "#/components/schemas/resource_organization/properties/deal_settings" email_type_id: "$ref": "#/components/schemas/resource_organization/properties/email_type_id" working_hours: "$ref": "#/components/schemas/resource_organization/properties/working_hours" allow_time_off: "$ref": "#/components/schemas/resource_organization/properties/allow_time_off" date_format_id: "$ref": "#/components/schemas/resource_organization/properties/date_format_id" expense_markup: "$ref": "#/components/schemas/resource_organization/properties/expense_markup" facility_costs: "$ref": "#/components/schemas/resource_organization/properties/facility_costs" single_sign_on: "$ref": "#/components/schemas/resource_organization/properties/single_sign_on" time_format_id: "$ref": "#/components/schemas/resource_organization/properties/time_format_id" time_reminders: "$ref": "#/components/schemas/resource_organization/properties/time_reminders" domain_verified: "$ref": "#/components/schemas/resource_organization/properties/domain_verified" man_day_minutes: "$ref": "#/components/schemas/resource_organization/properties/man_day_minutes" remove_branding: "$ref": "#/components/schemas/resource_organization/properties/remove_branding" time_display_id: "$ref": "#/components/schemas/resource_organization/properties/time_display_id" allow_user_email: "$ref": "#/components/schemas/resource_organization/properties/allow_user_email" currency_default: "$ref": "#/components/schemas/resource_organization/properties/currency_default" email_local_name: "$ref": "#/components/schemas/resource_organization/properties/email_local_name" expense_settings: "$ref": "#/components/schemas/resource_organization/properties/expense_settings" financial_months: "$ref": "#/components/schemas/resource_organization/properties/financial_months" invitation_token: "$ref": "#/components/schemas/resource_organization/properties/invitation_token" number_format_id: "$ref": "#/components/schemas/resource_organization/properties/number_format_id" overhead_type_id: "$ref": "#/components/schemas/resource_organization/properties/overhead_type_id" self_attribution: "$ref": "#/components/schemas/resource_organization/properties/self_attribution" subsidiary_count: "$ref": "#/components/schemas/resource_organization/properties/subsidiary_count" time_reminder_at: "$ref": "#/components/schemas/resource_organization/properties/time_reminder_at" time_reminder_id: "$ref": "#/components/schemas/resource_organization/properties/time_reminder_id" decimal_places_id: "$ref": "#/components/schemas/resource_organization/properties/decimal_places_id" email_domain_name: "$ref": "#/components/schemas/resource_organization/properties/email_domain_name" email_sender_name: "$ref": "#/components/schemas/resource_organization/properties/email_sender_name" fiscal_year_start: "$ref": "#/components/schemas/resource_organization/properties/fiscal_year_start" scim_bearer_token: "$ref": "#/components/schemas/resource_organization/properties/scim_bearer_token" week_start_day_id: "$ref": "#/components/schemas/resource_organization/properties/week_start_day_id" currency_format_id: "$ref": "#/components/schemas/resource_organization/properties/currency_format_id" quick_start_config: "$ref": "#/components/schemas/resource_organization/properties/quick_start_config" rounding_method_id: "$ref": "#/components/schemas/resource_organization/properties/rounding_method_id" currency_normalized: "$ref": "#/components/schemas/resource_organization/properties/currency_normalized" onboarding_progress: "$ref": "#/components/schemas/resource_organization/properties/onboarding_progress" original_avatar_url: "$ref": "#/components/schemas/resource_organization/properties/original_avatar_url" force_single_sign_on: "$ref": "#/components/schemas/resource_organization/properties/force_single_sign_on" organization_type_id: "$ref": "#/components/schemas/resource_organization/properties/organization_type_id" rounding_interval_id: "$ref": "#/components/schemas/resource_organization/properties/rounding_interval_id" timesheet_submission: "$ref": "#/components/schemas/resource_organization/properties/timesheet_submission" force_two_factor_auth: "$ref": "#/components/schemas/resource_organization/properties/force_two_factor_auth" limited_service_types: "$ref": "#/components/schemas/resource_organization/properties/limited_service_types" time_locking_interval: "$ref": "#/components/schemas/resource_organization/properties/time_locking_interval" facility_costs_default: "$ref": "#/components/schemas/resource_organization/properties/facility_costs_default" time_locking_period_id: "$ref": "#/components/schemas/resource_organization/properties/time_locking_period_id" time_locking_reminders: "$ref": "#/components/schemas/resource_organization/properties/time_locking_reminders" verification_status_id: "$ref": "#/components/schemas/resource_organization/properties/verification_status_id" sample_data_imported_at: "$ref": "#/components/schemas/resource_organization/properties/sample_data_imported_at" sample_data_reverted_at: "$ref": "#/components/schemas/resource_organization/properties/sample_data_reverted_at" time_reminder_condition: "$ref": "#/components/schemas/resource_organization/properties/time_reminder_condition" time_tracking_policy_id: "$ref": "#/components/schemas/resource_organization/properties/time_tracking_policy_id" autotracking_schedule_id: "$ref": "#/components/schemas/resource_organization/properties/autotracking_schedule_id" conflict_resolver_active: "$ref": "#/components/schemas/resource_organization/properties/conflict_resolver_active" facility_costs_breakdown: "$ref": "#/components/schemas/resource_organization/properties/facility_costs_breakdown" self_attribution_comment: "$ref": "#/components/schemas/resource_organization/properties/self_attribution_comment" exchange_rate_provider_id: "$ref": "#/components/schemas/resource_organization/properties/exchange_rate_provider_id" facility_costs_normalized: "$ref": "#/components/schemas/resource_organization/properties/facility_costs_normalized" numbering_format_settings: "$ref": "#/components/schemas/resource_organization/properties/numbering_format_settings" invoice_rounding_method_id: "$ref": "#/components/schemas/resource_organization/properties/invoice_rounding_method_id" overhead_recalculation_day: "$ref": "#/components/schemas/resource_organization/properties/overhead_recalculation_day" revenue_recognition_type_id: "$ref": "#/components/schemas/resource_organization/properties/revenue_recognition_type_id" financial_month_locking_date: "$ref": "#/components/schemas/resource_organization/properties/financial_month_locking_date" overhead_amortization_period: "$ref": "#/components/schemas/resource_organization/properties/overhead_amortization_period" request_for_resource_enabled: "$ref": "#/components/schemas/resource_organization/properties/request_for_resource_enabled" timesheet_submission_settings: "$ref": "#/components/schemas/resource_organization/properties/timesheet_submission_settings" customer_success_specialist_id: "$ref": "#/components/schemas/resource_organization/properties/customer_success_specialist_id" time_tracking_policies_enabled: "$ref": "#/components/schemas/resource_organization/properties/time_tracking_policies_enabled" timesheet_submission_reminders: "$ref": "#/components/schemas/resource_organization/properties/timesheet_submission_reminders" open_budget_recognition_date_id: "$ref": "#/components/schemas/resource_organization/properties/open_budget_recognition_date_id" overhead_subsidiary_switched_at: "$ref": "#/components/schemas/resource_organization/properties/overhead_subsidiary_switched_at" delivered_budget_recognition_date_id: "$ref": "#/components/schemas/resource_organization/properties/delivered_budget_recognition_date_id" financial_month_locking_partial_edit: "$ref": "#/components/schemas/resource_organization/properties/financial_month_locking_partial_edit" invoice_timesheet_export_configuration: "$ref": "#/components/schemas/resource_organization/properties/invoice_timesheet_export_configuration" relationships: type: object properties: owner: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" organization_subscription: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection organization collection_time_entry_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: day: "$ref": "#/components/schemas/resource_time_entry_report/properties/day" week: "$ref": "#/components/schemas/resource_time_entry_report/properties/week" year: "$ref": "#/components/schemas/resource_time_entry_report/properties/year" count: "$ref": "#/components/schemas/resource_time_entry_report/properties/count" group: "$ref": "#/components/schemas/resource_time_entry_report/properties/group" month: "$ref": "#/components/schemas/resource_time_entry_report/properties/month" status: "$ref": "#/components/schemas/resource_time_entry_report/properties/status" quarter: "$ref": "#/components/schemas/resource_time_entry_report/properties/quarter" unit_id: "$ref": "#/components/schemas/resource_time_entry_report/properties/unit_id" currency: "$ref": "#/components/schemas/resource_time_entry_report/properties/currency" ended_at: "$ref": "#/components/schemas/resource_time_entry_report/properties/ended_at" invoiced: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoiced" overhead: "$ref": "#/components/schemas/resource_time_entry_report/properties/overhead" stage_type: "$ref": "#/components/schemas/resource_time_entry_report/properties/stage_type" started_at: "$ref": "#/components/schemas/resource_time_entry_report/properties/started_at" total_cost: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_cost" total_time: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_time" autotracked: "$ref": "#/components/schemas/resource_time_entry_report/properties/autotracked" date_period: "$ref": "#/components/schemas/resource_time_entry_report/properties/date_period" billing_type: "$ref": "#/components/schemas/resource_time_entry_report/properties/billing_type" section_name: "$ref": "#/components/schemas/resource_time_entry_report/properties/section_name" custom_fields: "$ref": "#/components/schemas/resource_time_entry_report/properties/custom_fields" jira_issue_id: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_id" formula_fields: "$ref": "#/components/schemas/resource_time_entry_report/properties/formula_fields" project_type_id: "$ref": "#/components/schemas/resource_time_entry_report/properties/project_type_id" total_work_cost: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_work_cost" track_method_id: "$ref": "#/components/schemas/resource_time_entry_report/properties/track_method_id" currency_default: "$ref": "#/components/schemas/resource_time_entry_report/properties/currency_default" invoicing_status: "$ref": "#/components/schemas/resource_time_entry_report/properties/invoicing_status" created_at_period: "$ref": "#/components/schemas/resource_time_entry_report/properties/created_at_period" jira_issue_status: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_status" intercompany_hours: "$ref": "#/components/schemas/resource_time_entry_report/properties/intercompany_hours" jira_issue_summary: "$ref": "#/components/schemas/resource_time_entry_report/properties/jira_issue_summary" total_cost_default: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_cost_default" currency_normalized: "$ref": "#/components/schemas/resource_time_entry_report/properties/currency_normalized" total_billable_time: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_billable_time" total_overhead_cost: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_overhead_cost" average_blended_rate: "$ref": "#/components/schemas/resource_time_entry_report/properties/average_blended_rate" people_custom_fields: "$ref": "#/components/schemas/resource_time_entry_report/properties/people_custom_fields" total_cost_normalized: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_cost_normalized" total_recognized_time: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_recognized_time" total_billable_revenue: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_billable_revenue" last_activity_at_period: "$ref": "#/components/schemas/resource_time_entry_report/properties/last_activity_at_period" total_recognized_profit: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_recognized_profit" total_work_cost_default: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_work_cost_default" total_recognized_revenue: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_recognized_revenue" average_recognized_margin: "$ref": "#/components/schemas/resource_time_entry_report/properties/average_recognized_margin" total_work_cost_normalized: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_work_cost_normalized" total_overhead_cost_default: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_overhead_cost_default" average_blended_rate_default: "$ref": "#/components/schemas/resource_time_entry_report/properties/average_blended_rate_default" total_facility_overhead_cost: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_facility_overhead_cost" total_internal_overhead_cost: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_internal_overhead_cost" total_billable_revenue_default: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_billable_revenue_default" total_overhead_cost_normalized: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_overhead_cost_normalized" average_blended_rate_normalized: "$ref": "#/components/schemas/resource_time_entry_report/properties/average_blended_rate_normalized" total_recognized_profit_default: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_recognized_profit_default" total_recognized_revenue_default: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_recognized_revenue_default" total_billable_revenue_normalized: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_billable_revenue_normalized" total_recognized_profit_normalized: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_recognized_profit_normalized" total_recognized_revenue_normalized: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_recognized_revenue_normalized" total_facility_overhead_cost_default: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_facility_overhead_cost_default" total_internal_overhead_cost_default: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_internal_overhead_cost_default" total_facility_overhead_cost_normalized: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_facility_overhead_cost_normalized" total_internal_overhead_cost_normalized: "$ref": "#/components/schemas/resource_time_entry_report/properties/total_internal_overhead_cost_normalized" relationships: type: object properties: task: "$ref": "#/components/schemas/_single_relationship" budget: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" approver: "$ref": "#/components/schemas/_single_relationship" task_list: "$ref": "#/components/schemas/_single_relationship" last_actor: "$ref": "#/components/schemas/_single_relationship" time_entry: "$ref": "#/components/schemas/_single_relationship" responsible: "$ref": "#/components/schemas/_single_relationship" task_report: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" person_report: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" creator_report: "$ref": "#/components/schemas/_single_relationship" project_report: "$ref": "#/components/schemas/_single_relationship" service_report: "$ref": "#/components/schemas/_single_relationship" approval_policy: "$ref": "#/components/schemas/_single_relationship" approver_report: "$ref": "#/components/schemas/_single_relationship" deal_subsidiary: "$ref": "#/components/schemas/_single_relationship" last_actor_report: "$ref": "#/components/schemas/_single_relationship" person_subsidiary: "$ref": "#/components/schemas/_single_relationship" responsible_report: "$ref": "#/components/schemas/_single_relationship" designated_approver: "$ref": "#/components/schemas/_single_relationship" deal_or_budget_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection time entry report single_overhead: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: capacity: "$ref": "#/components/schemas/resource_overhead/properties/capacity" currency: "$ref": "#/components/schemas/resource_overhead/properties/currency" ended_on: "$ref": "#/components/schemas/resource_overhead/properties/ended_on" started_on: "$ref": "#/components/schemas/resource_overhead/properties/started_on" updated_at: "$ref": "#/components/schemas/resource_overhead/properties/updated_at" total_hours: "$ref": "#/components/schemas/resource_overhead/properties/total_hours" client_hours: "$ref": "#/components/schemas/resource_overhead/properties/client_hours" use_overhead: "$ref": "#/components/schemas/resource_overhead/properties/use_overhead" exchange_rate: "$ref": "#/components/schemas/resource_overhead/properties/exchange_rate" facility_costs: "$ref": "#/components/schemas/resource_overhead/properties/facility_costs" internal_hours: "$ref": "#/components/schemas/resource_overhead/properties/internal_hours" overhead_hours: "$ref": "#/components/schemas/resource_overhead/properties/overhead_hours" time_off_costs: "$ref": "#/components/schemas/resource_overhead/properties/time_off_costs" time_off_hours: "$ref": "#/components/schemas/resource_overhead/properties/time_off_hours" uses_averaging: "$ref": "#/components/schemas/resource_overhead/properties/uses_averaging" recalculated_at: "$ref": "#/components/schemas/resource_overhead/properties/recalculated_at" averaging_period: "$ref": "#/components/schemas/resource_overhead/properties/averaging_period" currency_default: "$ref": "#/components/schemas/resource_overhead/properties/currency_default" overhead_controls: "$ref": "#/components/schemas/resource_overhead/properties/overhead_controls" overtracked_costs: "$ref": "#/components/schemas/resource_overhead/properties/overtracked_costs" overtracked_hours: "$ref": "#/components/schemas/resource_overhead/properties/overtracked_hours" undertracked_costs: "$ref": "#/components/schemas/resource_overhead/properties/undertracked_costs" undertracked_hours: "$ref": "#/components/schemas/resource_overhead/properties/undertracked_hours" currency_normalized: "$ref": "#/components/schemas/resource_overhead/properties/currency_normalized" internal_work_costs: "$ref": "#/components/schemas/resource_overhead/properties/internal_work_costs" recalculating_status: "$ref": "#/components/schemas/resource_overhead/properties/recalculating_status" client_overhead_hours: "$ref": "#/components/schemas/resource_overhead/properties/client_overhead_hours" facility_cost_per_hour: "$ref": "#/components/schemas/resource_overhead/properties/facility_cost_per_hour" facility_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/facility_costs_default" internal_expense_costs: "$ref": "#/components/schemas/resource_overhead/properties/internal_expense_costs" time_off_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/time_off_costs_default" internal_overhead_hours: "$ref": "#/components/schemas/resource_overhead/properties/internal_overhead_hours" time_off_overhead_hours: "$ref": "#/components/schemas/resource_overhead/properties/time_off_overhead_hours" facility_costs_breakdown: "$ref": "#/components/schemas/resource_overhead/properties/facility_costs_breakdown" facility_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/facility_costs_normalized" overtracked_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/overtracked_costs_default" time_off_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/time_off_costs_normalized" new_internal_cost_per_hour: "$ref": "#/components/schemas/resource_overhead/properties/new_internal_cost_per_hour" undertracked_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/undertracked_costs_default" internal_work_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/internal_work_costs_default" internal_componentized_costs: "$ref": "#/components/schemas/resource_overhead/properties/internal_componentized_costs" overtracked_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/overtracked_costs_normalized" undertracked_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/undertracked_costs_normalized" facility_cost_per_hour_default: "$ref": "#/components/schemas/resource_overhead/properties/facility_cost_per_hour_default" internal_expense_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/internal_expense_costs_default" internal_work_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/internal_work_costs_normalized" facility_cost_per_hour_normalized: "$ref": "#/components/schemas/resource_overhead/properties/facility_cost_per_hour_normalized" internal_expense_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/internal_expense_costs_normalized" new_internal_cost_per_hour_default: "$ref": "#/components/schemas/resource_overhead/properties/new_internal_cost_per_hour_default" internal_componentized_costs_default: "$ref": "#/components/schemas/resource_overhead/properties/internal_componentized_costs_default" new_internal_cost_per_hour_normalized: "$ref": "#/components/schemas/resource_overhead/properties/new_internal_cost_per_hour_normalized" internal_componentized_costs_normalized: "$ref": "#/components/schemas/resource_overhead/properties/internal_componentized_costs_normalized" relationships: type: object properties: updater: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single overhead collection_payment_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: week: "$ref": "#/components/schemas/resource_payment_report/properties/week" year: "$ref": "#/components/schemas/resource_payment_report/properties/year" count: "$ref": "#/components/schemas/resource_payment_report/properties/count" group: "$ref": "#/components/schemas/resource_payment_report/properties/group" month: "$ref": "#/components/schemas/resource_payment_report/properties/month" quarter: "$ref": "#/components/schemas/resource_payment_report/properties/quarter" currency: "$ref": "#/components/schemas/resource_payment_report/properties/currency" date_period: "$ref": "#/components/schemas/resource_payment_report/properties/date_period" total_amount: "$ref": "#/components/schemas/resource_payment_report/properties/total_amount" formula_fields: "$ref": "#/components/schemas/resource_payment_report/properties/formula_fields" currency_default: "$ref": "#/components/schemas/resource_payment_report/properties/currency_default" currency_normalized: "$ref": "#/components/schemas/resource_payment_report/properties/currency_normalized" total_amount_default: "$ref": "#/components/schemas/resource_payment_report/properties/total_amount_default" total_amount_normalized: "$ref": "#/components/schemas/resource_payment_report/properties/total_amount_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" payment: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" invoice_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection payment report single_email: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: body: "$ref": "#/components/schemas/resource_email/properties/body" from: "$ref": "#/components/schemas/resource_email/properties/from" unread: "$ref": "#/components/schemas/resource_email/properties/unread" snippet: "$ref": "#/components/schemas/resource_email/properties/snippet" subject: "$ref": "#/components/schemas/resource_email/properties/subject" outgoing: "$ref": "#/components/schemas/resource_email/properties/outgoing" body_html: "$ref": "#/components/schemas/resource_email/properties/body_html" failed_at: "$ref": "#/components/schemas/resource_email/properties/failed_at" linked_id: "$ref": "#/components/schemas/resource_email/properties/linked_id" created_at: "$ref": "#/components/schemas/resource_email/properties/created_at" recipients: "$ref": "#/components/schemas/resource_email/properties/recipients" auto_linked: "$ref": "#/components/schemas/resource_email/properties/auto_linked" external_id: "$ref": "#/components/schemas/resource_email/properties/external_id" linked_type: "$ref": "#/components/schemas/resource_email/properties/linked_type" received_at: "$ref": "#/components/schemas/resource_email/properties/received_at" delivered_at: "$ref": "#/components/schemas/resource_email/properties/delivered_at" dismissed_at: "$ref": "#/components/schemas/resource_email/properties/dismissed_at" participants: "$ref": "#/components/schemas/resource_email/properties/participants" body_truncated: "$ref": "#/components/schemas/resource_email/properties/body_truncated" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" thread: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" recipients: "$ref": "#/components/schemas/_collection_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" integration: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" participants: "$ref": "#/components/schemas/_collection_relationship" cc_recipients: "$ref": "#/components/schemas/_collection_relationship" to_recipients: "$ref": "#/components/schemas/_collection_relationship" bcc_recipients: "$ref": "#/components/schemas/_collection_relationship" payment_reminder: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single email single_line_item: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: amount: "$ref": "#/components/schemas/resource_line_item/properties/amount" unit_id: "$ref": "#/components/schemas/resource_line_item/properties/unit_id" currency: "$ref": "#/components/schemas/resource_line_item/properties/currency" discount: "$ref": "#/components/schemas/resource_line_item/properties/discount" position: "$ref": "#/components/schemas/resource_line_item/properties/position" quantity: "$ref": "#/components/schemas/resource_line_item/properties/quantity" tax_name: "$ref": "#/components/schemas/resource_line_item/properties/tax_name" tax_value: "$ref": "#/components/schemas/resource_line_item/properties/tax_value" amount_tax: "$ref": "#/components/schemas/resource_line_item/properties/amount_tax" unit_price: "$ref": "#/components/schemas/resource_line_item/properties/unit_price" amount_default: "$ref": "#/components/schemas/resource_line_item/properties/amount_default" amount_with_tax: "$ref": "#/components/schemas/resource_line_item/properties/amount_with_tax" currency_default: "$ref": "#/components/schemas/resource_line_item/properties/currency_default" amount_normalized: "$ref": "#/components/schemas/resource_line_item/properties/amount_normalized" amount_tax_default: "$ref": "#/components/schemas/resource_line_item/properties/amount_tax_default" unit_price_default: "$ref": "#/components/schemas/resource_line_item/properties/unit_price_default" currency_normalized: "$ref": "#/components/schemas/resource_line_item/properties/currency_normalized" amount_tax_normalized: "$ref": "#/components/schemas/resource_line_item/properties/amount_tax_normalized" unit_price_normalized: "$ref": "#/components/schemas/resource_line_item/properties/unit_price_normalized" amount_with_tax_default: "$ref": "#/components/schemas/resource_line_item/properties/amount_with_tax_default" amount_with_tax_normalized: "$ref": "#/components/schemas/resource_line_item/properties/amount_with_tax_normalized" relationships: type: object properties: expense: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" kpd_code: "$ref": "#/components/schemas/_single_relationship" tax_rate: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single line item single_folder: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_folder/properties/name" hidden: "$ref": "#/components/schemas/resource_folder/properties/hidden" position: "$ref": "#/components/schemas/resource_folder/properties/position" placement: "$ref": "#/components/schemas/resource_folder/properties/placement" archived_at: "$ref": "#/components/schemas/resource_folder/properties/archived_at" relationships: type: object properties: project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: A single folder resource response. collection_exchange_rate: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_exchange_rate/properties/date" rates: "$ref": "#/components/schemas/resource_exchange_rate/properties/rates" out_of_date: "$ref": "#/components/schemas/resource_exchange_rate/properties/out_of_date" relationships: type: object properties: {} meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection exchange rate collection_resource_request: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_resource_request/properties/note" time: "$ref": "#/components/schemas/resource_resource_request/properties/time" title: "$ref": "#/components/schemas/resource_resource_request/properties/title" fields: "$ref": "#/components/schemas/resource_resource_request/properties/fields" status: "$ref": "#/components/schemas/resource_resource_request/properties/status" currency: "$ref": "#/components/schemas/resource_resource_request/properties/currency" ended_on: "$ref": "#/components/schemas/resource_resource_request/properties/ended_on" created_at: "$ref": "#/components/schemas/resource_resource_request/properties/created_at" percentage: "$ref": "#/components/schemas/resource_resource_request/properties/percentage" started_on: "$ref": "#/components/schemas/resource_resource_request/properties/started_on" total_time: "$ref": "#/components/schemas/resource_resource_request/properties/total_time" canceled_at: "$ref": "#/components/schemas/resource_resource_request/properties/canceled_at" resolved_at: "$ref": "#/components/schemas/resource_resource_request/properties/resolved_at" custom_fields: "$ref": "#/components/schemas/resource_resource_request/properties/custom_fields" exchange_date: "$ref": "#/components/schemas/resource_resource_request/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_resource_request/properties/exchange_rate" time_to_close: "$ref": "#/components/schemas/resource_resource_request/properties/time_to_close" rejected_reason: "$ref": "#/components/schemas/resource_resource_request/properties/rejected_reason" currency_default: "$ref": "#/components/schemas/resource_resource_request/properties/currency_default" booking_method_id: "$ref": "#/components/schemas/resource_resource_request/properties/booking_method_id" max_cost_per_hour: "$ref": "#/components/schemas/resource_resource_request/properties/max_cost_per_hour" currency_normalized: "$ref": "#/components/schemas/resource_resource_request/properties/currency_normalized" exchange_rate_normalized: "$ref": "#/components/schemas/resource_resource_request/properties/exchange_rate_normalized" max_cost_per_hour_default: "$ref": "#/components/schemas/resource_resource_request/properties/max_cost_per_hour_default" max_cost_per_hour_normalized: "$ref": "#/components/schemas/resource_resource_request/properties/max_cost_per_hour_normalized" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" resolver: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: A paginated collection of resource requests. collection_email: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: body: "$ref": "#/components/schemas/resource_email/properties/body" from: "$ref": "#/components/schemas/resource_email/properties/from" unread: "$ref": "#/components/schemas/resource_email/properties/unread" snippet: "$ref": "#/components/schemas/resource_email/properties/snippet" subject: "$ref": "#/components/schemas/resource_email/properties/subject" outgoing: "$ref": "#/components/schemas/resource_email/properties/outgoing" body_html: "$ref": "#/components/schemas/resource_email/properties/body_html" failed_at: "$ref": "#/components/schemas/resource_email/properties/failed_at" linked_id: "$ref": "#/components/schemas/resource_email/properties/linked_id" created_at: "$ref": "#/components/schemas/resource_email/properties/created_at" recipients: "$ref": "#/components/schemas/resource_email/properties/recipients" auto_linked: "$ref": "#/components/schemas/resource_email/properties/auto_linked" external_id: "$ref": "#/components/schemas/resource_email/properties/external_id" linked_type: "$ref": "#/components/schemas/resource_email/properties/linked_type" received_at: "$ref": "#/components/schemas/resource_email/properties/received_at" delivered_at: "$ref": "#/components/schemas/resource_email/properties/delivered_at" dismissed_at: "$ref": "#/components/schemas/resource_email/properties/dismissed_at" participants: "$ref": "#/components/schemas/resource_email/properties/participants" body_truncated: "$ref": "#/components/schemas/resource_email/properties/body_truncated" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" thread: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" recipients: "$ref": "#/components/schemas/_collection_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" integration: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" participants: "$ref": "#/components/schemas/_collection_relationship" cc_recipients: "$ref": "#/components/schemas/_collection_relationship" to_recipients: "$ref": "#/components/schemas/_collection_relationship" bcc_recipients: "$ref": "#/components/schemas/_collection_relationship" payment_reminder: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection email collection_service_type_assignment: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: {} relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection service type assignment collection_attachment: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: url: "$ref": "#/components/schemas/resource_attachment/properties/url" name: "$ref": "#/components/schemas/resource_attachment/properties/name" size: "$ref": "#/components/schemas/resource_attachment/properties/size" thumb: "$ref": "#/components/schemas/resource_attachment/properties/thumb" resized: "$ref": "#/components/schemas/resource_attachment/properties/resized" temp_url: "$ref": "#/components/schemas/resource_attachment/properties/temp_url" created_at: "$ref": "#/components/schemas/resource_attachment/properties/created_at" deleted_at: "$ref": "#/components/schemas/resource_attachment/properties/deleted_at" message_id: "$ref": "#/components/schemas/resource_attachment/properties/message_id" external_id: "$ref": "#/components/schemas/resource_attachment/properties/external_id" content_type: "$ref": "#/components/schemas/resource_attachment/properties/content_type" attachable_type: "$ref": "#/components/schemas/resource_attachment/properties/attachable_type" attachment_type: "$ref": "#/components/schemas/resource_attachment/properties/attachment_type" relationships: type: object properties: bill: "$ref": "#/components/schemas/_single_relationship" deal: "$ref": "#/components/schemas/_single_relationship" page: "$ref": "#/components/schemas/_single_relationship" task: "$ref": "#/components/schemas/_single_relationship" email: "$ref": "#/components/schemas/_single_relationship" comment: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" expense: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_type: "$ref": "#/components/schemas/_single_relationship" document_style: "$ref": "#/components/schemas/_single_relationship" purchase_order: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection attachment single_price: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_price/properties/name" rate: "$ref": "#/components/schemas/resource_price/properties/rate" markup: "$ref": "#/components/schemas/resource_price/properties/markup" unit_id: "$ref": "#/components/schemas/resource_price/properties/unit_id" currency: "$ref": "#/components/schemas/resource_price/properties/currency" discount: "$ref": "#/components/schemas/resource_price/properties/discount" quantity: "$ref": "#/components/schemas/resource_price/properties/quantity" updated_at: "$ref": "#/components/schemas/resource_price/properties/updated_at" rate_default: "$ref": "#/components/schemas/resource_price/properties/rate_default" custom_fields: "$ref": "#/components/schemas/resource_price/properties/custom_fields" editor_config: "$ref": "#/components/schemas/resource_price/properties/editor_config" estimated_cost: "$ref": "#/components/schemas/resource_price/properties/estimated_cost" billing_type_id: "$ref": "#/components/schemas/resource_price/properties/billing_type_id" estimated_hours: "$ref": "#/components/schemas/resource_price/properties/estimated_hours" rate_normalized: "$ref": "#/components/schemas/resource_price/properties/rate_normalized" currency_default: "$ref": "#/components/schemas/resource_price/properties/currency_default" budget_cap_enabled: "$ref": "#/components/schemas/resource_price/properties/budget_cap_enabled" currency_normalized: "$ref": "#/components/schemas/resource_price/properties/currency_normalized" time_tracking_enabled: "$ref": "#/components/schemas/resource_price/properties/time_tracking_enabled" estimated_cost_default: "$ref": "#/components/schemas/resource_price/properties/estimated_cost_default" booking_tracking_enabled: "$ref": "#/components/schemas/resource_price/properties/booking_tracking_enabled" expense_tracking_enabled: "$ref": "#/components/schemas/resource_price/properties/expense_tracking_enabled" estimated_cost_normalized: "$ref": "#/components/schemas/resource_price/properties/estimated_cost_normalized" relationships: type: object properties: company: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" rate_card: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single price single_invoice: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_invoice/properties/note" amount: "$ref": "#/components/schemas/resource_invoice/properties/amount" footer: "$ref": "#/components/schemas/resource_invoice/properties/footer" number: "$ref": "#/components/schemas/resource_invoice/properties/number" pay_on: "$ref": "#/components/schemas/resource_invoice/properties/pay_on" paid_on: "$ref": "#/components/schemas/resource_invoice/properties/paid_on" sent_on: "$ref": "#/components/schemas/resource_invoice/properties/sent_on" subject: "$ref": "#/components/schemas/resource_invoice/properties/subject" credited: "$ref": "#/components/schemas/resource_invoice/properties/credited" currency: "$ref": "#/components/schemas/resource_invoice/properties/currency" discount: "$ref": "#/components/schemas/resource_invoice/properties/discount" exported: "$ref": "#/components/schemas/resource_invoice/properties/exported" tag_list: "$ref": "#/components/schemas/resource_invoice/properties/tag_list" email_key: "$ref": "#/components/schemas/resource_invoice/properties/email_key" export_id: "$ref": "#/components/schemas/resource_invoice/properties/export_id" tax1_name: "$ref": "#/components/schemas/resource_invoice/properties/tax1_name" tax2_name: "$ref": "#/components/schemas/resource_invoice/properties/tax2_name" amount_tax: "$ref": "#/components/schemas/resource_invoice/properties/amount_tax" created_at: "$ref": "#/components/schemas/resource_invoice/properties/created_at" deleted_at: "$ref": "#/components/schemas/resource_invoice/properties/deleted_at" tax1_value: "$ref": "#/components/schemas/resource_invoice/properties/tax1_value" tax2_value: "$ref": "#/components/schemas/resource_invoice/properties/tax2_value" updated_at: "$ref": "#/components/schemas/resource_invoice/properties/updated_at" amount_paid: "$ref": "#/components/schemas/resource_invoice/properties/amount_paid" delivery_on: "$ref": "#/components/schemas/resource_invoice/properties/delivery_on" exported_at: "$ref": "#/components/schemas/resource_invoice/properties/exported_at" invoiced_on: "$ref": "#/components/schemas/resource_invoice/properties/invoiced_on" sample_data: "$ref": "#/components/schemas/resource_invoice/properties/sample_data" finalized_at: "$ref": "#/components/schemas/resource_invoice/properties/finalized_at" finalized_on: "$ref": "#/components/schemas/resource_invoice/properties/finalized_on" amount_unpaid: "$ref": "#/components/schemas/resource_invoice/properties/amount_unpaid" custom_fields: "$ref": "#/components/schemas/resource_invoice/properties/custom_fields" exchange_date: "$ref": "#/components/schemas/resource_invoice/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_invoice/properties/exchange_rate" line_item_tax: "$ref": "#/components/schemas/resource_invoice/properties/line_item_tax" payment_terms: "$ref": "#/components/schemas/resource_invoice/properties/payment_terms" amount_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_default" amount_credited: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited" amount_with_tax: "$ref": "#/components/schemas/resource_invoice/properties/amount_with_tax" invoice_type_id: "$ref": "#/components/schemas/resource_invoice/properties/invoice_type_id" pay_on_relative: "$ref": "#/components/schemas/resource_invoice/properties/pay_on_relative" creation_options: "$ref": "#/components/schemas/resource_invoice/properties/creation_options" currency_default: "$ref": "#/components/schemas/resource_invoice/properties/currency_default" last_activity_at: "$ref": "#/components/schemas/resource_invoice/properties/last_activity_at" amount_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_normalized" note_interpolated: "$ref": "#/components/schemas/resource_invoice/properties/note_interpolated" amount_tax_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_tax_default" amount_written_off: "$ref": "#/components/schemas/resource_invoice/properties/amount_written_off" export_invoice_url: "$ref": "#/components/schemas/resource_invoice/properties/export_invoice_url" amount_paid_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_paid_default" currency_normalized: "$ref": "#/components/schemas/resource_invoice/properties/currency_normalized" footer_interpolated: "$ref": "#/components/schemas/resource_invoice/properties/footer_interpolated" invoice_template_id: "$ref": "#/components/schemas/resource_invoice/properties/invoice_template_id" bank_account_details: "$ref": "#/components/schemas/resource_invoice/properties/bank_account_details" company_reference_id: "$ref": "#/components/schemas/resource_invoice/properties/company_reference_id" amount_tax_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_tax_normalized" amount_unpaid_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_unpaid_default" purchase_order_number: "$ref": "#/components/schemas/resource_invoice/properties/purchase_order_number" amount_paid_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_paid_normalized" amount_credited_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_default" amount_with_tax_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_with_tax_default" amount_credited_with_tax: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_with_tax" amount_unpaid_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_unpaid_normalized" amount_credited_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_normalized" amount_with_tax_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_with_tax_normalized" amount_written_off_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_written_off_default" export_integration_type_id: "$ref": "#/components/schemas/resource_invoice/properties/export_integration_type_id" amount_written_off_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_written_off_normalized" amount_credited_with_tax_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_with_tax_default" amount_credited_with_tax_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_with_tax_normalized" relationships: type: object properties: issuer: "$ref": "#/components/schemas/_single_relationship" bill_to: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" bill_from: "$ref": "#/components/schemas/_single_relationship" attachment: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" bank_account: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_type: "$ref": "#/components/schemas/_single_relationship" parent_invoice: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" invoice_attributions: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single invoice single_automatic_invoicing_rule: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: skip_weekends: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/skip_weekends" reference_date: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/reference_date" creation_offset: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/creation_offset" next_invoice_date: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/next_invoice_date" creation_offset_unit: "$ref": "#/components/schemas/resource_automatic_invoicing_rule/properties/creation_offset_unit" relationships: type: object properties: budget: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single automatic invoicing rule single_survey_field_option: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_survey_field_option/properties/name" color_id: "$ref": "#/components/schemas/resource_survey_field_option/properties/color_id" position: "$ref": "#/components/schemas/resource_survey_field_option/properties/position" archived_at: "$ref": "#/components/schemas/resource_survey_field_option/properties/archived_at" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" survey_field: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single survey field option collection_timesheet_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: week: "$ref": "#/components/schemas/resource_timesheet_report/properties/week" count: "$ref": "#/components/schemas/resource_timesheet_report/properties/count" group: "$ref": "#/components/schemas/resource_timesheet_report/properties/group" currency: "$ref": "#/components/schemas/resource_timesheet_report/properties/currency" friday_time: "$ref": "#/components/schemas/resource_timesheet_report/properties/friday_time" monday_time: "$ref": "#/components/schemas/resource_timesheet_report/properties/monday_time" sunday_time: "$ref": "#/components/schemas/resource_timesheet_report/properties/sunday_time" tuesday_time: "$ref": "#/components/schemas/resource_timesheet_report/properties/tuesday_time" saturday_time: "$ref": "#/components/schemas/resource_timesheet_report/properties/saturday_time" thursday_time: "$ref": "#/components/schemas/resource_timesheet_report/properties/thursday_time" formula_fields: "$ref": "#/components/schemas/resource_timesheet_report/properties/formula_fields" wednesday_time: "$ref": "#/components/schemas/resource_timesheet_report/properties/wednesday_time" friday_capacity: "$ref": "#/components/schemas/resource_timesheet_report/properties/friday_capacity" monday_capacity: "$ref": "#/components/schemas/resource_timesheet_report/properties/monday_capacity" sunday_capacity: "$ref": "#/components/schemas/resource_timesheet_report/properties/sunday_capacity" currency_default: "$ref": "#/components/schemas/resource_timesheet_report/properties/currency_default" friday_available: "$ref": "#/components/schemas/resource_timesheet_report/properties/friday_available" monday_available: "$ref": "#/components/schemas/resource_timesheet_report/properties/monday_available" sunday_available: "$ref": "#/components/schemas/resource_timesheet_report/properties/sunday_available" tuesday_capacity: "$ref": "#/components/schemas/resource_timesheet_report/properties/tuesday_capacity" saturday_capacity: "$ref": "#/components/schemas/resource_timesheet_report/properties/saturday_capacity" thursday_capacity: "$ref": "#/components/schemas/resource_timesheet_report/properties/thursday_capacity" tuesday_available: "$ref": "#/components/schemas/resource_timesheet_report/properties/tuesday_available" saturday_available: "$ref": "#/components/schemas/resource_timesheet_report/properties/saturday_available" thursday_available: "$ref": "#/components/schemas/resource_timesheet_report/properties/thursday_available" wednesday_capacity: "$ref": "#/components/schemas/resource_timesheet_report/properties/wednesday_capacity" currency_normalized: "$ref": "#/components/schemas/resource_timesheet_report/properties/currency_normalized" wednesday_available: "$ref": "#/components/schemas/resource_timesheet_report/properties/wednesday_available" week_submission_status: "$ref": "#/components/schemas/resource_timesheet_report/properties/week_submission_status" relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection timesheet report collection_notification: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: read: "$ref": "#/components/schemas/resource_notification/properties/read" title: "$ref": "#/components/schemas/resource_notification/properties/title" excerpt: "$ref": "#/components/schemas/resource_notification/properties/excerpt" mention: "$ref": "#/components/schemas/resource_notification/properties/mention" root_id: "$ref": "#/components/schemas/resource_notification/properties/root_id" changeset: "$ref": "#/components/schemas/resource_notification/properties/changeset" dismissed: "$ref": "#/components/schemas/resource_notification/properties/dismissed" important: "$ref": "#/components/schemas/resource_notification/properties/important" parent_id: "$ref": "#/components/schemas/resource_notification/properties/parent_id" root_type: "$ref": "#/components/schemas/resource_notification/properties/root_type" target_id: "$ref": "#/components/schemas/resource_notification/properties/target_id" parent_type: "$ref": "#/components/schemas/resource_notification/properties/parent_type" target_type: "$ref": "#/components/schemas/resource_notification/properties/target_type" parent_title: "$ref": "#/components/schemas/resource_notification/properties/parent_title" target_label: "$ref": "#/components/schemas/resource_notification/properties/target_label" target_title: "$ref": "#/components/schemas/resource_notification/properties/target_title" last_action_at: "$ref": "#/components/schemas/resource_notification/properties/last_action_at" made_by_automation: "$ref": "#/components/schemas/resource_notification/properties/made_by_automation" new_activities_count: "$ref": "#/components/schemas/resource_notification/properties/new_activities_count" first_unread_activity_id: "$ref": "#/components/schemas/resource_notification/properties/first_unread_activity_id" relationships: type: object properties: actor: "$ref": "#/components/schemas/_single_relationship" owner: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection notification collection_budget_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: week: "$ref": "#/components/schemas/resource_budget_report/properties/week" year: "$ref": "#/components/schemas/resource_budget_report/properties/year" count: "$ref": "#/components/schemas/resource_budget_report/properties/count" group: "$ref": "#/components/schemas/resource_budget_report/properties/group" month: "$ref": "#/components/schemas/resource_budget_report/properties/month" status: "$ref": "#/components/schemas/resource_budget_report/properties/status" quarter: "$ref": "#/components/schemas/resource_budget_report/properties/quarter" currency: "$ref": "#/components/schemas/resource_budget_report/properties/currency" deal_type: "$ref": "#/components/schemas/resource_budget_report/properties/deal_type" recurring: "$ref": "#/components/schemas/resource_budget_report/properties/recurring" total_cost: "$ref": "#/components/schemas/resource_budget_report/properties/total_cost" date_period: "$ref": "#/components/schemas/resource_budget_report/properties/date_period" project_type: "$ref": "#/components/schemas/resource_budget_report/properties/project_type" total_profit: "$ref": "#/components/schemas/resource_budget_report/properties/total_profit" custom_fields: "$ref": "#/components/schemas/resource_budget_report/properties/custom_fields" total_expense: "$ref": "#/components/schemas/resource_budget_report/properties/total_expense" total_revenue: "$ref": "#/components/schemas/resource_budget_report/properties/total_revenue" formula_fields: "$ref": "#/components/schemas/resource_budget_report/properties/formula_fields" total_credited: "$ref": "#/components/schemas/resource_budget_report/properties/total_credited" total_invoiced: "$ref": "#/components/schemas/resource_budget_report/properties/total_invoiced" end_date_period: "$ref": "#/components/schemas/resource_budget_report/properties/end_date_period" total_work_cost: "$ref": "#/components/schemas/resource_budget_report/properties/total_work_cost" closed_at_period: "$ref": "#/components/schemas/resource_budget_report/properties/closed_at_period" currency_default: "$ref": "#/components/schemas/resource_budget_report/properties/currency_default" tracking_type_id: "$ref": "#/components/schemas/resource_budget_report/properties/tracking_type_id" created_at_period: "$ref": "#/components/schemas/resource_budget_report/properties/created_at_period" total_budget_used: "$ref": "#/components/schemas/resource_budget_report/properties/total_budget_used" total_future_cost: "$ref": "#/components/schemas/resource_budget_report/properties/total_future_cost" total_worked_time: "$ref": "#/components/schemas/resource_budget_report/properties/total_worked_time" total_budget_total: "$ref": "#/components/schemas/resource_budget_report/properties/total_budget_total" total_cost_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_cost_default" average_actual_rate: "$ref": "#/components/schemas/resource_budget_report/properties/average_actual_rate" currency_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/currency_normalized" delivered_on_period: "$ref": "#/components/schemas/resource_budget_report/properties/delivered_on_period" total_billable_time: "$ref": "#/components/schemas/resource_budget_report/properties/total_billable_time" total_budgeted_time: "$ref": "#/components/schemas/resource_budget_report/properties/total_budgeted_time" average_budget_usage: "$ref": "#/components/schemas/resource_budget_report/properties/average_budget_usage" total_draft_invoiced: "$ref": "#/components/schemas/resource_budget_report/properties/total_draft_invoiced" total_estimated_cost: "$ref": "#/components/schemas/resource_budget_report/properties/total_estimated_cost" total_estimated_time: "$ref": "#/components/schemas/resource_budget_report/properties/total_estimated_time" total_profit_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_profit_default" average_invoiced_rate: "$ref": "#/components/schemas/resource_budget_report/properties/average_invoiced_rate" average_profit_margin: "$ref": "#/components/schemas/resource_budget_report/properties/average_profit_margin" purchase_order_number: "$ref": "#/components/schemas/resource_budget_report/properties/purchase_order_number" recurring_interval_id: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_interval_id" total_cost_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_cost_normalized" total_expense_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_expense_default" total_forecasted_cost: "$ref": "#/components/schemas/resource_budget_report/properties/total_forecasted_cost" total_revenue_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_revenue_default" total_unapproved_time: "$ref": "#/components/schemas/resource_budget_report/properties/total_unapproved_time" total_budget_remaining: "$ref": "#/components/schemas/resource_budget_report/properties/total_budget_remaining" total_credited_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_credited_default" total_expense_billable: "$ref": "#/components/schemas/resource_budget_report/properties/total_expense_billable" total_invoiced_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_invoiced_default" total_services_revenue: "$ref": "#/components/schemas/resource_budget_report/properties/total_services_revenue" last_activity_at_period: "$ref": "#/components/schemas/resource_budget_report/properties/last_activity_at_period" total_manually_invoiced: "$ref": "#/components/schemas/resource_budget_report/properties/total_manually_invoiced" total_pending_invoicing: "$ref": "#/components/schemas/resource_budget_report/properties/total_pending_invoicing" total_profit_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_profit_normalized" total_work_cost_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_work_cost_default" recurring_ends_on_period: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_ends_on_period" total_expense_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_expense_normalized" total_future_booked_time: "$ref": "#/components/schemas/resource_budget_report/properties/total_future_booked_time" total_future_budget_used: "$ref": "#/components/schemas/resource_budget_report/properties/total_future_budget_used" total_revenue_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_revenue_normalized" next_occurrence_on_period: "$ref": "#/components/schemas/resource_budget_report/properties/next_occurrence_on_period" revenue_distribution_type: "$ref": "#/components/schemas/resource_budget_report/properties/revenue_distribution_type" total_budget_used_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_budget_used_default" total_credited_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_credited_normalized" total_future_cost_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_future_cost_default" total_invoiced_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_invoiced_normalized" recurring_starts_on_period: "$ref": "#/components/schemas/resource_budget_report/properties/recurring_starts_on_period" total_budget_total_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_budget_total_default" total_work_cost_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_work_cost_normalized" average_actual_rate_default: "$ref": "#/components/schemas/resource_budget_report/properties/average_actual_rate_default" average_invoiced_percentage: "$ref": "#/components/schemas/resource_budget_report/properties/average_invoiced_percentage" average_budget_usage_default: "$ref": "#/components/schemas/resource_budget_report/properties/average_budget_usage_default" total_budget_used_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_budget_used_normalized" total_draft_invoiced_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_draft_invoiced_default" total_estimated_cost_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_estimated_cost_default" total_forecasted_budget_used: "$ref": "#/components/schemas/resource_budget_report/properties/total_forecasted_budget_used" total_future_cost_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_future_cost_normalized" average_forecasted_time_usage: "$ref": "#/components/schemas/resource_budget_report/properties/average_forecasted_time_usage" average_invoiced_rate_default: "$ref": "#/components/schemas/resource_budget_report/properties/average_invoiced_rate_default" average_profit_margin_default: "$ref": "#/components/schemas/resource_budget_report/properties/average_profit_margin_default" total_budget_total_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_budget_total_normalized" total_forecasted_cost_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_forecasted_cost_default" average_actual_rate_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/average_actual_rate_normalized" total_budget_remaining_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_budget_remaining_default" total_estimated_remaining_time: "$ref": "#/components/schemas/resource_budget_report/properties/total_estimated_remaining_time" total_expense_billable_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_expense_billable_default" total_forecasted_billable_time: "$ref": "#/components/schemas/resource_budget_report/properties/total_forecasted_billable_time" total_services_revenue_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_services_revenue_default" average_budget_usage_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/average_budget_usage_normalized" average_forecasted_budget_usage: "$ref": "#/components/schemas/resource_budget_report/properties/average_forecasted_budget_usage" total_draft_invoiced_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_draft_invoiced_normalized" total_estimated_cost_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_estimated_cost_normalized" total_forecasted_budget_overrun: "$ref": "#/components/schemas/resource_budget_report/properties/total_forecasted_budget_overrun" total_manually_invoiced_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_manually_invoiced_default" total_pending_invoicing_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_pending_invoicing_default" average_invoiced_rate_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/average_invoiced_rate_normalized" average_profit_margin_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/average_profit_margin_normalized" total_forecasted_cost_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_forecasted_cost_normalized" total_future_budget_used_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_future_budget_used_default" average_forecasted_budget_overrun: "$ref": "#/components/schemas/resource_budget_report/properties/average_forecasted_budget_overrun" total_budget_remaining_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_budget_remaining_normalized" total_expense_billable_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_expense_billable_normalized" total_services_revenue_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_services_revenue_normalized" total_manually_invoiced_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_manually_invoiced_normalized" total_pending_invoicing_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_pending_invoicing_normalized" average_invoiced_percentage_default: "$ref": "#/components/schemas/resource_budget_report/properties/average_invoiced_percentage_default" total_future_budget_used_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_future_budget_used_normalized" total_forecasted_budget_used_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_forecasted_budget_used_default" average_invoiced_percentage_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/average_invoiced_percentage_normalized" average_forecasted_budget_usage_default: "$ref": "#/components/schemas/resource_budget_report/properties/average_forecasted_budget_usage_default" total_forecasted_budget_overrun_default: "$ref": "#/components/schemas/resource_budget_report/properties/total_forecasted_budget_overrun_default" total_forecasted_budget_used_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_forecasted_budget_used_normalized" average_forecasted_budget_overrun_default: "$ref": "#/components/schemas/resource_budget_report/properties/average_forecasted_budget_overrun_default" average_forecasted_budget_usage_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/average_forecasted_budget_usage_normalized" total_forecasted_budget_overrun_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/total_forecasted_budget_overrun_normalized" average_forecasted_budget_overrun_normalized: "$ref": "#/components/schemas/resource_budget_report/properties/average_forecasted_budget_overrun_normalized" relationships: type: object properties: budget: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" contract: "$ref": "#/components/schemas/_single_relationship" pipeline: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" deal_status: "$ref": "#/components/schemas/_single_relationship" origin_deal: "$ref": "#/components/schemas/_single_relationship" responsible: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" owner_report: "$ref": "#/components/schemas/_single_relationship" company_report: "$ref": "#/components/schemas/_single_relationship" project_report: "$ref": "#/components/schemas/_single_relationship" primary_contact: "$ref": "#/components/schemas/_single_relationship" origin_deal_report: "$ref": "#/components/schemas/_single_relationship" designated_approver: "$ref": "#/components/schemas/_single_relationship" primary_contact_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection budget report single_approval_policy_assignment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: target_type: "$ref": "#/components/schemas/resource_approval_policy_assignment/properties/target_type" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" approval_policy: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single approval policy assignment collection_timer: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: person_id: "$ref": "#/components/schemas/resource_timer/properties/person_id" started_at: "$ref": "#/components/schemas/resource_timer/properties/started_at" stopped_at: "$ref": "#/components/schemas/resource_timer/properties/stopped_at" total_time: "$ref": "#/components/schemas/resource_timer/properties/total_time" relationships: type: object properties: time_entry: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection timer collection_section: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_section/properties/name" position: "$ref": "#/components/schemas/resource_section/properties/position" preferences: "$ref": "#/components/schemas/resource_section/properties/preferences" editor_config: "$ref": "#/components/schemas/resource_section/properties/editor_config" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection section collection_company: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: vat: "$ref": "#/components/schemas/resource_company/properties/vat" name: "$ref": "#/components/schemas/resource_company/properties/name" domain: "$ref": "#/components/schemas/resource_company/properties/domain" contact: "$ref": "#/components/schemas/resource_company/properties/contact" due_days: "$ref": "#/components/schemas/resource_company/properties/due_days" settings: "$ref": "#/components/schemas/resource_company/properties/settings" tag_list: "$ref": "#/components/schemas/resource_company/properties/tag_list" avatar_url: "$ref": "#/components/schemas/resource_company/properties/avatar_url" created_at: "$ref": "#/components/schemas/resource_company/properties/created_at" archived_at: "$ref": "#/components/schemas/resource_company/properties/archived_at" external_id: "$ref": "#/components/schemas/resource_company/properties/external_id" sample_data: "$ref": "#/components/schemas/resource_company/properties/sample_data" billing_name: "$ref": "#/components/schemas/resource_company/properties/billing_name" company_code: "$ref": "#/components/schemas/resource_company/properties/company_code" custom_fields: "$ref": "#/components/schemas/resource_company/properties/custom_fields" external_sync: "$ref": "#/components/schemas/resource_company/properties/external_sync" default_currency: "$ref": "#/components/schemas/resource_company/properties/default_currency" last_activity_at: "$ref": "#/components/schemas/resource_company/properties/last_activity_at" parent_company_id: "$ref": "#/components/schemas/resource_company/properties/parent_company_id" default_tax_rate_id: "$ref": "#/components/schemas/resource_company/properties/default_tax_rate_id" original_avatar_url: "$ref": "#/components/schemas/resource_company/properties/original_avatar_url" projectless_budgets: "$ref": "#/components/schemas/resource_company/properties/projectless_budgets" default_subsidiary_id: "$ref": "#/components/schemas/resource_company/properties/default_subsidiary_id" default_document_type_id: "$ref": "#/components/schemas/resource_company/properties/default_document_type_id" invoice_email_recipients: "$ref": "#/components/schemas/resource_company/properties/invoice_email_recipients" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" parent_company: "$ref": "#/components/schemas/_single_relationship" default_tax_rate: "$ref": "#/components/schemas/_single_relationship" einvoice_identity: "$ref": "#/components/schemas/_single_relationship" default_subsidiary: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" default_document_type: "$ref": "#/components/schemas/_single_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" integration_exporter_configuration: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection company single_task_dependency: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: type_id: "$ref": "#/components/schemas/resource_task_dependency/properties/type_id" relationships: type: object properties: task: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" dependent_task: "$ref": "#/components/schemas/_single_relationship" reverse_dependency: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single task dependency collection_workflow_status: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_workflow_status/properties/name" color_id: "$ref": "#/components/schemas/resource_workflow_status/properties/color_id" position: "$ref": "#/components/schemas/resource_workflow_status/properties/position" category_id: "$ref": "#/components/schemas/resource_workflow_status/properties/category_id" relationships: type: object properties: workflow: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection workflow status single_document_style: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_document_style/properties/name" styles: "$ref": "#/components/schemas/resource_document_style/properties/styles" relationships: type: object properties: attachments: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single document style collection_custom_field: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_custom_field/properties/name" global: "$ref": "#/components/schemas/resource_custom_field/properties/global" position: "$ref": "#/components/schemas/resource_custom_field/properties/position" required: "$ref": "#/components/schemas/resource_custom_field/properties/required" sensitive: "$ref": "#/components/schemas/resource_custom_field/properties/sensitive" created_at: "$ref": "#/components/schemas/resource_custom_field/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_custom_field/properties/updated_at" archived_at: "$ref": "#/components/schemas/resource_custom_field/properties/archived_at" data_type_id: "$ref": "#/components/schemas/resource_custom_field/properties/data_type_id" customizable_type: "$ref": "#/components/schemas/resource_custom_field/properties/customizable_type" quick_add_enabled: "$ref": "#/components/schemas/resource_custom_field/properties/quick_add_enabled" formatting_type_id: "$ref": "#/components/schemas/resource_custom_field/properties/formatting_type_id" aggregation_type_id: "$ref": "#/components/schemas/resource_custom_field/properties/aggregation_type_id" show_in_add_edit_views: "$ref": "#/components/schemas/resource_custom_field/properties/show_in_add_edit_views" relationships: type: object properties: survey: "$ref": "#/components/schemas/_single_relationship" options: "$ref": "#/components/schemas/_collection_relationship" project: "$ref": "#/components/schemas/_single_relationship" section: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection custom field collection_payment_reminder_sequence: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/name" created_at: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/updated_at" default_sequence: "$ref": "#/components/schemas/resource_payment_reminder_sequence/properties/default_sequence" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" payment_reminders: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection payment reminder sequence single_entitlement: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_entitlement/properties/note" used: "$ref": "#/components/schemas/resource_entitlement/properties/used" pending: "$ref": "#/components/schemas/resource_entitlement/properties/pending" end_date: "$ref": "#/components/schemas/resource_entitlement/properties/end_date" allocated: "$ref": "#/components/schemas/resource_entitlement/properties/allocated" start_date: "$ref": "#/components/schemas/resource_entitlement/properties/start_date" relationships: type: object properties: event: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" approval_workflow: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single entitlement collection_board: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_board/properties/name" hidden: "$ref": "#/components/schemas/resource_board/properties/hidden" position: "$ref": "#/components/schemas/resource_board/properties/position" placement: "$ref": "#/components/schemas/resource_board/properties/placement" archived_at: "$ref": "#/components/schemas/resource_board/properties/archived_at" relationships: type: object properties: project: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection board single_attachment: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: url: "$ref": "#/components/schemas/resource_attachment/properties/url" name: "$ref": "#/components/schemas/resource_attachment/properties/name" size: "$ref": "#/components/schemas/resource_attachment/properties/size" thumb: "$ref": "#/components/schemas/resource_attachment/properties/thumb" resized: "$ref": "#/components/schemas/resource_attachment/properties/resized" temp_url: "$ref": "#/components/schemas/resource_attachment/properties/temp_url" aws_policy: "$ref": "#/components/schemas/resource_attachment/properties/aws_policy" created_at: "$ref": "#/components/schemas/resource_attachment/properties/created_at" deleted_at: "$ref": "#/components/schemas/resource_attachment/properties/deleted_at" message_id: "$ref": "#/components/schemas/resource_attachment/properties/message_id" external_id: "$ref": "#/components/schemas/resource_attachment/properties/external_id" content_type: "$ref": "#/components/schemas/resource_attachment/properties/content_type" attachable_type: "$ref": "#/components/schemas/resource_attachment/properties/attachable_type" attachment_type: "$ref": "#/components/schemas/resource_attachment/properties/attachment_type" relationships: type: object properties: bill: "$ref": "#/components/schemas/_single_relationship" deal: "$ref": "#/components/schemas/_single_relationship" page: "$ref": "#/components/schemas/_single_relationship" task: "$ref": "#/components/schemas/_single_relationship" email: "$ref": "#/components/schemas/_single_relationship" comment: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" expense: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_type: "$ref": "#/components/schemas/_single_relationship" document_style: "$ref": "#/components/schemas/_single_relationship" purchase_order: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single attachment single_lost_reason: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_lost_reason/properties/name" archived_at: "$ref": "#/components/schemas/resource_lost_reason/properties/archived_at" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single lost reason collection_proposal: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: date: "$ref": "#/components/schemas/resource_proposal/properties/date" name: "$ref": "#/components/schemas/resource_proposal/properties/name" note: "$ref": "#/components/schemas/resource_proposal/properties/note" footer: "$ref": "#/components/schemas/resource_proposal/properties/footer" signed: "$ref": "#/components/schemas/resource_proposal/properties/signed" status: "$ref": "#/components/schemas/resource_proposal/properties/status" sent_at: "$ref": "#/components/schemas/resource_proposal/properties/sent_at" currency: "$ref": "#/components/schemas/resource_proposal/properties/currency" end_date: "$ref": "#/components/schemas/resource_proposal/properties/end_date" created_at: "$ref": "#/components/schemas/resource_proposal/properties/created_at" disclaimer: "$ref": "#/components/schemas/resource_proposal/properties/disclaimer" link_status: "$ref": "#/components/schemas/resource_proposal/properties/link_status" public_uuid: "$ref": "#/components/schemas/resource_proposal/properties/public_uuid" budget_total: "$ref": "#/components/schemas/resource_proposal/properties/budget_total" audit_pdf_url: "$ref": "#/components/schemas/resource_proposal/properties/audit_pdf_url" custom_fields: "$ref": "#/components/schemas/resource_proposal/properties/custom_fields" exchange_date: "$ref": "#/components/schemas/resource_proposal/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_proposal/properties/exchange_rate" responder_name: "$ref": "#/components/schemas/resource_proposal/properties/responder_name" responder_email: "$ref": "#/components/schemas/resource_proposal/properties/responder_email" currency_default: "$ref": "#/components/schemas/resource_proposal/properties/currency_default" original_pdf_url: "$ref": "#/components/schemas/resource_proposal/properties/original_pdf_url" note_interpolated: "$ref": "#/components/schemas/resource_proposal/properties/note_interpolated" status_changed_at: "$ref": "#/components/schemas/resource_proposal/properties/status_changed_at" disclaimer_enabled: "$ref": "#/components/schemas/resource_proposal/properties/disclaimer_enabled" currency_normalized: "$ref": "#/components/schemas/resource_proposal/properties/currency_normalized" footer_interpolated: "$ref": "#/components/schemas/resource_proposal/properties/footer_interpolated" budget_total_default: "$ref": "#/components/schemas/resource_proposal/properties/budget_total_default" purchase_order_number: "$ref": "#/components/schemas/resource_proposal/properties/purchase_order_number" budget_total_normalized: "$ref": "#/components/schemas/resource_proposal/properties/budget_total_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" client: "$ref": "#/components/schemas/_single_relationship" contact: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" tax_rate: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" proposal_to: "$ref": "#/components/schemas/_single_relationship" responsible: "$ref": "#/components/schemas/_single_relationship" deal_creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_type: "$ref": "#/components/schemas/_single_relationship" proposal_from: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection proposal collection_survey_field: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_survey_field/properties/name" global: "$ref": "#/components/schemas/resource_survey_field/properties/global" position: "$ref": "#/components/schemas/resource_survey_field/properties/position" required: "$ref": "#/components/schemas/resource_survey_field/properties/required" sensitive: "$ref": "#/components/schemas/resource_survey_field/properties/sensitive" created_at: "$ref": "#/components/schemas/resource_survey_field/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_survey_field/properties/updated_at" archived_at: "$ref": "#/components/schemas/resource_survey_field/properties/archived_at" data_type_id: "$ref": "#/components/schemas/resource_survey_field/properties/data_type_id" customizable_type: "$ref": "#/components/schemas/resource_survey_field/properties/customizable_type" quick_add_enabled: "$ref": "#/components/schemas/resource_survey_field/properties/quick_add_enabled" formatting_type_id: "$ref": "#/components/schemas/resource_survey_field/properties/formatting_type_id" aggregation_type_id: "$ref": "#/components/schemas/resource_survey_field/properties/aggregation_type_id" show_in_add_edit_views: "$ref": "#/components/schemas/resource_survey_field/properties/show_in_add_edit_views" relationships: type: object properties: survey: "$ref": "#/components/schemas/_single_relationship" options: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" origin_field: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection survey field collection_booking: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_booking/properties/note" time: "$ref": "#/components/schemas/resource_booking/properties/time" draft: "$ref": "#/components/schemas/resource_booking/properties/draft" hours: "$ref": "#/components/schemas/resource_booking/properties/hours" approved: "$ref": "#/components/schemas/resource_booking/properties/approved" canceled: "$ref": "#/components/schemas/resource_booking/properties/canceled" ended_on: "$ref": "#/components/schemas/resource_booking/properties/ended_on" rejected: "$ref": "#/components/schemas/resource_booking/properties/rejected" created_at: "$ref": "#/components/schemas/resource_booking/properties/created_at" percentage: "$ref": "#/components/schemas/resource_booking/properties/percentage" stage_type: "$ref": "#/components/schemas/resource_booking/properties/stage_type" started_on: "$ref": "#/components/schemas/resource_booking/properties/started_on" total_time: "$ref": "#/components/schemas/resource_booking/properties/total_time" updated_at: "$ref": "#/components/schemas/resource_booking/properties/updated_at" approved_at: "$ref": "#/components/schemas/resource_booking/properties/approved_at" canceled_at: "$ref": "#/components/schemas/resource_booking/properties/canceled_at" external_id: "$ref": "#/components/schemas/resource_booking/properties/external_id" rejected_at: "$ref": "#/components/schemas/resource_booking/properties/rejected_at" autotracking: "$ref": "#/components/schemas/resource_booking/properties/autotracking" custom_fields: "$ref": "#/components/schemas/resource_booking/properties/custom_fields" rejected_reason: "$ref": "#/components/schemas/resource_booking/properties/rejected_reason" last_activity_at: "$ref": "#/components/schemas/resource_booking/properties/last_activity_at" booking_method_id: "$ref": "#/components/schemas/resource_booking/properties/booking_method_id" total_working_days: "$ref": "#/components/schemas/resource_booking/properties/total_working_days" people_custom_fields: "$ref": "#/components/schemas/resource_booking/properties/people_custom_fields" relationships: type: object properties: task: "$ref": "#/components/schemas/_single_relationship" event: "$ref": "#/components/schemas/_single_relationship" origin: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" approver: "$ref": "#/components/schemas/_single_relationship" canceler: "$ref": "#/components/schemas/_single_relationship" rejecter: "$ref": "#/components/schemas/_single_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" scenario_item: "$ref": "#/components/schemas/_single_relationship" resource_request: "$ref": "#/components/schemas/_single_relationship" approval_statuses: "$ref": "#/components/schemas/_collection_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection booking collection_einvoice_transaction: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: failed_at: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/failed_at" format_id: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/format_id" created_at: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/updated_at" delivered_at: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/delivered_at" failed_reason: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/failed_reason" tax_cleared_at: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/tax_cleared_at" sender_routing_id: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/sender_routing_id" receiver_routing_id: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/receiver_routing_id" fiscalization_failed_at: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/fiscalization_failed_at" fiscalization_failed_reason: "$ref": "#/components/schemas/resource_einvoice_transaction/properties/fiscalization_failed_reason" relationships: type: object properties: sender: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Successful response containing a list of e-invoice transaction resources. collection_time_entry_version: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: event: "$ref": "#/components/schemas/resource_time_entry_version/properties/event" item_id: "$ref": "#/components/schemas/resource_time_entry_version/properties/item_id" changeset: "$ref": "#/components/schemas/resource_time_entry_version/properties/changeset" item_name: "$ref": "#/components/schemas/resource_time_entry_version/properties/item_name" item_type: "$ref": "#/components/schemas/resource_time_entry_version/properties/item_type" created_at: "$ref": "#/components/schemas/resource_time_entry_version/properties/created_at" object_changes: "$ref": "#/components/schemas/resource_time_entry_version/properties/object_changes" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection time entry version single_einvoice_configuration: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: created_at: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/updated_at" mer_enabled: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/mer_enabled" face_enabled: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/face_enabled" ksef_enabled: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/ksef_enabled" mer_username: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/mer_username" kpd_code_mapping: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/kpd_code_mapping" tax_rate_mapping: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/tax_rate_mapping" xrechnung_enabled: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/xrechnung_enabled" payment_means_type_id: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/payment_means_type_id" include_pdf_attachment: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/include_pdf_attachment" include_timesheet_attachment: "$ref": "#/components/schemas/resource_einvoice_configuration/properties/include_timesheet_attachment" relationships: type: object properties: subsidiary: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Successful response containing a single e-invoice configuration resource. single_deal_status: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_deal_status/properties/name" used: "$ref": "#/components/schemas/resource_deal_status/properties/used" color_id: "$ref": "#/components/schemas/resource_deal_status/properties/color_id" position: "$ref": "#/components/schemas/resource_deal_status/properties/position" status_id: "$ref": "#/components/schemas/resource_deal_status/properties/status_id" archived_at: "$ref": "#/components/schemas/resource_deal_status/properties/archived_at" probability: "$ref": "#/components/schemas/resource_deal_status/properties/probability" lost_reason_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/lost_reason_enabled" probability_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/probability_enabled" time_tracking_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/time_tracking_enabled" booking_tracking_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/booking_tracking_enabled" expense_tracking_enabled: "$ref": "#/components/schemas/resource_deal_status/properties/expense_tracking_enabled" relationships: type: object properties: pipeline: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single deal status single_deal: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: cost: "$ref": "#/components/schemas/resource_deal/properties/cost" date: "$ref": "#/components/schemas/resource_deal/properties/date" name: "$ref": "#/components/schemas/resource_deal/properties/name" note: "$ref": "#/components/schemas/resource_deal/properties/note" budget: "$ref": "#/components/schemas/resource_deal/properties/budget" footer: "$ref": "#/components/schemas/resource_deal/properties/footer" number: "$ref": "#/components/schemas/resource_deal/properties/number" profit: "$ref": "#/components/schemas/resource_deal/properties/profit" suffix: "$ref": "#/components/schemas/resource_deal/properties/suffix" expense: "$ref": "#/components/schemas/resource_deal/properties/expense" revenue: "$ref": "#/components/schemas/resource_deal/properties/revenue" color_id: "$ref": "#/components/schemas/resource_deal/properties/color_id" currency: "$ref": "#/components/schemas/resource_deal/properties/currency" discount: "$ref": "#/components/schemas/resource_deal/properties/discount" end_date: "$ref": "#/components/schemas/resource_deal/properties/end_date" invoiced: "$ref": "#/components/schemas/resource_deal/properties/invoiced" position: "$ref": "#/components/schemas/resource_deal/properties/position" tag_list: "$ref": "#/components/schemas/resource_deal/properties/tag_list" closed_at: "$ref": "#/components/schemas/resource_deal/properties/closed_at" email_key: "$ref": "#/components/schemas/resource_deal/properties/email_key" created_at: "$ref": "#/components/schemas/resource_deal/properties/created_at" deal_value: "$ref": "#/components/schemas/resource_deal/properties/deal_value" deleted_at: "$ref": "#/components/schemas/resource_deal/properties/deleted_at" todo_count: "$ref": "#/components/schemas/resource_deal/properties/todo_count" budget_used: "$ref": "#/components/schemas/resource_deal/properties/budget_used" deal_number: "$ref": "#/components/schemas/resource_deal/properties/deal_number" external_id: "$ref": "#/components/schemas/resource_deal/properties/external_id" probability: "$ref": "#/components/schemas/resource_deal/properties/probability" sample_data: "$ref": "#/components/schemas/resource_deal/properties/sample_data" worked_time: "$ref": "#/components/schemas/resource_deal/properties/worked_time" budget_total: "$ref": "#/components/schemas/resource_deal/properties/budget_total" cost_default: "$ref": "#/components/schemas/resource_deal/properties/cost_default" deal_type_id: "$ref": "#/components/schemas/resource_deal/properties/deal_type_id" delivered_on: "$ref": "#/components/schemas/resource_deal/properties/delivered_on" lost_comment: "$ref": "#/components/schemas/resource_deal/properties/lost_comment" billable_time: "$ref": "#/components/schemas/resource_deal/properties/billable_time" budgeted_time: "$ref": "#/components/schemas/resource_deal/properties/budgeted_time" client_access: "$ref": "#/components/schemas/resource_deal/properties/client_access" custom_fields: "$ref": "#/components/schemas/resource_deal/properties/custom_fields" editor_config: "$ref": "#/components/schemas/resource_deal/properties/editor_config" exchange_date: "$ref": "#/components/schemas/resource_deal/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_deal/properties/exchange_rate" external_sync: "$ref": "#/components/schemas/resource_deal/properties/external_sync" profit_margin: "$ref": "#/components/schemas/resource_deal/properties/profit_margin" proposal_note: "$ref": "#/components/schemas/resource_deal/properties/proposal_note" time_approval: "$ref": "#/components/schemas/resource_deal/properties/time_approval" time_to_close: "$ref": "#/components/schemas/resource_deal/properties/time_to_close" todo_due_date: "$ref": "#/components/schemas/resource_deal/properties/todo_due_date" access_to_deal: "$ref": "#/components/schemas/resource_deal/properties/access_to_deal" budget_warning: "$ref": "#/components/schemas/resource_deal/properties/budget_warning" draft_invoiced: "$ref": "#/components/schemas/resource_deal/properties/draft_invoiced" estimated_time: "$ref": "#/components/schemas/resource_deal/properties/estimated_time" origin_deal_id: "$ref": "#/components/schemas/resource_deal/properties/origin_deal_id" profit_default: "$ref": "#/components/schemas/resource_deal/properties/profit_default" amount_credited: "$ref": "#/components/schemas/resource_deal/properties/amount_credited" cost_normalized: "$ref": "#/components/schemas/resource_deal/properties/cost_normalized" expense_default: "$ref": "#/components/schemas/resource_deal/properties/expense_default" man_day_minutes: "$ref": "#/components/schemas/resource_deal/properties/man_day_minutes" proposal_footer: "$ref": "#/components/schemas/resource_deal/properties/proposal_footer" revenue_default: "$ref": "#/components/schemas/resource_deal/properties/revenue_default" sales_closed_at: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_at" sales_closed_on: "$ref": "#/components/schemas/resource_deal/properties/sales_closed_on" currency_default: "$ref": "#/components/schemas/resource_deal/properties/currency_default" deal_value_total: "$ref": "#/components/schemas/resource_deal/properties/deal_value_total" expense_approval: "$ref": "#/components/schemas/resource_deal/properties/expense_approval" invoiced_default: "$ref": "#/components/schemas/resource_deal/properties/invoiced_default" last_activity_at: "$ref": "#/components/schemas/resource_deal/properties/last_activity_at" services_revenue: "$ref": "#/components/schemas/resource_deal/properties/services_revenue" tracking_type_id: "$ref": "#/components/schemas/resource_deal/properties/tracking_type_id" connection_status: "$ref": "#/components/schemas/resource_deal/properties/connection_status" deal_value_source: "$ref": "#/components/schemas/resource_deal/properties/deal_value_source" manually_invoiced: "$ref": "#/components/schemas/resource_deal/properties/manually_invoiced" note_interpolated: "$ref": "#/components/schemas/resource_deal/properties/note_interpolated" pending_invoicing: "$ref": "#/components/schemas/resource_deal/properties/pending_invoicing" profit_normalized: "$ref": "#/components/schemas/resource_deal/properties/profit_normalized" projected_revenue: "$ref": "#/components/schemas/resource_deal/properties/projected_revenue" retainer_interval: "$ref": "#/components/schemas/resource_deal/properties/retainer_interval" days_since_created: "$ref": "#/components/schemas/resource_deal/properties/days_since_created" expense_normalized: "$ref": "#/components/schemas/resource_deal/properties/expense_normalized" revenue_normalized: "$ref": "#/components/schemas/resource_deal/properties/revenue_normalized" rounding_method_id: "$ref": "#/components/schemas/resource_deal/properties/rounding_method_id" budget_used_default: "$ref": "#/components/schemas/resource_deal/properties/budget_used_default" currency_normalized: "$ref": "#/components/schemas/resource_deal/properties/currency_normalized" footer_interpolated: "$ref": "#/components/schemas/resource_deal/properties/footer_interpolated" invoiced_normalized: "$ref": "#/components/schemas/resource_deal/properties/invoiced_normalized" budget_total_default: "$ref": "#/components/schemas/resource_deal/properties/budget_total_default" previous_probability: "$ref": "#/components/schemas/resource_deal/properties/previous_probability" rounding_interval_id: "$ref": "#/components/schemas/resource_deal/properties/rounding_interval_id" days_in_current_stage: "$ref": "#/components/schemas/resource_deal/properties/days_in_current_stage" deal_value_per_period: "$ref": "#/components/schemas/resource_deal/properties/deal_value_per_period" profit_margin_default: "$ref": "#/components/schemas/resource_deal/properties/profit_margin_default" purchase_order_number: "$ref": "#/components/schemas/resource_deal/properties/purchase_order_number" budget_used_normalized: "$ref": "#/components/schemas/resource_deal/properties/budget_used_normalized" draft_invoiced_default: "$ref": "#/components/schemas/resource_deal/properties/draft_invoiced_default" amount_credited_default: "$ref": "#/components/schemas/resource_deal/properties/amount_credited_default" budget_total_normalized: "$ref": "#/components/schemas/resource_deal/properties/budget_total_normalized" retainer_interval_count: "$ref": "#/components/schemas/resource_deal/properties/retainer_interval_count" sales_status_updated_at: "$ref": "#/components/schemas/resource_deal/properties/sales_status_updated_at" days_since_last_activity: "$ref": "#/components/schemas/resource_deal/properties/days_since_last_activity" deal_value_total_default: "$ref": "#/components/schemas/resource_deal/properties/deal_value_total_default" profit_margin_normalized: "$ref": "#/components/schemas/resource_deal/properties/profit_margin_normalized" retainer_deal_value_type: "$ref": "#/components/schemas/resource_deal/properties/retainer_deal_value_type" services_revenue_default: "$ref": "#/components/schemas/resource_deal/properties/services_revenue_default" draft_invoiced_normalized: "$ref": "#/components/schemas/resource_deal/properties/draft_invoiced_normalized" manually_invoiced_default: "$ref": "#/components/schemas/resource_deal/properties/manually_invoiced_default" pending_invoicing_default: "$ref": "#/components/schemas/resource_deal/properties/pending_invoicing_default" projected_revenue_default: "$ref": "#/components/schemas/resource_deal/properties/projected_revenue_default" revenue_distribution_type: "$ref": "#/components/schemas/resource_deal/properties/revenue_distribution_type" amount_credited_normalized: "$ref": "#/components/schemas/resource_deal/properties/amount_credited_normalized" manual_invoicing_status_id: "$ref": "#/components/schemas/resource_deal/properties/manual_invoicing_status_id" proposal_note_interpolated: "$ref": "#/components/schemas/resource_deal/properties/proposal_note_interpolated" deal_value_total_normalized: "$ref": "#/components/schemas/resource_deal/properties/deal_value_total_normalized" revenue_distribution_method: "$ref": "#/components/schemas/resource_deal/properties/revenue_distribution_method" services_revenue_normalized: "$ref": "#/components/schemas/resource_deal/properties/services_revenue_normalized" manually_invoiced_normalized: "$ref": "#/components/schemas/resource_deal/properties/manually_invoiced_normalized" pending_invoicing_normalized: "$ref": "#/components/schemas/resource_deal/properties/pending_invoicing_normalized" projected_revenue_normalized: "$ref": "#/components/schemas/resource_deal/properties/projected_revenue_normalized" proposal_footer_interpolated: "$ref": "#/components/schemas/resource_deal/properties/proposal_footer_interpolated" deal_value_per_period_default: "$ref": "#/components/schemas/resource_deal/properties/deal_value_per_period_default" validate_expense_when_closing: "$ref": "#/components/schemas/resource_deal/properties/validate_expense_when_closing" deal_value_per_period_normalized: "$ref": "#/components/schemas/resource_deal/properties/deal_value_per_period_normalized" service_type_restricted_tracking: "$ref": "#/components/schemas/resource_deal/properties/service_type_restricted_tracking" relationships: type: object properties: company: "$ref": "#/components/schemas/_single_relationship" contact: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" contract: "$ref": "#/components/schemas/_single_relationship" pipeline: "$ref": "#/components/schemas/_single_relationship" tax_rate: "$ref": "#/components/schemas/_single_relationship" template: "$ref": "#/components/schemas/_single_relationship" next_todo: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" deal_status: "$ref": "#/components/schemas/_single_relationship" lost_reason: "$ref": "#/components/schemas/_single_relationship" origin_deal: "$ref": "#/components/schemas/_single_relationship" responsible: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_type: "$ref": "#/components/schemas/_single_relationship" primary_contact: "$ref": "#/components/schemas/_single_relationship" invoice_template: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" designated_approver: "$ref": "#/components/schemas/_single_relationship" proposal_document_type: "$ref": "#/components/schemas/_single_relationship" time_approval_workflow: "$ref": "#/components/schemas/_single_relationship" automatic_invoicing_rule: "$ref": "#/components/schemas/_single_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" expense_approval_workflow: "$ref": "#/components/schemas/_single_relationship" approval_policy_assignment: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single deal collection_approval_policy: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_approval_policy/properties/name" custom: "$ref": "#/components/schemas/resource_approval_policy/properties/custom" default: "$ref": "#/components/schemas/resource_approval_policy/properties/default" type_id: "$ref": "#/components/schemas/resource_approval_policy/properties/type_id" archived_at: "$ref": "#/components/schemas/resource_approval_policy/properties/archived_at" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection approval policy single_organization_membership: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: position: "$ref": "#/components/schemas/resource_organization_membership/properties/position" updated_at: "$ref": "#/components/schemas/resource_organization_membership/properties/updated_at" preferences: "$ref": "#/components/schemas/resource_organization_membership/properties/preferences" weekly_emails: "$ref": "#/components/schemas/resource_organization_membership/properties/weekly_emails" docs_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/docs_filter_id" time_reminders: "$ref": "#/components/schemas/resource_organization_membership/properties/time_reminders" deals_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/deals_filter_id" tasks_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/tasks_filter_id" tasks_layout_id: "$ref": "#/components/schemas/resource_organization_membership/properties/tasks_layout_id" people_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/people_filter_id" budgets_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/budgets_filter_id" bookings_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/bookings_filter_id" contacts_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/contacts_filter_id" expenses_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/expenses_filter_id" invoices_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/invoices_filter_id" payments_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/payments_filter_id" projects_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/projects_filter_id" quick_start_config: "$ref": "#/components/schemas/resource_organization_membership/properties/quick_start_config" companies_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/companies_filter_id" email_notifications: "$ref": "#/components/schemas/resource_organization_membership/properties/email_notifications" employees_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/employees_filter_id" company_time_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/company_time_filter_id" time_reports_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/time_reports_filter_id" deal_services_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/deal_services_filter_id" salary_reports_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/salary_reports_filter_id" time_approvals_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/time_approvals_filter_id" budget_services_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/budget_services_filter_id" booking_approvals_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/booking_approvals_filter_id" expense_approvals_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/expense_approvals_filter_id" time_entry_reports_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/time_entry_reports_filter_id" granular_notification_preferences: "$ref": "#/components/schemas/resource_organization_membership/properties/granular_notification_preferences" internal_budget_services_filter_id: "$ref": "#/components/schemas/resource_organization_membership/properties/internal_budget_services_filter_id" relationships: type: object properties: user: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" docs_favorite_filter: "$ref": "#/components/schemas/_single_relationship" time_tracking_policy: "$ref": "#/components/schemas/_single_relationship" deals_favorite_filter: "$ref": "#/components/schemas/_single_relationship" tasks_favorite_filter: "$ref": "#/components/schemas/_single_relationship" people_favorite_filter: "$ref": "#/components/schemas/_single_relationship" budgets_favorite_filter: "$ref": "#/components/schemas/_single_relationship" bookings_favorite_filter: "$ref": "#/components/schemas/_single_relationship" contacts_favorite_filter: "$ref": "#/components/schemas/_single_relationship" expenses_favorite_filter: "$ref": "#/components/schemas/_single_relationship" invoices_favorite_filter: "$ref": "#/components/schemas/_single_relationship" payments_favorite_filter: "$ref": "#/components/schemas/_single_relationship" projects_favorite_filter: "$ref": "#/components/schemas/_single_relationship" companies_favorite_filter: "$ref": "#/components/schemas/_single_relationship" employees_favorite_filter: "$ref": "#/components/schemas/_single_relationship" company_time_favorite_filter: "$ref": "#/components/schemas/_single_relationship" time_reports_favorite_filter: "$ref": "#/components/schemas/_single_relationship" deal_services_favorite_filter: "$ref": "#/components/schemas/_single_relationship" salary_reports_favorite_filter: "$ref": "#/components/schemas/_single_relationship" time_approvals_favorite_filter: "$ref": "#/components/schemas/_single_relationship" budget_services_favorite_filter: "$ref": "#/components/schemas/_single_relationship" booking_approvals_favorite_filter: "$ref": "#/components/schemas/_single_relationship" expense_approvals_favorite_filter: "$ref": "#/components/schemas/_single_relationship" time_entry_reports_favorite_filter: "$ref": "#/components/schemas/_single_relationship" internal_budget_services_favorite_filter: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single organization membership single_deal_cost_rate: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: currency: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/currency" rate_cents: "$ref": "#/components/schemas/resource_deal_cost_rate/properties/rate_cents" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single deal cost rate collection_filter: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_filter/properties/name" hidden: "$ref": "#/components/schemas/resource_filter/properties/hidden" params: "$ref": "#/components/schemas/resource_filter/properties/params" public: "$ref": "#/components/schemas/resource_filter/properties/public" report: "$ref": "#/components/schemas/resource_filter/properties/report" shared: "$ref": "#/components/schemas/resource_filter/properties/shared" columns: "$ref": "#/components/schemas/resource_filter/properties/columns" default: "$ref": "#/components/schemas/resource_filter/properties/default" sort_by: "$ref": "#/components/schemas/resource_filter/properties/sort_by" type_id: "$ref": "#/components/schemas/resource_filter/properties/type_id" formulas: "$ref": "#/components/schemas/resource_filter/properties/formulas" group_by: "$ref": "#/components/schemas/resource_filter/properties/group_by" settings: "$ref": "#/components/schemas/resource_filter/properties/settings" layout_id: "$ref": "#/components/schemas/resource_filter/properties/layout_id" created_at: "$ref": "#/components/schemas/resource_filter/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_filter/properties/updated_at" original_id: "$ref": "#/components/schemas/resource_filter/properties/original_id" pulse_count: "$ref": "#/components/schemas/resource_filter/properties/pulse_count" transpose_by: "$ref": "#/components/schemas/resource_filter/properties/transpose_by" chart_type_id: "$ref": "#/components/schemas/resource_filter/properties/chart_type_id" exchange_date: "$ref": "#/components/schemas/resource_filter/properties/exchange_date" export_params: "$ref": "#/components/schemas/resource_filter/properties/export_params" filterable_id: "$ref": "#/components/schemas/resource_filter/properties/filterable_id" predefined_id: "$ref": "#/components/schemas/resource_filter/properties/predefined_id" last_viewed_at: "$ref": "#/components/schemas/resource_filter/properties/last_viewed_at" column_settings: "$ref": "#/components/schemas/resource_filter/properties/column_settings" filterable_type: "$ref": "#/components/schemas/resource_filter/properties/filterable_type" report_layout_id: "$ref": "#/components/schemas/resource_filter/properties/report_layout_id" exchange_currency: "$ref": "#/components/schemas/resource_filter/properties/exchange_currency" last_pulse_sent_at: "$ref": "#/components/schemas/resource_filter/properties/last_pulse_sent_at" filterable_collection: "$ref": "#/components/schemas/resource_filter/properties/filterable_collection" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" memberships: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" report_category: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection filter single_task: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: title: "$ref": "#/components/schemas/resource_task/properties/title" closed: "$ref": "#/components/schemas/resource_task/properties/closed" number: "$ref": "#/components/schemas/resource_task/properties/number" private: "$ref": "#/components/schemas/resource_task/properties/private" type_id: "$ref": "#/components/schemas/resource_task/properties/type_id" due_date: "$ref": "#/components/schemas/resource_task/properties/due_date" due_time: "$ref": "#/components/schemas/resource_task/properties/due_time" tag_list: "$ref": "#/components/schemas/resource_task/properties/tag_list" closed_at: "$ref": "#/components/schemas/resource_task/properties/closed_at" email_key: "$ref": "#/components/schemas/resource_task/properties/email_key" placement: "$ref": "#/components/schemas/resource_task/properties/placement" created_at: "$ref": "#/components/schemas/resource_task/properties/created_at" deleted_at: "$ref": "#/components/schemas/resource_task/properties/deleted_at" start_date: "$ref": "#/components/schemas/resource_task/properties/start_date" todo_count: "$ref": "#/components/schemas/resource_task/properties/todo_count" updated_at: "$ref": "#/components/schemas/resource_task/properties/updated_at" task_number: "$ref": "#/components/schemas/resource_task/properties/task_number" worked_time: "$ref": "#/components/schemas/resource_task/properties/worked_time" billable_time: "$ref": "#/components/schemas/resource_task/properties/billable_time" custom_fields: "$ref": "#/components/schemas/resource_task/properties/custom_fields" subtask_count: "$ref": "#/components/schemas/resource_task/properties/subtask_count" bookings_count: "$ref": "#/components/schemas/resource_task/properties/bookings_count" remaining_time: "$ref": "#/components/schemas/resource_task/properties/remaining_time" repeat_on_date: "$ref": "#/components/schemas/resource_task/properties/repeat_on_date" open_todo_count: "$ref": "#/components/schemas/resource_task/properties/open_todo_count" initial_estimate: "$ref": "#/components/schemas/resource_task/properties/initial_estimate" last_activity_at: "$ref": "#/components/schemas/resource_task/properties/last_activity_at" repeat_origin_id: "$ref": "#/components/schemas/resource_task/properties/repeat_origin_id" repeat_on_weekday: "$ref": "#/components/schemas/resource_task/properties/repeat_on_weekday" subtask_placement: "$ref": "#/components/schemas/resource_task/properties/subtask_placement" todo_assignee_ids: "$ref": "#/components/schemas/resource_task/properties/todo_assignee_ids" creation_method_id: "$ref": "#/components/schemas/resource_task/properties/creation_method_id" open_subtask_count: "$ref": "#/components/schemas/resource_task/properties/open_subtask_count" repeat_on_interval: "$ref": "#/components/schemas/resource_task/properties/repeat_on_interval" repeat_on_monthday: "$ref": "#/components/schemas/resource_task/properties/repeat_on_monthday" repeat_schedule_id: "$ref": "#/components/schemas/resource_task/properties/repeat_schedule_id" task_dependency_count: "$ref": "#/components/schemas/resource_task/properties/task_dependency_count" linked_dependency_count: "$ref": "#/components/schemas/resource_task/properties/linked_dependency_count" blocking_dependency_count: "$ref": "#/components/schemas/resource_task/properties/blocking_dependency_count" waiting_on_dependency_count: "$ref": "#/components/schemas/resource_task/properties/waiting_on_dependency_count" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" assignee: "$ref": "#/components/schemas/_single_relationship" task_list: "$ref": "#/components/schemas/_single_relationship" last_actor: "$ref": "#/components/schemas/_single_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" parent_task: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" repeated_task: "$ref": "#/components/schemas/_single_relationship" template_object: "$ref": "#/components/schemas/_single_relationship" workflow_status: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single task collection_kpd_code: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: code: "$ref": "#/components/schemas/resource_kpd_code/properties/code" is_kpd: "$ref": "#/components/schemas/resource_kpd_code/properties/is_kpd" kpd_name: "$ref": "#/components/schemas/resource_kpd_code/properties/kpd_name" nkd_name: "$ref": "#/components/schemas/resource_kpd_code/properties/nkd_name" created_at: "$ref": "#/components/schemas/resource_kpd_code/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_kpd_code/properties/updated_at" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Successful response containing a list of KPD code resources. collection_webhook: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_webhook/properties/name" test: "$ref": "#/components/schemas/resource_webhook/properties/test" type_id: "$ref": "#/components/schemas/resource_webhook/properties/type_id" event_id: "$ref": "#/components/schemas/resource_webhook/properties/event_id" state_id: "$ref": "#/components/schemas/resource_webhook/properties/state_id" target_url: "$ref": "#/components/schemas/resource_webhook/properties/target_url" custom_headers: "$ref": "#/components/schemas/resource_webhook/properties/custom_headers" deactivated_at: "$ref": "#/components/schemas/resource_webhook/properties/deactivated_at" retry_attempts: "$ref": "#/components/schemas/resource_webhook/properties/retry_attempts" signature_token: "$ref": "#/components/schemas/resource_webhook/properties/signature_token" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection webhook collection_invoice: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_invoice/properties/note" amount: "$ref": "#/components/schemas/resource_invoice/properties/amount" footer: "$ref": "#/components/schemas/resource_invoice/properties/footer" number: "$ref": "#/components/schemas/resource_invoice/properties/number" pay_on: "$ref": "#/components/schemas/resource_invoice/properties/pay_on" paid_on: "$ref": "#/components/schemas/resource_invoice/properties/paid_on" sent_on: "$ref": "#/components/schemas/resource_invoice/properties/sent_on" subject: "$ref": "#/components/schemas/resource_invoice/properties/subject" credited: "$ref": "#/components/schemas/resource_invoice/properties/credited" currency: "$ref": "#/components/schemas/resource_invoice/properties/currency" discount: "$ref": "#/components/schemas/resource_invoice/properties/discount" exported: "$ref": "#/components/schemas/resource_invoice/properties/exported" tag_list: "$ref": "#/components/schemas/resource_invoice/properties/tag_list" email_key: "$ref": "#/components/schemas/resource_invoice/properties/email_key" export_id: "$ref": "#/components/schemas/resource_invoice/properties/export_id" tax1_name: "$ref": "#/components/schemas/resource_invoice/properties/tax1_name" tax2_name: "$ref": "#/components/schemas/resource_invoice/properties/tax2_name" amount_tax: "$ref": "#/components/schemas/resource_invoice/properties/amount_tax" created_at: "$ref": "#/components/schemas/resource_invoice/properties/created_at" deleted_at: "$ref": "#/components/schemas/resource_invoice/properties/deleted_at" tax1_value: "$ref": "#/components/schemas/resource_invoice/properties/tax1_value" tax2_value: "$ref": "#/components/schemas/resource_invoice/properties/tax2_value" updated_at: "$ref": "#/components/schemas/resource_invoice/properties/updated_at" amount_paid: "$ref": "#/components/schemas/resource_invoice/properties/amount_paid" delivery_on: "$ref": "#/components/schemas/resource_invoice/properties/delivery_on" exported_at: "$ref": "#/components/schemas/resource_invoice/properties/exported_at" invoiced_on: "$ref": "#/components/schemas/resource_invoice/properties/invoiced_on" sample_data: "$ref": "#/components/schemas/resource_invoice/properties/sample_data" finalized_at: "$ref": "#/components/schemas/resource_invoice/properties/finalized_at" finalized_on: "$ref": "#/components/schemas/resource_invoice/properties/finalized_on" amount_unpaid: "$ref": "#/components/schemas/resource_invoice/properties/amount_unpaid" custom_fields: "$ref": "#/components/schemas/resource_invoice/properties/custom_fields" exchange_date: "$ref": "#/components/schemas/resource_invoice/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_invoice/properties/exchange_rate" line_item_tax: "$ref": "#/components/schemas/resource_invoice/properties/line_item_tax" payment_terms: "$ref": "#/components/schemas/resource_invoice/properties/payment_terms" amount_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_default" amount_credited: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited" amount_with_tax: "$ref": "#/components/schemas/resource_invoice/properties/amount_with_tax" invoice_type_id: "$ref": "#/components/schemas/resource_invoice/properties/invoice_type_id" pay_on_relative: "$ref": "#/components/schemas/resource_invoice/properties/pay_on_relative" creation_options: "$ref": "#/components/schemas/resource_invoice/properties/creation_options" currency_default: "$ref": "#/components/schemas/resource_invoice/properties/currency_default" last_activity_at: "$ref": "#/components/schemas/resource_invoice/properties/last_activity_at" amount_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_normalized" note_interpolated: "$ref": "#/components/schemas/resource_invoice/properties/note_interpolated" amount_tax_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_tax_default" amount_written_off: "$ref": "#/components/schemas/resource_invoice/properties/amount_written_off" export_invoice_url: "$ref": "#/components/schemas/resource_invoice/properties/export_invoice_url" amount_paid_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_paid_default" currency_normalized: "$ref": "#/components/schemas/resource_invoice/properties/currency_normalized" footer_interpolated: "$ref": "#/components/schemas/resource_invoice/properties/footer_interpolated" invoice_template_id: "$ref": "#/components/schemas/resource_invoice/properties/invoice_template_id" bank_account_details: "$ref": "#/components/schemas/resource_invoice/properties/bank_account_details" company_reference_id: "$ref": "#/components/schemas/resource_invoice/properties/company_reference_id" amount_tax_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_tax_normalized" amount_unpaid_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_unpaid_default" purchase_order_number: "$ref": "#/components/schemas/resource_invoice/properties/purchase_order_number" amount_paid_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_paid_normalized" amount_credited_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_default" amount_with_tax_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_with_tax_default" amount_credited_with_tax: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_with_tax" amount_unpaid_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_unpaid_normalized" amount_credited_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_normalized" amount_with_tax_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_with_tax_normalized" amount_written_off_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_written_off_default" export_integration_type_id: "$ref": "#/components/schemas/resource_invoice/properties/export_integration_type_id" amount_written_off_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_written_off_normalized" amount_credited_with_tax_default: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_with_tax_default" amount_credited_with_tax_normalized: "$ref": "#/components/schemas/resource_invoice/properties/amount_credited_with_tax_normalized" relationships: type: object properties: issuer: "$ref": "#/components/schemas/_single_relationship" bill_to: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" bill_from: "$ref": "#/components/schemas/_single_relationship" attachment: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" bank_account: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_type: "$ref": "#/components/schemas/_single_relationship" parent_invoice: "$ref": "#/components/schemas/_single_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" invoice_attributions: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection invoice single_page_version: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_page_version/properties/name" created_at: "$ref": "#/components/schemas/resource_page_version/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_page_version/properties/updated_at" body_snapshot: "$ref": "#/components/schemas/resource_page_version/properties/body_snapshot" title_snapshot: "$ref": "#/components/schemas/resource_page_version/properties/title_snapshot" prosemirror_steps: "$ref": "#/components/schemas/resource_page_version/properties/prosemirror_steps" restored_from_version_id: "$ref": "#/components/schemas/resource_page_version/properties/restored_from_version_id" relationships: type: object properties: page: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single page version collection_survey: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: title: "$ref": "#/components/schemas/resource_survey/properties/title" created_at: "$ref": "#/components/schemas/resource_survey/properties/created_at" updated_at: "$ref": "#/components/schemas/resource_survey/properties/updated_at" public_uuid: "$ref": "#/components/schemas/resource_survey/properties/public_uuid" submission_access: "$ref": "#/components/schemas/resource_survey/properties/submission_access" relationships: type: object properties: creator: "$ref": "#/components/schemas/_single_relationship" project: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection survey collection_role: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_role/properties/name" description: "$ref": "#/components/schemas/resource_role/properties/description" permissions: "$ref": "#/components/schemas/resource_role/properties/permissions" base_role_id: "$ref": "#/components/schemas/resource_role/properties/base_role_id" people_count: "$ref": "#/components/schemas/resource_role/properties/people_count" user_type_id: "$ref": "#/components/schemas/resource_role/properties/user_type_id" editable_by_user: "$ref": "#/components/schemas/resource_role/properties/editable_by_user" active_users_count: "$ref": "#/components/schemas/resource_role/properties/active_users_count" active_agents_count: "$ref": "#/components/schemas/resource_role/properties/active_agents_count" inactive_users_count: "$ref": "#/components/schemas/resource_role/properties/inactive_users_count" resolved_permissions: "$ref": "#/components/schemas/resource_role/properties/resolved_permissions" inactive_agents_count: "$ref": "#/components/schemas/resource_role/properties/inactive_agents_count" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection role collection_line_item: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: amount: "$ref": "#/components/schemas/resource_line_item/properties/amount" unit_id: "$ref": "#/components/schemas/resource_line_item/properties/unit_id" currency: "$ref": "#/components/schemas/resource_line_item/properties/currency" discount: "$ref": "#/components/schemas/resource_line_item/properties/discount" position: "$ref": "#/components/schemas/resource_line_item/properties/position" quantity: "$ref": "#/components/schemas/resource_line_item/properties/quantity" tax_name: "$ref": "#/components/schemas/resource_line_item/properties/tax_name" tax_value: "$ref": "#/components/schemas/resource_line_item/properties/tax_value" amount_tax: "$ref": "#/components/schemas/resource_line_item/properties/amount_tax" unit_price: "$ref": "#/components/schemas/resource_line_item/properties/unit_price" amount_default: "$ref": "#/components/schemas/resource_line_item/properties/amount_default" amount_with_tax: "$ref": "#/components/schemas/resource_line_item/properties/amount_with_tax" currency_default: "$ref": "#/components/schemas/resource_line_item/properties/currency_default" amount_normalized: "$ref": "#/components/schemas/resource_line_item/properties/amount_normalized" amount_tax_default: "$ref": "#/components/schemas/resource_line_item/properties/amount_tax_default" unit_price_default: "$ref": "#/components/schemas/resource_line_item/properties/unit_price_default" currency_normalized: "$ref": "#/components/schemas/resource_line_item/properties/currency_normalized" amount_tax_normalized: "$ref": "#/components/schemas/resource_line_item/properties/amount_tax_normalized" unit_price_normalized: "$ref": "#/components/schemas/resource_line_item/properties/unit_price_normalized" amount_with_tax_default: "$ref": "#/components/schemas/resource_line_item/properties/amount_with_tax_default" amount_with_tax_normalized: "$ref": "#/components/schemas/resource_line_item/properties/amount_with_tax_normalized" relationships: type: object properties: expense: "$ref": "#/components/schemas/_single_relationship" invoice: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" kpd_code: "$ref": "#/components/schemas/_single_relationship" tax_rate: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" service_type: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection line item collection_custom_domain: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: name: "$ref": "#/components/schemas/resource_custom_domain/properties/name" mailgun_mx: "$ref": "#/components/schemas/resource_custom_domain/properties/mailgun_mx" mailgun_spf: "$ref": "#/components/schemas/resource_custom_domain/properties/mailgun_spf" verified_at: "$ref": "#/components/schemas/resource_custom_domain/properties/verified_at" mailgun_dkim: "$ref": "#/components/schemas/resource_custom_domain/properties/mailgun_dkim" allow_user_email: "$ref": "#/components/schemas/resource_custom_domain/properties/allow_user_email" email_sender_name: "$ref": "#/components/schemas/resource_custom_domain/properties/email_sender_name" email_sender_address: "$ref": "#/components/schemas/resource_custom_domain/properties/email_sender_address" relationships: type: object properties: organization: "$ref": "#/components/schemas/_single_relationship" subsidiaries: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection custom domain single_booking: content: application/vnd.api+json: schema: type: object properties: data: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_booking/properties/note" time: "$ref": "#/components/schemas/resource_booking/properties/time" draft: "$ref": "#/components/schemas/resource_booking/properties/draft" hours: "$ref": "#/components/schemas/resource_booking/properties/hours" approved: "$ref": "#/components/schemas/resource_booking/properties/approved" canceled: "$ref": "#/components/schemas/resource_booking/properties/canceled" ended_on: "$ref": "#/components/schemas/resource_booking/properties/ended_on" rejected: "$ref": "#/components/schemas/resource_booking/properties/rejected" created_at: "$ref": "#/components/schemas/resource_booking/properties/created_at" percentage: "$ref": "#/components/schemas/resource_booking/properties/percentage" stage_type: "$ref": "#/components/schemas/resource_booking/properties/stage_type" started_on: "$ref": "#/components/schemas/resource_booking/properties/started_on" total_time: "$ref": "#/components/schemas/resource_booking/properties/total_time" updated_at: "$ref": "#/components/schemas/resource_booking/properties/updated_at" approved_at: "$ref": "#/components/schemas/resource_booking/properties/approved_at" canceled_at: "$ref": "#/components/schemas/resource_booking/properties/canceled_at" external_id: "$ref": "#/components/schemas/resource_booking/properties/external_id" rejected_at: "$ref": "#/components/schemas/resource_booking/properties/rejected_at" autotracking: "$ref": "#/components/schemas/resource_booking/properties/autotracking" custom_fields: "$ref": "#/components/schemas/resource_booking/properties/custom_fields" rejected_reason: "$ref": "#/components/schemas/resource_booking/properties/rejected_reason" last_activity_at: "$ref": "#/components/schemas/resource_booking/properties/last_activity_at" booking_method_id: "$ref": "#/components/schemas/resource_booking/properties/booking_method_id" total_working_days: "$ref": "#/components/schemas/resource_booking/properties/total_working_days" people_custom_fields: "$ref": "#/components/schemas/resource_booking/properties/people_custom_fields" relationships: type: object properties: task: "$ref": "#/components/schemas/_single_relationship" event: "$ref": "#/components/schemas/_single_relationship" origin: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" service: "$ref": "#/components/schemas/_single_relationship" updater: "$ref": "#/components/schemas/_single_relationship" approver: "$ref": "#/components/schemas/_single_relationship" canceler: "$ref": "#/components/schemas/_single_relationship" rejecter: "$ref": "#/components/schemas/_single_relationship" attachments: "$ref": "#/components/schemas/_collection_relationship" organization: "$ref": "#/components/schemas/_single_relationship" scenario_item: "$ref": "#/components/schemas/_single_relationship" resource_request: "$ref": "#/components/schemas/_single_relationship" approval_statuses: "$ref": "#/components/schemas/_collection_relationship" custom_field_people: "$ref": "#/components/schemas/_collection_relationship" custom_field_attachments: "$ref": "#/components/schemas/_collection_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Single booking collection_payroll_item_report: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: count: "$ref": "#/components/schemas/resource_payroll_item_report/properties/count" group: "$ref": "#/components/schemas/resource_payroll_item_report/properties/group" role_id: "$ref": "#/components/schemas/resource_payroll_item_report/properties/role_id" currency: "$ref": "#/components/schemas/resource_payroll_item_report/properties/currency" end_date: "$ref": "#/components/schemas/resource_payroll_item_report/properties/end_date" start_date: "$ref": "#/components/schemas/resource_payroll_item_report/properties/start_date" total_cost: "$ref": "#/components/schemas/resource_payroll_item_report/properties/total_cost" total_time: "$ref": "#/components/schemas/resource_payroll_item_report/properties/total_time" person_type: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_type" custom_fields: "$ref": "#/components/schemas/resource_payroll_item_report/properties/custom_fields" person_status: "$ref": "#/components/schemas/resource_payroll_item_report/properties/person_status" formula_fields: "$ref": "#/components/schemas/resource_payroll_item_report/properties/formula_fields" salary_type_id: "$ref": "#/components/schemas/resource_payroll_item_report/properties/salary_type_id" total_capacity: "$ref": "#/components/schemas/resource_payroll_item_report/properties/total_capacity" payroll_item_id: "$ref": "#/components/schemas/resource_payroll_item_report/properties/payroll_item_id" currency_default: "$ref": "#/components/schemas/resource_payroll_item_report/properties/currency_default" payroll_item_type: "$ref": "#/components/schemas/resource_payroll_item_report/properties/payroll_item_type" total_availability: "$ref": "#/components/schemas/resource_payroll_item_report/properties/total_availability" total_cost_default: "$ref": "#/components/schemas/resource_payroll_item_report/properties/total_cost_default" currency_normalized: "$ref": "#/components/schemas/resource_payroll_item_report/properties/currency_normalized" total_time_off_cost: "$ref": "#/components/schemas/resource_payroll_item_report/properties/total_time_off_cost" total_time_off_time: "$ref": "#/components/schemas/resource_payroll_item_report/properties/total_time_off_time" total_scheduled_time: "$ref": "#/components/schemas/resource_payroll_item_report/properties/total_scheduled_time" total_cost_normalized: "$ref": "#/components/schemas/resource_payroll_item_report/properties/total_cost_normalized" total_time_off_cost_default: "$ref": "#/components/schemas/resource_payroll_item_report/properties/total_time_off_cost_default" total_time_off_cost_normalized: "$ref": "#/components/schemas/resource_payroll_item_report/properties/total_time_off_cost_normalized" relationships: type: object properties: person: "$ref": "#/components/schemas/_single_relationship" report: "$ref": "#/components/schemas/_single_relationship" salary: "$ref": "#/components/schemas/_single_relationship" booking: "$ref": "#/components/schemas/_single_relationship" company: "$ref": "#/components/schemas/_single_relationship" subsidiary: "$ref": "#/components/schemas/_single_relationship" time_entry: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" person_report: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection payroll item report collection_entitlement: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_entitlement/properties/note" used: "$ref": "#/components/schemas/resource_entitlement/properties/used" pending: "$ref": "#/components/schemas/resource_entitlement/properties/pending" end_date: "$ref": "#/components/schemas/resource_entitlement/properties/end_date" allocated: "$ref": "#/components/schemas/resource_entitlement/properties/allocated" start_date: "$ref": "#/components/schemas/resource_entitlement/properties/start_date" relationships: type: object properties: event: "$ref": "#/components/schemas/_single_relationship" person: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" approval_workflow: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Collection entitlement collection_purchase_order: content: application/vnd.api+json: schema: type: object properties: data: type: array items: type: object properties: attributes: type: object properties: note: "$ref": "#/components/schemas/resource_purchase_order/properties/note" footer: "$ref": "#/components/schemas/resource_purchase_order/properties/footer" number: "$ref": "#/components/schemas/resource_purchase_order/properties/number" sent_on: "$ref": "#/components/schemas/resource_purchase_order/properties/sent_on" subject: "$ref": "#/components/schemas/resource_purchase_order/properties/subject" currency: "$ref": "#/components/schemas/resource_purchase_order/properties/currency" exported: "$ref": "#/components/schemas/resource_purchase_order/properties/exported" email_key: "$ref": "#/components/schemas/resource_purchase_order/properties/email_key" export_id: "$ref": "#/components/schemas/resource_purchase_order/properties/export_id" issued_on: "$ref": "#/components/schemas/resource_purchase_order/properties/issued_on" status_id: "$ref": "#/components/schemas/resource_purchase_order/properties/status_id" created_at: "$ref": "#/components/schemas/resource_purchase_order/properties/created_at" export_url: "$ref": "#/components/schemas/resource_purchase_order/properties/export_url" total_cost: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost" delivery_on: "$ref": "#/components/schemas/resource_purchase_order/properties/delivery_on" exported_at: "$ref": "#/components/schemas/resource_purchase_order/properties/exported_at" received_on: "$ref": "#/components/schemas/resource_purchase_order/properties/received_on" exchange_date: "$ref": "#/components/schemas/resource_purchase_order/properties/exchange_date" exchange_rate: "$ref": "#/components/schemas/resource_purchase_order/properties/exchange_rate" total_received: "$ref": "#/components/schemas/resource_purchase_order/properties/total_received" currency_default: "$ref": "#/components/schemas/resource_purchase_order/properties/currency_default" note_interpolated: "$ref": "#/components/schemas/resource_purchase_order/properties/note_interpolated" payment_status_id: "$ref": "#/components/schemas/resource_purchase_order/properties/payment_status_id" total_cost_default: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_default" currency_normalized: "$ref": "#/components/schemas/resource_purchase_order/properties/currency_normalized" footer_interpolated: "$ref": "#/components/schemas/resource_purchase_order/properties/footer_interpolated" total_cost_with_tax: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_with_tax" total_cost_normalized: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_normalized" total_received_default: "$ref": "#/components/schemas/resource_purchase_order/properties/total_received_default" total_received_normalized: "$ref": "#/components/schemas/resource_purchase_order/properties/total_received_normalized" export_integration_type_id: "$ref": "#/components/schemas/resource_purchase_order/properties/export_integration_type_id" total_cost_with_tax_default: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_with_tax_default" total_cost_with_tax_normalized: "$ref": "#/components/schemas/resource_purchase_order/properties/total_cost_with_tax_normalized" relationships: type: object properties: deal: "$ref": "#/components/schemas/_single_relationship" vendor: "$ref": "#/components/schemas/_single_relationship" bill_to: "$ref": "#/components/schemas/_single_relationship" creator: "$ref": "#/components/schemas/_single_relationship" bill_from: "$ref": "#/components/schemas/_single_relationship" attachment: "$ref": "#/components/schemas/_single_relationship" organization: "$ref": "#/components/schemas/_single_relationship" document_type: "$ref": "#/components/schemas/_single_relationship" meta: "$ref": "#/components/schemas/_meta" included: type: array items: {} description: Paginated list of purchase orders in JSON:API format, with related vendor, deal, creator, document type, bill-to, bill-from, and attachment resources available via `include`. securitySchemes: header_token: in: header name: X-Auth-Token type: apiKey description: Authentication via API token passed in the X-Auth-Token request header.