{"openapi":"3.0.0","info":{"version":"2.0.0","title":"ScopeStack API","termsOfService":"https://scopestack.io/terms/","description":"      This Application Programming Interface (API) for interacting with ScopeStack data adheres to the JSON:API\n      standards (see https://jsonapi.org).\n\n      This document covers the publicly supported V2 endpoints, which are focused on project and catalog\n      management. Endpoints used internally by the ScopeStack application are not documented here and are not\n      supported for third-party use.\n\n      Per the JSON:API standard, the API accepts and returns the ContentType 'application/vnd.api+json'.  The basic\n      structure of this JSON format is as follows:\n\n      {\n        data: {\n          id: \u003cresource-id\u003e,\n          type: \u003cresource-class\u003e,\n          attributes: {\n            name: 'Example Data',\n          }\n        }\n      }\n\n      Of note:\n        * When creating a new resource, the data.id value should be omitted (it will be assigned by the server and\n          included in the response).\n        * When updating a resource, data.id is required. On paths ending in the resource's own /{id}, it must\n          match that id; on nested paths such as /v2/projects/{project_id}/psa-project, the path id is the\n          parent's and data.id is the nested record's.\n        * Resource classes are always plural names such as 'projects' or 'project-services'\n        * Resource classes and attributes are generally hyphenated (e.g., project-expenses not project_expenses)\n\n      Unlike V1, V2 paths are not prefixed with an account slug.  The account is determined by the credentials used\n      to make the request:\n\n        * Retrieve collection:         GET /v2/{collection-name}\n                                       GET /v2/projects\n\n        * Create (add to collection):  POST /v2/{collection-name}\n                                       POST /v2/projects\n\n        * Read item:                   GET /v2/{collection-name}/{item-id}\n                                       GET /v2/projects/12345\n\n        * Update item:                 PATCH /v2/{collection-name}/{item-id}\n                                       PATCH /v2/projects/12345\n\n        * Delete item:                 DELETE /v2/{collection-name}/{item-id}\n                                       DELETE /v2/projects/12345\n\n      Each resource endpoint will include a 'relationships' object, listing the data associated with the resource\n      in view.  For example, the 'project-expense' resource includes four relationships: project, phase,\n      expense-category, and resource.\n\n      This 'relationships' object is the appropriate way to add or change relationships between two resources.  For\n      example if a project expense included a relationship to resource 123 and needed to use resource 125 instead,\n      then a PATCH request should be sent to the project-expense endpoint with the new relationship data as part of\n      the payload:\n\n      PATCH https://api.scopestack.io/v2/project-expenses/12345\n      {\n        data: {\n          id: 12345,\n          type: 'project-expenses',\n          attributes: { ... },\n          relationships: {\n            resource: { data: { id: 125, type: 'resources' } }\n          }\n        }\n      }\n\n      Related records may be added to the payload when retrieving the resource by adding an 'include' query\n      parameter followed by a comma-separated list of relationship names.  For example, to include the project phase\n      and resource information with project expense 12345 a query should look like this:\n\n      GET https://api.scopestack.io/v2/project-expenses/12345?include=phase,resource\n\n      When the 'include' query parameter is added to a query, the response will include an attribute called\n      'included' which will be an array of included objects for the query.  Note that it is possible to add the\n      'include' parameter to collection queries as well as individual record queries.\n\n      Relationship linkage (the related record's id and type under relationships.\u003cname\u003e.data) is only reliably\n      returned for relationships named in 'include'.  Without it a relationship may carry only links, which reads\n      as if the relationship were empty, so include every relationship you intend to read.\n\n      Collection data is always paged back to the requester.  The API adds a 'links' attribute to the response with\n      three values:\n\n        * first: the first page of the paged data\n        * next: the next page of the paged data (relative to the current page)\n        * last: the last page of the paged data\n\n      By default, data is broken into pages of 250 resources at a time.  The requester may request a different page\n      size by adding a 'page[size]' query parameter to the request. Values between 1 and 1000 are supported.\n","contact":{"name":"ScopeStack Support","email":"support@scopestack.io"},"license":{"name":"MIT"}},"servers":[{"url":"https://api.scopestack.io","description":"production server"}],"tags":[{"name":"account","description":"account operations"}],"paths":{"/v2/account-logo":{"get":{"summary":"Find account logo by ID","description":"Returns a account logo for the account by ID","operationId":"V2GetAccountLogo","tags":["account"],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_AccountLogoResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update account logo by ID","description":"Update the account logo by ID","operationId":"V2UpdateAccountLogo","tags":["account"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_AccountLogoResource"}}}}}},"responses":{"200":{"description":"Update AccountLogo response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_AccountLogoResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/approval-steps":{"get":{"summary":"List approval steps for account","description":"Returns a paged list of approval steps for the account","operationId":"V2ListApprovalStepsForAccount","tags":["approval step"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the approval steps are attached","schema":{"type":"string"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each approval step","schema":{"type":"array","items":{"type":"string","enum":["project","project-version","project-approvals"]}}}],"responses":{"200":{"description":"Approval Step list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ApprovalStepResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProjectVersionResource"},{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/approval-steps/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find approval step by ID","description":"Returns a approval step for the account by ID","operationId":"V2GetApprovalStep","tags":["approval step"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each approval step","schema":{"type":"array","items":{"type":"string","enum":["project","project-version","project-approvals"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ApprovalStepResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProjectVersionResource"},{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/approved-services":{"get":{"summary":"List approved services for account","description":"Returns a paged list of the most recently approved version of each service","operationId":"V2ListApprovedServicesForAccount","tags":["approved service"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the service","schema":{"type":"string"}},{"name":"filter[tag_list]","in":"query","required":false,"description":"Services tagged with AT LEAST ONE of the tags in the provided comma-separated list","schema":{"type":"string"}},{"name":"filter[sku]","in":"query","required":false,"description":"SKU of the service","schema":{"type":"string"}},{"name":"filter[lob]","in":"query","required":false,"description":"Comma-separated list of ID of lines of business to which the service is associated","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[service-category]","in":"query","required":false,"description":"Comma-separated list of IDs of service categories to which the service is associated","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[phase]","in":"query","required":false,"description":"ID of project phase to which the service is associated","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[blueprint]","in":"query","required":false,"description":"ID of blueprint with which the service is associated","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[service_type]","in":"query","required":false,"description":"name of service-type of the service","schema":{"type":"string","enum":["professional_services","managed_services"]}},{"name":"filter[state]","in":"query","required":false,"description":"Comma-separated list of names of state of the service. Ignored: approved services are always active.","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["pending","active","deleted","custom"]}}},{"name":"filter[payment-frequency]","in":"query","required":false,"description":"Comma-separated list of names of state of the billing frequency for the service","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["one_time","monthly","quarterly","yearly"]}}},{"name":"filter[survey_recommended]","in":"query","required":false,"description":"true to return only services that appear in survey recommendations","schema":{"type":"boolean"}},{"name":"filter[questionnaire]","in":"query","required":false,"description":"ID of questionnaire with which the service is associated","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[exclude]","in":"query","required":false,"description":"comma-separated list of IDs to exclude from the response","schema":{"type":"string"}},{"name":"filter[created-at.after]","in":"query","required":false,"description":"Day on or after which the approved service was created. Time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[created-at.before]","in":"query","required":false,"description":"Day on or before which the approved service was created. Time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[updated-at.after]","in":"query","required":false,"description":"Day on or after which the approved service was updated. Time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[updated-at.before]","in":"query","required":false,"description":"Day on or before which the approved service was updated. Time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[ids]","in":"query","required":false,"description":"Comma-separated list of IDs of services to to download","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[search]","in":"query","required":false,"description":"Characters related to service attributes","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["name","-name","sku","-sku","service_type","-service_type","created_at","-created_at","updated_at","-updated_at","service_category.nested_name","-service_category.nested_name","phase.name","-phase.name"]}}},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each approved service","schema":{"type":"array","items":{"type":"string","enum":["account","resource","phase","service-category","approved-subservices","products","approved-subservices.resource","approved-subservices.approved-service"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Approved service list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ApprovedServiceResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_PhaseResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"},{"$ref":"#/components/schemas/v2_ApprovedSubserviceResource"},{"$ref":"#/components/schemas/v2_ProductResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/approved-services/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find approved service by ID","description":"Returns the most recently approved version of a service; 404 if it has never been approved","operationId":"V2GetApprovedServiceById","tags":["approved service"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with the approved service","schema":{"type":"array","items":{"type":"string","enum":["account","resource","phase","service-category","approved-subservices","products","approved-subservices.resource","approved-subservices.approved-service"]}}}],"responses":{"200":{"description":"Approved service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ApprovedServiceResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_PhaseResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"},{"$ref":"#/components/schemas/v2_ApprovedSubserviceResource"},{"$ref":"#/components/schemas/v2_ProductResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/approved-subservices":{"get":{"summary":"List approved subservices for account","description":"Returns a paged list of the most recently approved version of each subservice","operationId":"V2ListApprovedSubservicesForAccount","tags":["approved subservice"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the subservice","schema":{"type":"string"}},{"name":"filter[service]","in":"query","required":false,"description":"ID of the parent service","schema":{"type":"string"}},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each approved subservice","schema":{"type":"array","items":{"type":"string","enum":["resource","approved-service"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Approved subservice list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ApprovedSubserviceResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ApprovedServiceResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/approved-subservices/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find approved subservice by ID","description":"Returns the most recently approved version of a subservice; 404 if it has never been approved","operationId":"V2GetApprovedSubserviceById","tags":["approved subservice"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with the approved subservice","schema":{"type":"array","items":{"type":"string","enum":["resource","approved-service"]}}}],"responses":{"200":{"description":"Approved subservice response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ApprovedSubserviceResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ApprovedServiceResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/attachment-types":{"get":{"summary":"List attachment types for account","description":"Returns a paged list of attachment types for the account","operationId":"V2ListAttachmentTypesForAccount","tags":["attachment type"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active attachment types, false for archived attachment types","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each attachment type","schema":{"type":"array","items":{"type":"string","enum":["account","project-attachments"]}}}],"responses":{"200":{"description":"Attachment Type list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_AttachmentTypeResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ProjectAttachmentResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create attachment type for account","description":"Create an attachment type for the account","operationId":"V2CreateAttachmentType","tags":["attachment type"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_AttachmentTypeResource"}}}}}},"responses":{"201":{"description":"Create Attachment Type response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_AttachmentTypeResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/attachment-types/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find attachment type by ID","description":"Returns a attachment type for the account by ID","operationId":"V2GetAttachmentType","tags":["attachment type"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each attachment type","schema":{"type":"array","items":{"type":"string","enum":["account","project-attachments"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_AttachmentTypeResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ProjectAttachmentResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update attachment type by ID","description":"Update the attachment type by ID","operationId":"V2UpdateAttachmentType","tags":["attachment type"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_AttachmentTypeResource"}}}}}},"responses":{"200":{"description":"Update Attachment Type response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_AttachmentTypeResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete attachment type by ID","description":"Delete the attachment type from the account by ID","operationId":"V2DeleteAttachmentType","tags":["attachment type"],"responses":{"204":{"description":"The Delete Attachment Type was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/audit-logs":{"get":{"summary":"List audit log for project or account","description":"Returns a paged list of audit log for the project or account","operationId":"V2ListAuditLogs","tags":["audit logs"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which changes are associated","schema":{"type":"string"}},{"name":"filter[context-type]","in":"query","required":false,"description":"Name of the data class that is the context for changes","schema":{"type":"string"}},{"name":"filter[context-id]","in":"query","required":false,"description":"ID of an instance of the data class that is the context for changes","schema":{"type":"string"}},{"name":"filter[after]","in":"query","required":false,"description":"Date or timestamp; entries created at or after it are included. A blank or unparseable value is ignored and the filter is not applied","schema":{"type":"string","format":"date-time"}},{"name":"filter[before]","in":"query","required":false,"description":"Date or timestamp; entries created strictly before it are included (exclusive). A blank or unparseable value is ignored and the filter is not applied","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["created-at","-created-at"]}}}],"responses":{"200":{"description":"Audit Log list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_AuditLogResource"}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/projects/{project_id}/audit-logs":{"parameters":[{"$ref":"#/components/parameters/project_id_parameter"}],"get":{"summary":"List audit log for project or account","description":"Returns a paged list of audit log for the project or account","operationId":"V2ListProjectAuditLogs","tags":["project"],"parameters":[{"name":"filter[after]","in":"query","required":false,"description":"Date or timestamp; entries created at or after it are included. A blank or unparseable value is ignored and the filter is not applied","schema":{"type":"string","format":"date-time"}},{"name":"filter[before]","in":"query","required":false,"description":"Date or timestamp; entries created strictly before it are included (exclusive). A blank or unparseable value is ignored and the filter is not applied","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["created-at","-created-at"]}}}],"responses":{"200":{"description":"Audit Log list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_AuditLogResource"}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/audit-logs/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find audit log by ID","description":"Returns a audit log for the project by ID","operationId":"V2GetAuditLogById","tags":["audit logs"],"responses":{"200":{"description":"Audit log response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_AuditLogResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/audit-logs/{id}/reverts":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Revert audit log by ID","description":"Revert the audited resource to its state PRIOR TO the change described by the audit log ","operationId":"V2RevertAuditLogById","tags":["audit logs"],"responses":{"204":{"description":"Audit log object was successfulll reverted to its prior state"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/blueprints":{"get":{"summary":"List blueprints for account","description":"Returns a paged list of blueprints for the account","operationId":"V2ListBlueprintsForAccount","tags":["blueprint"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"Characters in the name of the blueprint","schema":{"type":"string"}},{"name":"filter[tag_list]","in":"query","required":false,"description":"Blueprints tagged with AT LEAST ONE of the tags in the provided comma-separated list","schema":{"type":"string"}},{"name":"filter[service-id]","in":"query","required":false,"description":"ID of a service that appears on the survey","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","name","-name","code","-code","tag-list","-tag-list","executive-summary","-executive-summary","solution-summary","-solution-summary","data-version","-data-version","payload","-payload"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each blueprint","schema":{"type":"array","items":{"type":"string","enum":["account","blueprint-items.resource"]}}}],"responses":{"200":{"description":"Blueprint list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_BlueprintResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create blueprint for account","description":"Create a blueprint for the account","operationId":"V2CreateBlueprint","tags":["blueprint"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_BlueprintResource"}}}}}},"responses":{"201":{"description":"Create Blueprint response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_BlueprintResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/blueprints/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find blueprint by ID","description":"Returns a blueprint for the account by ID","operationId":"V2GetBlueprint","tags":["blueprint"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each blueprint","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_BlueprintResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update blueprint by ID","description":"Update the blueprint by ID","operationId":"V2UpdateBlueprint","tags":["blueprint"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_BlueprintResource"}}}}}},"responses":{"200":{"description":"Update Blueprint response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_BlueprintResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete blueprint by ID","description":"Delete the blueprint from the account by ID","operationId":"V2DeleteBlueprint","tags":["blueprint"],"responses":{"204":{"description":"The Delete Blueprint was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/blueprints/{id}/duplications":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Duplicate blueprint by ID","description":"Duplicates a blueprint (and its items) for the account by ID and returns the newly created blueprint","operationId":"V2DuplicateBlueprint","tags":["blueprint"],"responses":{"201":{"description":"Newly duplicated blueprint response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_BlueprintResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/business-units":{"get":{"summary":"List business units for account","description":"Returns a paged list of business units for the account","operationId":"V2ListBusinessUnitsForAccount","tags":["business unit"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active business units, false for archived business units","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each business unit","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Business Unit list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_BusinessUnitResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create business unit for account","description":"Create a business unit for the account","operationId":"V2CreateBusinessUnit","tags":["business unit"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_BusinessUnitResource"}}}}}},"responses":{"201":{"description":"Create BusinessUnit response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_BusinessUnitResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/business-units/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find business unit by ID","description":"Returns a business unit for the account by ID","operationId":"V2GetBusinessUnit","tags":["business unit"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each business unit","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_BusinessUnitResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update business unit by ID","description":"Update the business unit by ID","operationId":"V2UpdateBusinessUnit","tags":["business unit"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_BusinessUnitResource"}}}}}},"responses":{"200":{"description":"Update BusinessUnit response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_BusinessUnitResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete business unit by ID","description":"Delete the business unit from the account by ID","operationId":"V2DeleteBusinessUnit","tags":["business unit"],"responses":{"204":{"description":"The business unit was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/business-units/{business_unit_id}/special-conditions":{"parameters":[{"$ref":"#/components/parameters/business_unit_id_parameter"}],"get":{"summary":"List special conditions for business unit","description":"Returns a paged list of special conditions for the business unit","operationId":"V2ListSpecialConditionsForBusinessUnit","tags":["business unit"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each business unit","schema":{"type":"array","items":{"type":"string","enum":["owner","service-condition"]}}}],"responses":{"200":{"description":"special condition list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create special condition for business unit","description":"Create a special condition for the business unit","operationId":"V2CreateSpecialConditionForBusinessUnit","tags":["business unit"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"responses":{"201":{"description":"Create special condition response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/business-units/{business_unit_id}/special-conditions/{id}":{"parameters":[{"$ref":"#/components/parameters/business_unit_id_parameter"},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find business unit special condition by ID","description":"Returns a business unit special condition","operationId":"V2GetBusinessUnitSpecialConditionById","tags":["business unit"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each business unit","schema":{"type":"array","items":{"type":"string","enum":["owner","service-condition"]}}}],"responses":{"200":{"description":"Find special condition by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update business unit special condition by ID","description":"Update the business unit special condition by ID","operationId":"V2UpdateBusinessUnitSpecialCondition","tags":["business unit"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"responses":{"200":{"description":"Update business unit special condition response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete business unit special condition by ID","description":"Delete the business unit special condition","operationId":"V2DeleteBusinessUnitSpecialCondition","tags":["business unit"],"responses":{"204":{"description":"The special condition was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/clients":{"get":{"summary":"List clients for account","description":"Returns a paged list of clients for the account","operationId":"V2ListClientsForAccount","tags":["client"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the client","schema":{"type":"string"}},{"name":"filter[domain]","in":"query","required":false,"description":"String of characters in the domain of the client","schema":{"type":"string"}},{"name":"filter[id]","in":"query","required":false,"description":"IDs of clients if a select group is required","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","active","-active","name","-name","msa-date","-msa-date","domain","-domain","user-defined-fields","-user-defined-fields"]}}},{"name":"filter[active]","in":"query","required":false,"description":"true for active clients, false for archived clients","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each client","schema":{"type":"array","items":{"type":"string","enum":["account","rate-table","contacts"]}}}],"responses":{"200":{"description":"Client list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ClientResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_RateTableResource"},{"$ref":"#/components/schemas/v2_ContactResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create client for account","description":"Create a client for the account","operationId":"V2CreateClient","tags":["client"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ClientResource"}}}}}},"responses":{"201":{"description":"Create Client response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ClientResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/clients/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find client by ID","description":"Returns a client for the account by ID","operationId":"V2GetClient","tags":["client"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each client","schema":{"type":"array","items":{"type":"string","enum":["account","rate-table","contacts"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ClientResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_RateTableResource"},{"$ref":"#/components/schemas/v2_ContactResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update client by ID","description":"Update the client by ID","operationId":"V2UpdateClient","tags":["client"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ClientResource"}}}}}},"responses":{"200":{"description":"Update Client response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ClientResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete client by ID","description":"Delete the client from the account by ID","operationId":"V2DeleteClient","tags":["client"],"responses":{"204":{"description":"The client was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/clients/downloads":{"get":{"summary":"Download active clients as CSV","description":"Returns a CSV of all active clients for the account, sorted alphabetically by name, with a column for each client user-defined field","operationId":"V2DownloadClientsCsv","tags":["client"],"responses":{"200":{"description":"CSV file of active clients","content":{"text/csv":{"schema":{"type":"string"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/clients/{id}/merge-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Merge another client into this client record","description":"This client will be active, the other client will be inactive, and all projects from the other client will be assigned to this client","operationId":"V2MergeClientRecords","tags":["client"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"id":{"type":"integer","description":"The ID of the client that will remain active.  This must match the ID in the URL"},"type":{"type":"string","example":"clients"},"attributes":{"type":"object","properties":{"client-id":{"type":"integer","description":"ID of the client whose projects will be assigned to this client and then archived"}}}}}}}}}},"responses":{"204":{"description":"Clients successfully merged"},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/clients/{client_id}/contacts":{"parameters":[{"$ref":"#/components/parameters/client_id_parameter"}],"get":{"summary":"List contacts for client","description":"Returns a paged list of contacts for client","operationId":"V2ListContactsForClient","tags":["client"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"Characters in the name of the contact","schema":{"type":"string"}},{"name":"filter[email]","in":"query","required":false,"description":"Characters in the email address of the contact","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active contacts, false for archived contacts","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"contact list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ContactResource"}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create contact for client","description":"Create a contact for client","operationId":"V2CreateContactForClient","tags":["client"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ContactResource"}}}}}},"responses":{"201":{"description":"Create contact response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ContactResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/clients/{client_id}/contacts/{id}":{"parameters":[{"$ref":"#/components/parameters/client_id_parameter"},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find client contact by ID","description":"Returns a client contact","operationId":"V2GetClientContactById","tags":["client"],"responses":{"200":{"description":"Find contact by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ContactResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update client contact by ID","description":"Update the client contact by ID","operationId":"V2UpdateClientContact","tags":["client"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ContactResource"}}}}}},"responses":{"200":{"description":"Update client contact response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ContactResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete client contact by ID","description":"Delete the client contact","operationId":"V2DeleteClientContact","tags":["client"],"responses":{"204":{"description":"The Delete contact was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/clients/{client_id}/special-conditions":{"parameters":[{"$ref":"#/components/parameters/client_id_parameter"}],"get":{"summary":"List special conditions for client","description":"Returns a paged list of special conditions for the client","operationId":"V2ListSpecialConditionsForClient","tags":["client"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each client","schema":{"type":"array","items":{"type":"string","enum":["owner","service-condition"]}}}],"responses":{"200":{"description":"special condition list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create special condition for client","description":"Create a special condition for the client","operationId":"V2CreateSpecialConditionForClient","tags":["client"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"responses":{"201":{"description":"Create special condition response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/clients/{client_id}/special-conditions/{id}":{"parameters":[{"$ref":"#/components/parameters/client_id_parameter"},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find client special condition by ID","description":"Returns a client special condition","operationId":"V2GetClientSpecialConditionById","tags":["client"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each client","schema":{"type":"array","items":{"type":"string","enum":["owner","service-condition"]}}}],"responses":{"200":{"description":"Find special condition by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update client special condition by ID","description":"Update the client special condition by ID","operationId":"V2UpdateClientSpecialCondition","tags":["client"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"responses":{"200":{"description":"Update client special condition response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete client special condition by ID","description":"Delete the client special condition","operationId":"V2DeleteClientSpecialCondition","tags":["client"],"responses":{"204":{"description":"The special condition was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/collaborators":{"get":{"summary":"List collaborators for account","description":"Returns a paged list of collaborators for the account","operationId":"V2ListCollaboratorsForAccount","tags":["collaborator"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the collaborator","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active collaborators, false for archived collaborators","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each collaborator","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Collaborator list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_CollaboratorResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/collaborators/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find collaborator by ID","description":"Returns a collaborator for the account by ID","operationId":"V2GetCollaboratorById","tags":["collaborator"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each collaborator","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Find collaborator by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_CollaboratorResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/contacts":{"get":{"summary":"List contacts","description":"Returns a paged list of contacts","operationId":"V2ListContactsForAccount","tags":["contact"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"Characters in the name of the contact","schema":{"type":"string"}},{"name":"filter[email]","in":"query","required":false,"description":"Characters in the email address of the contact","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active contacts, false for archived contacts","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"contact list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ContactResource"}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create contact","description":"Create a contact","operationId":"V2CreateContact","tags":["contact"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ContactResource"}}}}}},"responses":{"201":{"description":"Create contact response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ContactResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/contacts/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find contact by ID","description":"Returns a contact","operationId":"V2GetContactById","tags":["contact"],"responses":{"200":{"description":"Find contact by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ContactResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update contact by ID","description":"Update the contact by ID","operationId":"V2UpdateContact","tags":["contact"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ContactResource"}}}}}},"responses":{"200":{"description":"Update contact response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ContactResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete contact by ID","description":"Delete the contact","operationId":"V2DeleteContact","tags":["contact"],"responses":{"204":{"description":"The Delete contact was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/crm-opportunities":{"get":{"summary":"List CRM opportunities imported for the account","description":"Returns a paged list of CRM Opportunities for the account","operationId":"V2ListCrmOpportunitiesForAccount","tags":["crm opportunity"],"parameters":[{"name":"filter[is-closed]","in":"query","required":false,"description":"true for opportunities the CRM considers closed, false for open ones. Defaults to false, so closed opportunities are omitted unless you send true","schema":{"type":"boolean","default":false}},{"name":"filter[display-name]","in":"query","required":false,"description":"Characters in the display name of the CRM opportunity","schema":{"type":"string"}},{"name":"filter[opportunity-id]","in":"query","required":false,"description":"The ID of the opportunity provided by the CRM","schema":{"type":"string"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each CRM opportunity","schema":{"type":"array","items":{"type":"string","enum":["account","projects"]}}}],"responses":{"200":{"description":"CRM Opportunity list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_CrmOpportunityResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ProjectResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/currencies":{"get":{"summary":"List currencies for account","description":"Returns a paged list of currencies for the account","operationId":"V2ListCurrencysForAccount","tags":["currency"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active projects, false for archived projects","schema":{"type":"boolean","default":true}},{"name":"filter[default]","in":"query","required":false,"description":"true for the default currency or the account, false for other currencies","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each currency","schema":{"type":"array","items":{"type":"string","enum":["account","rate-tables","users"]}}}],"responses":{"200":{"description":"Currency list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_CurrencyResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_RateTableResource"},{"$ref":"#/components/schemas/v2_UserResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create client for account","description":"Create a client for the account","operationId":"V2CreateCurrency","tags":["currency"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_CurrencyResource"}}}}}},"responses":{"201":{"description":"Create Currency response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_CurrencyResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/currencies/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find currency by ID","description":"Returns a currency for the account by ID","operationId":"V2GetCurrency","tags":["currency"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each currency","schema":{"type":"array","items":{"type":"string","enum":["account","rate-tables","users"]}}}],"responses":{"200":{"description":"Currency response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_CurrencyResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_RateTableResource"},{"$ref":"#/components/schemas/v2_UserResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update currency by ID","description":"Update the currency by ID","operationId":"V2UpdateCurrency","tags":["currency"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_CurrencyResource"}}}}}},"responses":{"200":{"description":"Update Currency response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_CurrencyResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete currency by ID","description":"Delete the currency from the account by ID","operationId":"V2DeleteCurrency","tags":["currency"],"responses":{"204":{"description":"The Delete Currency was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/customer-successes":{"get":{"summary":"List customer successes for project or account","description":"Returns a paged list of customer successes for the project or account","operationId":"V2ListCustomerSuccesses","tags":["customer success"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"True for records in active use; false for soft-deleted records","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each blueprint","schema":{"type":"array","items":{"type":"string","enum":["project","account","performance-indicators"]}}}],"responses":{"200":{"description":"Project Contact list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_CustomerSuccessResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_PerformanceIndicatorResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create customer successes for project","description":"Create a customer success for the project","operationId":"V2CreateCustomerSuccess","tags":["customer success"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_CustomerSuccessResource"}}}}}},"responses":{"201":{"description":"Create Project Contact response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_CustomerSuccessResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/customer-successes/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find customer success by ID","description":"Returns a customer success for the project by ID","operationId":"V2GetCustomerSuccess","tags":["customer success"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each blueprint","schema":{"type":"array","items":{"type":"string","enum":["project","account","performance-indicators"]}}}],"responses":{"200":{"description":"Project Contact list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_CustomerSuccessResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_PerformanceIndicatorResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update customer success by ID","description":"Update the customer success by ID","operationId":"V2UpdateCustomerSuccess","tags":["customer success"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_CustomerSuccessResource"}}}}}},"responses":{"200":{"description":"Update Project Contact response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_CustomerSuccessResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete customer success by ID","description":"Delete the customer success from the project by ID","operationId":"V2DeleteCustomerSuccess","tags":["customer success"],"responses":{"204":{"description":"The Project Contact was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/document-deliveries":{"get":{"summary":"List document delivries for an account, project, or project document","description":"Returns a paged list of document deliveries","operationId":"V2ListDocumentDeliveriesForAccount","tags":["document delivery"],"parameters":[{"name":"filter[project_document]","in":"query","required":false,"description":"ID of the project document for which the document deliver was scheduled","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active document delivery, false for archived document delivery","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each document delivery","schema":{"type":"array","items":{"type":"string","enum":["project"]}}}],"responses":{"200":{"description":"Document delivery list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_DocumentDeliveryResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/document-deliveries/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find document delivery by ID","description":"Returns a document delivery by ID","operationId":"V2GetDocumentDelivery","tags":["document delivery"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each document delivery","schema":{"type":"array","items":{"type":"string","enum":["project"]}}}],"responses":{"200":{"description":"Document delivery response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_DocumentDeliveryResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/document-requests":{"get":{"summary":"List document requests for account","description":"Returns a paged list of document requests for the account","operationId":"V2ListDocumentRequestsForAccount","tags":["document requests"],"parameters":[{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","status","-status","delivery-type","-delivery-type","email-list","-email-list","force-regeneration","-force-regeneration","generate-pdf","-generate-pdf","document-url","-document-url","templates","-templates","account-connection-id","-account-connection-id","drive-id","-drive-id","filepath","-filepath"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each document requests","schema":{"type":"array","items":{"type":"string","enum":["project","document-deliveries","project-documents"]}}}],"responses":{"200":{"description":"Document Request list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_DocumentRequestResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_DocumentDeliveryResource"},{"$ref":"#/components/schemas/v2_ProjectDocumentResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create document requests for account","description":"Create a document requests for the account","operationId":"V2CreateDocumentRequest","tags":["document requests"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_DocumentRequestResource"}}}}}},"responses":{"201":{"description":"Create DocumentRequest response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_DocumentRequestResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/document-requests/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find document requests by ID","description":"Returns a document requests for the account by ID","operationId":"V2GetDocumentRequest","tags":["document requests"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each document requests","schema":{"type":"array","items":{"type":"string","enum":["project","document-deliveries","project-documents"]}}}],"responses":{"200":{"description":"Document Request response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_DocumentRequestResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_DocumentDeliveryResource"},{"$ref":"#/components/schemas/v2_ProjectDocumentResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update document requests by ID","description":"Update the document requests by ID","operationId":"V2UpdateDocumentRequest","tags":["document requests"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_DocumentRequestResource"}}}}}},"responses":{"200":{"description":"Update Document Request response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_DocumentRequestResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete document requests by ID","description":"Delete the document requests from the account by ID","operationId":"V2DeleteDocumentRequest","tags":["document requests"],"responses":{"204":{"description":"The document requests was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/document-templates":{"get":{"summary":"List document templates for account","description":"Returns a paged list of document templates for the account","operationId":"V2ListDocumentTemplatesForAccount","tags":["document template"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the document template","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"explode":false,"description":"true for active document templates, false for archived document templates","schema":{"type":"array","items":{"type":"boolean"}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each document template","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Document Template list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_DocumentTemplateResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create document template for account","description":"Create a document template for the account","operationId":"V2CreateDocumentTemplate","tags":["document template"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_DocumentTemplateResource"}}}}}},"responses":{"201":{"description":"Create DocumentTemplate response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_DocumentTemplateResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/document-templates/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find document template by ID","description":"Returns a document template for the account by ID","operationId":"V2GetDocumentTemplate","tags":["document template"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each document template","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Document template response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_DocumentTemplateResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update document template by ID","description":"Update the document template by ID. An update that leaves the format as word_template needs a file uploaded first with POST /v2/document-templates/{id}/uploads; without one it returns 422 (merge-template can't be blank)","operationId":"V2UpdateDocumentTemplate","tags":["document template"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_DocumentTemplateResource"}}}}}},"responses":{"200":{"description":"Update DocumentTemplate response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_DocumentTemplateResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete document template by ID","description":"Delete the document template from the account by ID","operationId":"V2DeleteDocumentTemplate","tags":["document template"],"responses":{"204":{"description":"The document template was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/document-templates/{id}/restore-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Restore the document template by ID","description":"Restore the document template","operationId":"V2RestoreDocumentTemplate","tags":["document template"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_DocumentTemplateResource"}}}}}},"responses":{"200":{"description":"Update document template response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_DocumentTemplateResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/document-templates/filename-format-options":{"get":{"summary":"Retrieves document template file format options","description":"Retrieves document template file format options","operationId":"V2GetFilenameFormatOptions","tags":["document template"],"responses":{"200":{"description":"Document template response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"filename-format":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/document-templates/{id}/downloads":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Download the merge template document attached to the document template","operationId":"V2DownloadDocumentTemplate","tags":["document template"],"responses":{"200":{"description":"Successful file download","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/document-templates/{id}/uploads":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Replace the merge template document with the provided document","operationId":"V2UploadDocumentTemplate","tags":["document template"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"document_template[merge_template]":{"description":"The file to be used as a merge template","type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"The merge template file was saved successfully"},"422":{"description":"The merge template file could not be saved successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/expense-categories":{"get":{"summary":"List expense categorys for account","description":"Returns a paged list of expense categorys for the account","operationId":"V2ListExpenseCategoriessForAccount","tags":["expense category"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active expense categories, false for archived expense categories","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each expense category","schema":{"type":"array","items":{"type":"string","enum":["account","phase"]}}},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","active","-active","name","-name","rate","-rate","use-resource-rate","-use-resource-rate","markup","-markup","variable","-variable","status","-status"]}}}],"responses":{"200":{"description":"Expense category list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ExpenseCategoryResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_PhaseResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create expense category for account","description":"Create an expense category for the account","operationId":"V2CreateExpenseCategory","tags":["expense category"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ExpenseCategoryResource"}}}}}},"responses":{"201":{"description":"Create Expense Category response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ExpenseCategoryResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/expense-categories/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find expense category by ID","description":"Returns a expense category for the account by ID","operationId":"V2GetExpenseCategoryById","tags":["expense category"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each expense category","schema":{"type":"array","items":{"type":"string","enum":["account","phase"]}}}],"responses":{"200":{"description":"Find expense category by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_ExpenseCategoryResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_PhaseResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update expense category by ID","description":"Update the expense category by ID","operationId":"V2UpdateExpenseCategory","tags":["expense category"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ExpenseCategoryResource"}}}}}},"responses":{"200":{"description":"Update Expense Category response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ExpenseCategoryResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete expense category by ID","description":"Delete the expense category from the account by ID","operationId":"V2DeleteExpenseCategory","tags":["expense category"],"responses":{"204":{"description":"The Delete Expense Category was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/external-requests":{"get":{"summary":"List external requests for account","description":"Returns a paged list of external requests for the account","operationId":"V2ListExternalRequestsForAccount","tags":["external request"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project that initiated the partner request","schema":{"type":"string"}},{"name":"filter[subcontractor]","in":"query","required":false,"description":"ID of the subcontractor that was requested for the partner request","schema":{"type":"string"}},{"name":"filter[subproject]","in":"query","required":false,"description":"ID of the subcontractor project that was offered for the partner request","schema":{"type":"string"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each client","schema":{"type":"array","items":{"type":"string","enum":["account","project","lob","subcontractor","subproject"]}}}],"responses":{"200":{"description":"External Request list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ExternalRequestResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_LobResource"},{"$ref":"#/components/schemas/v2_SubcontractorResource"},{"$ref":"#/components/schemas/v2_SubprojectResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/external-requests/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find external request by ID","description":"Returns a external request for the account by ID","operationId":"V2GetExternalRequest","tags":["external request"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each client","schema":{"type":"array","items":{"type":"string","enum":["account","project","lob","subcontractor","subproject"]}}}],"responses":{"200":{"description":"External Request response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ExternalRequestResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_LobResource"},{"$ref":"#/components/schemas/v2_SubcontractorResource"},{"$ref":"#/components/schemas/v2_SubprojectResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/external-requests/{id}/acceptances":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Accept a external request","description":"Accept a external request by ID on behalf of the subcontactor","operationId":"V2AcceptExternalRequest","tags":["external request"],"responses":{"200":{"description":"Accept External Request response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ExternalRequestResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/external-requests/{id}/offers":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Offer services for a external request","description":"Offer to provide services as a subcontractor on a external request","operationId":"V2OfferExternalRequest","tags":["external request"],"responses":{"200":{"description":"Offer External Request response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ExternalRequestResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/external-requests/{id}/declinations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Decline a external request","description":"Decline the request to provide services as a subcontractor on a external request","operationId":"V2DeclineExternalRequest","tags":["external request"],"responses":{"200":{"description":"Decline External Request response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ExternalRequestResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/partner-requests/{id}/external-services":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"List external services for a partner request","description":"Returns a paged list of project services for the partner request","operationId":"V2ListPartnerRequestExternalServices","tags":["partner request"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each service","schema":{"type":"array","items":{"type":"string","enum":["source","project-phase","project-task","subtasks"]}}}],"responses":{"200":{"description":"List of services offered by the subproject on a partner request","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ThirdPartyServiceResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectPhaseResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/governances":{"get":{"summary":"List governances for account","description":"Returns a paged list of governances for the account","operationId":"V2ListGovernancesForAccount","tags":["governance"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the governance","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active governances, false for archived governances","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each governance","schema":{"type":"array","items":{"type":"string","enum":["account","resource","phase","service-category"]}}}],"responses":{"200":{"description":"Governance list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_GovernanceResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_PhaseResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create governance for account","description":"Create a governance for the account","operationId":"V2CreateGovernance","tags":["governance"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_GovernanceResource"}}}}}},"responses":{"201":{"description":"Create Governance response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_GovernanceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/governances/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find governance by ID","description":"Returns a governance for the account by ID","operationId":"V2GetGovernanceById","tags":["governance"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each governance","schema":{"type":"array","items":{"type":"string","enum":["account","resource","phase","service-category"]}}}],"responses":{"200":{"description":"Find governance by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_GovernanceResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_PhaseResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update governance by ID","description":"Update the governance by ID","operationId":"V2UpdateGovernance","tags":["governance"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_GovernanceResource"}}}}}},"responses":{"200":{"description":"Update Governance response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_GovernanceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete governance by ID","description":"Delete the governance from the account by ID","operationId":"V2DeleteGovernance","tags":["governance"],"responses":{"204":{"description":"The governance was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/governances/{id}/moves":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"patch":{"summary":"Move the governance into a new position in the list by ID","description":"Moves the governance into its new position and Returns a governance for the account by ID","operationId":"V2ChangeGovernancePositionById","tags":["governance"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_GovernanceResource"}}}}}},"responses":{"200":{"description":"Find governance by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_GovernanceResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/governances/{id}/restore-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Restore a soft-deleted governance by ID","description":"Clears deleted_at on the governance, returning it to the active set","operationId":"V2RestoreGovernanceById","tags":["governance"],"responses":{"200":{"description":"Restored governance response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_GovernanceResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/governances/{id}/purge-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"delete":{"summary":"Permanently delete a soft-deleted governance by ID","description":"Hard-deletes the governance record. Only valid for governances that have already been soft-deleted.","operationId":"V2PurgeGovernanceById","tags":["governance"],"responses":{"204":{"description":"The governance was purged successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/integrated-products":{"get":{"summary":"List Products available in an integrated product source","description":"Returns a paged list of products from the integrated product source","operationId":"V2ListIntegratedProducts","tags":["integrated products"],"parameters":[{"name":"filter[account-connection]","in":"query","required":false,"description":"Account connection ID designating which product integration should be used.","schema":{"type":"string"}},{"name":"filter[product-id]","in":"query","required":false,"description":"External Product ID defined in the integrated product source.","schema":{"type":"string"}},{"name":"filter[name]","in":"query","required":false,"description":"Sequence of characters in the name of the product","schema":{"type":"string"}},{"name":"filter[manufacturer-part-number]","in":"query","required":false,"description":"Sequence of characters in the manufacturer part number of the product","schema":{"type":"string"}},{"name":"filter[manufacturer-name]","in":"query","required":false,"description":"Sequence of characters in the name of the product manufacturer","schema":{"type":"string"}},{"name":"filter[vendor-name]","in":"query","required":false,"description":"Sequence of characters in the name of the product vendor","schema":{"type":"string"}},{"name":"filter[sku]","in":"query","required":false,"description":"Sequence of characters in the product SKU","schema":{"type":"string"}},{"name":"filter[category]","in":"query","required":false,"description":"Sequence of characters in the product category","schema":{"type":"string"}},{"name":"filter[subcategory]","in":"query","required":false,"description":"Sequence of characters in the product subcategory","schema":{"type":"string"}},{"name":"page[number]","in":"query","required":false,"description":"When paginating, which page number is being requested","schema":{"type":"number"}},{"name":"page[size]","in":"query","required":false,"description":"When paginating, maximum number of records per page","schema":{"type":"number"}}],"responses":{"200":{"description":"Integrated Products list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_IntegratedProductResource"}},"links":{"$ref":"#/components/schemas/v2_paging"},"meta":{"type":"object","properties":{"record-count":{"type":"integer"}}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/language-fields":{"get":{"summary":"List language fields for account","description":"Returns a paged list of language fields for the account","operationId":"V2ListLanguageFieldsForAccount","tags":["language field"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active language fields, false for archived language fields","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each language field","schema":{"type":"array","items":{"type":"string","enum":["account","project-expenses"]}}}],"responses":{"200":{"description":"Langauge field list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_LanguageFieldResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ProjectExpenseResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create language field for account","description":"Create a language field for the account","operationId":"V2CreateLanguageField","tags":["language field"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LanguageFieldResource"}}}}}},"responses":{"201":{"description":"Create Language Field response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LanguageFieldResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/language-fields/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find language field by ID","description":"Returns a language field for the account by ID","operationId":"V2GetLanguageFieldById","tags":["language field"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each language field","schema":{"type":"array","items":{"type":"string","enum":["account","project-expenses"]}}}],"responses":{"200":{"description":"Find language field by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LanguageFieldResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ProjectExpenseResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update language field by ID","description":"Update the language field by ID","operationId":"V2UpdateLanguageField","tags":["language field"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LanguageFieldResource"}}}}}},"responses":{"200":{"description":"Update Language Field response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LanguageFieldResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete language field by ID","description":"Delete the language field from the account by ID","operationId":"V2DeleteLanguageField","tags":["language field"],"responses":{"204":{"description":"The Delete Language Field was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/language-fields/{id}/moves":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"patch":{"summary":"Move the language field into a new position in the list by ID","description":"Moves the language field into its new position and Returns a language field for the account by ID","operationId":"V2ChangeLanguageFieldPositionById","tags":["language field"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LanguageFieldResource"}}}}}},"responses":{"200":{"description":"Find language field by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LanguageFieldResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/services/{service_id}/level-of-efforts":{"parameters":[{"$ref":"#/components/parameters/service_id_parameter"}],"get":{"summary":"Retrieves levels of effort","description":"Retrieves levels of effort","operationId":"V2GetServiceLevelsOfEffort","tags":["service"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Service levels of effort retreived successfully","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_LevelOfEffortResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create level of effort","description":"Create level of effort","operationId":"V2CreateLevelOfEffortForService","tags":["service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LevelOfEffortResource"}}}}}},"responses":{"201":{"description":"Create level of effort response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LevelOfEffortResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/services/{service_id}/level-of-efforts/{id}":{"parameters":[{"$ref":"#/components/parameters/service_id_parameter"},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Retrieves level of effort","description":"Retrieves level of effort","operationId":"V2GetServiceLevelOfEffort","tags":["service"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Level of effort retreived successfully","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_LevelOfEffortResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"patch":{"summary":"Update level of effort","description":"Update level of effort","operationId":"V2UpdateLevelOfEffortForService","tags":["service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LevelOfEffortResource"}}}}}},"responses":{"201":{"description":"Create level of effort response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LevelOfEffortResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete level of effort by ID","description":"Delete the level of effort by ID","operationId":"V2DeleteLevelOfEffortFromService","tags":["service"],"responses":{"204":{"description":"The level of effort was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/subservices/{subservice_id}/level-of-efforts":{"parameters":[{"$ref":"#/components/parameters/subservice_id_parameter"}],"get":{"summary":"Retrieves levels of effort","description":"Retrieves levels of effort","operationId":"V2GetSubserviceLevelsOfEffort","tags":["subservice"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Subservice levels of effort retreived successfully","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_LevelOfEffortResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create level of effort","description":"Create level of effort","operationId":"V2CreateLevelOfEffortForSubservice","tags":["subservice"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LevelOfEffortResource"}}}}}},"responses":{"201":{"description":"Create level of effort response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LevelOfEffortResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/subservices/{subservice_id}/level-of-efforts/{id}":{"parameters":[{"$ref":"#/components/parameters/subservice_id_parameter"},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Retrieves level of effort","description":"Retrieves level of effort","operationId":"V2GetSubserviceLevelOfEffort","tags":["subservice"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Level of effort retreived successfully","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_LevelOfEffortResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"patch":{"summary":"Update level of effort","description":"Update level of effort","operationId":"V2UpdateLevelOfEffortForSubservice","tags":["subservice"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LevelOfEffortResource"}}}}}},"responses":{"201":{"description":"Create level of effort response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LevelOfEffortResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete level of effort by ID","description":"Delete the level of effort by ID","operationId":"V2DeleteLevelOfEffortFromSubservice","tags":["subservice"],"responses":{"204":{"description":"The level of effort was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/line-of-businesses":{"get":{"summary":"List line of businesses for account","description":"Returns a paged list of line of busineses for the account","operationId":"V2ListLineOfBusinessesForAccount","tags":["line of business"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the line of business","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active line of business, false for archived line of business","schema":{"default":true,"type":"boolean"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each line of business","schema":{"type":"array","items":{"type":"string","enum":["account","service-approvers"]}}}],"responses":{"200":{"description":"LineOfBusiness list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_LineOfBusinessResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ServiceApproverResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create line of business for account","description":"Create a line of business for the account","operationId":"V2CreateLineOfBusiness","tags":["line of business"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LineOfBusinessResource"}}}}}},"responses":{"201":{"description":"Create LineOfBusiness response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LineOfBusinessResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/line-of-businesses/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find line of business by ID","description":"Returns a line of business for the account by ID","operationId":"V2GetLineOfBusiness","tags":["line of business"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each line of business","schema":{"type":"array","items":{"type":"string","enum":["account","service-approvers"]}}}],"responses":{"200":{"description":"Line of Business response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LineOfBusinessResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ServiceApproverResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update line of business by ID","description":"Update the line of business by ID","operationId":"V2UpdateLineOfBusiness","tags":["line of business"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LineOfBusinessResource"}}}}}},"responses":{"200":{"description":"Update Line Of Business response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LineOfBusinessResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete line of business by ID","description":"Delete the line of business from the account by ID","operationId":"V2DeleteLineOfBusiness","tags":["line of business"],"responses":{"204":{"description":"The Delete Line Of Business was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/line-of-businesses/{id}/moves":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"patch":{"summary":"Move the line of business into a new position in the list by ID","description":"Moves the line of business into its new position and returns updated line of business","operationId":"V2ChangeLineOfBusinessPositionById","tags":["line of business"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LineOfBusinessResource"}}}}}},"responses":{"200":{"description":"Find line of business by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LineOfBusinessResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/line-of-businesses/{id}/restore-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Restore a soft-deleted line of business by ID","description":"Clears deleted_at on the line of business, returning it to the active set","operationId":"V2RestoreLineOfBusinessById","tags":["line of business"],"responses":{"200":{"description":"Restored line of business response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_LineOfBusinessResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/line-of-businesses/{id}/purge-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"delete":{"summary":"Permanently delete a soft-deleted line of business by ID","description":"Hard-deletes the line of business record. Only valid for soft-deleted records.","operationId":"V2PurgeLineOfBusinessById","tags":["line of business"],"responses":{"204":{"description":"The line of business was purged successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/me":{"get":{"summary":"Information about the current user","description":"Information about the current user including account ID and account slug that can be used for later queries","operationId":"V2WhoAmI","tags":["me"],"responses":{"200":{"description":"Who Am I response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_MeResource"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/projects/{project_id}/notes":{"parameters":[{"$ref":"#/components/parameters/project_id_parameter"}],"get":{"summary":"List notes for project or account","description":"Returns a paged list of notes for the project or account","operationId":"V2ListNotes","tags":["note"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each note","schema":{"type":"array","items":{"type":"string","enum":["project"]}}}],"responses":{"200":{"description":"Project Contact list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_NoteResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create notes for project","description":"Create a note for the project","operationId":"V2CreateNote","tags":["note"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_NoteResource"}}}}}},"responses":{"201":{"description":"Create Project Contact response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_NoteResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/projects/{project_id}/notes/{id}":{"parameters":[{"$ref":"#/components/parameters/project_id_parameter"},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find note by ID","description":"Returns a note for the project by ID","operationId":"V2GetNote","tags":["note"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each note","schema":{"type":"array","items":{"type":"string","enum":["project"]}}}],"responses":{"200":{"description":"Project Contact list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_NoteResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update note by ID","description":"Update the note by ID","operationId":"V2UpdateNote","tags":["note"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_NoteResource"}}}}}},"responses":{"200":{"description":"Update Project Contact response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_NoteResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete note by ID","description":"Delete the note from the project by ID","operationId":"V2DeleteNote","tags":["note"],"responses":{"204":{"description":"The Project Contact was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/partner-requests":{"get":{"summary":"List partner_requests for account","description":"Returns a paged list of partner_requests for the account","operationId":"V2ListPartnerRequestsForAccount","tags":["partner request"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project that initiated the partner request","schema":{"type":"string"}},{"name":"filter[subcontractor]","in":"query","required":false,"description":"ID of the subcontractor that was requested for the partner request","schema":{"type":"string"}},{"name":"filter[subproject]","in":"query","required":false,"description":"ID of the subcontractor project that was offered for the partner request","schema":{"type":"string"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each client","schema":{"type":"array","items":{"type":"string","enum":["account","project","lob","subcontractor","currency","third-party-services"]}}}],"responses":{"200":{"description":"Partner Request list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_PartnerRequestResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_LobResource"},{"$ref":"#/components/schemas/v2_SubcontractorResource"},{"$ref":"#/components/schemas/v2_CurrencyResource"},{"$ref":"#/components/schemas/v2_ThirdPartyServiceResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create partner_request for account","description":"Create a partner_request for the account","operationId":"V2CreatePartnerRequest","tags":["partner request"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PartnerRequestResource"}}}}}},"responses":{"201":{"description":"Create Partner Request response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PartnerRequestResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/partner-requests/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find partner_request by ID","description":"Returns a partner_request for the account by ID","operationId":"V2GetPartnerRequest","tags":["partner request"],"responses":{"200":{"description":"Partner ReqeuesProjectt response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PartnerRequestResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update partner_request by ID","description":"Update the partner_request by ID","operationId":"V2UpdatePartnerRequest","tags":["partner request"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PartnerRequestResource"}}}}}},"responses":{"200":{"description":"Update Partner Request response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PartnerRequestResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete partner_request by ID","description":"Delete the partner_request from the account by ID","operationId":"V2DeletePartnerRequest","tags":["partner request"],"responses":{"204":{"description":"The Delete Partner Request was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/partner-requests/{id}/completions":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Complete a partner_request","description":"Complete the partner request by accepting the services offered by the subcontactor","operationId":"V2CompletePartnerRequest","tags":["partner request"],"responses":{"200":{"description":"Complete Partner Request response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PartnerRequestResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/partner-requests/{id}/revisions":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Revise a partner_request","description":"Request a revision to the services offered by the subcontractor on a partner request","operationId":"V2RevisePartnerRequest","tags":["partner request"],"responses":{"200":{"description":"Revise Partner Request response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PartnerRequestResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/partner-requests/{id}/declinations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Decline a partner_request","description":"Decline the services offered by a subcontractor on a partner request","operationId":"V2DeclinePartnerRequest","tags":["partner request"],"responses":{"200":{"description":"Decline Partner Request response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PartnerRequestResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/payment-credits":{"get":{"summary":"List payment credits for account","description":"Returns a paged list of payment credits for the account","operationId":"V2ListPaymentCreditsForAccount","tags":["payment credit"],"parameters":[{"name":"filter[payment-source]","in":"query","required":false,"description":"Sequence of characters in the name of the payment source","schema":{"type":"string"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each payment credit","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Payment Credit list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_PaymentCreditResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create payment credit for account","description":"Create a payment credit for the account","operationId":"V2CreatePaymentCredit","tags":["payment credit"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentCreditResource"}}}}}},"responses":{"201":{"description":"Create Payment Credit response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentCreditResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/payment-credits/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find payment credit by ID","description":"Returns a payment credit for the account by ID","operationId":"V2GetPaymentCredit","tags":["payment credit"],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentCreditResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update payment credit by ID","description":"Update the payment credit by ID","operationId":"V2UpdatePaymentCredit","tags":["payment credit"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentCreditResource"}}}}}},"responses":{"200":{"description":"Update Payment Credit response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentCreditResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete payment credit by ID","description":"Delete the payment credit from the account by ID","operationId":"V2DeletePaymentCredit","tags":["payment credit"],"responses":{"204":{"description":"The Delete Payment Credit was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/payment-terms":{"get":{"summary":"List payment terms for account","description":"Returns a paged list of payment terms for the account","operationId":"V2ListPaymentTermsForAccount","tags":["payment term"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active payment credits, false for archived payment credits","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each payment credit","schema":{"type":"array","items":{"type":"string","enum":["account","phase"]}}}],"responses":{"200":{"description":"Payment Term list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_PaymentTermResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_PhaseResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create payment term for account","description":"Create a payment term for the account","operationId":"V2CreatePaymentTerm","tags":["payment term"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentTermResource"}}}}}},"responses":{"201":{"description":"Create Payment Term response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentTermResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/payment-terms/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find payment term by ID","description":"Returns a payment term for the account by ID","operationId":"V2GetPaymentTerm","tags":["payment term"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each payment credit","schema":{"type":"array","items":{"type":"string","enum":["account","phase"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_PaymentTermResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_PhaseResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update payment term by ID","description":"Update the payment term by ID","operationId":"V2UpdatePaymentTerm","tags":["payment term"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentTermResource"}}}}}},"responses":{"200":{"description":"Update Payment Term response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentTermResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete payment term by ID","description":"Delete the payment term from the account by ID","operationId":"V2DeletePaymentTerm","tags":["payment term"],"responses":{"204":{"description":"The Delete Payment Term was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/performance-indicators":{"get":{"summary":"List performance indicators for account","description":"Returns a paged list of performance indicators for the account","operationId":"V2ListPerformanceIndicatorsForAccount","tags":["performance indicator"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active performance indicator, false for archived performance indicator","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each performance indicator","schema":{"type":"array","items":{"type":"string","enum":["customer-success"]}}}],"responses":{"200":{"description":"Performance Indicator list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_PerformanceIndicatorResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_CustomerSuccessResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create performance indicator for account","description":"Create a performance indicator for the account","operationId":"V2CreatePerformanceIndicator","tags":["performance indicator"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PerformanceIndicatorResource"}}}}}},"responses":{"201":{"description":"Create Performance Indicator response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PerformanceIndicatorResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/performance-indicators/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find performance indicator by ID","description":"Returns a performance indicator for the account by ID","operationId":"V2GetPerformanceIndicator","tags":["performance indicator"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each performance indicator","schema":{"type":"array","items":{"type":"string","enum":["customer-success"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PerformanceIndicatorResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_CustomerSuccessResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update performance indicator by ID","description":"Update the performance indicator by ID","operationId":"V2UpdatePerformanceIndicator","tags":["performance indicator"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PerformanceIndicatorResource"}}}}}},"responses":{"200":{"description":"Update Performance Indicator response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PerformanceIndicatorResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete performance indicator by ID","description":"Delete the performance indicator from the account by ID","operationId":"V2DeletePerformanceIndicator","tags":["performance indicator"],"responses":{"204":{"description":"The Delete Performance Indicator was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/phases":{"get":{"summary":"List phases for account","description":"Returns a paged list of phases for the account","operationId":"V2ListPhasesForAccount","tags":["phase"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active phases, false for archived phases","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each phase","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Phase list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_PhaseResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create phase for account","description":"Create a phase for the account","operationId":"V2CreatePhase","tags":["phase"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PhaseResource"}}}}}},"responses":{"201":{"description":"Create Phase response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PhaseResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/phases/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find phase by ID","description":"Returns a phase for the account by ID","operationId":"V2GetPhaseById","tags":["phase"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each phase","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Find phase by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_PhaseResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update phase by ID","description":"Update the phase by ID","operationId":"V2UpdatePhase","tags":["phase"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PhaseResource"}}}}}},"responses":{"200":{"description":"Update Phase response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PhaseResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete phase by ID","description":"Delete the phase from the account by ID","operationId":"V2DeletePhase","tags":["phase"],"responses":{"204":{"description":"The phase was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/phases/{id}/moves":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"patch":{"summary":"Move the phase into a new position in the list by ID","description":"Moves the phase into its new position and returns a phase for the account by ID","operationId":"V2ChangePhasePositionById","tags":["phase"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PhaseResource"}}}}}},"responses":{"200":{"description":"Find phase by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PhaseResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/phases/{id}/restore-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Restore a soft-deleted phase by ID","description":"Clears deleted_at on the phase, returning it to the active set","operationId":"V2RestorePhaseById","tags":["phase"],"responses":{"200":{"description":"Restored phase response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PhaseResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/phases/{id}/purge-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"delete":{"summary":"Permanently delete a soft-deleted phase by ID","description":"Hard-deletes the phase record. Only valid for phases that have already been soft-deleted.","operationId":"V2PurgePhaseById","tags":["phase"],"responses":{"204":{"description":"The phase was purged successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/presales-engineers":{"get":{"summary":"List presales engineers for account","description":"Returns a paged list of presales engineers for the account","operationId":"V2ListPresalesEngineersForAccount","tags":["presales engineer"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the presales engineer","schema":{"type":"string"}},{"name":"filter[email]","in":"query","required":false,"description":"String of characters in the email address of the presales engineer","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active presales engineers, false for archived presales engineers","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each presales engineer","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Presales Engineer list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_PresalesEngineerResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/presales-engineers/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find presales engineer by ID","description":"Returns a presales engineer for the account by ID","operationId":"V2GetPresalesEngineerById","tags":["presales engineer"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each presales engineer","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Find presales engineer by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_PresalesEngineerResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/projects/{project_id}/pricing-adjustments":{"parameters":[{"$ref":"#/components/parameters/project_id_parameter"}],"get":{"summary":"List pricing adjustments for account","description":"Returns a paged list of pricing adjustments for the account","operationId":"V2ListPricingAdjustmentsForAccount","tags":["pricing adjustment"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each pricing adjustment","schema":{"type":"array","items":{"type":"string","enum":["project"]}}}],"responses":{"200":{"description":"PricingAdjustment list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_PricingAdjustmentResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create pricing adjustment for account","description":"Create a pricing adjustment for the account","operationId":"V2CreatePricingAdjustment","tags":["pricing adjustment"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PricingAdjustmentResource"}}}}}},"responses":{"201":{"description":"Create PricingAdjustment response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PricingAdjustmentResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/projects/{project_id}/pricing-adjustments/{id}":{"parameters":[{"$ref":"#/components/parameters/project_id_parameter"},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Update a specific resource","description":"Updates an existing resource with the provided data","operationId":"V2GetPricingAdjustmentById","tags":["pricing adjustment"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each pricing adjustment","schema":{"type":"array","items":{"type":"string","enum":["project"]}}}],"responses":{"200":{"description":"Update resource response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PricingAdjustmentResource"}}}}}}}},"patch":{"summary":"Update pricing adjustment by ID","description":"Updates an existing pricing adjustment with the provided data","operationId":"V2UpdatePricingAdjustmentById","tags":["pricing adjustment"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PricingAdjustmentResource"}}}}}},"responses":{"200":{"description":"Update resource response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PricingAdjustmentResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete pricing adjustment by ID","description":"Delete the pricing adjustment from the account by ID","operationId":"V2DeletePricingAdjustmentById","tags":["pricing adjustment"],"responses":{"204":{"description":"The Pricing Adjustment was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/products/{product_id}/product-accountings":{"parameters":[{"name":"product_id","description":"ID of product","in":"path","required":true,"schema":{"type":"integer"}}],"get":{"summary":"List product accountings","description":"Returns a paged list of product accounting","operationId":"V2ListProductAccountingsForAccount","tags":["product"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each product accounting","schema":{"type":"array","items":{"type":"string","enum":["product","service-category"]}}}],"responses":{"200":{"description":"Product Accounting list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProductAccountingResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProductResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create product accounting for product","description":"Create a product accounting for the product","operationId":"V2CreateProductAccounting","tags":["product"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProductAccountingResource"}}}}}},"responses":{"201":{"description":"Create ProductAccounting response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProductAccountingResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/products/{product_id}/product-accountings/{id}":{"parameters":[{"name":"product_id","description":"ID of product","in":"path","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find product accounting by ID","description":"Returns a product accounting by ID","operationId":"V2GetProductAccounting","tags":["product"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each product accounting","schema":{"type":"array","items":{"type":"string","enum":["product","service-category"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProductAccountingResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProductResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update product accounting by ID","description":"Update the product accounting by ID","operationId":"V2UpdateProductAccounting","tags":["product"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProductAccountingResource"}}}}}},"responses":{"200":{"description":"Update ProductAccounting response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProductAccountingResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete product accounting by ID","description":"Delete the product accounting by ID","operationId":"V2DeleteProductAccounting","tags":["product"],"responses":{"204":{"description":"The product accounting was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/products":{"get":{"summary":"List products for account","description":"Returns a paged list of products for the account","operationId":"V2ListProductsForAccount","tags":["product"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the product","schema":{"type":"string"}},{"name":"filter[category]","in":"query","required":false,"description":"String of characters in the category of the product","schema":{"type":"string"}},{"name":"filter[subcategory]","in":"query","required":false,"description":"String of characters in the subcategory of the product","schema":{"type":"string"}},{"name":"filter[sku]","in":"query","required":false,"description":"String of characters in the sku of the product","schema":{"type":"string"}},{"name":"filter[product-id]","in":"query","required":false,"description":"String of characters in the product_id of the product","schema":{"type":"string"}},{"name":"filter[manufacturer-name]","in":"query","required":false,"description":"String of characters in the manufacturer name of the product","schema":{"type":"string"}},{"name":"filter[manufacturer-part-number]","in":"query","required":false,"description":"String of characters in the manufacturer part number of the product","schema":{"type":"string"}},{"name":"filter[vendor-name]","in":"query","required":false,"description":"String of characters in the name of the product vendor","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active products, false for archived products","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each product","schema":{"type":"array","items":{"type":"string","enum":["account","services"]}}}],"responses":{"200":{"description":"Product list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProductResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ServiceResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create product for account","description":"Create a product for the account","operationId":"V2CreateProduct","tags":["product"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProductResource"}}}}}},"responses":{"201":{"description":"Create Product response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProductResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/products/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find product by ID","description":"Returns a product for the account by ID","operationId":"V2GetProduct","tags":["product"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each product","schema":{"type":"array","items":{"type":"string","enum":["account","services"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProductResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ServiceResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update product by ID","description":"Update the product by ID","operationId":"V2UpdateProduct","tags":["product"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProductResource"}}}}}},"responses":{"200":{"description":"Update Product response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProductResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete product by ID","description":"Delete the product from the account by ID","operationId":"V2DeleteProduct","tags":["product"],"responses":{"204":{"description":"The Delete Product was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-approvals":{"get":{"summary":"List project approvals for account","description":"Returns a paged list of project approvals for the account","operationId":"V2ListProjectApprovalsForAccount","tags":["project approval"],"parameters":[{"name":"filter[approval-step]","in":"query","required":false,"description":"ID of the approval step to which this approval belongs","schema":{"type":"string"}},{"name":"filter[pending-user-approval]","in":"query","required":false,"description":"Comma-separated list of user IDs; returns open (required or optional) approvals assigned to those users on pending approval steps of active projects that are in approval","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","created-at","-created-at"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each client","schema":{"type":"array","items":{"type":"string","enum":["project","user","approval-step"]}}}],"responses":{"200":{"description":"Project Approval list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_UserResource"},{"$ref":"#/components/schemas/v2_ApprovalStepResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project approval for account","description":"Create a project approval for the account","operationId":"V2CreateProjectApproval","tags":["project approval"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}}}}}},"responses":{"201":{"description":"Create Project Approval response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-approvals/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project approval by ID","description":"Returns a project approval for the account by ID","operationId":"V2GetProjectApproval","tags":["project approval"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each client","schema":{"type":"array","items":{"type":"string","enum":["project","user","approval-step"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_UserResource"},{"$ref":"#/components/schemas/v2_ApprovalStepResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project approval by ID","description":"Update the project approval by ID","operationId":"V2UpdateProjectApproval","tags":["project approval"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}}}}}},"responses":{"200":{"description":"Update Project Approval response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete project approval by ID","description":"Delete the project approval from the account by ID","operationId":"V2DeleteProjectApproval","tags":["project approval"],"responses":{"204":{"description":"The Delete Project Approval was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-approvals/{id}/approvals":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Approve project approval request by ID","description":"Approve a project approval request for the account by ID","operationId":"V2ApproveProjectApprovalById","tags":["project approval"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}}}}}},"responses":{"200":{"description":"Update Project Approval response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-approvals/{id}/cancellations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Cancel project approval request by ID","description":"Cancel a project approval request for the account by ID","operationId":"V2CancelProjectApprovalById","tags":["project approval"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}}}}}},"responses":{"200":{"description":"Update Project Approval response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-approvals/{id}/declinations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Decline project approval request by ID","description":"Decline a project approval request for the account by ID","operationId":"V2DeclineProjectApprovalById","tags":["project approval"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}}}}}},"responses":{"200":{"description":"Update Project Approval response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-approvals/{id}/rescope-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Rescope project approval request by ID","description":"Rescope a project approval request for the account by ID","operationId":"V2RescopeProjectApprovalById","tags":["project approval"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}}}}}},"responses":{"200":{"description":"Update Project Approval response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectApprovalResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-attachments":{"get":{"summary":"List project attachments for account","description":"Returns a paged list of project attachments for the account","operationId":"V2ListProjectAttachmentsForAccount","tags":["project attachment"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the attachments are associated","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active attachments, false for archived attachments","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project attachment","schema":{"type":"array","items":{"type":"string","enum":["project","attachment-type"]}}}],"responses":{"200":{"description":"Project Attachment list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectAttachmentResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_AttachmentTypeResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project attachment for project","description":"Create a project attachment for the project","operationId":"V2CreateProjectAttachment","tags":["project attachment"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectAttachmentResource"}}}}}},"responses":{"201":{"description":"Create Project Attachment response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectAttachmentResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-attachments/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project attachment by ID","description":"Returns a project attachment for the account by ID","operationId":"V2GetProjectAttachmentById","tags":["project attachment"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project attachment","schema":{"type":"array","items":{"type":"string","enum":["project","attachment-type"]}}}],"responses":{"200":{"description":"Find project attachment by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_ProjectAttachmentResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_AttachmentTypeResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project attachment by ID","description":"Update the project attachment by ID","operationId":"V2UpdateProjectAttachment","tags":["project attachment"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectAttachmentResource"}}}}}},"responses":{"200":{"description":"Update Project Attachment response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectAttachmentResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete project attachment by ID","description":"Delete the project attachment from the project by ID","operationId":"V2DeleteProjectAttachment","tags":["project attachment"],"responses":{"204":{"description":"The Project Attachment was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-attachments/{id}/downloads":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Download the file attached to the project attachment","operationId":"V2DownloadProjectAttachment","tags":["project attachment"],"responses":{"200":{"description":"Successful file download","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-attachments/{id}/upload":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Replace the file attached to the project attachment with the provided document","operationId":"V2UploadProjectAttachment","tags":["project attachment"],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"properties":{"project_attachment[document]":{"description":"The file to attach to the project","type":"string","format":"binary"}}}}}},"responses":{"201":{"description":"The attached file was saved successfully"},"422":{"description":"The attached file could not be saved successfully; errors explain why"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-collaborators":{"get":{"summary":"List project collaborators for project or account","description":"Returns a paged list of project collaborators for the project or account","operationId":"V2ListProjectCollaborators","tags":["project collaborator"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the project services are attached","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active projects, false for archived projects","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project collaborator","schema":{"type":"array","items":{"type":"string","enum":["project","user"]}}}],"responses":{"200":{"description":"Project Collaborator list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectCollaboratorResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_UserResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create collaborators for project","description":"Create a collaborator for the project","operationId":"V2CreateProjectCollaborator","tags":["project collaborator"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectCollaboratorResource"}}}}}},"responses":{"201":{"description":"Create Project Collaborator response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectCollaboratorResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-collaborators/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project collaborator by ID","description":"Returns a project collaborator for the project by ID","operationId":"V2GetProjectCollaboratorById","tags":["project collaborator"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project collaborator","schema":{"type":"array","items":{"type":"string","enum":["project","user"]}}}],"responses":{"200":{"description":"Project Collaborator list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectCollaboratorResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_UserResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project collaborator by ID","description":"Update the project collaborator by ID","operationId":"V2UpdateProjectCollaborator","tags":["project collaborator"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectCollaboratorResource"}}}}}},"responses":{"200":{"description":"Update Project Collaborator response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectCollaboratorResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete project collaborator by ID","description":"Delete the project collaborator from the project by ID","operationId":"V2DeleteProjectCollaborator","tags":["project collaborator"],"responses":{"204":{"description":"The Project Collaborator was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-conditions":{"get":{"summary":"List project conditions for account","description":"Returns a paged list of project conditions for the account","operationId":"V2ListProjectConditionsForAccount","tags":["project condition"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the conditions are attached","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active project conditions, false for archived project conditions","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project condition","schema":{"type":"array","items":{"type":"string","enum":["project","service-condition"]}}}],"responses":{"200":{"description":"ProjectCondition list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectConditionResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ServiceConditionResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-conditions/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project condition by ID","description":"Returns a project condition for the account by ID","operationId":"V2GetProjectCondition","tags":["project condition"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project condition","schema":{"type":"array","items":{"type":"string","enum":["project","service-condition"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectConditionResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ServiceConditionResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project condition by ID","description":"Update the project condition by ID","operationId":"V2UpdateProjectCondition","tags":["project condition"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectConditionResource"}}}}}},"responses":{"200":{"description":"Update ProjectCondition response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectConditionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete project condition by ID","description":"Delete the project condition from the account by ID","operationId":"V2DeleteProjectCondition","tags":["project condition"],"responses":{"204":{"description":"The Delete ProjectCondition was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-conditions/{id}/skips":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Mark the project condition skipped by ID","description":"Update the status of the project condition to skipped by ID","operationId":"V2SkipProjectCondition","tags":["project condition"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectConditionResource"}}}}}},"responses":{"200":{"description":"Skipped Project Condition response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectConditionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-conditions/{id}/restore-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Mark the project condition active by ID","description":"Update the status of the project condition to active by ID","operationId":"V2RestoreProjectCondition","tags":["project condition"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectConditionResource"}}}}}},"responses":{"200":{"description":"Restored Project Condition response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectConditionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-contacts":{"get":{"summary":"List project contacts for project or account","description":"Returns a paged list of project contacts for the project or account","operationId":"V2ListProjectContacts","tags":["project contact"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the contact are attached","schema":{"type":"string"}},{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the contact","schema":{"type":"string"}},{"name":"filter[email]","in":"query","required":false,"description":"String of characters in the email address of the contact","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active project contacts, false for archived project contacts","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project contact","schema":{"type":"array","items":{"type":"string","enum":["project","contact"]}}}],"responses":{"200":{"description":"Project Contact list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectContactResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ContactResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create contacts for project","description":"Create a contact for the project","operationId":"V2CreateProjectContact","tags":["project contact"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectContactResource"}}}}}},"responses":{"201":{"description":"Create Project Contact response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectContactResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-contacts/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project contact by ID","description":"Returns a project contact for the project by ID","operationId":"V2GetProjectContact","tags":["project contact"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project contact","schema":{"type":"array","items":{"type":"string","enum":["project","contact"]}}}],"responses":{"200":{"description":"Project Contact list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectContactResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ContactResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project contact by ID","description":"Update the project contact by ID","operationId":"V2UpdateProjectContact","tags":["project contact"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectContactResource"}}}}}},"responses":{"200":{"description":"Update Project Contact response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectContactResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete project contact by ID","description":"Delete the project contact from the project by ID","operationId":"V2DeleteProjectContact","tags":["project contact"],"responses":{"204":{"description":"The Project Contact was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-credits":{"get":{"summary":"List project credits for project or account","description":"Returns a paged list of project credits for the project or account","operationId":"V2ListProjectCredits","tags":["project credit"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the credits are attached","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active project credits, false for archived project credits","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project credit","schema":{"type":"array","items":{"type":"string","enum":["project","payment-credit"]}}}],"responses":{"200":{"description":"Project Credit list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectCreditResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_PaymentCreditResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project credit for project","description":"Create a project credit for the project","operationId":"V2CreateProjectCredit","tags":["project credit"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectCreditResource"}}}}}},"responses":{"201":{"description":"Create Project Credit response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectCreditResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-credits/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project credit by ID","description":"Returns a project credit for the project by ID","operationId":"V2GetProjectCreditById","tags":["project credit"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project credit","schema":{"type":"array","items":{"type":"string","enum":["project","payment-credit"]}}}],"responses":{"200":{"description":"Project credit response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectCreditResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_PaymentCreditResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project credit by ID","description":"Update the project credit by ID","operationId":"V2UpdateProjectCredit","tags":["project credit"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectCreditResource"}}}}}},"responses":{"200":{"description":"Update Project Credit response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectCreditResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete project credit by ID","description":"Delete the project credit from the project by ID","operationId":"V2DeleteProjectCredit","tags":["project credit"],"responses":{"204":{"description":"The Project Credit was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/payment-schedules":{"get":{"summary":"List saved payment schedules","description":"Returns saved payment schedules for the account, optionally filtered by project","operationId":"V2ListPaymentSchedules","tags":["payment schedule"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project that owns the schedule","schema":{"type":"string"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Payment schedule list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_PaymentScheduleResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Save a payment schedule for a project","description":"Builds a draft schedule from the project's current pricing and saves it. Returns 422 if the project already has a saved schedule.","operationId":"V2CreatePaymentSchedule","tags":["payment schedule"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentScheduleResource"}}}}}},"responses":{"201":{"description":"Create Payment Schedule response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentScheduleResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/payment-schedules/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find payment schedule by ID","description":"Returns a saved payment schedule by ID","operationId":"V2GetPaymentScheduleById","tags":["payment schedule"],"responses":{"200":{"description":"Payment schedule response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentScheduleResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete payment schedule by ID","description":"Deletes the saved schedule; the project returns to its computed schedule","operationId":"V2DeletePaymentSchedule","tags":["payment schedule"],"responses":{"204":{"description":"The payment schedule was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/payment-schedule-sources":{"get":{"summary":"List payment schedule funding sources","description":"Returns the funding sources of saved payment schedules with live, allocated, delta and state","operationId":"V2ListPaymentScheduleSources","tags":["payment schedule"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"PaymentScheduleSource list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_PaymentScheduleSourceResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create a funding source","description":"kind carved_out with a project-service relationship carves the service out of its group; any other kind persists a live source that has no persisted row yet","operationId":"V2CreatePaymentScheduleSource","tags":["payment schedule"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentScheduleSourceResource"}}}}}},"responses":{"201":{"description":"Created PaymentScheduleSource response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentScheduleSourceResource"}}}}}},"422":{"description":"The service cannot be carved out, or no such live source is unmatched"},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/payment-schedule-sources/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find payment schedule source by ID","operationId":"V2GetPaymentScheduleSource","tags":["payment schedule"],"responses":{"200":{"description":"PaymentScheduleSource response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentScheduleSourceResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Un-carve a carved-out source or remove a stale source","description":"Removes the source and its allocations. A carved-out service returns to its group; any other source can be removed only when it no longer matches live pricing","operationId":"V2DeletePaymentScheduleSource","tags":["payment schedule"],"responses":{"204":{"description":"The source was removed"},"422":{"description":"The source still matches live pricing and is not carved out"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/payment-schedule-sources/{id}/placements":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Place a source on a payment","description":"Replaces the source allocations with one on the payment, for the amount or the live amount","operationId":"V2PlacePaymentScheduleSource","tags":["payment schedule"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["scheduled-payment-id"],"properties":{"scheduled-payment-id":{"type":"string"},"amount":{"type":"string","example":"1000.00"}}}}}},"responses":{"200":{"description":"The PaymentScheduleSource","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentScheduleSourceResource"}}}}}},"422":{"description":"The payment or amount is invalid"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/payment-schedule-sources/{id}/amortizations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Amortize a carved-out source","description":"Spreads the live amount evenly across the schedule recurring payments","operationId":"V2AmortizePaymentScheduleSource","tags":["payment schedule"],"responses":{"200":{"description":"The PaymentScheduleSource","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentScheduleSourceResource"}}}}}},"422":{"description":"The source is not carved out or there are no recurring payments"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/scheduled-payments":{"get":{"summary":"List scheduled payments","description":"Returns the payments of saved payment schedules for the account","operationId":"V2ListScheduledPayments","tags":["payment schedule"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"ScheduledPayment list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ScheduledPaymentResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create a scheduled payment","description":"Creates a payment with no allocations on a saved payment schedule","operationId":"V2CreateScheduledPayment","tags":["payment schedule"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ScheduledPaymentResource"}}}}}},"responses":{"201":{"description":"Created ScheduledPayment response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ScheduledPaymentResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/scheduled-payments/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find scheduled payment by ID","operationId":"V2GetScheduledPayment","tags":["payment schedule"],"responses":{"200":{"description":"ScheduledPayment response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ScheduledPaymentResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update scheduled payment by ID","operationId":"V2UpdateScheduledPayment","tags":["payment schedule"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ScheduledPaymentResource"}}}}}},"responses":{"200":{"description":"Updated ScheduledPayment response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ScheduledPaymentResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete scheduled payment by ID","operationId":"V2DeleteScheduledPayment","tags":["payment schedule"],"responses":{"204":{"description":"The ScheduledPayment was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/scheduled-payments/{id}/splits":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Split an amount off a scheduled payment","description":"Moves the amount into a new linked payment placed after this one, taking it proportionally from each source allocation","operationId":"V2SplitScheduledPayment","tags":["payment schedule"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"required":["amount"],"properties":{"amount":{"type":"string","example":"6000.00"}}}}}},"responses":{"201":{"description":"The new ScheduledPayment","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ScheduledPaymentResource"}}}}}},"422":{"description":"The amount is missing or invalid"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/scheduled-payments/{id}/merges":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Merge split payments back","description":"Folds every split part of this root payment back into it","operationId":"V2MergeScheduledPayment","tags":["payment schedule"],"responses":{"200":{"description":"The root ScheduledPayment","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ScheduledPaymentResource"}}}}}},"422":{"description":"The payment cannot be merged"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/payment-allocations":{"get":{"summary":"List payment allocations","description":"Returns the allocations of saved payment schedules for the account","operationId":"V2ListPaymentAllocations","tags":["payment schedule"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"PaymentAllocation list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_PaymentAllocationResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create a payment allocation","description":"Places an amount of a source on a payment; both must belong to the same schedule","operationId":"V2CreatePaymentAllocation","tags":["payment schedule"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentAllocationResource"}}}}}},"responses":{"201":{"description":"Created PaymentAllocation response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentAllocationResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/payment-allocations/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find payment allocation by ID","operationId":"V2GetPaymentAllocation","tags":["payment schedule"],"responses":{"200":{"description":"PaymentAllocation response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentAllocationResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update payment allocation amount","operationId":"V2UpdatePaymentAllocation","tags":["payment schedule"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentAllocationResource"}}}}}},"responses":{"200":{"description":"Updated PaymentAllocation response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PaymentAllocationResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete payment allocation by ID","operationId":"V2DeletePaymentAllocation","tags":["payment schedule"],"responses":{"204":{"description":"The PaymentAllocation was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-documents":{"get":{"summary":"List project documents for account","description":"Returns a paged list of project documents for the account","operationId":"V2ListProjectDocumentsForAccount","tags":["project document"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the documents are attached","schema":{"type":"string"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project document","schema":{"type":"array","items":{"type":"string","enum":["project","document-deliveries"]}}}],"responses":{"200":{"description":"Project Document list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectDocumentResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_DocumentDeliveryResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project document for account","description":"Create a project document for the account","operationId":"V2CreateProjectDocument","tags":["project document"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectDocumentResource"}}}}}},"responses":{"201":{"description":"Create Project Document response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectDocumentResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-documents/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project document by ID","description":"Returns a project document for the account by ID","operationId":"V2GetProjectDocument","tags":["project document"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project document","schema":{"type":"array","items":{"type":"string","enum":["project","document-deliveries"]}}}],"responses":{"200":{"description":"Project document response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectDocumentResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_DocumentDeliveryResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-documents/{id}/downloads":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Download the generated document attached to the project document","operationId":"V2DownloadProjectDocument","tags":["project document"],"responses":{"200":{"description":"Successful file download","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/projects/{project_id}/project-duplications":{"parameters":[{"$ref":"#/components/parameters/project_id_parameter"}],"post":{"summary":"Duplicate a project","description":"Creates a project duplication in the context of the project identified by project-id. The project becomes the source; the requested content array of {type, id} records is expanded from the source and applied to a new target project asynchronously. Poll GET /v2/project-duplications/{id} for status.","operationId":"V2CreateProjectDuplication","tags":["project"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectDuplicationResource"}}}}}},"responses":{"201":{"description":"Create Project Duplication response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectDuplicationResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-expenses":{"get":{"summary":"List project expenses for project or account","description":"Returns a paged list of project expenses for the project or account","operationId":"V2ListProjectExpenses","tags":["project expense"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the expenses are attached","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active project expenses, false for archived project expenses","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project expense","schema":{"type":"array","items":{"type":"string","enum":["project","project-phase","expense-category","project-resource","resource","resource-rate","project-service"]}}},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","active","-active","rate","-rate","quantity","-quantity","description","-description","markup","-markup","revenue","-revenue","cost","-cost","variable","-variable"]}}}],"responses":{"200":{"description":"Project Expense list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectExpenseResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProjectPhaseResource"},{"$ref":"#/components/schemas/v2_ExpenseCategoryResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ResourceRateResource"},{"$ref":"#/components/schemas/v2_ProjectServiceResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project expense for project","description":"Create a project expense for the project","operationId":"V2CreateProjectExpense","tags":["project expense"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectExpenseResource"}}}}}},"responses":{"201":{"description":"Create Project Expense response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectExpenseResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-expenses/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project expense by ID","description":"Returns a project expense for the project by ID","operationId":"V2GetProjectExpenseById","tags":["project expense"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project expense","schema":{"type":"array","items":{"type":"string","enum":["project","project-phase","expense-category","project-resource","resource","resource-rate","project-service"]}}}],"responses":{"200":{"description":"Project list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectExpenseResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProjectPhaseResource"},{"$ref":"#/components/schemas/v2_ExpenseCategoryResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ResourceRateResource"},{"$ref":"#/components/schemas/v2_ProjectServiceResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project expense by ID","description":"Update the project expense by ID","operationId":"V2UpdateProjectExpense","tags":["project expense"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectExpenseResource"}}}}}},"responses":{"200":{"description":"Update Project Expense response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectExpenseResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete project expense by ID","description":"Delete the project expense from the project by ID","operationId":"V2DeleteProjectExpense","tags":["project expense"],"responses":{"204":{"description":"The Project Expense was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-governances":{"get":{"summary":"List project governances for project or account","description":"Returns a paged list of project governances for the project or account","operationId":"V2ListProjectGovernances","tags":["project governance"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the governances are attached","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active project governances, false for archived project governances","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project governance","schema":{"type":"array","items":{"type":"string","enum":["project","project-phase","governance","project-resource","resource","resource-rate","service-category"]}}}],"responses":{"200":{"description":"Project Governance list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectGovernanceResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProjectPhaseResource"},{"$ref":"#/components/schemas/v2_GovernanceResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ResourceRateResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project governance for project","description":"Create a project governance for the project","operationId":"V2CreateProjectGovernance","tags":["project governance"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectGovernanceResource"}}}}}},"responses":{"201":{"description":"Create Project Governance response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectGovernanceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-governances/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project governance by ID","description":"Returns a project governance for the project by ID","operationId":"V2GetProjectGovernanceById","tags":["project governance"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project governance","schema":{"type":"array","items":{"type":"string","enum":["project","project-phase","governance","project-resource","resource","resource-rate","service-category"]}}}],"responses":{"200":{"description":"Project list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectGovernanceResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProjectPhaseResource"},{"$ref":"#/components/schemas/v2_GovernanceResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ResourceRateResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project governance by ID","description":"Update the project governance by ID","operationId":"V2UpdateProjectGovernance","tags":["project governance"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectGovernanceResource"}}}}}},"responses":{"200":{"description":"Update Project Governance response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectGovernanceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete project governance by ID","description":"Delete the project governance from the project by ID","operationId":"V2DeleteProjectGovernance","tags":["project governance"],"responses":{"204":{"description":"The Delete Project Governance was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-governances/{id}/moves":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"patch":{"summary":"Move the project governance into a new position in the list by ID","description":"Moves the project governance into its new position and Returns a project governance for the account by ID","operationId":"V2ChangeProjectGovernancePositionById","tags":["project governance"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectGovernanceResource"}}}}}},"responses":{"200":{"description":"Find project governance by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectGovernanceResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-locations":{"get":{"summary":"List project locations for project or account","description":"Returns a paged list of project locations for the project or account","operationId":"V2ListProjectLocations","tags":["project location"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the locations are attached","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active project locations, false for archived project locations","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project location","schema":{"type":"array","items":{"type":"string","enum":["project","client-location"]}}}],"responses":{"200":{"description":"Project Location list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectLocationResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ClientLocationResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project location for project","description":"Create a project location for the project","operationId":"V2CreateProjectLocation","tags":["project location"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectLocationResource"}}}}}},"responses":{"201":{"description":"Create Project Location response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectLocationResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-locations/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project location by ID","description":"Returns a project location for the project by ID","operationId":"V2GetProjectLocationById","tags":["project location"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project location","schema":{"type":"array","items":{"type":"string","enum":["project","client-location"]}}}],"responses":{"200":{"description":"Project list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectLocationResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ClientLocationResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project location by ID","description":"Update the project location by ID","operationId":"V2UpdateProjectLocation","tags":["project location"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectLocationResource"}}}}}},"responses":{"200":{"description":"Update Project Location response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectLocationResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete project location by ID","description":"Delete the project location from the project by ID","operationId":"V2DeleteProjectLocation","tags":["project location"],"responses":{"204":{"description":"The Delete Project Location was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-phases":{"get":{"summary":"List phases for account","description":"Returns a paged list of phases for the project","operationId":"V2ListProjectPhasesForAccount","tags":["project phase"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active project phases, false for archived project phases","schema":{"type":"boolean","default":true}},{"name":"filter[project]","in":"query","required":false,"description":"filter project by the project id","schema":{"type":"number"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project phase","schema":{"type":"array","items":{"type":"string","enum":["project","phase"]}}}],"responses":{"200":{"description":"Project Phase list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectPhaseResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_PhaseResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project phase for account","description":"Create a project phase for the account","operationId":"V2CreateProjectPhase","tags":["project phase"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectPhaseResource"}}}}}},"responses":{"201":{"description":"Create Project Phase response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectPhaseResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-phases/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find phase by ID","description":"Returns a phase for the project by ID","operationId":"V2GetProjectPhaseById","tags":["project phase"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project phase","schema":{"type":"array","items":{"type":"string","enum":["project","phase"]}}}],"responses":{"200":{"description":"Find Project Phase by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectPhaseResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_PhaseResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project phase by ID","description":"Update the project phase by ID","operationId":"V2UpdateProjectPhase","tags":["project phase"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectPhaseResource"}}}}}},"responses":{"200":{"description":"Update Project Phase response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectPhaseResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete project phase by ID","description":"Delete the project phase from the account by ID","operationId":"V2DeleteProjectPhase","tags":["project phase"],"responses":{"204":{"description":"The Project Phase was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-products":{"get":{"summary":"List products for project","description":"Returns a paged list of products for the project","operationId":"V2ListProjectProductsForAccount","tags":["project product"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the products are attached","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active project products, false for archived project products","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","active","-active","name","-name","description","-description","quantity","-quantity","sku","-sku","product-id","-product-id","manufacturer-part-number","-manufacturer-part-number","unit-of-measure","-unit-of-measure","category","-category","subcategory","-subcategory","unit-cost","-unit-cost","unit-price","-unit-price","custom","-custom","variable-rates","-variable-rates","billing-frequency","-billing-frequency","line-number","-line-number","vendor-discount","-vendor-discount","list-price","-list-price","markup","-markup","project-variables","-project-variables","source","-source","hardware-price","-hardware-price","hardware-cost","-hardware-cost","custom-hardware-price?","-custom-hardware-price?","custom-hardware-cost?","-custom-hardware-cost?","project-location.name","-project-location.name"]}}},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project product","schema":{"type":"array","items":{"type":"string","enum":["project","product","project-service","project-location"]}}}],"responses":{"200":{"description":"Product list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectProductResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProductResource"},{"$ref":"#/components/schemas/v2_ProjectServiceResource"},{"$ref":"#/components/schemas/v2_ProjectLocationResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create product for project","description":"Create a product for the project","operationId":"V2CreateProjectProduct","tags":["project product"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectProductResource"}}}}}},"responses":{"201":{"description":"Create Product response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectProductResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-products/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find product by ID","description":"Returns a product for the project by ID","operationId":"V2GetProjectProduct","tags":["project product"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project product","schema":{"type":"array","items":{"type":"string","enum":["project","product","project-service","project-location"]}}}],"responses":{"200":{"description":"Project product response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectProductResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProductResource"},{"$ref":"#/components/schemas/v2_ProjectServiceResource"},{"$ref":"#/components/schemas/v2_ProjectLocationResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update product on project by ID","description":"Update the product on a project by ID","operationId":"V2UpdateProjectProduct","tags":["project product"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectProductResource"}}}}}},"responses":{"200":{"description":"Update Product response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectProductResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete product by ID","description":"Delete the product from the account by ID","operationId":"V2DeleteProjectProduct","tags":["project product"],"responses":{"204":{"description":"The Delete Product was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-resources":{"get":{"summary":"List project resources for account","description":"Returns a paged list of project resources for the account","operationId":"V2ListProjectResourcesForAccount","tags":["project resources"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the resources are attached","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active project resources, false for archived project resources","schema":{"type":"boolean","default":true}},{"name":"filter[governed-categories]","in":"query","required":false,"description":"List of category IDs to filter the resource rates by","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project resource","schema":{"type":"array","items":{"type":"string","enum":["project","resource","line-of-business"]}}}],"responses":{"200":{"description":"ProjectResource list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectResourceResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_LineOfBusinessResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project resource for account","description":"Create a project resource for the account","operationId":"V2CreateProjectResource","tags":["project resources"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResourceResource"}}}}}},"responses":{"201":{"description":"Create Project Resource response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResourceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-resources/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find Project Resourceby ID","description":"Returns a Project Resourcefor the account by ID","operationId":"V2GetProjectResource","tags":["project resources"],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResourceResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_LineOfBusinessResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update Project Resourceby ID","description":"Update the Project Resourceby ID","operationId":"V2UpdateProjectResource","tags":["project resources"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResourceResource"}}}}}},"responses":{"200":{"description":"Update ProjectResource response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResourceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete Project Resource by ID","description":"Delete the Project Resource from the account by ID","operationId":"V2DeleteProjectResource","tags":["project resources"],"responses":{"204":{"description":"The project resource was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-services":{"get":{"summary":"List project services for project or account","description":"Returns a paged list of project services for the project or account","operationId":"V2ListProjectServices","tags":["project service"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the project services are attached","schema":{"type":"string"}},{"name":"filter[phase]","in":"query","required":false,"description":"ID of the project phase in which the project services are scoped","schema":{"type":"string"}},{"name":"filter[lob]","in":"query","required":false,"description":"ID of the line of business (LOB) to which the project services are aligned","schema":{"type":"string"}},{"name":"filter[project-location]","in":"query","required":false,"description":"ID of the project location where the service will be performed","schema":{"type":"string"}},{"name":"filter[service-type]","in":"query","required":false,"schema":{"type":"string","enum":["professional_services","managed_services"]}},{"name":"filter[active]","in":"query","required":false,"description":"true for active projects, false for archived projects","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project service","schema":{"type":"array","items":{"type":"string","enum":["project","project-location","project-phase","project-resource","resource","service","lob","service-category","project-subservices","source-project-service"]}}}],"responses":{"200":{"description":"Project Service list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectServiceResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProjectLocationResource"},{"$ref":"#/components/schemas/v2_ProjectPhaseResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ServiceResource"},{"$ref":"#/components/schemas/v2_LobResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"},{"$ref":"#/components/schemas/v2_ProjectSubserviceResource"},{"$ref":"#/components/schemas/v2_ProjectServiceResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project service for account","description":"Create a project service for the account","operationId":"V2CreateProjectService","tags":["project service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectServiceResource"}}}}}},"responses":{"201":{"description":"Create Project Service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectServiceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-services/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project service by ID","description":"Returns a project service for the project by ID","operationId":"V2GetProjectServiceById","tags":["project service"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project service","schema":{"type":"array","items":{"type":"string","enum":["project","project-location","project-phase","project-resource","resource","service","lob","service-category","project-subservices","source-project-service"]}}}],"responses":{"200":{"description":"Project Service list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectServiceResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProjectLocationResource"},{"$ref":"#/components/schemas/v2_ProjectPhaseResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ServiceResource"},{"$ref":"#/components/schemas/v2_LobResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"},{"$ref":"#/components/schemas/v2_ProjectSubserviceResource"},{"$ref":"#/components/schemas/v2_ProjectServiceResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project service by ID","description":"Update the project service by ID","operationId":"V2UpdateProjectService","tags":["project service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectServiceResource"}}}}}},"responses":{"200":{"description":"Update Project Service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectServiceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete project service by ID","description":"Delete the project service from the account by ID","operationId":"V2DeleteProjectService","tags":["project service"],"responses":{"204":{"description":"The Delete Project Service was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-services/{id}/duplications":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Duplicate the service on the project","description":"Returns the newly created service(s)","operationId":"V2DuplicateProjectServiceById","tags":["project service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"object","required":["id","type"],"properties":{"id":{"type":"integer","description":"The ID of the Project Service being updated"},"type":{"type":"string","example":"project-services","description":"The name of the resource class -- always project-services"},"attributes":{"type":"object","properties":{"all_locations":{"type":"boolean","description":"When true, if the project includes multiple locations then the service will be duplicated once for each location"}}}}}}}}}},"responses":{"200":{"description":"Project Service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectServiceResource"}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-services/{id}/refresh-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Refresh project service name, service description, and langauge fields from the standard service","description":"Set the name, service description, and language fields of the project service equal to their current value on the standard service","operationId":"V2RefreshProjectServiceById","tags":["project service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"object","required":["id","type"],"properties":{"id":{"type":"integer","description":"The ID of the Project Service being updated"},"type":{"type":"string","example":"project-services","description":"The name of the resource class -- always project-services"}}}}}}}},"responses":{"200":{"description":"Project Service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectServiceResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-services/{id}/standard-synchronizations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Upsert the current values from the project service into v2/services","description":"Returns the project service for the project by ID.  If synchronization created a standard service then the new service will be returned in the sideloaded data","operationId":"V2SyncrhonizeStandardProjectServiceById","tags":["project service"],"requestBody":{"required":false,"description":"Optional values for the new standard's custom variables, keyed by variable name. They take precedence over the project service's own values.","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"attributes":{"properties":{"variables":{"type":"object","additionalProperties":{"type":"string"}}}}}}}}}}},"responses":{"200":{"description":"Project Service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectServiceResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-subservices":{"get":{"summary":"List project subservices for project or account","description":"Returns a paged list of project subservices for the project or account","operationId":"V2ListProjectSubservices","tags":["project subservice"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active project subservices, false for archived project subservices","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project subservice","schema":{"type":"array","items":{"type":"string","enum":["account","project","project-service","project-location","lob","phase","project-resource","resource","service-category","subservice","source-project-subservice"]}}}],"responses":{"200":{"description":"Project Subservice list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectSubserviceResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProjectServiceResource"},{"$ref":"#/components/schemas/v2_ProjectLocationResource"},{"$ref":"#/components/schemas/v2_LobResource"},{"$ref":"#/components/schemas/v2_PhaseResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"},{"$ref":"#/components/schemas/v2_SubserviceResource"},{"$ref":"#/components/schemas/v2_ProjectSubserviceResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project subservice for account","description":"Create a project subservice for the account","operationId":"V2CreateProjectSubservice","tags":["project subservice"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectSubserviceResource"}}}}}},"responses":{"201":{"description":"Create Project Subservice response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectSubserviceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-subservices/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project subservice by ID","description":"Returns a project subservice for the project by ID","operationId":"V2GetProjectSubserviceById","tags":["project subservice"],"responses":{"200":{"description":"Project Subservice list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectSubserviceResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProjectServiceResource"},{"$ref":"#/components/schemas/v2_ProjectLocationResource"},{"$ref":"#/components/schemas/v2_LobResource"},{"$ref":"#/components/schemas/v2_PhaseResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"},{"$ref":"#/components/schemas/v2_SubserviceResource"},{"$ref":"#/components/schemas/v2_ProjectSubserviceResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project subservice by ID","description":"Update the project subservice by ID","operationId":"V2UpdateProjectSubservice","tags":["project subservice"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectSubserviceResource"}}}}}},"responses":{"200":{"description":"Update Project Subservice response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectSubserviceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete project subservice by ID","description":"Delete the project subservice from the account by ID","operationId":"V2DeleteProjectSubservice","tags":["project subservice"],"responses":{"204":{"description":"The Delete Project Subservice was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-subservices/{id}/standard-synchronizations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Upsert the current values from the project subservice into v2/subservices","description":"Returns the project subservice for the project by ID.  If synchronization created a standard service then the new service will be returned in the sideloaded data","operationId":"V2SyncrhonizeStandardProjectSubserviceById","tags":["project subservice"],"responses":{"200":{"description":"Project Subservice response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectSubserviceResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-surveys":{"get":{"summary":"List project surveys for project or account","description":"Returns a paged list of project surveys for the project or account","operationId":"V2ListProjectSurveys","tags":["project survey"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Project Survey list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectSurveyResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_SurveyResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-surveys/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project survey by ID","description":"Returns a project survey for the account by ID","operationId":"V2GetProjectSurvey","tags":["project survey"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project survey","schema":{"type":"array","items":{"type":"string","enum":["project","survey"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectSurveyResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_SurveyResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-variables":{"get":{"summary":"List project variables for account","description":"Returns a paged list of project variables for the account","operationId":"V2ListProjectVariables","tags":["project variables"],"parameters":[{"name":"filter[variable-context]","in":"query","required":false,"description":"The name of the resource class to which the variable is attached","schema":{"type":"string","enum":["client","crm_opportunity","project","governance","service_location","project_contact","product","resource","section","service","teammate"]}},{"name":"filter[active]","in":"query","required":false,"description":"true for active project variables, false for archived project variables","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project variable","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Project Variable list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectVariableResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project variable for account","description":"Create a project variable for the account","operationId":"V2CreateProjectVariable","tags":["project variables"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVariableResource"}}}}}},"responses":{"201":{"description":"Create Project Variable response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVariableResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-variables/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project variable by ID","description":"Returns a project variables for the account by ID","operationId":"V2GetProjectVariableById","tags":["project variables"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project variable","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Find Project Variable by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVariableResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project variable by ID","description":"Update the project variable by ID","operationId":"V2UpdateProjectVariable","tags":["project variables"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVariableResource"}}}}}},"responses":{"200":{"description":"Update Project Variable response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVariableResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete project variable by ID","description":"Delete the project variable from the account by ID","operationId":"V2DeleteProjectVariable","tags":["project variables"],"responses":{"204":{"description":"The project variable was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-variables/{id}/moves":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"patch":{"summary":"Move the project variable into a new position in the list","description":"Updates the position of the project variable","operationId":"V2ChangeProjectVariablePositionById","tags":["project variables"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVariableResource"}}}}}},"responses":{"200":{"description":"Repositioned project variable response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVariableResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-variables/{id}/restore-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Restore a soft-deleted project variable by ID","description":"Clears deleted_at on the project variable, returning it to the active set","operationId":"V2RestoreProjectVariableById","tags":["project variables"],"responses":{"200":{"description":"Restored project variable response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVariableResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-variables/{id}/purge-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"delete":{"summary":"Permanently delete a soft-deleted project variable by ID","description":"Hard-deletes the project variable record. Only valid for records that have already been soft-deleted.","operationId":"V2PurgeProjectVariableById","tags":["project variables"],"responses":{"204":{"description":"The project variable was purged successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-versions":{"get":{"summary":"List project versions for project or account","description":"Returns a paged list of project versions for the project or account","operationId":"V2ListProjectVersions","tags":["project version"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the versions are attached","schema":{"type":"string"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project version","schema":{"type":"array","items":{"type":"string","enum":["project","approval-steps"]}}}],"responses":{"200":{"description":"Project Version list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectVersionResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ApprovalStepResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project version for project","description":"Create a project version for the project","operationId":"V2CreateProjectVersion","tags":["project version"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVersionResource"}}}}}},"responses":{"201":{"description":"Create Project Version response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVersionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/project-versions/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project version by ID","description":"Returns a project version for the project by ID","operationId":"V2GetProjectVersionById","tags":["project version"],"responses":{"200":{"description":"Project list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVersionResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ApprovalStepResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project version by ID","description":"Update the project version by ID","operationId":"V2UpdateProjectVersion","tags":["project version"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVersionResource"}}}}}},"responses":{"200":{"description":"Update Project Version response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectVersionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/project-versions/{id}/reverts":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Revert project state to what it was when this version was completed","description":"Revert the project to version by ID","operationId":"V2RevertProjectVersion","tags":["project version"],"responses":{"204":{"description":"Project state was reverted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/projects":{"get":{"summary":"List projects for account","description":"Returns a paged list of projects for the account","operationId":"V2ListProjectsForAccount","tags":["project"],"parameters":[{"name":"filter[project-name]","in":"query","required":false,"description":"String of characters in the name of the project","schema":{"type":"string"}},{"name":"filter[search]","in":"query","required":false,"description":"String of at least 3 characters found in any of the project name, client name, a teammate name, or a text project variable. Select-option variables match on the option label, not the stored value","schema":{"type":"string"}},{"name":"filter[status]","in":"query","required":false,"description":"Status of the project","schema":{"type":"string","enum":["building","technical_approval","sales_approval","business_approval","approved","won","lost","canceled"]}},{"name":"filter[creator.id]","in":"query","required":false,"description":"ID of the user that created the project","schema":{"type":"string"}},{"name":"filter[team.id]","in":"query","required":false,"description":"ID of a team with users that are collaborators on the project","schema":{"type":"string"}},{"name":"filter[collaborator.id]","in":"query","required":false,"description":"ID of a user that worked on or was invited to the project","schema":{"type":"string"}},{"name":"filter[client.id]","in":"query","required":false,"description":"ID of client on the project","schema":{"type":"string"}},{"name":"filter[client.name]","in":"query","required":false,"description":"name of the client on the project","schema":{"type":"string"}},{"name":"filter[presales-engineer.id]","in":"query","required":false,"description":"ID of presales engineer on the project","schema":{"type":"string"}},{"name":"filter[presales-engineer.name]","in":"query","required":false,"description":"name of the presales engineer on the project","schema":{"type":"string"}},{"name":"filter[sales-executive.id]","in":"query","required":false,"description":"ID of sales executive on the project","schema":{"type":"string"}},{"name":"filter[sales-executive.name]","in":"query","required":false,"description":"name of the sales executive on the project","schema":{"type":"string"}},{"name":"filter[created-at.after]","in":"query","required":false,"description":"Day on or after which the project was created. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[created-at.before]","in":"query","required":false,"description":"Day on or before which the project was created. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[updated-at.after]","in":"query","required":false,"description":"Day on or after which the project was updated. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[updated-at.before]","in":"query","required":false,"description":"Day on or before which the project was updated. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[approved-at.after]","in":"query","required":false,"description":"earliest date or time a project was approved","schema":{"type":"string","format":"date-time"}},{"name":"filter[approved-at.before]","in":"query","required":false,"description":"latest date or time a project was approved","schema":{"type":"string","format":"date-time"}},{"name":"filter[my-projects]","in":"query","required":false,"description":"true for projects where the current user is a collaborator","schema":{"type":"boolean"}},{"name":"filter[tag-list]","in":"query","required":false,"description":"Projects tagged with AT LEAST ONE of the tags in the provided comma-separated list","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active projects, false for archived projects","schema":{"type":"boolean","default":true}},{"name":"filter[service-id]","in":"query","required":false,"description":"ID of a service that appears on the survey","schema":{"type":"string"}},{"name":"filter[rate-table]","in":"query","required":false,"description":"ID of a rate table that appears on a project","schema":{"type":"string"}},{"name":"filter[lob]","in":"query","required":false,"description":"ID of an lob used in a project","schema":{"type":"string"}},{"name":"filter[business-unit]","in":"query","required":false,"description":"ID of an lob used in a project","schema":{"type":"string"}},{"name":"filter[change-order]","in":"query","required":false,"description":"Change-request child projects are excluded by default (false). true lists only children; true,false lists all projects.","schema":{"type":"string","default":"false"}},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","active","-active","project-name","-project-name","status","-status","project-variables","-project-variables","submitted-at","-submitted-at","approved-at","-approved-at","executive-summary","-executive-summary","key-objectives","-key-objectives","our-responsibilities","-our-responsibilities","client-responsibilities","-client-responsibilities","solution-summary","-solution-summary","out-of-scope","-out-of-scope","field-labels","-field-labels","payment-info","-payment-info","total-effort","-total-effort","total-revenue","-total-revenue","ms-revenue","-ms-revenue","third-party-revenue","-third-party-revenue","contract-revenue","-contract-revenue","contract-cost","-contract-cost","price-adjustment","-price-adjustment","mrr-adjustment","-mrr-adjustment","mrr-terms","-mrr-terms","recurring-billing-frequency","-recurring-billing-frequency","contract-margin","-contract-margin","service-start-date","-service-start-date","include-ps-revenue-in-mrr","-include-ps-revenue-in-mrr","net-mrr","-net-mrr","created-at","-created-at","updated-at","-updated-at","tag-list","-tag-list","client-name","-client-name","presales-engineer-name","-presales-engineer-name","sales-executive-name","-sales-executive-name","travel-limit","-travel-limit","service-category","-service-category","cola","-cola","msa-date","-msa-date","storage-options","-storage-options","payment-schedule-status","-payment-schedule-status","ps-revenue-adjustment","-ps-revenue-adjustment","ps-cost-adjustment","-ps-cost-adjustment","ms-revenue-adjustment","-ms-revenue-adjustment","ms-cost-adjustment","-ms-cost-adjustment","change-order-summary","-change-order-summary","change-order?","-change-order?"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project","schema":{"type":"array","items":{"type":"string","enum":["account","business-unit","client","creator","document-template","external-request","sales-executive","presales-engineer","psa-project","payment-term","payment-schedule","rate-table","crm-opportunity","approval-steps","customer-successes","notes","project-attachments","project-collaborators","project-contacts","project-conditions","project-credits","project-documents","project-expenses","project-governances","project-locations","project-products","project-phases","project-resources","resource-plans","project-services","partner-requests","project-versions","resource-rates","quotes","audit-logs","pricing-adjustments","change-orders","parent-change-order","change-order-projects"]}}}],"responses":{"200":{"description":"Project list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ProjectResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_BusinessUnitResource"},{"$ref":"#/components/schemas/v2_ClientResource"},{"$ref":"#/components/schemas/v2_CreatorResource"},{"$ref":"#/components/schemas/v2_DocumentTemplateResource"},{"$ref":"#/components/schemas/v2_ExternalRequestResource"},{"$ref":"#/components/schemas/v2_SalesExecutiveResource"},{"$ref":"#/components/schemas/v2_PresalesEngineerResource"},{"$ref":"#/components/schemas/v2_PsaProjectResource"},{"$ref":"#/components/schemas/v2_PaymentTermResource"},{"$ref":"#/components/schemas/v2_PaymentScheduleResource"},{"$ref":"#/components/schemas/v2_RateTableResource"},{"$ref":"#/components/schemas/v2_CrmOpportunityResource"},{"$ref":"#/components/schemas/v2_ApprovalStepResource"},{"$ref":"#/components/schemas/v2_CustomerSuccessResource"},{"$ref":"#/components/schemas/v2_NoteResource"},{"$ref":"#/components/schemas/v2_ProjectAttachmentResource"},{"$ref":"#/components/schemas/v2_ProjectCollaboratorResource"},{"$ref":"#/components/schemas/v2_ProjectContactResource"},{"$ref":"#/components/schemas/v2_ProjectConditionResource"},{"$ref":"#/components/schemas/v2_ProjectCreditResource"},{"$ref":"#/components/schemas/v2_ProjectDocumentResource"},{"$ref":"#/components/schemas/v2_ProjectExpenseResource"},{"$ref":"#/components/schemas/v2_ProjectGovernanceResource"},{"$ref":"#/components/schemas/v2_ProjectLocationResource"},{"$ref":"#/components/schemas/v2_ProjectProductResource"},{"$ref":"#/components/schemas/v2_ProjectPhaseResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"},{"$ref":"#/components/schemas/v2_ResourcePlanResource"},{"$ref":"#/components/schemas/v2_ProjectServiceResource"},{"$ref":"#/components/schemas/v2_PartnerRequestResource"},{"$ref":"#/components/schemas/v2_ProjectVersionResource"},{"$ref":"#/components/schemas/v2_ResourceRateResource"},{"$ref":"#/components/schemas/v2_QuoteResource"},{"$ref":"#/components/schemas/v2_AuditLogResource"},{"$ref":"#/components/schemas/v2_PricingAdjustmentResource"},{"$ref":"#/components/schemas/v2_ChangeOrderResource"},{"$ref":"#/components/schemas/v2_ChangeOrderResource"},{"$ref":"#/components/schemas/v2_ProjectResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create project for account","description":"Create a project for the account","operationId":"V2CreateProject","tags":["project"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_CreateProjectResource"}}}}}},"responses":{"201":{"description":"Create Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}}}}},"/v2/projects/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find project by ID","description":"Returns a project for the account by ID","operationId":"V2GetProjectById","tags":["project"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project","schema":{"type":"array","items":{"type":"string","enum":["account","business-unit","client","creator","document-template","external-request","sales-executive","presales-engineer","psa-project","payment-term","payment-schedule","rate-table","crm-opportunity","approval-steps","customer-successes","notes","project-attachments","project-collaborators","project-contacts","project-conditions","project-credits","project-documents","project-expenses","project-governances","project-locations","project-products","project-phases","project-resources","resource-plans","project-services","partner-requests","project-versions","resource-rates","quotes","audit-logs","pricing-adjustments","change-orders","parent-change-order","change-order-projects"]}}}],"responses":{"200":{"description":"Project list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_BusinessUnitResource"},{"$ref":"#/components/schemas/v2_ClientResource"},{"$ref":"#/components/schemas/v2_CreatorResource"},{"$ref":"#/components/schemas/v2_DocumentTemplateResource"},{"$ref":"#/components/schemas/v2_ExternalRequestResource"},{"$ref":"#/components/schemas/v2_SalesExecutiveResource"},{"$ref":"#/components/schemas/v2_PresalesEngineerResource"},{"$ref":"#/components/schemas/v2_PsaProjectResource"},{"$ref":"#/components/schemas/v2_PaymentTermResource"},{"$ref":"#/components/schemas/v2_PaymentScheduleResource"},{"$ref":"#/components/schemas/v2_RateTableResource"},{"$ref":"#/components/schemas/v2_CrmOpportunityResource"},{"$ref":"#/components/schemas/v2_ApprovalStepResource"},{"$ref":"#/components/schemas/v2_CustomerSuccessResource"},{"$ref":"#/components/schemas/v2_NoteResource"},{"$ref":"#/components/schemas/v2_ProjectAttachmentResource"},{"$ref":"#/components/schemas/v2_ProjectCollaboratorResource"},{"$ref":"#/components/schemas/v2_ProjectContactResource"},{"$ref":"#/components/schemas/v2_ProjectConditionResource"},{"$ref":"#/components/schemas/v2_ProjectCreditResource"},{"$ref":"#/components/schemas/v2_ProjectDocumentResource"},{"$ref":"#/components/schemas/v2_ProjectExpenseResource"},{"$ref":"#/components/schemas/v2_ProjectGovernanceResource"},{"$ref":"#/components/schemas/v2_ProjectLocationResource"},{"$ref":"#/components/schemas/v2_ProjectProductResource"},{"$ref":"#/components/schemas/v2_ProjectPhaseResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"},{"$ref":"#/components/schemas/v2_ResourcePlanResource"},{"$ref":"#/components/schemas/v2_ProjectServiceResource"},{"$ref":"#/components/schemas/v2_PartnerRequestResource"},{"$ref":"#/components/schemas/v2_ProjectVersionResource"},{"$ref":"#/components/schemas/v2_ResourceRateResource"},{"$ref":"#/components/schemas/v2_QuoteResource"},{"$ref":"#/components/schemas/v2_AuditLogResource"},{"$ref":"#/components/schemas/v2_PricingAdjustmentResource"},{"$ref":"#/components/schemas/v2_ChangeOrderResource"},{"$ref":"#/components/schemas/v2_ChangeOrderResource"},{"$ref":"#/components/schemas/v2_ProjectResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update project by ID","description":"Update the project by ID","operationId":"V2UpdateProject","tags":["project"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_CreateProjectResource"}}}}}},"responses":{"200":{"description":"Update Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete project by ID","description":"Archive the project from the account by ID","operationId":"V2DeleteProject","tags":["project"],"responses":{"204":{"description":"The Project was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/projects/{id}/purge-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"delete":{"summary":"Purge project by ID","description":"Delete the project from the account by ID","operationId":"V2PurgeProject","tags":["project"],"responses":{"204":{"description":"The Project was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/projects/{id}/restore-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Restore an archived project by ID","description":"Clears deleted_at on the project and on the change-request projects archived with it","operationId":"V2RestoreProject","tags":["project"],"responses":{"200":{"description":"Restored project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/projects/{id}/crm-integrations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"delete":{"summary":"Remove Crm Integration from Project by ID","description":"Remove Crm Integration from Project by ID","operationId":"V2RemoveCrmIntegrationFromProject","tags":["project"],"responses":{"204":{"description":"The Project CRM Integration was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/projects/{id}/approval-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Request approval for a project by ID","description":"Returns the updated project after the request for approval","operationId":"V2RequestApprovalForProjectById","tags":["project"],"requestBody":{"required":false,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"properties":{"attributes":{"properties":{"override_scope_review":{"type":"boolean","description":"Submit despite a scope review below the account's passing grade (needs the projects.scope_review override privilege; the override is recorded)"},"override_reason":{"type":"string","description":"Why the scope review was overridden; recorded with the override"}}}}}}}}}},"responses":{"200":{"description":"Project after approval request","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResource"}}}}}},"422":{"description":"Data format and validation issues, or a scope review below the passing grade (errors[0].meta has grade, score, passing_grade and can_override).","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}}}}},"/v2/projects/{id}/approval-cancellations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Cancel approval request for a project by ID","description":"Returns the updated project after the approval request has been canceled","operationId":"V2CancelApprovalRequestForProjectById","tags":["project"],"responses":{"200":{"description":"Project after approval request canceled","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResource"}}}}}},"422":{"description":"Data format and validation issues in errors.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}}}}},"/v2/projects/{id}/rescope-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Reset the project to the building state to restart scoping","description":"Returns the project after resetting the status to building","operationId":"V2RestartScopingForProjectById","tags":["project"],"responses":{"200":{"description":"Project after restarting scoping","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResource"}}}}}},"422":{"description":"Data format and validation issues in errors.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}}}}},"/v2/projects/{id}/deal-wins":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Mark project won by ID","description":"Returns the project after updating the status to won","operationId":"V2UpdateProjectToWonById","tags":["project"],"responses":{"200":{"description":"Project after marked won","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResource"}}}}}},"422":{"description":"Data format and validation issues in errors.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}}}}},"/v2/projects/{id}/deal-losses":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Mark project lost by ID","description":"Returns the project after updating the status to lost","operationId":"V2UpdateProjectToLostById","tags":["project"],"responses":{"200":{"description":"Project after marked lost","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResource"}}}}}},"422":{"description":"Data format and validation issues in errors.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}}}}},"/v2/projects/{id}/crm-synchronizations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Synchronize project revenue to CRM","description":"Synchronize project revenue to CRM","operationId":"V2SyncProjectRevenueToCRM","tags":["project"],"responses":{"204":{"description":"The Project synchronized successfully"},"422":{"description":"Unable to synchronize project revenue to CRM","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}}}}},"/v2/projects/{id}/duplications":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Duplicate a project by ID","description":"Returns the (new) duplicated project","operationId":"V2DuplicateProjectById","tags":["project"],"responses":{"200":{"description":"Duplicate Project","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResource"}}}}}},"422":{"description":"Validation errors from source project.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}}}}},"/v2/projects/exports":{"post":{"summary":"Export projects","description":"Initiates an export job for the user projects","operationId":"V2ExportProjects","tags":["project"],"requestBody":{"required":false,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["include_archived"],"properties":{"include_archived":{"type":"boolean"},"filter":{"type":"object","description":"The v2 projects index filters (e.g. active, status, project-name). When filter or sort is sent, the CSV follows them instead of the saved project view, include_archived is ignored, and change-order projects follow their parent.","additionalProperties":true},"sort":{"type":"string","description":"A v2 projects index sort, e.g. -updated-at"}}}}}}}}}},"responses":{"202":{"description":"Export job started","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"job_id":{"type":"string"}}}}}}}}},"/v2/projects/{id}/margin-settings":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Sets target margin of project services via project contract margin","description":"Sets target margin of project services via project contract margin","operationId":"V2UpdateTargetMargin","tags":["project"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"object","required":["attributes"],"properties":{"attributes":{"type":"object","required":["contract-margin"],"properties":{"contract-margin":{"type":"number","format":"double","description":"Target contract margin as a fraction, e.g. 0.25 for 25%","example":0.25}}}}}}}}}},"responses":{"200":{"description":"Project after project service target margins set","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ProjectResource"}}}}}},"422":{"description":"Data format and validation issues in errors.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}}}}},"/v2/projects/{id}/merge-data":{"parameters":[{"$ref":"#/components/parameters/id_parameter"},{"name":"filter[version]","in":"query","required":false,"description":"Merge data format: 1 (default) or 2","schema":{"type":"string","enum":["1","2"],"default":"1"}}],"get":{"summary":"Fetch a JSON representation of merge data","description":"Fetch a JSON representation of merge data","operationId":"V2ProjectMergeData","tags":["project"],"responses":{"200":{"description":"Merge data for the project","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","default":"merge-data"},"attributes":{"type":"object","properties":{"content":{"type":"object"}}}}}}}}}},"403":{"description":"User lacks the projects.merge_data privilege"},"404":{"description":"Project not found"},"422":{"description":"Data format and validation issues in errors.","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}}}}},"/v2/projects/{id}/scope-review":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Get the saved scope review of a project","description":"Return the saved scored SOW completeness review of the project (service and subservice language, phase structure, level of effort, content quality, and leftover placeholders). Responds 404 when no review has been generated. Attributes include generated_at, stale (project changed since generation) and completed_item_ids (checkmarks on failed/warning checks and placeholder warnings)","operationId":"ProjectScopeReview","tags":["project"],"responses":{"200":{"description":"Scope review for the project","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","default":"scope-review"},"attributes":{"type":"object","properties":{"score":{"type":"integer","nullable":true,"description":"0-100, the average of each check category's percentage. Null when the account's scope review settings turn every check off"},"grade":{"type":"string","nullable":true,"enum":["A","B","C","D","F"]},"passing_grade":{"type":"string","enum":["A","B","C","D"],"description":"The account's current passing grade"},"passing":{"type":"boolean","description":"Whether score meets the account's current passing grade (true when score is null). In required mode a project below it cannot be submitted for approval without an override"},"summary":{"type":"string"},"checks":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"category":{"type":"string"},"item":{"type":"string"},"status":{"type":"string","enum":["passed","warning","failed"]},"detail":{"type":"string"},"service":{"type":"string"},"project_service_id":{"type":"integer"},"subservice":{"type":"string"},"project_subservice_id":{"type":"integer"},"field":{"type":"string"}}}},"placeholder_warnings":{"type":"array","description":"Empty when the account turns the placeholders hint off","items":{"type":"object","properties":{"id":{"type":"string"},"location":{"type":"string"},"text":{"type":"string"}}}},"failed_count":{"type":"integer"},"warning_count":{"type":"integer"},"passed_count":{"type":"integer"},"generated_at":{"type":"string","format":"date-time"},"stale":{"type":"boolean"},"completed_item_ids":{"type":"array","items":{"type":"string"}},"estimate_hints":{"type":"array","description":"Project services whose catalog service has historically run over or under its estimate, limited to services the viewer can see. Never affects score, grade or checks. Present only when the account's estimate_accuracy hint is on.","items":{"type":"object","properties":{"project_service_id":{"type":"integer"},"task_id":{"type":"integer"},"service":{"type":"string"},"direction":{"type":"string","enum":["over","under"]},"bias_percentage":{"type":"number"},"confidence":{"type":"number"},"observation_count":{"type":"integer"}}}},"overrides":{"type":"array","description":"Submissions for approval that went ahead below the passing grade, newest first","items":{"type":"object","properties":{"user":{"type":"string","nullable":true,"description":"Name of the user who overrode; null if the user was removed"},"created_at":{"type":"string","format":"date-time"},"grade":{"type":"string"},"score":{"type":"integer"},"passing_grade":{"type":"string"},"reason":{"type":"string","nullable":true}}}},"missing_services":{"type":"object","description":"Catalog services often sold with this project's services, snapshotted when the review was generated and filtered for the viewer. Never affects score, grade or checks. Present only when the release.service-correlations flag is on for the viewer and the account's missing_services hint is on.","properties":{"status":{"type":"string","enum":["ok","insufficient_data","not_generated"]},"basket_count":{"type":"integer","nullable":true},"minimum_baskets":{"type":"integer","nullable":true},"last_computed_at":{"type":"string","nullable":true,"format":"date-time"},"suggestions":{"type":"array","items":{"type":"object","properties":{"task_id":{"type":"integer"},"name":{"type":"string"},"tier":{"type":"string","enum":["high","medium"]},"score":{"type":"number"},"because_of":{"type":"array","items":{"type":"string"}}}}},"dismissed":{"type":"array","items":{"type":"object","properties":{"task_id":{"type":"integer"},"name":{"type":"string"},"dismissed_at":{"type":"string","format":"date-time"}}}}}}}}}}}}}}},"403":{"description":"User lacks the projects.scope_review view privilege"},"404":{"description":"Project not found, or no scope review has been generated"}}},"post":{"summary":"Generate the scope review of a project","description":"Run a new scope review of the project and save it, replacing any saved review and clearing its checkmarks. Requires the projects.scope_review manage privilege","operationId":"V2GenerateScopeReview","tags":["project"],"responses":{"200":{"description":"The newly saved scope review (same shape as the GET response)"},"403":{"description":"User lacks the projects.scope_review manage privilege"},"404":{"description":"Project not found"}}},"patch":{"summary":"Update scope review checkmarks","description":"Replace completed_item_ids on the saved review. generated_at must match the saved review; ids must belong to failed/warning checks or placeholder warnings. Requires the projects.scope_review manage privilege","operationId":"V2UpdateScopeReview","tags":["project"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"object","properties":{"type":{"type":"string","default":"scope-review"},"attributes":{"type":"object","required":["generated_at","completed_item_ids"],"properties":{"generated_at":{"type":"string","format":"date-time"},"completed_item_ids":{"type":"array","items":{"type":"string"}}}}}}}}}}},"responses":{"200":{"description":"The updated scope review (same shape as the GET response)"},"403":{"description":"User lacks the projects.scope_review manage privilege"},"404":{"description":"Project not found, or no scope review has been generated"},"409":{"description":"generated_at does not match the saved review (it was regenerated)"},"422":{"description":"completed_item_ids contains unknown or non-checkable items"}}}},"/v2/projects/{id}/scope-review/dismissed-services":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Dismiss a missing-service suggestion","description":"Dismiss a suggested missing service for this project. Idempotent. Does not mark the review stale. Requires the projects.scope_review manage privilege","operationId":"V2DismissScopeReviewService","tags":["project"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"object","properties":{"type":{"type":"string","default":"dismissed-services"},"attributes":{"type":"object","required":["task_id"],"properties":{"task_id":{"type":"integer"}}}}}}}}}},"responses":{"200":{"description":"The scope review (same shape as the GET response)"},"204":{"description":"Dismissed; no scope review has been generated"},"403":{"description":"User lacks the projects.scope_review manage privilege"},"404":{"description":"Project not found"},"422":{"description":"task_id missing, or not a root catalog service visible to the user in this account"}}}},"/v2/projects/{id}/scope-review/dismissed-services/{task_id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"},{"name":"task_id","in":"path","description":"Id of the dismissed service","required":true,"schema":{"type":"integer"}}],"delete":{"summary":"Undo a missing-service dismissal","description":"Restore a dismissed suggested service. Requires the projects.scope_review manage privilege","operationId":"V2UndismissScopeReviewService","tags":["project"],"responses":{"200":{"description":"The scope review (same shape as the GET response)"},"204":{"description":"Undone; no scope review has been generated"},"403":{"description":"User lacks the projects.scope_review manage privilege"},"404":{"description":"Project not found, or the service was not dismissed"}}}},"/v2/projects/{project_id}/psa-project":{"parameters":[{"$ref":"#/components/parameters/project_id_parameter"}],"get":{"summary":"Get the PSA project for a project","description":"Returns the PSA project associated with the project (at most one)","operationId":"V2GetPsaProject","tags":["psa project"],"responses":{"200":{"description":"PSA project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_PsaProjectResource"}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create the PSA project for a project","description":"Creates the PSA project and enqueues the push to the PSA tool. The push runs in the background: a 201 means the request was accepted, not that the PSA accepted it. Read `error-message` and `project-id` with GET afterwards","operationId":"V2CreatePsaProject","tags":["psa project"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PsaProjectCreateRequest"}}}}}},"responses":{"201":{"description":"Create PSA project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PsaProjectResource"}}}}}},"422":{"description":"Validation failed; errors explain why (for example a blank `start-on` or `end-on`, or on POST an `account-connection` outside your account)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"patch":{"summary":"Update / resubmit the PSA project","description":"Updates the PSA project, clears the last error and re-enqueues the push to the PSA tool. `data.id` is required and must be the ID returned by GET. Relationships cannot be changed. Send empty `attributes` to resubmit with the stored settings","operationId":"V2UpdatePsaProject","tags":["psa project"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PsaProjectUpdateRequest"}}}}}},"responses":{"200":{"description":"Update PSA project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_PsaProjectResource"}}}}}},"422":{"description":"Validation failed; errors explain why (for example a blank `start-on` or `end-on`, or on POST an `account-connection` outside your account)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/questionnaires/{questionnaire_id}/questionnaire-sections":{"parameters":[{"name":"questionnaire_id","description":"ID of the questionnaire","in":"path","required":true,"schema":{"type":"integer"}}],"get":{"summary":"List questionnaire sections for questionnaire","description":"Returns a paged list of questionnaire sections for the questionnaire","operationId":"V2ListQuestionnaireSectionsForQuestionnaire","tags":["questionnaire"],"parameters":[{"name":"sort","in":"query","required":false,"style":"form","explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","name","-name","expression","-expression","position","-position","introduction","-introduction"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"style":"form","explode":false,"description":"Associated data that may be loaded with each questionnaire section","schema":{"type":"array","items":{"type":"string","enum":["questionnaire","questions"]}}}],"responses":{"200":{"description":"Questionnaire Section list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_QuestionnaireSectionResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_QuestionnaireResource"},{"$ref":"#/components/schemas/v2_QuestionResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create questionnaire section for questionnaire","description":"Create a questionnaire section for the questionnaire","operationId":"V2CreateQuestionnaireSection","tags":["questionnaire"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireSectionResource"}}}}}},"responses":{"201":{"description":"Create Questionnaire Section response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireSectionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/questionnaires/{questionnaire_id}/questionnaire-sections/{id}":{"parameters":[{"name":"questionnaire_id","description":"ID of the questionnaire","in":"path","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find questionnaire section by ID","description":"Returns a questionnaire section for the questionnaire by ID","operationId":"V2GetQuestionnaireSectionById","tags":["questionnaire"],"parameters":[{"name":"include","in":"query","description":"Include related resources in the response. The only supported value is \"questions\".","required":false,"schema":{"type":"array","items":{"type":"string","enum":["questionnaire","questions"]}}}],"responses":{"200":{"description":"Find questionnaire section by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireSectionResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_QuestionnaireResource"},{"$ref":"#/components/schemas/v2_QuestionResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update questionnaire section by ID","description":"Update the questionnaire section by ID","operationId":"V2UpdateQuestionnaireSection","tags":["questionnaire"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireSectionResource"}}}}}},"responses":{"200":{"description":"Update Questionnaire Section response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireSectionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete questionnaire section by ID","description":"Delete the questionnaire section from the questionnaire by ID","operationId":"V2DeleteQuestionnaireSection","tags":["questionnaire"],"responses":{"204":{"description":"The Delete QuestionnaireSection was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/questionnaires":{"get":{"summary":"List questionnaires for account","description":"Returns a paged list of questionnaires for the account","operationId":"V2ListQuestionnairesForAccount","tags":["questionnaire"],"parameters":[{"name":"filter[tag-list]","in":"query","required":false,"description":"Questionnaires tagged with one or more of the tags in the provided comma-separated list","schema":{"type":"string"}},{"name":"filter[service-id]","in":"query","required":false,"description":"ID of a service that appears on the questionnaire","schema":{"type":"string"}},{"name":"filter[team.id]","in":"query","required":false,"style":"form","explode":false,"description":"Questionnaires assigned to one or more of the teams with the specified IDs","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[active]","in":"query","required":false,"description":"true for active questionnaires, false for archived questionnaires","schema":{"type":"boolean","default":true}},{"name":"filter[published]","in":"query","required":false,"description":"true if this survey has been published in settings.","schema":{"type":"boolean","default":true}},{"name":"sort","in":"query","required":false,"style":"form","explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","active","-active","name","-name","published","-published","created-at","-created-at","slug","-slug","introduction","-introduction","thank-you","-thank-you","completion-url","-completion-url","questions","-questions","sections","-sections","tag-list","-tag-list","teams","-teams"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"style":"form","explode":false,"description":"Associated data that may be loaded with each questionnaire","schema":{"type":"array","items":{"type":"string","enum":["account","questions","questionnaire-sections","calculations","lookups","recommendations"]}}}],"responses":{"200":{"description":"Questionnaire list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_QuestionnaireResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_QuestionResource"},{"$ref":"#/components/schemas/v2_QuestionnaireSectionResource"},{"$ref":"#/components/schemas/v2_QuestionnaireCalculationResource"},{"$ref":"#/components/schemas/v2_QuestionnaireLookupResource"},{"$ref":"#/components/schemas/v2_QuestionnaireRecommendationResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create questionnaire for account","description":"Create a questionnaire for the account","operationId":"V2CreateQuestionnaire","tags":["questionnaire"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireResource"}}}}}},"responses":{"201":{"description":"Create Questionnaire response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/questionnaires/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find questionnaire by ID","description":"Returns a questionnaire for the account by ID","operationId":"V2GetQuestionnaireById","tags":["questionnaire"],"parameters":[{"name":"include","in":"query","description":"Include related resources in the response. The only supported value is \"questions\".","required":false,"schema":{"type":"array","items":{"type":"string","enum":["account","questions","questionnaire-sections","calculations","lookups","recommendations"]}}}],"responses":{"200":{"description":"Find questionnaire by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_QuestionResource"},{"$ref":"#/components/schemas/v2_QuestionnaireSectionResource"},{"$ref":"#/components/schemas/v2_QuestionnaireCalculationResource"},{"$ref":"#/components/schemas/v2_QuestionnaireLookupResource"},{"$ref":"#/components/schemas/v2_QuestionnaireRecommendationResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update questionnaire by ID","description":"Update the questionnaire by ID","operationId":"V2UpdateQuestionnaire","tags":["questionnaire"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireResource"}}}}}},"responses":{"200":{"description":"Update Questionnaire response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete questionnaire by ID","description":"Delete the questionnaire from the account by ID","operationId":"V2DeleteQuestionnaire","tags":["questionnaire"],"responses":{"204":{"description":"The Delete Questionnaire was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/questionnaires/{id}/duplications":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Duplicate questionnaire by ID","description":"Deep-copies a questionnaire (sections, questions, calculations, lookups, recommendations) for the account by ID and returns the newly created questionnaire","operationId":"V2DuplicateQuestionnaire","tags":["questionnaire"],"responses":{"201":{"description":"Newly duplicated questionnaire response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/questionnaires/{id}/evaluations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Evaluate an equation based on survey responses","description":"Request the result of an equation (e.g., the condition for showing a survey section or a calculation) based on the provided user responses for the survey","operationId":"V2EvaluateQuestionnaire","tags":["questionnaire"],"requestBody":{"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["questionnaires"]},"attributes":{"type":"object","required":["responses","equation"],"properties":{"responses":{"type":"array","items":{"type":"object","required":["question_id","question","answer"],"properties":{"question_id":{"type":"integer","example":123,"description":"ID of the question to which this response provides the answer"},"question":{"type":"string","example":"How many floors in the building?","description":"Text of the question to which this response provides the answer"},"answer":{"type":"string","example":"4","description":"Response to the question provided by the user"}}}},"equation":{"type":"string"}}}}}}}}}},"responses":{"200":{"description":"Result of evaluating the provided equation based on the survey and provided responses","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string","enum":["questionnaires"]},"attributes":{"type":"object","oneOf":[{"$ref":"#/components/schemas/v2_EvlauateStringAttributes"},{"$ref":"#/components/schemas/v2_EvlauateNumberAttributes"},{"$ref":"#/components/schemas/v2_EvlauateBooleanAttributes"}]}}}}}}}}}}},"/v2/questionnaires/{questionnaire_id}/questions":{"parameters":[{"name":"questionnaire_id","description":"ID of the questionnaire","in":"path","required":true,"schema":{"type":"integer"}}],"get":{"summary":"List questions for questionnaire","description":"Returns a paged list of questions for the questionnaire","operationId":"V2ListQuestionsForQuestionnaire","tags":["question"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active questions, false for archived questions","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each question","schema":{"type":"array","items":{"type":"string","enum":["account","questionnaire","questionnaire-section"]}}}],"responses":{"200":{"description":"Question list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_QuestionResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_QuestionnaireResource"},{"$ref":"#/components/schemas/v2_QuestionnaireSectionResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create question for a questionnaire","description":"Create a question for a questionnaire","operationId":"V2CreateQuestion","tags":["question"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionResource"}}}}}},"responses":{"201":{"description":"Create Question response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/questionnaires/{questionnaire_id}/questions/{id}":{"parameters":[{"name":"questionnaire_id","description":"ID of the questionnaire","in":"path","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find question by ID","description":"Returns a question for the questionnaire by ID","operationId":"V2GetQuestionById","tags":["question"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each question","schema":{"type":"array","items":{"type":"string","enum":["account","questionnaire","questionnaire-section"]}}}],"responses":{"200":{"description":"Find question by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_QuestionResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_QuestionnaireResource"},{"$ref":"#/components/schemas/v2_QuestionnaireSectionResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update question by ID","description":"Update the question by ID","operationId":"V2UpdateQuestion","tags":["question"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionResource"}}}}}},"responses":{"200":{"description":"Update Question response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete question by ID","description":"Delete the question by ID","operationId":"V2DeleteQuestion","tags":["question"],"responses":{"204":{"description":"The question was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/questionnaires/{questionnaire_id}/questionnaire-calculations":{"parameters":[{"name":"questionnaire_id","description":"ID of the questionnaire","in":"path","required":true,"schema":{"type":"integer"}}],"get":{"summary":"List questionnaire calculations for questionnaire","description":"Returns a paged list of questionnaire calculations for the questionnaire","operationId":"V2ListQuestionnaireCalculationsForQuestionnaire","tags":["questionnaire-calculation"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active calculations, false for archived calculations","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each calculation","schema":{"type":"array","items":{"type":"string","enum":["questionnaire"]}}}],"responses":{"200":{"description":"Questionnaire calculation list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_QuestionnaireCalculationResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_QuestionnaireResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create questionnaire calculation","description":"Create a calculation for a questionnaire","operationId":"V2CreateQuestionnaireCalculation","tags":["questionnaire-calculation"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireCalculationResource"}}}}}},"responses":{"201":{"description":"Create questionnaire calculation response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireCalculationResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/questionnaires/{questionnaire_id}/questionnaire-calculations/{id}":{"parameters":[{"name":"questionnaire_id","description":"ID of the questionnaire","in":"path","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find questionnaire calculation by ID","description":"Returns a questionnaire calculation for the questionnaire by ID","operationId":"V2GetQuestionnaireCalculationById","tags":["questionnaire-calculation"],"responses":{"200":{"description":"Find questionnaire calculation by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireCalculationResource"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update questionnaire calculation by ID","description":"Update the questionnaire calculation by ID","operationId":"V2UpdateQuestionnaireCalculation","tags":["questionnaire-calculation"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireCalculationResource"}}}}}},"responses":{"200":{"description":"Update questionnaire calculation response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireCalculationResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete questionnaire calculation by ID","description":"Delete the questionnaire calculation by ID","operationId":"V2DeleteQuestionnaireCalculation","tags":["questionnaire-calculation"],"responses":{"204":{"description":"The questionnaire calculation was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/questionnaires/{questionnaire_id}/questionnaire-lookups":{"parameters":[{"name":"questionnaire_id","description":"ID of the questionnaire","in":"path","required":true,"schema":{"type":"integer"}}],"get":{"summary":"List questionnaire lookups for questionnaire","description":"Returns a paged list of questionnaire lookups for the questionnaire","operationId":"V2ListQuestionnaireLookupsForQuestionnaire","tags":["questionnaire-lookup"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active lookups, false for archived lookups","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each lookup","schema":{"type":"array","items":{"type":"string","enum":["questionnaire"]}}}],"responses":{"200":{"description":"Questionnaire lookup list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_QuestionnaireLookupResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_QuestionnaireResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create questionnaire lookup","description":"Create a lookup for a questionnaire","operationId":"V2CreateQuestionnaireLookup","tags":["questionnaire-lookup"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireLookupResource"}}}}}},"responses":{"201":{"description":"Create questionnaire lookup response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireLookupResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/questionnaires/{questionnaire_id}/questionnaire-lookups/{id}":{"parameters":[{"name":"questionnaire_id","description":"ID of the questionnaire","in":"path","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find questionnaire lookup by ID","description":"Returns a questionnaire lookup for the questionnaire by ID","operationId":"V2GetQuestionnaireLookupById","tags":["questionnaire-lookup"],"responses":{"200":{"description":"Find questionnaire lookup by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireLookupResource"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update questionnaire lookup by ID","description":"Update the questionnaire lookup by ID","operationId":"V2UpdateQuestionnaireLookup","tags":["questionnaire-lookup"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireLookupResource"}}}}}},"responses":{"200":{"description":"Update questionnaire lookup response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireLookupResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete questionnaire lookup by ID","description":"Delete the questionnaire lookup by ID","operationId":"V2DeleteQuestionnaireLookup","tags":["questionnaire-lookup"],"responses":{"204":{"description":"The questionnaire lookup was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/questionnaires/{questionnaire_id}/questionnaire-recommendations":{"parameters":[{"name":"questionnaire_id","description":"ID of the questionnaire","in":"path","required":true,"schema":{"type":"integer"}}],"get":{"summary":"List questionnaire recommendations for questionnaire","description":"Returns a paged list of questionnaire recommendations for the questionnaire","operationId":"V2ListQuestionnaireRecommendationsForQuestionnaire","tags":["questionnaire-recommendation"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active recommendations, false for archived recommendations","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each recommendation","schema":{"type":"array","items":{"type":"string","enum":["questionnaire"]}}}],"responses":{"200":{"description":"Questionnaire recommendation list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_QuestionnaireRecommendationResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_QuestionnaireResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create questionnaire recommendation","description":"Create a recommendation for a questionnaire","operationId":"V2CreateQuestionnaireRecommendation","tags":["questionnaire-recommendation"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireRecommendationResource"}}}}}},"responses":{"201":{"description":"Create questionnaire recommendation response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireRecommendationResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/questionnaires/{questionnaire_id}/questionnaire-recommendations/{id}":{"parameters":[{"name":"questionnaire_id","description":"ID of the questionnaire","in":"path","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find questionnaire recommendation by ID","description":"Returns a questionnaire recommendation for the questionnaire by ID","operationId":"V2GetQuestionnaireRecommendationById","tags":["questionnaire-recommendation"],"responses":{"200":{"description":"Find questionnaire recommendation by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireRecommendationResource"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update questionnaire recommendation by ID","description":"Update the questionnaire recommendation by ID","operationId":"V2UpdateQuestionnaireRecommendation","tags":["questionnaire-recommendation"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireRecommendationResource"}}}}}},"responses":{"200":{"description":"Update questionnaire recommendation response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuestionnaireRecommendationResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete questionnaire recommendation by ID","description":"Delete the questionnaire recommendation by ID","operationId":"V2DeleteQuestionnaireRecommendation","tags":["questionnaire-recommendation"],"responses":{"204":{"description":"The questionnaire recommendation was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/scope-review-settings":{"get":{"summary":"Get the scope review settings for the account","description":"Returns a one-item list holding the account's scope review settings, created with defaults on first read. Requires the settings.scope_review view privilege","operationId":"V2ListScopeReviewSettings","tags":["scope review settings"],"responses":{"200":{"description":"Scope review settings list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ScopeReviewSettingResource"}}}}}}},"403":{"description":"User lacks the settings.scope_review view privilege"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/scope-review-settings/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find scope review settings by ID","description":"Returns the account's scope review settings. Requires the settings.scope_review view privilege","operationId":"V2GetScopeReviewSetting","tags":["scope review settings"],"responses":{"200":{"description":"Scope review settings response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ScopeReviewSettingResource"}}}}}},"403":{"description":"User lacks the settings.scope_review view privilege"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update scope review settings","description":"Update the account's scope review settings. rules and hints merge into the stored values. Requires the settings.scope_review manage privilege","operationId":"V2UpdateScopeReviewSetting","tags":["scope review settings"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ScopeReviewSettingResource"}}}}}},"responses":{"200":{"description":"Updated scope review settings response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ScopeReviewSettingResource"}}}}}},"403":{"description":"User lacks the settings.scope_review manage privilege"},"422":{"description":"Invalid mode, passing-grade, loe-high-hours, rule level or hint; nothing is saved"},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/quotes":{"get":{"summary":"List quotes for account","description":"Returns a paged list of quotes for the account","operationId":"V2ListQuotesForAccount","tags":["quote"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the quotes are attached","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active projects, false for archived projects","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project quote","schema":{"type":"array","items":{"type":"string","enum":["project","vendor","lob"]}}}],"responses":{"200":{"description":"Quote list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_QuoteResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_VendorResource"},{"$ref":"#/components/schemas/v2_LobResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create quote for account","description":"Create a quote for the account","operationId":"V2CreateQuote","tags":["quote"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuoteResource"}}}}}},"responses":{"201":{"description":"Create Quote response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuoteResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/quotes/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each project quote","schema":{"type":"array","items":{"type":"string","enum":["project","vendor","lob"]}}}],"get":{"summary":"Find quote by ID","description":"Returns a quote for the account by ID","operationId":"V2GetQuote","tags":["quote"],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuoteResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_VendorResource"},{"$ref":"#/components/schemas/v2_LobResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update quote by ID","description":"Update the quote by ID","operationId":"V2UpdateQuote","tags":["quote"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuoteResource"}}}}}},"responses":{"200":{"description":"Update Quote response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuoteResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete quote by ID","description":"Delete the quote from the account by ID","operationId":"V2DeleteQuote","tags":["quote"],"responses":{"204":{"description":"The Delete Quote was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/quotes/{id}/recalculations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Recalculate costs for the quote by ID","description":"Recalculate costs for the quote by ID","operationId":"V2RecalculateQuote","tags":["quote"],"responses":{"200":{"description":"Recalculate Quote response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuoteResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/quotes/{id}/document-acceptances":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Update the vendor document status to accepted","description":"Update the vendor document status to accepted","operationId":"V2AcceptVendorDocumentForQuote","tags":["quote"],"responses":{"200":{"description":"Quote response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_QuoteResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/rate-tables":{"get":{"summary":"List Rate Tables for account","description":"Returns a paged list of Rate Tables for the account","operationId":"V2ListRateTablesForAccount","tags":["rate table"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active rate tables, false for archived rate tables","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each rate table","schema":{"type":"array","items":{"type":"string","enum":["account","currency","clients","projects","users","resource-rates"]}}}],"responses":{"200":{"description":"Rate Table list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_RateTableResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_CurrencyResource"},{"$ref":"#/components/schemas/v2_ClientResource"},{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_UserResource"},{"$ref":"#/components/schemas/v2_ResourceRateResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create Rate Table for account","description":"Create a Rate Table for the account","operationId":"V2CreateRateTable","tags":["rate table"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_RateTableResource"}}}}}},"responses":{"201":{"description":"Create Rate Table response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_RateTableResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/rate-tables/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find Rate Table by ID","description":"Returns a Rate Table for the account by ID","operationId":"V2GetRateTable","tags":["rate table"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with the rate table","schema":{"type":"array","items":{"type":"string","enum":["account","currency","clients","projects","users","resource-rates"]}}}],"responses":{"200":{"description":"Rate table response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_RateTableResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update Rate Table by ID","description":"Update the Rate Table by ID","operationId":"V2UpdateRateTable","tags":["rate table"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_RateTableResource"}}}}}},"responses":{"200":{"description":"Update Rate table response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_RateTableResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete Rate Table by ID","description":"Delete the Rate Table from the account by ID","operationId":"V2DeleteRateTable","tags":["rate table"],"responses":{"204":{"description":"The Delete Rate Table was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/rate-tables/{id}/duplications":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Duplicate Rate Table by ID","description":"Duplicates a Rate Table for the account by ID and returns the newly created rate table","operationId":"V2DuplicateRateTable","tags":["rate table"],"responses":{"200":{"description":"Newly duplicated Rate table response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_RateTableResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/resource-allocations":{"get":{"summary":"List resource allocations for project or account","description":"Returns a paged list of resource allocations for the project or account","operationId":"V2ListResourceAllocations","tags":["resource allocation"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each resource allocation","schema":{"type":"array","items":{"type":"string","enum":["resource-plan","project-resource"]}}}],"responses":{"200":{"description":"Resource allocation list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ResourceAllocationResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ResourcePlanResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create resource allocation for project","description":"Create a resource allocation for the project","operationId":"V2CreateResourceAllocation","tags":["resource allocation"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceAllocationResource"}}}}}},"responses":{"201":{"description":"Create Resource allocation response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceAllocationResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/resource-allocations/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find resource allocation by ID","description":"Returns a resource allocation for the project by ID","operationId":"V2GetResourceAllocationById","tags":["resource allocation"],"responses":{"200":{"description":"Project list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceAllocationResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update resource allocation by ID","description":"Update the resource allocation by ID","operationId":"V2UpdateResourceAllocation","tags":["resource allocation"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceAllocationResource"}}}}}},"responses":{"200":{"description":"Update Resource allocation response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceAllocationResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete resource allocation by ID","description":"Delete the resource allocation from the project by ID","operationId":"V2DeleteResourceAllocation","tags":["resource allocation"],"responses":{"204":{"description":"The Resource allocation was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/resource-plans":{"get":{"summary":"List resource plans for project or account","description":"Returns a paged list of resource plans for the project or account","operationId":"V2ListResourcePlans","tags":["resource plan"],"parameters":[{"name":"filter[project]","in":"query","required":false,"description":"ID of the project to which the resource plans are attached","schema":{"type":"string"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each resource plan","schema":{"type":"array","items":{"type":"string","enum":["project","resource-allocations"]}}}],"responses":{"200":{"description":"Resource plan list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ResourcePlanResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ResourcePlanResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create resource plan for project","description":"Create a resource plan for the project","operationId":"V2CreateResourcePlan","tags":["resource plan"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourcePlanResource"}}}}}},"responses":{"201":{"description":"Create Resource plan response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourcePlanResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/resource-plans/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find resource plan by ID","description":"Returns a resource plan for the project by ID","operationId":"V2GetResourcePlanById","tags":["resource plan"],"responses":{"200":{"description":"Project list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourcePlanResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update resource plan by ID","description":"Update the resource plan by ID","operationId":"V2UpdateResourcePlan","tags":["resource plan"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourcePlanResource"}}}}}},"responses":{"200":{"description":"Update Resource plan response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourcePlanResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete resource plan by ID","description":"Delete the resource plan from the project by ID","operationId":"V2DeleteResourcePlan","tags":["resource plan"],"responses":{"204":{"description":"The Resource plan was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/resource-plans/{id}/duplications":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Duplicate resource plan by ID","description":"Duplicate the resource plan from the project by ID","operationId":"V2DuplicateResourcePlan","tags":["resource plan"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourcePlanResource"}}}}}},"responses":{"200":{"description":"The Resource plan was deleted successfully","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourcePlanResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/resource-rates":{"get":{"summary":"List resources for account","description":"Returns a paged list of resources for the account","operationId":"V2ListResourceRatesForAccount","tags":["resource rate"],"parameters":[{"name":"filter[resource]","in":"query","required":false,"description":"ID of the resource to which the resource rate is associated","schema":{"type":"string"}},{"name":"filter[rate-table]","in":"query","required":false,"description":"ID of the rate table to which the resource rate is associated","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active resource rates, false for archived resource rates","schema":{"type":"boolean","default":true}},{"name":"filter[governed-categories]","in":"query","required":false,"description":"List of category IDs to filter the resource rates by","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each resource rate","schema":{"type":"array","items":{"type":"string","enum":["rate-table","resource","line-of-business"]}}}],"responses":{"200":{"description":"Resource Rate list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ResourceRateResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_CurrencyResource"},{"$ref":"#/components/schemas/v2_ClientResource"},{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_UserResource"},{"$ref":"#/components/schemas/v2_ResourceRateResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create Resource Rate for account","description":"Create a Resource Rate for the account","operationId":"V2CreateResourceRate","tags":["resource rate"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceRateResource"}}}}}},"responses":{"201":{"description":"Create ResourceRate response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceRateResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/resource-rates/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find resource rate by ID","description":"Returns a resource rate for the account by ID","operationId":"V2GetResourceRateById","tags":["resource rate"],"responses":{"200":{"description":"Find resource rate by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceRateResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update resource rate by ID","description":"Update the resource rate by ID","operationId":"V2UpdateResourceRate","tags":["resource rate"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceRateResource"}}}}}},"responses":{"200":{"description":"Update Resource Rate response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceRateResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete resource rate by ID","description":"Delete the resource rate from the account by ID","operationId":"V2DeleteResourceRate","tags":["resource rate"],"responses":{"204":{"description":"The Delete Resource Rate was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/resources":{"get":{"summary":"List resources for account","description":"Returns a paged list of resources for the account","operationId":"V2ListResourcesForAccount","tags":["resource"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active resources, false for archived resources","schema":{"type":"boolean","default":true}},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each resource","schema":{"type":"array","items":{"type":"string","enum":["account"]}}},{"name":"filter","in":"query","required":false,"schema":{"properties":{"active":{"type":"boolean","description":"True for records in active use; false for soft-deleted records"}}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Resource list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ResourceResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create resource for account","description":"Create a resource for the account","operationId":"V2CreateResource","tags":["resource"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceResource"}}}}}},"responses":{"201":{"description":"Create Resource response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/resources/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find resource by ID","description":"Returns a resource for the account by ID","operationId":"V2GetResourceById","tags":["resource"],"responses":{"200":{"description":"Find resource by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_ResourceResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update resource by ID","description":"Update the resource by ID","operationId":"V2UpdateResource","tags":["resource"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceResource"}}}}}},"responses":{"200":{"description":"Update Resource response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ResourceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete resource by ID","description":"Delete the resource from the account by ID","operationId":"V2DeleteResource","tags":["resource"],"responses":{"204":{"description":"The resource was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/roles":{"get":{"summary":"List roles for account","description":"Returns a paged list of roles for the account","operationId":"V2ListRolesForAccount","tags":["role"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the role","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","name","-name","privileges","-privileges","default","-default"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each role","schema":{"type":"array","items":{"type":"string","enum":["account","users"]}}}],"responses":{"200":{"description":"Role list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_RoleResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_UserResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create role for account","description":"Create a role for the account","operationId":"V2CreateRole","tags":["role"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_RoleResource"}}}}}},"responses":{"201":{"description":"Create Role response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_RoleResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/roles/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find role by ID","description":"Returns a role for the account by ID","operationId":"V2GetRole","tags":["role"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each role","schema":{"type":"array","items":{"type":"string","enum":["account","users"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_RoleResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_UserResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update role by ID","description":"Update the role by ID","operationId":"V2UpdateRole","tags":["role"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_RoleResource"}}}}}},"responses":{"200":{"description":"Update Role response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_RoleResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete role by ID","description":"Delete the role from the account by ID","operationId":"V2DeleteRole","tags":["role"],"responses":{"204":{"description":"The role was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/sales-executives":{"get":{"summary":"List sales executives for account","description":"Returns a paged list of sales executives for the account","operationId":"V2ListSalesExecutivesForAccount","tags":["sales executive"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the sales executive","schema":{"type":"string"}},{"name":"filter[email]","in":"query","required":false,"description":"String of characters in the email address of the sales executive","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active sales executives, false for archived sales executives","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each sales executive","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Sales executive list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_SalesExecutiveResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create sales executive for account","description":"Create a sales executive for the account","operationId":"V2CreateSalesExecutive","tags":["sales executive"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SalesExecutiveResource"}}}}}},"responses":{"201":{"description":"Create Sales executive response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SalesExecutiveResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/sales-executives/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find sales executive by ID","description":"Returns a sales executive for the account by ID","operationId":"V2GetSalesExecutiveById","tags":["sales executive"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each sales executive","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Find sales executive by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SalesExecutiveResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update sales executive by ID","description":"Update the sales executive by ID","operationId":"V2UpdateSalesExecutive","tags":["sales executive"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SalesExecutiveResource"}}}}}},"responses":{"200":{"description":"Update Sales executive response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SalesExecutiveResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete sales executive by ID","description":"Delete the sales executive from the account by ID","operationId":"V2DeleteSalesExecutive","tags":["sales executive"],"responses":{"204":{"description":"The Delete Sales executive was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/service-categories":{"get":{"summary":"List service categorys for account","description":"Returns a paged list of service categorys for the account","operationId":"V2ListServiceCategorysForAccount","tags":["service category"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the service category","schema":{"type":"string"}},{"name":"filter[lob]","in":"query","required":false,"description":"ID of line of business to which the service category is associated","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active service categories, false for archived service categories","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each service category","schema":{"type":"array","items":{"type":"string","enum":["account"]}}},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","active","-active","name","-name","nested-name","-nested-name","position","-position","code","-code","has-parent?","-has-parent?","lob-id","-lob-id"]}}}],"responses":{"200":{"description":"Service Category list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create service category for account","description":"Create a service category for the account","operationId":"V2CreateServiceCategory","tags":["service category"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}}}}}},"responses":{"201":{"description":"Create Service Category response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/service-categories/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find service category by ID","description":"Returns a service category for the account by ID","operationId":"V2GetServiceCategory","tags":["service category"],"responses":{"200":{"description":"Service Category response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceCategoryResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update service category by ID","description":"Update the service category by ID","operationId":"V2UpdateServiceCategory","tags":["service category"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}}}}}},"responses":{"200":{"description":"Update Service Category response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete service category by ID","description":"Delete the service category from the account by ID","operationId":"V2DeleteServiceCategory","tags":["service category"],"responses":{"204":{"description":"The service category was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/service-categories/{id}/moves":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"patch":{"summary":"Move the service cateogory into a new position in the list by ID","description":"Moves the service category into its new position and returns updated service category ","operationId":"V2ChangeServiceCategoryPositionById","tags":["service category"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}}}}}},"responses":{"200":{"description":"Find service category by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/service-categories/{id}/restore-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Restore a soft-deleted service category by ID","description":"Clears deleted_at on the service category, returning it to the active set","operationId":"V2RestoreServiceCategoryById","tags":["service category"],"responses":{"200":{"description":"Restored service category response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceCategoryResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/service-categories/{id}/purge-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"delete":{"summary":"Permanently delete a soft-deleted service category by ID","description":"Hard-deletes the service category. Only valid for records that have been soft-deleted.","operationId":"V2PurgeServiceCategoryById","tags":["service category"],"responses":{"204":{"description":"The service category was purged successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/service-conditions":{"get":{"summary":"List service conditions for account","description":"Returns a paged list of service conditions for the account","operationId":"V2ListServiceConditionsForAccount","tags":["service condition"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active service conditions, false for archived service conditions","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each service condition","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"ServiceCondition list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ServiceConditionResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create service condition","description":"Create a service condition for the account","operationId":"V2CreateServiceCondition","tags":["service condition"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceConditionResource"}}}}}},"responses":{"201":{"description":"Create Service Condition response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceConditionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/service-conditions/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find service condition by ID","description":"Returns a service condition for the account by ID","operationId":"V2GetServiceCondition","tags":["service condition"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each service condition","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceConditionResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update service condition by ID","description":"Update the service condition by ID","operationId":"V2UpdateServiceCondition","tags":["service condition"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceConditionResource"}}}}}},"responses":{"200":{"description":"Update ServiceCondition response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceConditionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete service condition by ID","description":"Delete the service condition from the account by ID","operationId":"V2DeleteServiceCondition","tags":["service condition"],"responses":{"204":{"description":"The Service Condition was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/service-conditions/{id}/moves":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"patch":{"summary":"Move the service condition into a new position in the list by ID","description":"Moves the service condition into its new position and returns the service condition by ID","operationId":"V2ChangeServiceConditionPositionById","tags":["service condition"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceConditionResource"}}}}}},"responses":{"200":{"description":"Move service condition by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceConditionResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/services":{"get":{"summary":"List services for account","description":"Returns a paged list of services for the account","operationId":"V2ListServicesForAccount","tags":["service"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the service","schema":{"type":"string"}},{"name":"filter[tag_list]","in":"query","required":false,"description":"Services tagged with AT LEAST ONE of the tags in the provided comma-separated list","schema":{"type":"string"}},{"name":"filter[sku]","in":"query","required":false,"description":"SKU of the service","schema":{"type":"string"}},{"name":"filter[lob]","in":"query","required":false,"description":"Comma-separated list of ID of lines of business to which the service is associated","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[service-category]","in":"query","required":false,"description":"Comma-separated list of IDs of service categories to which the service is associated","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[phase]","in":"query","required":false,"description":"ID of project phase to which the service is associated","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[blueprint]","in":"query","required":false,"description":"ID of blueprint with which the service is associated","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[service_type]","in":"query","required":false,"description":"name of service-type of the service","schema":{"type":"string","enum":["professional_services","managed_services"]}},{"name":"filter[state]","in":"query","required":false,"description":"Comma-separated list of service states. Defaults to active, so pending and other services are omitted unless you name their state","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["pending","active","deleted","custom"]}}},{"name":"filter[payment-frequency]","in":"query","required":false,"description":"Comma-separated list of names of state of the billing frequency for the service","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["one_time","monthly","quarterly","yearly"]}}},{"name":"filter[survey_recommended]","in":"query","required":false,"description":"true to return only services that appear in survey recommendations","schema":{"type":"boolean"}},{"name":"filter[questionnaire]","in":"query","required":false,"description":"ID of questionnaire with which the service is associated","schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[exclude]","in":"query","required":false,"description":"comma-separated list of IDs to exclude from the response","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active service, false for archived service","schema":{"type":"boolean","default":true}},{"name":"filter[created-at.after]","in":"query","required":false,"description":"Day on or after which the service was created. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[created-at.before]","in":"query","required":false,"description":"Day on or before which the service was created. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[updated-at.after]","in":"query","required":false,"description":"Day on or after which the service was updated. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[updated-at.before]","in":"query","required":false,"description":"Day on or before which the service was updated. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[ids]","in":"query","required":false,"description":"Comma-separated list of IDs of services to to download","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[search]","in":"query","required":false,"description":"Characters related to service attributes","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["name","-name","service_description","-service_description","service_type","-service_type","sku","-sku","created_at","-created_at","updated_at","-updated_at","service_category.nested_name","-service_category.nested_name","phase.name","-phase.name"]}}},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each service","schema":{"type":"array","items":{"type":"string","enum":["account","resource","phase","service-category","subservices","products","subservices.resource"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Service list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ServiceResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_PhaseResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"},{"$ref":"#/components/schemas/v2_SubserviceResource"},{"$ref":"#/components/schemas/v2_ProductResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create service for account","description":"Create a service for the account","operationId":"V2CreateService","tags":["service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceResource"}}}}}},"responses":{"201":{"description":"Create Service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/services/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find service by ID","description":"Returns a service for the account by ID","operationId":"V2GetServiceById","tags":["service"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each service","schema":{"type":"array","items":{"type":"string","enum":["account","resource","phase","service-category","subservices","products"]}}}],"responses":{"200":{"description":"Find service by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_PhaseResource"},{"$ref":"#/components/schemas/v2_ServiceCategoryResource"},{"$ref":"#/components/schemas/v2_SubserviceResource"},{"$ref":"#/components/schemas/v2_ProductResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update service by ID","description":"Update the service by ID","operationId":"V2UpdateService","tags":["service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceResource"}}}}}},"responses":{"200":{"description":"Update Service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete service by ID","description":"Delete the service from the account by ID","operationId":"V2DeleteService","tags":["service"],"responses":{"204":{"description":"The Delete Service was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/services/{id}/activations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Activate the service by ID","description":"Activate the service","operationId":"V2ActivateService","tags":["service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceResource"}}}}}},"responses":{"200":{"description":"Update service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceResource"}}}}}},"422":{"description":"Unprocessable entity when service is in the wrong state","content":{"application/vnd.api+json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/services/{id}/restore-requests":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Restore the service by ID","description":"Restore the service","operationId":"V2RestoreService","tags":["service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceResource"}}}}}},"responses":{"200":{"description":"Update service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceResource"}}}}}},"422":{"description":"Unprocessable entity when service is in the wrong state","content":{"application/vnd.api+json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/services/{id}/duplications":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Duplicate a service by ID","description":"Duplicate a service by ID","operationId":"V2DuplicateService","tags":["service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceResource"}}}}}},"responses":{"200":{"description":"The service was duplicated successfully","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/services/{id}/downloads":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"CSV of service by ID","description":"Csv of a service by ID","operationId":"V2DownloadService","tags":["service"],"responses":{"200":{"description":"The service was sent successfully","content":{"text/csv":{"schema":{"type":"string"}}}}}}},"/v2/services/downloads":{"post":{"summary":"Csv with selected services","description":"Csv with selected services","operationId":"V2DownloadListOfServices","tags":["service"],"parameters":[{"name":"filter[ids]","in":"query","required":false,"description":"Comma-separated list of IDs of services to to download","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"The services were sent successfully","content":{"text/csv":{"schema":{"type":"string"}}}}}}},"/v2/service-approvers":{"get":{"summary":"List service approvers for account","description":"Returns a paged list of service approvers for the account","operationId":"V2ListServiceApproversForAccount","tags":["service approver"],"parameters":[{"name":"filter[lob]","in":"query","required":false,"description":"IDs of lines of business if a select group is required","schema":{"type":"string"}},{"name":"filter[user]","in":"query","required":false,"description":"IDs of users if a select group is required","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","name","-name"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each service approver","schema":{"type":"array","items":{"type":"string","enum":["account","user","line-of-business"]}}}],"responses":{"200":{"description":"Service Approver list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ServiceApproverResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_UserResource"},{"$ref":"#/components/schemas/v2_LineOfBusinessResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create service approver for account","description":"Create a service approver for the account","operationId":"V2CreateServiceApprover","tags":["service approver"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceApproverResource"}}}}}},"responses":{"201":{"description":"Create ServiceApprover response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceApproverResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/service-approvers/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find service approver by ID","description":"Returns a service approver for the account by ID","operationId":"V2GetServiceApprover","tags":["service approver"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each service approver","schema":{"type":"array","items":{"type":"string","enum":["account","user","line-of-business"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceApproverResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_UserResource"},{"$ref":"#/components/schemas/v2_LineOfBusinessResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update service approver by ID","description":"Update the service approver by ID","operationId":"V2UpdateServiceApprover","tags":["service approver"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceApproverResource"}}}}}},"responses":{"200":{"description":"Update Service Approver response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ServiceApproverResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete service approver by ID","description":"Delete the service approver from the account by ID","operationId":"V2DeleteServiceApprover","tags":["service approver"],"responses":{"204":{"description":"The service approver was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/subcontractors":{"get":{"summary":"List subcontractors for account","description":"Returns a paged list of subcontractors for the account","operationId":"V2ListSubcontractorsForAccount","tags":["subcontractor"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Subcontractor list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_SubcontractorResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/subcontractors/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find subcontractor by ID","description":"Returns a subcontractor for the account by ID","operationId":"V2GetSubcontractor","tags":["subcontractor"],"responses":{"200":{"description":"Subcontractor Project response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_SubcontractorResource"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/subservices":{"get":{"summary":"List subservices for account","description":"Returns a paged list of subservices for the account","operationId":"V2ListSubservicesForAccount","tags":["subservice"],"parameters":[{"name":"filter[state]","in":"query","required":false,"description":"name of the state of the subservice. Defaults to active, so subservices in other states are omitted unless you name their state","schema":{"type":"string","enum":["pending","active","deleted","custom"],"default":"active"}},{"name":"filter[active]","in":"query","required":false,"description":"true for active subservices, false for archived subservices","schema":{"type":"boolean","default":true}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each subservice","schema":{"type":"array","items":{"type":"string","enum":["resource","service"]}}}],"responses":{"200":{"description":"Subservice list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_SubserviceResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ServiceResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create subservice for account","description":"Create a subservice for the account","operationId":"V2CreateSubservice","tags":["subservice"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SubserviceResource"}}}}}},"responses":{"201":{"description":"Create Subservice response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SubserviceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/subservices/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find subservice by ID","description":"Returns a subservice for the account by ID","operationId":"V2GetSubserviceById","tags":["subservice"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each subservice","schema":{"type":"array","items":{"type":"string","enum":["resource","service"]}}}],"responses":{"200":{"description":"Find subservice by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SubserviceResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ServiceResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update subservice by ID","description":"Update the subservice by ID","operationId":"V2UpdateSubservice","tags":["subservice"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SubserviceResource"}}}}}},"responses":{"200":{"description":"Update Subservice response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SubserviceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete subservice by ID","description":"Delete the subservice from the account by ID","operationId":"V2DeleteSubservice","tags":["subservice"],"responses":{"204":{"description":"The Delete Subservice was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/subservices/{id}/activations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Activate the subservice by ID","description":"Activate the subservice","operationId":"V2ActivateSubservice","tags":["subservice"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SubserviceResource"}}}}}},"responses":{"200":{"description":"Update subservice response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SubserviceResource"}}}}}},"422":{"description":"Unprocessable entity when subservice is in the wrong state","content":{"application/vnd.api+json":{"schema":{"properties":{"errors":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"}}}}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/subservices/{id}/moves":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"patch":{"summary":"Move the subservice into a new position in the list by ID","description":"Moves the subservice into its new position and Returns a subservice for the account by ID","operationId":"V2ChangeSubservicePositionById","tags":["subservice"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SubserviceResource"}}}}}},"responses":{"200":{"description":"Update Subservice response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SubserviceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/survey-recommendations":{"get":{"summary":"List survey recommendations for account","description":"Returns a paged list of survey recommendations for the account","operationId":"V2ListSurveyRecommendationsForAccount","tags":["survey recommendation"],"parameters":[{"name":"filter[survey]","in":"query","required":false,"explode":false,"description":"ID of the survey to which the responses belong","schema":{"type":"string"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each survey","schema":{"type":"array","items":{"type":"string","enum":["survey","resource","project-resource"]}}}],"responses":{"200":{"description":"Survey list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_SurveyRecommendationResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_SurveyResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/survey-recommendations/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find survey recommendation by ID","description":"Returns a survey recommendation for the account by ID","operationId":"V2GetSurveyRecommendationById","tags":["survey recommendation"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each survey","schema":{"type":"array","items":{"type":"string","enum":["survey","resource","project-resource"]}}}],"responses":{"200":{"description":"Find survey recommendation by ID response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_SurveyRecommendationResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_SurveyResource"},{"$ref":"#/components/schemas/v2_ResourceResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update survey recommendation by ID","description":"Update the survey recommendation by ID","operationId":"V2UpdateSurveyRecommendation","tags":["survey recommendation"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"object","$ref":"#/components/schemas/v2_SurveyRecommendationResource"}}}}}},"responses":{"200":{"description":"Update Survey response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_SurveyRecommendationResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete survey recommendation by ID","description":"Delete the survey recommendation from the account by ID","operationId":"V2DeleteSurveyRecommendation","tags":["survey recommendation"],"responses":{"204":{"description":"The Delete Survey was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/survey-recommendations/{id}/applications":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Apply survey recommendations","description":"Apply a survey recommendations to a project","operationId":"V2ApplySurveyRecommendation","tags":["survey recommendation"],"responses":{"200":{"description":"Survey with calculated recommendations","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_SurveyRecommendationResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/survey-responses":{"get":{"summary":"List survey responses for account","description":"Returns a paged list of survey responses for the account","operationId":"V2ListSurveyResponsesForAccount","tags":["survey response"],"parameters":[{"name":"filter[survey]","in":"query","required":false,"explode":false,"description":"ID of the survey to which the responses belong","schema":{"type":"string"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each client","schema":{"type":"array","items":{"type":"string","enum":["survey","source"]}}}],"responses":{"200":{"description":"Survey Response list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_SurveyResponseResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_SurveyResource"},{"$ref":"#/components/schemas/v2_QuestionResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create survey response for account","description":"Create a survey response for the account","operationId":"V2CreateSurveyResponse","tags":["survey response"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SurveyResponseResource"}}}}}},"responses":{"201":{"description":"Create Survey Response response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SurveyResponseResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/survey-responses/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find survey response by ID","description":"Returns a survey response for the account by ID","operationId":"V2GetSurveyResponseById","tags":["survey response"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each client","schema":{"type":"array","items":{"type":"string","enum":["survey","source"]}}}],"responses":{"200":{"description":"Find survey response by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SurveyResponseResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_SurveyResource"},{"$ref":"#/components/schemas/v2_QuestionResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update survey response by ID","description":"Update the survey response by ID","operationId":"V2UpdateSurveyResponse","tags":["survey response"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SurveyResponseResource"}}}}}},"responses":{"200":{"description":"Update Survey Response response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SurveyResponseResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete survey response by ID","description":"Delete the survey response from the account by ID","operationId":"V2DeleteSurveyResponse","tags":["survey response"],"responses":{"204":{"description":"The Delete Survey Response was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/surveys":{"get":{"summary":"List surveys for account","description":"Returns a paged list of surveys for the account","operationId":"V2ListSurveysForAccount","tags":["survey"],"parameters":[{"name":"filter[status]","in":"query","required":false,"description":"Current status of the survey","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["pending","shared","completed","applied","revised"]}}},{"name":"filter[name]","in":"query","required":false,"description":"Characters in the name of the survey","schema":{"type":"string"}},{"name":"filter[questionnaire-id]","in":"query","required":false,"description":"Comma-separated list of Survey IDs that were filled out","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[project-id]","in":"query","required":false,"description":"Comma-separated list of IDs of projects to which surveys were linked","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[tag-list]","in":"query","required":false,"description":"Surveys with a questionnaires tagged with one or more of the tags in the provided comma-separated list","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filter[contact-name]","in":"query","required":false,"description":"Characters in the name provided by the individual completing the survey","schema":{"type":"string"}},{"name":"filter[created-at.after]","in":"query","required":false,"description":"Day on or after which the survey was created. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[created-at.before]","in":"query","required":false,"description":"Day on or before which the survey was created. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[updated-at.after]","in":"query","required":false,"description":"Day on or after which the survey was updated. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[updated-at.before]","in":"query","required":false,"description":"Day on or before which the survey was updated. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[creator]","in":"query","required":false,"description":"ID of the user that created the survey","schema":{"type":"string"}},{"name":"filter[sender-id]","in":"query","required":false,"description":"ID of the user that shared the survey","schema":{"type":"string"}},{"name":"filter[emails]","in":"query","required":false,"description":"string of characters in the email address of a recipient of a shared survey","schema":{"type":"string"}},{"name":"filter[shared]","in":"query","required":false,"description":"if true, return only surveys that were shared; otherwise returns all surveys","schema":{"type":"boolean"}},{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","name","-name","contact_name","-contact_name","contact_email","-contact_email","responses","-responses","recommendations","-recommendations","updated_at","-updated_at","created_at","-created_at","status","-status","emails","-emails","sender","-sender","sent_at","-sent_at","calculations","-calculations","user_id","-user_id","completed_by","-completed_by","project.project_name","-project.project_name"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each survey","schema":{"type":"array","items":{"type":"string","enum":["account","questionnaire","project-survey","project","survey-responses","survey-recommendations"]}}}],"responses":{"200":{"description":"Survey list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_SurveyResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_QuestionnaireResource"},{"$ref":"#/components/schemas/v2_ProjectSurveyResource"},{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_SurveyResponseResource"},{"$ref":"#/components/schemas/v2_SurveyRecommendationResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create survey for account","description":"Create a survey for the account","operationId":"V2CreateSurvey","tags":["survey"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SurveyResource"}}}}}},"responses":{"201":{"description":"Create Survey response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SurveyResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/surveys/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find survey by ID","description":"Returns a survey for the account by ID","operationId":"V2GetSurveyById","tags":["survey"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each survey","schema":{"type":"array","items":{"type":"string","enum":["account","questionnaire","project-survey","project","survey-responses","survey-recommendations"]}}}],"responses":{"200":{"description":"Find survey by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SurveyResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_QuestionnaireResource"},{"$ref":"#/components/schemas/v2_ProjectSurveyResource"},{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_SurveyResponseResource"},{"$ref":"#/components/schemas/v2_SurveyRecommendationResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update survey by ID","description":"Update the survey by ID","operationId":"V2UpdateSurvey","tags":["survey"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SurveyResource"}}}}}},"responses":{"200":{"description":"Update Survey response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SurveyResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete survey by ID","description":"Delete the survey from the account by ID","operationId":"V2DeleteSurvey","tags":["survey"],"responses":{"204":{"description":"The Delete Survey was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/surveys/{id}/calculations":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Calculate survey recommendations","description":"Calculate survey recommendations based on the current state of the survey","operationId":"V2CalculateSurveyRecommendations","tags":["survey"],"responses":{"200":{"description":"Survey with calculated recommendations","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SurveyResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/surveys/{id}/applications":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Apply survey recommendations","description":"Apply survey recommendations based on the current state of the survey","operationId":"V2ApplySurveyRecommendations","tags":["survey"],"responses":{"200":{"description":"Survey with applied recommendations","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SurveyResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/surveys/{id}/shares":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"post":{"summary":"Share a survey with multiple emails","description":"Share a specific survey by providing a list of email addresses.","operationId":"V2ShareSurvey","tags":["survey"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string"},"description":"A list of email addresses where the survey will be shared."}}}}}}}},"responses":{"201":{"description":"Survey successfully shared and a shared_survey record was created.","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"string","description":"Descriptive message of the response","example":"Surveys shared successfully."}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/tags":{"get":{"summary":"List tags for account","description":"Returns a paged list of tags for the account","operationId":"V2ListTagsForAccount","tags":["tag"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"filter","in":"query","required":false,"schema":{"properties":{"name":{"type":"string","description":"String of characters in the name of the contact"}}}}],"responses":{"200":{"description":"Tag list response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_TagResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/tags/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find tag by ID","description":"Returns a tag for the account by ID","operationId":"V2GetTag","tags":["tag"],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/v2_TagResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/services/{service_id}/task-rates":{"parameters":[{"$ref":"#/components/parameters/service_id_parameter"}],"get":{"summary":"Retrieves task rates","description":"Retrieves task rates","operationId":"V2GetServiceTaskRates","tags":["service"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Service task rates retreived successfully","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_TaskRateResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create task rate","description":"Create task rate","operationId":"V2CreateTaskRateForService","tags":["service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TaskRateResource"}}}}}},"responses":{"201":{"description":"Create task rate response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TaskRateResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/services/{service_id}/task-rates/{id}":{"parameters":[{"$ref":"#/components/parameters/service_id_parameter"},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Retrieves task rate","description":"Retrieves task rate","operationId":"V2GetServiceTaskRate","tags":["service"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Task rate retreived successfully","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_TaskRateResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"patch":{"summary":"Update task rate","description":"Update task rate","operationId":"V2UpdateTaskRateForService","tags":["service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TaskRateResource"}}}}}},"responses":{"201":{"description":"Create task rate response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TaskRateResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete task rate by ID","description":"Delete the task rate by ID","operationId":"V2DeleteTaskRateFromService","tags":["service"],"responses":{"204":{"description":"The task rate was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/subservices/{subservice_id}/task-rates":{"parameters":[{"$ref":"#/components/parameters/subservice_id_parameter"}],"get":{"summary":"Retrieves task rates","description":"Retrieves task rates","operationId":"V2GetSubserviceTaskRates","tags":["subservice"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Subservice task rates retreived successfully","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_TaskRateResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create task rate","description":"Create task rate","operationId":"V2CreateTaskRateForSubservice","tags":["subservice"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TaskRateResource"}}}}}},"responses":{"201":{"description":"Create task rate response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TaskRateResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/subservices/{subservice_id}/task-rates/{id}":{"parameters":[{"$ref":"#/components/parameters/subservice_id_parameter"},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Retrieves task rate","description":"Retrieves task rate","operationId":"V2GetSubserviceTaskRate","tags":["subservice"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Task rate retreived successfully","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_TaskRateResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"patch":{"summary":"Update task rate","description":"Update task rate","operationId":"V2UpdateTaskRateForSubservice","tags":["subservice"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TaskRateResource"}}}}}},"responses":{"201":{"description":"Create task rate response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TaskRateResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete task rate by ID","description":"Delete the task rate by ID","operationId":"V2DeleteTaskRateFromSubservice","tags":["subservice"],"responses":{"204":{"description":"The task rate was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/products/{product_id}/task-rates":{"parameters":[{"name":"product_id","description":"ID of record","in":"path","required":true,"schema":{"type":"integer"}}],"get":{"summary":"Retrieves task rates","description":"Retrieves task rates","operationId":"V2GetProductTaskRates","tags":["product"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Product task rates retreived successfully","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_TaskRateResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create task rate","description":"Create task rate","operationId":"V2CreateTaskRateForProduct","tags":["product"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TaskRateResource"}}}}}},"responses":{"201":{"description":"Create task rate response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TaskRateResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/products/{product_id}/task-rates/{id}":{"parameters":[{"name":"product_id","description":"ID of record","in":"path","required":true,"schema":{"type":"integer"}},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Retrieves task rate","description":"Retrieves task rate","operationId":"V2GetProductTaskRate","tags":["product"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Task rate retreived successfully","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_TaskRateResource"}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"patch":{"summary":"Update task rate","description":"Update task rate","operationId":"V2UpdateTaskRateForProduct","tags":["product"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TaskRateResource"}}}}}},"responses":{"201":{"description":"Create task rate response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TaskRateResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"delete":{"summary":"Delete task rate by ID","description":"Delete the task rate by ID","operationId":"V2DeleteTaskRateFromProduct","tags":["product"],"responses":{"204":{"description":"The task rate was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/teams":{"get":{"summary":"List teams for account","description":"Returns a paged list of teams for the account","operationId":"V2ListTeamsForAccount","tags":["team"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each team","schema":{"type":"array","items":{"type":"string","enum":["account","users"]}}},{"name":"filter","in":"query","required":false,"schema":{"properties":{"name":{"type":"string","description":"String of characters in the name of the contact"}}}}],"responses":{"200":{"description":"Team list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_TeamResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_UserResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create team for account","description":"Create a team for the account","operationId":"V2CreateTeam","tags":["team"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TeamResource"}}}}}},"responses":{"201":{"description":"Create Team response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TeamResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/teams/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find team by ID","description":"Returns a team for the account by ID","operationId":"V2GetTeam","tags":["team"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each team","schema":{"type":"array","items":{"type":"string","enum":["account","users"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TeamResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_UserResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update team by ID","description":"Update the team by ID","operationId":"V2UpdateTeam","tags":["team"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TeamResource"}}}}}},"responses":{"200":{"description":"Update Team response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TeamResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete team by ID","description":"Delete the team from the account by ID","operationId":"V2DeleteTeam","tags":["team"],"responses":{"204":{"description":"The Team was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/text-blocks":{"get":{"summary":"List text blocks for account","description":"Returns a paged list of text blocks for the account","operationId":"V2ListTextBlocksForAccount","tags":["text block"],"parameters":[{"name":"sort","in":"query","required":false,"explode":false,"description":"Names of attributes that should be used to sort the data.  Prefix \"-\" indicates descending","schema":{"type":"array","items":{"type":"string","enum":["id","-id","name","-name","slug","-slug","merge-block","-merge-block"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each text block","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"TextBlock list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_TextBlockResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create text block for account","description":"Create a text block for the account","operationId":"V2CreateTextBlock","tags":["text block"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TextBlockResource"}}}}}},"responses":{"201":{"description":"Create TextBlock response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TextBlockResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/text-blocks/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find text block by ID","description":"Returns a text block for the account by ID","operationId":"V2GetTextBlock","tags":["text block"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each text block","schema":{"type":"array","items":{"type":"string","enum":["account"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TextBlockResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"}]}}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update text block by ID","description":"Update the text block by ID","operationId":"V2UpdateTextBlock","tags":["text block"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TextBlockResource"}}}}}},"responses":{"200":{"description":"Update TextBlock response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_TextBlockResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete text block by ID","description":"Delete the text block from the account by ID","operationId":"V2DeleteTextBlock","tags":["text block"],"responses":{"204":{"description":"The text block was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/third-party-services":{"get":{"summary":"List third party services for account","description":"Returns a paged list of third party services for the account","operationId":"V2ListThirdPartyServicesForAccount","tags":["third party service"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active third party services, false for deleted ones","schema":{"type":"boolean","default":true}},{"name":"filter[source-type]","in":"query","required":false,"description":"name of the class to which the third party resource is associated","schema":{"type":"string","enum":["Quote","ThirdPartyRequest","ThirdPartyService"]}},{"name":"filter[source-id]","in":"query","required":false,"description":"ID of the class to which the third party resource is associated","schema":{"type":"string"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each third party service","schema":{"type":"array","items":{"type":"string","enum":["source","project-phase","project-task","subtasks"]}}}],"responses":{"200":{"description":"ThirdPartyService list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_ThirdPartyServiceResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectPhaseResource"},{"$ref":"#/components/schemas/v2_ThirdPartyServiceResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create third party service for account","description":"Create a third party service for the account","operationId":"V2CreateThirdPartyService","tags":["third party service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ThirdPartyServiceResource"}}}}}},"responses":{"201":{"description":"Create ThirdPartyService response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ThirdPartyServiceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/third-party-services/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find third party service by ID","description":"Returns a third party service for the account by ID","operationId":"V2GetThirdPartyService","tags":["third party service"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each third party service","schema":{"type":"array","items":{"type":"string","enum":["source","project-phase","project-task","subtasks"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ThirdPartyServiceResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_ProjectPhaseResource"},{"$ref":"#/components/schemas/v2_ThirdPartyServiceResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update third party service by ID","description":"Update the third party service by ID","operationId":"V2UpdateThirdPartyService","tags":["third party service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ThirdPartyServiceResource"}}}}}},"responses":{"200":{"description":"Update Third Party Service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ThirdPartyServiceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete third party service by ID","description":"Delete the third party service from the account by ID","operationId":"V2DeleteThirdPartyService","tags":["third party service"],"responses":{"204":{"description":"The Delete Third Party Service was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/third-party-services/{id}/moves":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"patch":{"summary":"Move the third party service by ID","description":"Move the third party service to the position identified in its position attribute as reorder the list","operationId":"V2MoveThirdPartyService","tags":["third party service"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ThirdPartyServiceResource"}}}}}},"responses":{"200":{"description":"Move Third Party Service response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_ThirdPartyServiceResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/users":{"get":{"summary":"List users for account","description":"Returns a paged list of users for the account. Without the settings.users view privilege, the list contains only your own user","operationId":"V2ListUsersForAccount","tags":["user"],"parameters":[{"name":"filter[active]","in":"query","required":false,"description":"true for active users, false for archived users","schema":{"type":"boolean","default":true}},{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the user","schema":{"type":"string"}},{"name":"filter[email]","in":"query","required":false,"description":"The full email address of the user. Exact match, not case-sensitive; a partial address matches nothing","schema":{"type":"string"}},{"name":"filter[title]","in":"query","required":false,"description":"String of characters in the title of the user","schema":{"type":"string"}},{"name":"filter[role]","in":"query","required":false,"description":"comma-separated list of role IDs; the user must be assigned to one or more of the roles","schema":{"type":"string"}},{"name":"filter[team]","in":"query","required":false,"description":"comma-separated list of team IDs; the user must be assigned to one or more of the teams","schema":{"type":"string"}},{"name":"filter[user-type]","in":"query","required":false,"description":"comma-separated list of user-types; the user must be assigned to one","schema":{"type":"string","enum":["view_only","licensed","sales","service","approver"]}},{"name":"filter[exclude]","in":"query","required":false,"description":"comma-separated list of IDs to exclude from the response","schema":{"type":"string"}},{"name":"filter[view-only]","in":"query","required":false,"description":"true or false to receive view-only (true) or licensed (false) users","schema":{"type":"boolean"}},{"name":"filter[created-at.after]","in":"query","required":false,"description":"Day on or after which the user was created. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"name":"filter[created-at.before]","in":"query","required":false,"description":"Day on or before which the user was created. Whole days: any time of day is ignored","schema":{"type":"string","format":"date-time"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each user","schema":{"type":"array","items":{"type":"string","enum":["account","rate-table","currency","teams","roles"]}}}],"responses":{"200":{"description":"User list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_UserResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_RateTableResource"},{"$ref":"#/components/schemas/v2_CurrencyResource"},{"$ref":"#/components/schemas/v2_TeamResource"},{"$ref":"#/components/schemas/v2_RoleResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create user for account","description":"Create a user for the account","operationId":"V2CreateUser","tags":["user"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_UserResourceWrite"}}}}}},"responses":{"201":{"description":"Create User response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_UserResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/users/current":{"get":{"summary":"Information about the current user","description":"Returns details about the current users for the account","operationId":"V2ShowCurrentUserForAccount","tags":["user"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each user","schema":{"type":"array","items":{"type":"string","enum":["account","rate-table","currency","teams","roles"]}}}],"responses":{"200":{"description":"Current User response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_UserResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_RateTableResource"},{"$ref":"#/components/schemas/v2_CurrencyResource"},{"$ref":"#/components/schemas/v2_TeamResource"},{"$ref":"#/components/schemas/v2_RoleResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/users/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find user by ID","description":"Returns a user for the account by ID. Without the settings.users view privilege, any ID other than your own returns 404","operationId":"V2GetUser","tags":["user"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each user","schema":{"type":"array","items":{"type":"string","enum":["account","rate-table","currency","teams","roles"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_UserResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_RateTableResource"},{"$ref":"#/components/schemas/v2_CurrencyResource"},{"$ref":"#/components/schemas/v2_TeamResource"},{"$ref":"#/components/schemas/v2_RoleResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update user by ID","description":"Update the user by ID","operationId":"V2UpdateUser","tags":["user"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_UserResourceWrite"}}}}}},"responses":{"200":{"description":"Update User response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_UserResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete user by ID","description":"Delete the user from the account by ID","operationId":"V2DeleteUser","tags":["user"],"responses":{"204":{"description":"The Delete User was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/users/{id}/filter-resets":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Clear data filters for user","description":"Reset filters for projects, etc so that the user can see all data available","operationId":"V2ResetUserFilters","tags":["user"],"responses":{"204":{"description":"User filters reset successfully"},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/users/{id}/user-unlocks":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"put":{"summary":"Clear lock on user account","description":"Reset the lock on the user acccount that was set when too many password attempts were made","operationId":"V2UnlockUser","tags":["user"],"responses":{"204":{"description":"User filters reset successfully"},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/vendors":{"get":{"summary":"List vendors for account","description":"Returns a paged list of vendors for the account","operationId":"V2ListVendorsForAccount","tags":["vendor"],"parameters":[{"name":"filter[name]","in":"query","required":false,"description":"String of characters in the name of the vendor","schema":{"type":"string"}},{"name":"filter[active]","in":"query","required":false,"description":"true for an active vendor, false for a soft-deleted vendor","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each vendor","schema":{"type":"array","items":{"type":"string","enum":["account","quotes"]}}}],"responses":{"200":{"description":"Vendor list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_VendorResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_QuoteResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create vendor for account","description":"Create a vendor for the account","operationId":"V2CreateVendor","tags":["vendor"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_VendorResource"}}}}}},"responses":{"201":{"description":"Create Vendor response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_VendorResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/vendors/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find vendor by ID","description":"Returns a vendor for the account by ID","operationId":"V2GetVendor","tags":["vendor"],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_VendorResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update vendor by ID","description":"Update the vendor by ID","operationId":"V2UpdateVendor","tags":["vendor"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_VendorResource"}}}}}},"responses":{"200":{"description":"Update Vendor response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_VendorResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete vendor by ID","description":"Delete the vendor from the account by ID","operationId":"V2DeleteVendor","tags":["vendor"],"responses":{"204":{"description":"The Delete Vendor was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/vendors/{vendor_id}/special-conditions":{"parameters":[{"$ref":"#/components/parameters/vendor_id_parameter"}],"get":{"summary":"List special conditions for vendor","description":"Returns a paged list of special conditions for the vendor","operationId":"V2ListSpecialConditionsForVendor","tags":["vendor"],"parameters":[{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"},{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each vendor","schema":{"type":"array","items":{"type":"string","enum":["owner","service-condition"]}}}],"responses":{"200":{"description":"special condition list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create special condition for vendor","description":"Create a special condition for the vendor","operationId":"V2CreateSpecialConditionForVendor","tags":["vendor"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"responses":{"201":{"description":"Create special condition response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/vendors/{vendor_id}/special-conditions/{id}":{"parameters":[{"$ref":"#/components/parameters/vendor_id_parameter"},{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find vendor special condition by ID","description":"Returns a vendor special condition","operationId":"V2GetVendorSpecialConditionById","tags":["vendor"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each vendor","schema":{"type":"array","items":{"type":"string","enum":["owner","service-condition"]}}}],"responses":{"200":{"description":"Find special condition by ID response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update vendor special condition by ID","description":"Update the vendor special condition by ID","operationId":"V2UpdateVendorSpecialCondition","tags":["vendor"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"responses":{"200":{"description":"Update vendor special condition response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_SpecialConditionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete vendor special condition by ID","description":"Delete the vendor special condition","operationId":"V2DeleteVendorSpecialCondition","tags":["vendor"],"responses":{"204":{"description":"The special condition was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}},"/v2/webhook-subscriptions":{"get":{"summary":"List webhook subscriptions for account","description":"Returns a paged list of webhook subscriptions for the account","operationId":"V2ListWebhookSubscriptionsForAccount","tags":["webhook subscription"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each webhook subscription","schema":{"type":"array","items":{"type":"string","enum":["account","webhook-publications"]}}},{"$ref":"#/components/parameters/current_page"},{"$ref":"#/components/parameters/page_size"}],"responses":{"200":{"description":"Webhook Subscription list response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/v2_WebhookSubscriptionResource"}},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_WebhookPublicationResource"}]}},"meta":{"$ref":"#/components/schemas/v2_paging_meta"},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}},"post":{"summary":"Create webhook subscription for account","description":"Create a webhook subscription for the account","operationId":"V2CreateWebhookSubscription","tags":["webhook subscription"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_WebhookSubscriptionResource"}}}}}},"responses":{"201":{"description":"Create Webhook Subscription response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_WebhookSubscriptionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}}}}},"/v2/webhook-subscriptions/{id}":{"parameters":[{"$ref":"#/components/parameters/id_parameter"}],"get":{"summary":"Find webhook subscription by ID","description":"Returns a webhook subscription for the account by ID","operationId":"V2GetWebhookSubscription","tags":["webhook subscription"],"parameters":[{"name":"include","in":"query","required":false,"explode":false,"description":"Associated data that may be loaded with each webhook subscription","schema":{"type":"array","items":{"type":"string","enum":["account","webhook-publications"]}}}],"responses":{"200":{"description":"Project response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_WebhookSubscriptionResource"},"included":{"type":"array","items":{"anyOf":[{"$ref":"#/components/schemas/v2_AccountResource"},{"$ref":"#/components/schemas/v2_WebhookPublicationResource"}]}},"links":{"$ref":"#/components/schemas/v2_paging"}}}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"patch":{"summary":"Update webhook subscription by ID","description":"Update the webhook subscription by ID","operationId":"V2UpdateWebhookSubscription","tags":["webhook subscription"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_WebhookSubscriptionResource"}}}}}},"responses":{"200":{"description":"Update Webhook Subscription response","content":{"application/vnd.api+json":{"schema":{"properties":{"data":{"$ref":"#/components/schemas/v2_WebhookSubscriptionResource"}}}}}},"400":{"description":"Bad request; data format and validation issues in errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_validation_error"}}}},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}},"delete":{"summary":"Delete webhook subscription by ID","description":"Delete the webhook subscription from the account by ID","operationId":"V2DeleteWebhookSubscription","tags":["webhook subscription"],"responses":{"204":{"description":"The Delete Webhook Subscription was deleted successfully"},"401":{"description":"Not authorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_authentication_error"}}}},"404":{"description":"Requested record not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/v2_not_found_error"}}}}}}}},"components":{"schemas":{"v2_relationships":{"type":"object","required":["data"],"properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"related":{"type":"string","format":"uri"}}},"data":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","description":"Name of resource collection"}}}}},"v2_relationships_string":{"type":"object","required":["data"],"properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"related":{"type":"string","format":"uri"}}},"data":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","description":"Name of resource collection"}}}}},"v2_to_many_relationships":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"related":{"type":"string","format":"uri"}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","description":"Name of resource collection"}}}}}},"v2_paging":{"type":"object","properties":{"first":{"type":"string","format":"uri","example":"https://api.scopestack.io/path/to/first-page","description":"URI of the first page or resources"},"next":{"type":"string","format":"uri","example":"https://api.scopestack.io/path/to/next-page","description":"URI of the next page or resources"},"last":{"type":"string","format":"uri","example":"https://api.scopestack.io/path/to/last-page","description":"URI of the last page or resources"}}},"v2_paging_meta":{"type":"object","properties":{"record-count":{"type":"integer"},"page-count":{"type":"integer"}}},"v2_validation_error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","example":"Param is not allowed"},"detail":{"type":"string","example":"created-at is not allowed"},"code":{"type":"string","example":"400"},"status":{"type":"string","example":"400"}}}}}},"v2_not_found_error":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"title":{"type":"string","example":"Record not found"},"detail":{"type":"string","example":"The record identified by 12345 could not be found."},"code":{"type":"string","example":"404"},"status":{"type":"string","example":"404"}}}}}},"v2_authentication_error":{"type":"object","properties":{"error":{"type":"string","example":"You must sign in or sign up before continuing."}}},"v2_AccountResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","example":"my-account","description":"Use the account-id attribute for the value to use in account relationship specification.  This attribute will match the account slug."},"type":{"type":"string","example":"accounts"},"attributes":{"type":"object","required":["slug","name"],"properties":{"slug":{"type":"string","pattern":"/^[a-z][a-z\\-]+$/","example":"my-company"},"account-id":{"type":"integer","description":"The ID of the account that should be used in account relationship data","example":1},"name":{"type":"string","example":"My Company"},"status":{"type":"string","example":"active","enum":["building","pending","trial","active","canceled"]},"rate-type":{"type":"string","description":"When specifying the level of effort for a service, this indicates the duration of the effort","example":"hour","enum":["hour","day","week"]},"loe-rounding":{"type":"string","description":"When level of effort calculations must be rounded off, this indicates the accuracy of the rounding off","example":"tenth_of_an_hour","enum":["one_minute","five_minutes","tenth_of_an_hour","ten_minutes","quarter_hour","half_hour","one_hour"]},"short-date-format":{"type":"string","enum":["%m/%d/%Y","%m-%d-%Y","%d/%m/%Y","%d-%m/%Y","%Y/%m/%d","%Y-%m-%d","%d-%b-%Y"]},"long-date-format":{"type":"string","enum":["%B %-e, %Y","%-e %B %Y","%Y %B %-e"]},"time-format":{"type":"string","enum":["%-l:%M %p","%l:%M %p","%H:%M"]},"street_adddress":{"type":"string","example":"123 Main St"},"city":{"type":"string","example":"Greenville"},"state":{"type":"string","example":"SC"},"postal_code":{"type":"string","example":"29615"},"country":{"type":"string","example":"US"},"time-zone":{"type":"string","example":"Eastern Time (US \u0026 Canada)","enum":["International Date Line West","Midway Island","American Samoa","Hawaii","Alaska","Pacific Time (US \u0026 Canada)","Tijuana","Mountain Time (US \u0026 Canada)","Arizona","Chihuahua","Mazatlan","Central Time (US \u0026 Canada)","Saskatchewan","Guadalajara","Mexico City","Monterrey","Central America","Eastern Time (US \u0026 Canada)","Indiana (East)","Bogota","Lima","Quito","Atlantic Time (Canada)","Caracas","La Paz","Santiago","Newfoundland","Brasilia","Buenos Aires","Montevideo","Georgetown","Puerto Rico","Greenland","Mid-Atlantic","Azores","Cape Verde Is.","Dublin","Edinburgh","Lisbon","London","Casablanca","Monrovia","UTC","Belgrade","Bratislava","Budapest","Ljubljana","Prague","Sarajevo","Skopje","Warsaw","Zagreb","Brussels","Copenhagen","Madrid","Paris","Amsterdam","Berlin","Bern","Zurich","Rome","Stockholm","Vienna","West Central Africa","Bucharest","Cairo","Helsinki","Kyiv","Riga","Sofia","Tallinn","Vilnius","Athens","Istanbul","Minsk","Jerusalem","Harare","Pretoria","Kaliningrad","Moscow","St. Petersburg","Volgograd","Samara","Kuwait","Riyadh","Nairobi","Baghdad","Tehran","Abu Dhabi","Muscat","Baku","Tbilisi","Yerevan","Kabul","Ekaterinburg","Islamabad","Karachi","Tashkent","Chennai","Kolkata","Mumbai","New Delhi","Kathmandu","Dhaka","Sri Jayawardenepura","Almaty","Astana","Novosibirsk","Rangoon","Bangkok","Hanoi","Jakarta","Krasnoyarsk","Beijing","Chongqing","Hong Kong","Urumqi","Kuala Lumpur","Singapore","Taipei","Perth","Irkutsk","Ulaanbaatar","Seoul","Osaka","Sapporo","Tokyo","Yakutsk","Darwin","Adelaide","Canberra","Melbourne","Sydney","Brisbane","Hobart","Vladivostok","Guam","Port Moresby","Magadan","Srednekolymsk","Solomon Is.","New Caledonia","Fiji","Kamchatka","Marshall Is.","Auckland","Wellington","Nuku'alofa","Tokelau Is.","Chatham Is.","Samoa"]},"plan-name":{"type":"string","example":"Adapt"},"crm?":{"type":"boolean","example":true},"psa?":{"type":"boolean","example":true},"entitlements":{"type":"array","description":"List of entitlements for the account based on the current subscription","example":["customizable-templates","professional-services-scoping","chat-and-email-support"],"items":{"type":"string"}},"settings":{"type":"object","properties":{"password_interval":{"type":"integer","description":"Number of days a password is valid before a reset is required.  When set to zero, password resets are never required"},"project_resource_rates":{"type":"boolean","description":"When true if a user is picking a resource for a service or governance item then the list of Standard Resources will come from the Rate Table associated with the project"},"watermarking":{"type":"boolean","description":"When true, generated Word documents will be watermarked and converted to PDF prior to project approval"},"sales-review":{"type":"boolean","description":"When true, the sales executive will be asked to approve projectes during the approval workflow"}},"example":{"project_resource_rates":false,"watermarking":true,"password_interval":90}},"plan-details":{"type":"object","properties":{"questionnaires":{"type":"boolean","description":"When true, users will have access to the Surveys menu in the top nagivation and maintain Surveys in Settings."},"approval_workflow":{"type":"boolean","description":"When true, projects will be sent through the Approval Workflow configured in Settings."},"partner_services":{"type":"boolean","description":"When true you may initiate project requests from partner accounts who will be integrated into your project as subcontractors"},"customer_success":{"type":"boolean","description":"When true, users will be able to establish project success criteria"}},"example":{"questionnaires":true,"approval_workflow":true,"partner_services":false,"customer_success":false}},"field-labels":{"type":"object","properties":{"executive_summary":{"type":"string"},"solution_summary":{"type":"string"},"customer_summary":{"type":"string"},"customer_success":{"type":"string"},"sales_executive":{"type":"string"},"presales_engineer":{"type":"string"},"client":{"type":"string"},"business_unit":{"type":"string"},"location":{"type":"string"},"our_responsibilities":{"type":"string"},"client_responsibilities":{"type":"string"},"out_of_scope":{"type":"string"}}}}},"relationships":{"type":"object","required":["account"],"properties":{"business-units":{"$ref":"#/components/schemas/v2_to_many_relationships"},"clients":{"$ref":"#/components/schemas/v2_to_many_relationships"},"crm-opportunities":{"$ref":"#/components/schemas/v2_to_many_relationships"},"document-templates":{"$ref":"#/components/schemas/v2_to_many_relationships"},"expense-categories":{"$ref":"#/components/schemas/v2_to_many_relationships"},"governances":{"$ref":"#/components/schemas/v2_to_many_relationships"},"payment-credits":{"$ref":"#/components/schemas/v2_to_many_relationships"},"payment-terms":{"$ref":"#/components/schemas/v2_to_many_relationships"},"phases":{"$ref":"#/components/schemas/v2_to_many_relationships"},"products":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-variables":{"$ref":"#/components/schemas/v2_to_many_relationships"},"projects":{"$ref":"#/components/schemas/v2_to_many_relationships"},"rate-tables":{"$ref":"#/components/schemas/v2_to_many_relationships"},"resources":{"$ref":"#/components/schemas/v2_to_many_relationships"},"roles":{"$ref":"#/components/schemas/v2_to_many_relationships"},"service-categories":{"$ref":"#/components/schemas/v2_to_many_relationships"},"services":{"$ref":"#/components/schemas/v2_to_many_relationships"},"teams":{"$ref":"#/components/schemas/v2_to_many_relationships"},"users":{"$ref":"#/components/schemas/v2_to_many_relationships"}}},"links":{"type":"object","properties":{"projects":{"type":"string","format":"uri"},"business-unit":{"type":"string","format":"uri"},"clients":{"type":"string","format":"uri"},"crm-opportunities":{"type":"string","format":"uri"},"document-templates":{"type":"string","format":"uri"},"expense-categories":{"type":"string","format":"uri"},"governances":{"type":"string","format":"uri"},"payment-terms":{"type":"string","format":"uri"},"presales-engineers":{"type":"string","format":"uri"},"phases":{"type":"string","format":"uri"},"project-variables":{"type":"string","format":"uri"},"resources":{"type":"string","format":"uri"},"sales-executives":{"type":"string","format":"uri"},"services":{"type":"string","format":"uri"},"users":{"type":"string","format":"uri"},"self":{"type":"string","format":"uri"}}}}},"v2_WebhookPublicationResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"webhook-publications"},"attributes":{"type":"object","required":["status"],"properties":{"status":{"type":"string","example":"success","enum":["pending","success","error","duplicate"]},"http-status":{"type":"integer","example":200},"source-type":{"type":"string","example":"Project"},"source-id":{"type":"integer","format":"int64"},"contents":{"type":"object"},"created-at":{"type":"string","format":"date-time"},"updated-at":{"type":"string","format":"date-time"}}},"relationships":{"type":"object","required":["webhook_subscription"],"properties":{"webhook-subscription":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ClientLocationResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"client-locations"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Headquarters"},"street":{"type":"string","example":"1 Main Street"},"street2":{"type":"string","example":"Suite 200"},"city":{"type":"string","example":"Boston"},"state":{"type":"string","example":"MA"},"postal-code":{"type":"string","example":"02110"},"country":{"type":"string","example":"US"},"active":{"type":"boolean"}}},"relationships":{"type":"object","properties":{"client":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ChangeOrderResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string"},"type":{"type":"string","example":"change-orders"},"attributes":{"type":"object","properties":{"number":{"type":"integer","readOnly":true},"cause":{"type":"string","enum":["customer_expansion","under_scoped","external_change","other"]},"cause-note":{"type":"string","nullable":true},"external-reference":{"type":"string","nullable":true},"external-url":{"type":"string","nullable":true},"status":{"type":"string","enum":["reference_only","building","technical_approval","sales_approval","business_approval","approved","won","lost","canceled"],"readOnly":true},"counts":{"type":"boolean","readOnly":true},"cost":{"type":"string","nullable":true,"readOnly":true,"description":"The change request's delta cost; null when reference-only","example":"12500.0"},"revenue":{"type":"string","nullable":true,"description":"Delta revenue; writable only when reference-only, else read from the child project","example":"12500.0"},"hours":{"oneOf":[{"type":"string"},{"type":"number"}],"nullable":true,"description":"Delta hours; writable only when reference-only, else read from the child project"},"reference-only":{"type":"boolean"},"source-items":{"type":"array","writeOnly":true,"description":"Create only: parent project-services/project-subservices to copy. An item may carry the change request line's own quantity (default: the parent line's; 0 for custom-hours tasks), override-hours (hours each, default 0; ignored for custom-hours tasks, which the catalog prices from quantity) and project-resource-id (default: the parent line's). These are what land on the change request project, not revised totals. An item whose values add no hours is skipped. A bare item (no values) is copied at zero hours.","items":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["project-services","project-subservices"]},"id":{"type":"string"},"quantity":{"type":"integer"},"override-hours":{"type":"number"},"project-resource-id":{"type":"string"}}}},"governance-items":{"type":"array","writeOnly":true,"description":"Hours for the parent project's fixed-hours governance on this change request; 0 leaves that governance out of the change request (its minimum does not apply)","items":{"type":"object","required":["id","hours"],"properties":{"id":{"type":"string"},"hours":{"type":"number"}}}},"created-at":{"type":"string","format":"date-time","readOnly":true},"updated-at":{"type":"string","format":"date-time","readOnly":true}}},"relationships":{"type":"object","properties":{"parent-project":{"$ref":"#/components/schemas/v2_relationships"},"child-project":{"$ref":"#/components/schemas/v2_relationships"},"user":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_AccountLogoResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"account-logos"},"attributes":{"type":"object","properties":{"logo":{"type":"string","description":"Base64 encoded image file"},"logo-uuid":{"type":"string","format":"uuid"}}}}},"v2_ApprovalStepResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"approval-steps"},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["pending","approved","declined","canceled","rescoped"],"example":"pending"},"step":{"type":"string","enum":["technical_approval","sales_approval","business_approval"],"example":"business_approval"},"description":{"type":"string","description":"High level description of the Approval Step","example":"Business Approval -- Canceled 18 June 2021 at 13:01"}}},"relationships":{"type":"object","properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"project-version":{"$ref":"#/components/schemas/v2_relationships"},"project-approvals":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_ApprovedServiceResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the catalog service this snapshot approves"},"type":{"type":"string","example":"approved-services"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"sku":{"type":"string"},"service-description":{"type":"string"},"guidance":{"type":"string"},"languages":{"type":"object"},"service-type":{"type":"string","enum":["professional_services","managed_services"]},"payment-frequency":{"type":"string","enum":["one_time","monthly","quarterly","yearly"]},"lob-id":{"type":"integer"},"minimum-quantity":{"type":"integer"},"suggested-hours":{"type":"number","format":"double"},"total-hours":{"type":"number","format":"double"},"custom-service-price":{"type":"boolean"},"custom-service-cost":{"type":"boolean"},"custom-hours":{"type":"boolean"},"tag-list":{"type":"array","items":{"type":"string"}},"user-defined-fields":{"type":"array","items":{"type":"object"}},"teams":{"type":"array","items":{"type":"object"}},"created-at":{"type":"string"},"updated-at":{"type":"string"}}},"relationships":{"type":"object"}}},"v2_ApprovedSubserviceResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the catalog subservice this snapshot approves"},"type":{"type":"string","example":"approved-subservices"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"service-description":{"type":"string"},"languages":{"type":"object"},"minimum-quantity":{"type":"integer"},"quantity":{"type":"integer"},"position":{"type":"integer"},"suggested-hours":{"type":"number","format":"double"},"custom-service-price":{"type":"boolean"},"custom-service-cost":{"type":"boolean"},"custom-hours":{"type":"boolean"},"created-at":{"type":"string"},"updated-at":{"type":"string"}}},"relationships":{"type":"object"}}},"v2_AttachmentTypeResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"attachment-types"},"attributes":{"type":"object","required":["name","document_type"],"properties":{"name":{"type":"string","example":"Network Schematic"},"document_type":{"type":"string","enum":["image","pdf","word"],"example":"image"}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"rate-table":{"$ref":"#/components/schemas/v2_relationships"},"project-attachments":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_AuditLogResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"audit-logs"},"attributes":{"type":"object","properties":{"name":{"type":"string","example":"Risk"},"item-type":{"type":"string","description":"Type of data changed such as Project or ProjectGovernance","example":"ProjectGovernance","enum":["Account","AccountConnection","ApprovalLevelUser","Blueprint","BlueprintItem","CustomerSuccess","DocumentTemplate","LevelOfEffort","MCPKey","Material","Membership","OauthApplication","PaymentAllocation","PaymentSchedule","PaymentScheduleSource","PerformanceIndicator","Project","ProjectApproval","ProjectAttachment","ProjectCollaborator","ProjectCondition","ProjectContact","ProjectCredit","ProjectDocument","ProjectExpense","ProjectGovernance","ProjectIntegration","ProjectLocation","ProjectMaterial","ProjectPhase","ProjectResource","ProjectService","ProjectSubservice","ProjectSurvey","PromptOverride","Quote","RateTable","ResourceRate","ScheduledPayment","ServiceApprover","Task","TaskMaterial","TaskRate","TeamUser","ThirdPartyRequest","ThirdPartyService","User"]},"item-id":{"type":"integer","example":12345,"description":"ID of the data that was changed"},"changed-by":{"type":"string","example":"Jon Smith","description":"Name of user triggering the data change"},"event":{"type":"string","description":"The type of event that caused the data to change such as \"create\" or \"update\"","example":"create"},"created-at":{"type":"string","format":"date-time","description":"Time when the data change occurred","example":"2022-03-01T12:34:56.789Z"},"changes":{"type":"array","description":"List of attributes that were changed","items":{"type":"object","properties":{"attribute":{"type":"string","description":"Name of an attribute that was changed","example":"rate"},"changed-from":{"type":"string","description":"Original value of the attribute.  Will be null if the event is \"create\"","example":"10"},"changed-to":{"type":"string","description":"Final value of the attribute after change.","example":"12"}}}}}}}},"v2_BlueprintResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"blueprints"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Big Blueprint"},"code":{"type":"string","example":"BP1"},"payload":{"type":"array","items":{"type":"object","anyOf":[{"$ref":"#/components/schemas/v2_ProjectResource"},{"$ref":"#/components/schemas/v2_ProjectCollaboratorResource"},{"$ref":"#/components/schemas/v2_ProjectConditionResource"},{"$ref":"#/components/schemas/v2_ProjectCreditResource"},{"$ref":"#/components/schemas/v2_ProjectExpenseResource"},{"$ref":"#/components/schemas/v2_ProjectGovernanceResource"},{"$ref":"#/components/schemas/v2_ProjectPhaseResource"},{"$ref":"#/components/schemas/v2_ProjectProductResource"},{"$ref":"#/components/schemas/v2_ProjectResourceResource"},{"$ref":"#/components/schemas/v2_ProjectServiceResource"},{"$ref":"#/components/schemas/v2_ProjectSubserviceResource"}]}},"tag-list":{"type":"array","items":{"type":"string"},"example":["demo","network"]},"executive-summary":{"type":"string","readOnly":true,"description":"Read-only mirror of project_attributes.attributes.executive_summary captured when the blueprint was saved.","example":"High-level executive summary"},"solution-summary":{"type":"string","readOnly":true,"description":"Read-only mirror of project_attributes.attributes.solution_summary captured when the blueprint was saved.","example":"High-level solution summary"}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_BusinessUnitResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"business-units"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Enterprise Team"},"external-name":{"type":"string","example":"Enterprise Team"},"street-address":{"type":"string","example":"221 Baker Street"},"street2":{"type":"string","example":"Suite B"},"city":{"type":"string","example":"London"},"state":{"type":"string","example":null},"postal-code":{"type":"string","example":"NW1"},"country":{"type":"string","description":"Alpha-2 country code","example":"gb"}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_CatalogItemResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"catalog-items"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Small Office Firewall Installation"},"service-description":{"type":"string","example":"Lorem ipsum ..."},"resource-name":{"type":"string","example":"Senior Engineer"},"phase-name":{"type":"string","example":"Implementation"},"total-hours":{"type":"number","format":"double","example":"0.0"},"suggested-hours":{"type":"integer","example":1},"languages":{"type":"object","properties":{"Deliverables":{"type":"string"},"Out of Scope":{"type":"string"}}}}},"relationships":{"type":"object","required":["account"],"properties":{"account":{"type":"object","$ref":"#/components/schemas/v2_relationships"},"rate-table":{"type":"object","$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ClientResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"clients"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Big Client, Inc"},"msa-date":{"type":"string","format":"date","example":"2026-11-18"},"domain":{"type":"string","description":"Domain of the clients website","example":"scopestack.io"},"user-defined-fields":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}},"active":{"type":"boolean","description":"True if the record is available for use; false if the record has been archived"}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"contacts":{"$ref":"#/components/schemas/v2_to_many_relationships"},"rate-table":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_CollaboratorResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"collaborators"},"attributes":{"type":"object","required":["name","active"],"properties":{"name":{"type":"string","example":"John Doe"},"active":{"type":"boolean","example":true}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ContactResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"contacts"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"John Doe"},"phone":{"type":"string","example":"555-321-7654"},"email":{"type":"string","example":"john.doe@mycompany.com"},"title":{"type":"string","example":"President"},"active":{"type":"boolean"},"sales":{"type":"boolean"},"presales":{"type":"boolean"}}},"relationships":{"type":"object","properties":{"contactable":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_CrmOpportunityResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"crm-opportunities"},"attributes":{"type":"object","properties":{"account-id":{"type":"string","example":"12345","description":"CRM ID of the client"},"opportunity-id":{"type":"string","example":"12345","description":"ID of the opportunity in the CRM"},"account-name":{"type":"string","example":"Big Data Headquarters","description":"Name of the client of the opportunity according to the CRM"},"name":{"type":"string","example":"Server farm build out","description":"Name of the project for the opportunity as imported from the CRM"},"display-name":{"type":"string","example":"Big Data, Inc / Server farm build out","description":"Combination of the customer and project name used when linking opportunity to link project"},"amount":{"type":"number","format":"decimal","example":"123456.78","description":"Value of opportunity as reported by the CRM"},"stage":{"type":"string","example":"3. Proposal","description":"Stage of the opportunity as reported by the CRM"},"is-closed":{"type":"boolean","example":false,"description":"True if the CRM indicates that the stage represents a closed (completed) opportunity"},"owner-id":{"type":"string","example":"12345","description":"CRM ID of the individual responsible for the opportunity"},"owner-name":{"type":"string","example":"12345","description":"Name of the individual responsible for the opportunity according to the CRM"},"location-name":{"type":"string","example":"Big Data Headquarters","description":"Name of the location of the opportunity according to the CRM"},"street":{"type":"string","example":"101 Wall Street","description":"Street address at which the opportunity exists according to the CRM"},"city":{"type":"string","example":"New York","description":"City/municipality in which the opportunity exists according to the CRM"},"state":{"type":"string","example":"NY","description":"State/Provide/Locality in which the opportunity exists according to the CRM"},"postal-code":{"type":"string","example":"10001","description":"Postal code in which the opportunity exists according to the CRM"},"country":{"type":"string","example":"US","description":"Country in which the opportunity exists according to the CRM"},"custom-attributes":{"type":"array","description":"Collection of custom mapped attributes from the CRM. Varies by customer and may be empty.","items":{"type":"object","properties":{"key":{"type":"string","description":"The key at which this value will be stored.  If using user-defined fields for CrmOpportunities, then this should match the \"name\" field","example":"msa_date"},"value":{"type":"string","description":"The value of the custom attribute as it was found in the CRM","example":"2026-11-19"}}}}}},"relationships":{"type":"object","required":["account"],"properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"crm-opportunity":{"$ref":"#/components/schemas/v2_relationships"},"projects":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_CurrencyResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"currencies"},"attributes":{"type":"object","required":["name","currency-type","conversion-rate"],"properties":{"name":{"type":"string","example":"USD"},"currency-type":{"type":"string","enum":["dollars","euros","dirham","francs","kroner","pounds","rand","rupeeI","rupeeN","shekels","won","yen"],"example":"dollars"},"conversion-rate":{"type":"number","format":"double","example":"0.84"},"default":{"type":"boolean"}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"resource-rates":{"$ref":"#/components/schemas/v2_to_many_relationships"},"users":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_CustomerSuccessResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"customer-successes"},"attributes":{"type":"object","required":["outcome"],"properties":{"outcome":{"type":"string","example":"Reduce OpEx by 10%"},"adoption-barriers":{"type":"string","example":"Training and use by workforce"},"ongoing-strategy":{"type":"string","example":"Favor virtual meetings over in-person meetings"},"position":{"type":"integer","format":"int32"}}},"relationships":{"type":"object","required":["project"],"properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"project":{"$ref":"#/components/schemas/v2_relationships"},"performance-indicators":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_DocumentDeliveryResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"document-deliveries"},"attributes":{"type":"object","properties":{"document-name":{"type":"string","description":"The name of the document template being delivered","example":"pending"},"status":{"type":"string","enum":["pending","in_progress","delivered","failed","canceled"],"example":"pending"},"delivery_type":{"type":"string","enum":["email","docusign","download","cloud_storage"],"example":"email"},"recipients":{"type":"object","properties":{"all":{"type":"string","description":"When delivery-type is email, then this is the list of all recipients","example":"peer@company.com"},"internal":{"type":"string","description":"When delivery-type is docusign, then this is the email address of an internal signatory","example":"peer@company.com"},"external":{"type":"string","description":"When delivery-type is docusign, then this is the email address of an external signatory","example":"president@your-customer.com"}}}}},"relationships":{"type":"object","properties":{"project":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_DocumentRequestResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","example":"document-requests"},"attributes":{"type":"object","required":["templates"],"properties":{"status":{"type":"string","enum":["created","processing","finished","failed"],"description":"Status of the request to generate the document","example":"generated"},"force-regeneration":{"type":"boolean","description":"When true, previously generated copies of the document will be destroyed and regenerated"},"generate-pdf":{"type":"boolean","description":"If true, Word Document templates will be converted to PDF before download"},"delivery-type":{"type":"string","enum":["download","email","docusign"],"description":"Whether the document will be delivered via direct download, email, or docusign"},"email-list":{"type":"string","description":"Comma-separated list of email addresses.  Used only if delivery-method is \"email\"","example":"user@example.com"},"account-connection-id":{"type":"string","description":"ID of the storage integration that will be used for storing the file after generation"},"drive-id":{"type":"string","description":"If using storage integration, ID of the folder to be used for storing the file"},"filepath":{"type":"string","description":"If using storage integration, File path represented by the drive_id"},"document-url":{"type":"string","format":"uri","readOnly":true,"description":"API endpoint that downloads the result once finished: the document itself, or a zip when several were requested. It is not a public storage link: send the same Authorization header as on any other request","example":"https://api.scopestack.io/v2/project-documents/12345/downloads"},"templates":{"type":"array","items":{"type":"object","required":["document_type","template_id"],"properties":{"document_type":{"type":"string","enum":["sow","pricing","breakdown","autotask","report"],"description":"Type of document being requested"},"template_id":{"type":"string","description":"If document_type is \"sow\" then this is the document template ID; otherwise, match the document_type value"},"filename":{"type":"string","description":"Desired filename.  If blank, they system will generate a filename from the template."}}}}}},"relationships":{"type":"object","required":["project"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"document-deliveries":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-documents":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_DocumentTemplateResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"document-templates"},"attributes":{"type":"object","required":["name","format"],"properties":{"name":{"type":"string","pattern":"^[a-zA-Z0-9\\-\\s]*$","description":"Letters, numbers, dashes and spaces only; anything else returns 422","example":"Professional Service SOW"},"format":{"type":"string","description":"The format of the template -- Mail Merge Fields (legacy) or Tag Merge Fields","enum":["word_template","html_template","tag_template"],"example":"word_template"},"merge-template":{"type":"string","description":"Base64 encoded Word Document to be used as a template for file generation"},"merge-template-filename":{"type":"string","description":"Since base64 file encoding does not include the original file name, you can provide the name of the document here"},"filename-format":{"type":"array","example":["client_name","project_name","current_date"],"items":{"type":"string"}},"template-format":{"type":"string","description":"The version of the data consumed by the template. v2 was released in April 2025","enum":["v1","v2"],"example":"v1"},"include-formatting":{"type":"boolean","description":"When true, currencies, dates, and times will include formattinng options for TagTemplates"},"default":{"type":"boolean","description":"When true, newly created projects are assigned this template. Only one template per account may be the default"},"change-order-default":{"type":"boolean","description":"When true, change requests created from a project are assigned this template. Only one template per account may be the change-request default"},"teams":{"type":"array","items":{"properties":{"id":{"type":"string","description":"ID of the team","example":"12345"},"name":{"type":"string","description":"name of the team","example":"Service Development"}}}}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"rate-table":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ExpenseCategoryResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"expense-categories"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Air fare"},"rate":{"type":"number","format":"double","example":"752.00","description":"Per unit price of the expense in default currency.  Leave blank if it varies by project."},"use-resource-rate":{"type":"boolean","description":"When true, a project expense with this category will use the Resource travel/expense rate"},"variable":{"type":"boolean","readOnly":true,"description":"When true, this expense category does not have a rate and does not use resource rates"},"markup":{"type":"number","format":"double","example":"10.0","description":"Markup percentage applied when adding this expense to project revenue"},"status":{"type":"string","enum":["optional","required"],"example":"optional","description":"Whether a project expense with this category is required or optional"}}},"relationships":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"phase":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ExternalRequestResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"external-requests"},"attributes":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Do something as a subcontractor"},"revision-description":{"type":"string","example":"Please make this less expensive"},"service-type":{"type":"string","enum":["professional_services","managed_services"],"example":"professional_services"},"cost":{"type":"number","format":"double","example":"1234.56"},"recurring-cost":{"type":"number","format":"double","example":"234.56"},"billing-frequency":{"type":"string","enum":["one_time","monthly","quarterly","yearly"],"example":"monthly"},"markup":{"type":"number","format":"double","example":"0.35"},"price":{"type":"number","format":"double","example":"1666.66"},"requested_at":{"type":"string","format":"date-time","example":"2024-01-01T12:00:00Z"}}},"relationships":{"type":"object","required":["project"],"description":"`account` is set from your API token; any account sent is ignored. To set `lob`, send `type` `lobs`; `service-categories` and `sections` are rejected","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"project":{"$ref":"#/components/schemas/v2_relationships"},"lob":{"$ref":"#/components/schemas/v2_relationships"},"subcontractor":{"$ref":"#/components/schemas/v2_relationships"},"subproject":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_GovernanceResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"governances"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Project management"},"active":{"type":"boolean","example":true},"rate":{"type":"number","format":"double","example":20.0},"fixed-hours":{"type":"number","format":"double","example":null},"minimum-hours":{"type":"number","format":"double","description":"Floor on the hours of project governance created from this item: fixed hours may not be set below it, and a percentage of total hours never computes below it","example":4.0,"default":0},"allocation-method":{"type":"string","enum":["prorate_phases_by_effort","select_phase","select_category","project_management_phase"],"example":"select_phase","default":"prorate_phases_by_effort"},"calculation-type":{"type":"string","enum":["percent_of_total","fixed_hours"],"example":"percent_of_total","default":"percent_of_total"},"required":{"type":"boolean","description":"When true, this governance item will be added to every project when the project is created","example":true,"default":true},"assign-effort-to-service":{"type":"boolean","description":"When true, the effort and resulting pricing of the effort will be assigned to the service rather than reported separately","example":false,"default":false},"filter-type":{"type":"string","description":"Determines how services are filtered before calculating the level of effort for this governance item","example":"all_services","enum":["all_services","filter_by_lob","filter_by_phase"]},"filter-id":{"type":"integer","description":"When filtering by phase or line-of-business (LOB), this is the ID of the phase or LOB that will scope the services","example":12345},"position":{"type":"integer","description":"Order in which governance should appear","example":1},"rate-rules":{"type":"array","description":"Ordered conditional rates for percent_of_total governance. The first rule whose conditions all hold replaces the base rate for all of the effort; a matched rate of 0 marks project lines not applicable. Facts: effort (gt, gte, lt, lte; hours \u003e= 0) and pricing_model (eq, ne; other, fixed_fee, time_and_materials, mixed)","items":{"type":"object","properties":{"conditions":{"type":"array","items":{"type":"object","properties":{"fact":{"type":"string","example":"effort"},"op":{"type":"string","example":"lte"},"value":{"example":40.0}}}},"rate":{"type":"number","format":"double","example":0.15}}},"default":[]},"project-variables":{"type":"array","description":"Governance-context project variables: each definition with this governance's value. Write [{ name, value }]; names not sent are left as they are","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}}}},"relationships":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"resource":{"$ref":"#/components/schemas/v2_relationships"},"phase":{"$ref":"#/components/schemas/v2_relationships"},"service-category":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_IntegratedProductResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"integrated-products"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Microsoft Office 365 License"},"description":{"type":"string","example":"Annual Microsoft Office 365 License for up to 10 users"},"sku":{"type":"string","example":"MS-365-10"},"product-id":{"type":"string","example":"MS-365-10"},"manufacturer-part-number":{"type":"string","example":"MS-365-10"},"unit-of-measure":{"type":"string","example":"each"},"category":{"type":"string","example":"Software"},"subcategory":{"type":"string","example":"License"},"unit-price":{"type":"number","format":"double"},"unit-cost":{"type":"number","format":"double"},"vendor-name":{"type":"string","example":"Intel"},"vendor-discount":{"type":"number","format":"double","description":"Discount from list price as a percentage of the list price","example":"10.0"},"vendor-rebate":{"type":"number","format":"double","description":"Rebate from list price as a percentage of the list price","example":"5.0"},"markup":{"type":"number","format":"double","description":"Markup as a percentage of the discounted list price","example":"20.0"},"billing-frequency":{"type":"string","enum":["one_time","monthly","bi-monthly","quarterly","semi-annual","yearly"],"example":"monthly"}}}}},"v2_LanguageFieldResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"language-fields"},"attributes":{"type":"object","required":["name","sow-language"],"properties":{"name":{"type":"string","example":"Implementation"},"sow-language":{"type":"string","example":"implementation_language"},"active":{"type":"boolean","example":true},"position":{"type":"number","format":"int32","example":1},"preamble":{"type":"string","example":"Lorem ipsum dolot..."},"postamble":{"type":"string","example":"Lorem ipsum dolot..."}}},"relationships":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"project-expenses":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_LevelOfEffortResource":{"type":"object","required":["type","attributes"],"description":"The service (or subservice) is taken from the request path. This resource has no relationships; sending one returns 400","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"level-of-efforts"},"attributes":{"type":"object","properties":{"minimum-quantity":{"type":"number","example":"2.0"},"base-amount":{"type":"number","format":"float","example":14.256},"unit-amount":{"type":"number","format":"float","example":10.412}}}}},"v2_LineOfBusinessResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"line-of-businesses"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Networking"},"code":{"type":"string","example":"NET-101"},"nested-name":{"type":"string","example":"Networking"},"position":{"type":"integer","format":"int64","description":"The sequence of this line of business within the list of lines of business for the account"}}},"relationships":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"service-approvers":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_LobResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"lobs"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Networking"},"code":{"type":"string","example":"NET-101"},"nested-name":{"type":"string","example":"Networking"},"position":{"type":"integer","format":"int64","description":"The sequence of this line of business within the list of lines of business for the account"}}},"relationships":{"type":"object","required":["account"],"properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_SubprojectResource":{"type":"object","properties":{"id":{"type":"integer"},"type":{"type":"string","example":"subprojects"},"attributes":{"type":"object","required":["project-name"],"properties":{"project-name":{"type":"string"},"status":{"type":"string"},"executive-summary":{"type":"string"},"key-objectives":{"type":"string"},"our-responsibilities":{"type":"string"},"client-responsibilities":{"type":"string"},"solution-summary":{"type":"string"},"out-of-scope":{"type":"string"},"total-effort":{"type":"number","format":"double"},"total-revenue":{"type":"number","format":"double"},"ms-revenue":{"type":"number","format":"double"},"third-party-revenue":{"type":"number","format":"double"},"submitted-at":{"type":"string","format":"date-time"},"approved-at":{"type":"string","format":"date-time"},"project-variables":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}},"field-labels":{"type":"object","properties":{"executive_summary":{"type":"string"},"solution_summary":{"type":"string"},"customer_summary":{"type":"string"},"customer_success":{"type":"string"},"sales_executive":{"type":"string"},"presales_engineer":{"type":"string"},"client":{"type":"string"},"business_unit":{"type":"string"},"location":{"type":"string"},"our_responsibilities":{"type":"string"},"client_responsibilities":{"type":"string"},"out_of_scope":{"type":"string"}}}}},"relationships":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"business-unit":{"$ref":"#/components/schemas/v2_relationships"},"client":{"$ref":"#/components/schemas/v2_relationships"},"document-template":{"$ref":"#/components/schemas/v2_relationships"},"external-request":{"$ref":"#/components/schemas/v2_relationships"},"sales-executive":{"$ref":"#/components/schemas/v2_relationships"},"presales-engineer":{"$ref":"#/components/schemas/v2_relationships"},"psa-project":{"$ref":"#/components/schemas/v2_relationships"},"crm-opportunity":{"$ref":"#/components/schemas/v2_relationships"},"payment-term":{"$ref":"#/components/schemas/v2_relationships"},"user":{"$ref":"#/components/schemas/v2_relationships"},"project-attachments":{"$ref":"#/components/schemas/v2_relationships"},"project-collaborators":{"$ref":"#/components/schemas/v2_relationships"},"project-contacts":{"$ref":"#/components/schemas/v2_relationships"},"project-conditions":{"$ref":"#/components/schemas/v2_relationships"},"project-expenses":{"$ref":"#/components/schemas/v2_relationships"},"project-governances":{"$ref":"#/components/schemas/v2_relationships"},"project-locations":{"$ref":"#/components/schemas/v2_relationships"},"project-materials":{"$ref":"#/components/schemas/v2_relationships"},"project-services":{"$ref":"#/components/schemas/v2_relationships"},"rate-table":{"$ref":"#/components/schemas/v2_relationships"},"approval-steps":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_CreatorResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"creators"},"attributes":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string","example":"John Doe"},"phone":{"type":"string","example":"212-555-1234"},"email":{"type":"string","example":"john.doe@madeup.com"},"title":{"type":"string","example":"Solution Architect"}}},"relationships":{"type":"object","required":["account"],"properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_MeResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"mes"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"John Doe"},"start-page":{"type":"string","enum":["Home","Projects","Approvals","Surveys","Settings"],"default":"Home"},"email":{"type":"string","example":"john.doe@madeup.com"},"phone":{"type":"string","example":"212-555-1234"},"title":{"type":"string","example":"Solution Architect"},"account-slug":{"type":"string","example":"my-account"},"account-id":{"type":"string","example":"1234"},"privileges":{"type":"array","items":{"type":"object","properties":{"privilege":{"type":"string","example":"projects.project_overview"},"access-level":{"type":"string","example":"manage","enum":["none","view","create","manage"]}}}},"site-admin":{"type":"boolean","example":false}}}}},"v2_NoteResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"notes"},"attributes":{"type":"object","required":["content"],"properties":{"content":{"type":"string","example":"Lorem ipsum dollet..."},"notable":{"type":"object","readOnly":true,"properties":{"notable-id":{"type":"integer","description":"ID of the object to which the note is attached"},"notable-type":{"type":"string","description":"data-type of the object to which the note is attached"},"name":{"type":"string","description":"name of the object to which the note is attached"}}},"username":{"type":"string","example":"John Doe"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"relationships":{"type":"object","required":["project"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_PartnerRequestResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"partner-requests"},"attributes":{"type":"object","required":["description","cost","markup"],"properties":{"description":{"type":"string","example":"Do something as a subcontractor"},"revision-description":{"type":"string","example":"Please make this less expensive"},"service-type":{"type":"string","enum":["professional_services","managed_services"],"example":"professional_services"},"cost":{"type":"number","format":"double","example":"1234.56"},"recurring-cost":{"type":"number","format":"double","example":"234.56"},"billing-frequency":{"type":"string","enum":["one_time","monthly","quarterly","yearly"],"example":"monthly"},"markup":{"type":"number","format":"double","example":"0.35"},"price":{"type":"number","format":"double","example":"1666.66"},"responded_at":{"type":"string","format":"date-time","example":"2024-01-01T12:00:00Z"}}},"relationships":{"type":"object","required":["project"],"description":"`account` is set from your API token; any account sent is ignored. To set `lob`, send `type` `lobs`; `service-categories` and `sections` are rejected","properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"lob":{"$ref":"#/components/schemas/v2_relationships"},"subcontractor":{"$ref":"#/components/schemas/v2_relationships"},"currency":{"$ref":"#/components/schemas/v2_relationships"},"third-party-services":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_PaymentCreditResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"payment-credits"},"attributes":{"type":"object","required":["payment-source","description"],"properties":{"payment-source":{"type":"string","example":"Big Vendor, LLC"},"description":{"type":"string","example":"Spring 2026 Rebate"},"criteria":{"type":"string","example":"Customer must purchase from Big Vendor, LLC and register product before June 1."}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_PaymentTermResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"payment-terms"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Fixed Fee Engagement"},"slug":{"type":"string","example":"fixed-fee-engagement"},"position":{"type":"integer","format":"int64"},"include-expense-in-revenue":{"type":"boolean","example":true,"description":"When true, project expenses will be included in the project revenue"},"include-expense-in-cost":{"type":"boolean","example":true,"description":"When true, project expenses will be included in the project cost"},"travel-limit":{"type":"boolean","example":false,"description":"When true, product price will be included in the project revenue"},"include-materials":{"type":"boolean","example":true,"description":"When true, product price will be included in the project revenue"},"pricing-model":{"type":"string","enum":["other","fixed_fee","time_and_materials","mixed"],"example":"fixed_fee"},"rounding":{"type":"string","enum":["2000.00","1300.00","1240.00","1235.00","1234.60","1234.57","1234.568"],"example":"1235.00","description":"Format for rounding pricings"},"default":{"type":"boolean","example":true,"description":"The default payment term will be assigned to a project if no other payment term has been assigned"},"terms":{"type":"array","description":"Payment terms managed inline as an array (full-set replace on write)","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Present on read; ignored on write (terms are replaced as a set)"},"description":{"type":"string"},"percentage_due":{"type":"integer","description":"Required when term-type is \"percent\"; the percentages of a payment term must sum to \u003c= 100"},"term_type":{"type":"string","enum":["percent","milestone"]},"position":{"type":"integer"},"phase_id":{"type":"integer","format":"int64","description":"Required when term-type is \"milestone\""}}}}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"rate-table":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_PerformanceIndicatorResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"performance-indicators"},"attributes":{"type":"object","required":["name"],"properties":{"due-on":{"type":"string","format":"date","example":"2021-11-01"},"started-on":{"type":"string","format":"date","example":"2021-10-31"},"completed-on":{"type":"string","format":"date","example":null},"status":{"type":"string","enum":["pending","in_progress","delayed","completed"],"example":"in_progress"},"notes":{"type":"string","example":"Lorem ipsum dolot..."}}},"relationships":{"type":"object","required":["customer-success"],"properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"project":{"$ref":"#/components/schemas/v2_relationships"},"customer-success":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_PhaseResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"phases"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Implementation"},"sow-language":{"type":"string","example":"implementation_language"},"active":{"type":"boolean","example":true},"position":{"type":"number","format":"int32","example":1},"default":{"type":"boolean","description":"True if this phase is added to every new project by default","example":false,"default":false}}},"relationships":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"project-expenses":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_PresalesEngineerResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"presales-engineers"},"attributes":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string","example":"John Doe"},"phone":{"type":"string","example":"212-555-1234"},"email":{"type":"string","example":"john.doe@madeup.com"},"title":{"type":"string","example":"Solution Architect"}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_PricingAdjustmentResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"pricing-adjustments"},"attributes":{"type":"object","required":["price","cost","source_type","source_id","billing_frequency"],"properties":{"price":{"type":"number","format":"double","example":150.0},"cost":{"type":"number","format":"double","example":120.0},"source_type":{"type":"string","example":"ProjectResource"},"source_id":{"type":"integer","format":"int64","example":1},"billing_frequency":{"type":"string","example":"monthly"}}},"relationships":{"type":"object","properties":{"project":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProductAccountingResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"product-accountings"},"attributes":{"type":"object","required":["code"],"properties":{"code":{"type":"string","example":"ABCD-1345"}}},"relationships":{"type":"object","required":["product"],"properties":{"product":{"$ref":"#/components/schemas/v2_relationships"},"service-category":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProductResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"products"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Microsoft Office 365 License"},"description":{"type":"string","example":"Annual Microsoft Office 365 License for up to 10 users"},"sku":{"type":"string","example":"MS-365-10"},"product-id":{"type":"string","example":"MS-365-10"},"manufacturer-part-number":{"type":"string","example":"MS-365-10"},"unit-of-measure":{"type":"string","example":"each"},"category":{"type":"string","example":"Software"},"subcategory":{"type":"string","example":"License"},"unit-price":{"type":"number","format":"double"},"unit-cost":{"type":"number","format":"double"},"list-price":{"type":"number","format":"double","example":"1000.0"},"vendor-discount":{"type":"number","format":"double","description":"Discount from list price as a percentage of the list price","example":"10.0"},"vendor-rebate":{"type":"number","format":"double","description":"Rebate from list price as a percentage of the list price","example":"5.0"},"markup":{"type":"number","format":"double","description":"Markup as a percentage of the discounted list price","example":"20.0"},"billing-frequency":{"type":"string","enum":["one_time","monthly","bi-monthly","quarterly","semi-annual","yearly"],"example":"monthly"},"project-variables":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectApprovalResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"project-approvals"},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["required","optional","declined","approved","canceled","rescope"],"example":"required"},"role":{"type":"string","example":"approver"},"reason":{"type":"string","description":"The reason why this user has been asked to participate in approval","example":"Contract Margin between 5.00% and 28.00%"},"comment":{"type":"string","example":"Great job!"},"completed-at":{"type":"string","format":"date-time","example":"2022-02-22T02:22:22.222Z"},"approver-name":{"type":"string","example":"John Smith"},"created-at":{"type":"string","format":"date-time","description":"When this approver was asked to participate in approval","example":"2022-02-22T02:22:22.222Z"}}},"relationships":{"type":"object","required":["user","approval-step"],"properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"user":{"$ref":"#/components/schemas/v2_relationships"},"approval-step":{"$ref":"#/components/schemas/v2_relationships"},"approval-level":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectAttachmentResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"project-attachments"},"attributes":{"type":"object","properties":{"document":{"type":"string","description":"Name of the file","example":"network-diagram.png"}}},"relationships":{"type":"object","required":["project"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"attachment-type":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectCollaboratorResource":{"type":"object","required":["type","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"lid":{"type":"string","description":"Local ID of the record (used only when building blueprint payload). ID must be blank if provided"},"type":{"type":"string","example":"project-collaborators"},"attributes":{"type":"object","properties":{"name":{"type":"string","example":"Jane Doe"},"project-variables":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}}}},"relationships":{"type":"object","required":["project","user"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"user":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectConditionResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"lid":{"type":"string","description":"Local ID of the record (used only when building blueprint payload). ID must be blank if provided"},"type":{"type":"string","example":"project-conditions"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Net 10"},"content":{"type":"string","example":"*All* payments are due within ten days of the completion of the proejct"},"status":{"type":"string","enum":["active","skipped","optional","deleted"],"example":"active"}}},"relationships":{"type":"object","required":["project","service-condition"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"service-condition":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectContactResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"project-contacts"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"John Doe"},"phone":{"type":"string","example":"555-321-7654"},"email":{"type":"string","example":"john.doe@mycompany.com"},"title":{"type":"string","example":"President"},"contact-type":{"type":"string","enum":["primary_customer_contact","customer_contact","primary_internal_contact","internal_contact"],"example":"customer_contact","default":"customer_contact"},"crm-contact-id":{"type":"string","writeOnly":true,"description":"Create-only: a ConnectWise contact id on the client's company. The contact is adopted as a client contact and fills any blank fields. Never returned.","example":"42"},"project-variables":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}}}},"relationships":{"type":"object","required":["project","contact"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"contact":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectCreditResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"lid":{"type":"string","description":"Local ID of the record (used only when building blueprint payload). ID must be blank if provided"},"type":{"type":"string","example":"project-credits"},"attributes":{"type":"object","required":["amount"],"properties":{"amount":{"type":"number","format":"double","example":"752.00"},"criteria":{"type":"string","example":"Customer must purchase and register before June 1."}}},"relationships":{"type":"object","required":["project","payment-credit"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"payment-credit":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_PaymentScheduleResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"payment-schedules"},"attributes":{"type":"object","properties":{"status":{"type":"string","enum":["balanced","drifted"],"description":"Whether the saved schedule still matches live pricing to the cent","readOnly":true},"warnings":{"type":"array","readOnly":true,"items":{"type":"string"}},"payment-term-id":{"type":"integer","readOnly":true},"service-start-date":{"type":"string","format":"date","readOnly":true},"recurring-billing-frequency":{"type":"string","readOnly":true},"mrr-terms":{"type":"integer","readOnly":true},"created-at":{"type":"string","format":"date-time","readOnly":true}}},"relationships":{"type":"object","required":["project"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"}}},"meta":{"type":"object","readOnly":true,"properties":{"unmatched-sources":{"type":"array","description":"Live funding sources with no persisted row yet; POST payment-schedule-sources to add","items":{"type":"object","properties":{"kind":{"type":"string"},"term-id":{"type":"integer","nullable":true},"project-service-id":{"type":"integer","nullable":true},"label":{"type":"string"},"live-amount":{"type":"string"}}}}}}}},"v2_PaymentScheduleSourceResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"payment-schedule-sources"},"attributes":{"type":"object","properties":{"kind":{"type":"string","enum":["one_time_total","milestone","balance_due","hardware","recurring","carved_out"],"description":"Funding source kind; set on create only"},"term-id":{"type":"integer","description":"Payment term milestone of a milestone source; set on create only"},"label":{"type":"string","readOnly":true},"live-amount":{"type":"string","readOnly":true},"allocated-amount":{"type":"string","readOnly":true},"delta":{"type":"string","readOnly":true},"state":{"type":"string","readOnly":true}}},"relationships":{"type":"object","required":["payment-schedule"],"properties":{"payment-schedule":{"$ref":"#/components/schemas/v2_relationships"},"project-service":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ScheduledPaymentResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"scheduled-payments"},"attributes":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"due-on":{"type":"string","format":"date"},"payment-type":{"type":"string","enum":["one_time","recurring"]},"position":{"type":"integer"},"amount":{"type":"string","description":"Sum of the payment allocations","readOnly":true}}},"relationships":{"type":"object","required":["payment-schedule"],"properties":{"payment-schedule":{"$ref":"#/components/schemas/v2_relationships"},"split-from":{"$ref":"#/components/schemas/v2_relationships"},"payment-allocations":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_PaymentAllocationResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"payment-allocations"},"attributes":{"type":"object","properties":{"amount":{"type":"string","description":"Decimal amount of the source placed on the payment"},"amortized":{"type":"boolean","readOnly":true}}},"relationships":{"type":"object","required":["scheduled-payment","payment-schedule-source"],"properties":{"scheduled-payment":{"$ref":"#/components/schemas/v2_relationships"},"payment-schedule-source":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectDocumentResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"project-documents"},"attributes":{"type":"object","required":["document-type","template-id"],"properties":{"name":{"type":"string","example":"Big ProjectDocument, Inc"},"status":{"type":"string","enum":["created","enqueued","processing","finished","failed","to_delete","generated","delivering"],"description":"Status of the request to generate the document","example":"generated"},"document-type":{"type":"string","enum":["sow","pricing","breakdown","autotask","report"],"description":"Type of document being generated"},"delivery-type":{"type":"string","enum":["download","email","docusign"],"description":"Whether the document will be delivered via direct download, email, or docusign"},"email-list":{"type":"string","description":"Comma-separated list of email addresses.  Used only if delivery-method is \"email\"","example":"user@example.com"},"force-regeneration":{"type":"boolean","description":"When false or omitted and the project already has a generated document of the same type (for sow and report, from the same template), that existing document is returned and is not regenerated. When true, every such existing copy is deleted first, including copies other users generated, and a new one is built"},"template-id":{"type":"string","description":"ID of the template to be used for generating the document.  For standard reports, this will match the document-type.","example":"12345"},"template-name":{"type":"string","description":"Name of the document template requested (read only).","example":"PS Template V3"},"document-url":{"type":"string","format":"uri","readOnly":true,"description":"API endpoint that downloads the generated document; empty until it exists. It is not a public storage link: send the same Authorization header as on any other request","example":"https://api.scopestack.io/v2/project-documents/12345/downloads"},"error-text":{"type":"string","description":"If the status is \"failed\" then this will contain information about the failure","example":"Something went wrong!"},"generate-pdf":{"type":"boolean","description":"If true, Word Document templates will be converted to PDF before download"},"account-connection-id":{"type":"string","description":"ID of the storage integration that will be used for storing the file after generation"},"drive-id":{"type":"string","description":"ID of the folder to be used for storing the file"},"filepath":{"type":"string","description":"Filepath represented by the drive_id -- for display to humans"},"filename":{"type":"string","description":"Desired name of the file when it is generated"}}},"relationships":{"type":"object","required":["project"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"document-deliveries":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_ProjectDuplicationResource":{"type":"object","required":["type","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"project-duplications"},"attributes":{"type":"object","properties":{"status":{"type":"string","readOnly":true,"example":"completed"},"content":{"type":"array","description":"On create: array of {type, id} records to duplicate. On read: the expanded snapshot.","items":{"type":"object","required":["id,","type"],"properties":{"id":{"type":"string","description":"ID of the project content to be duplicated onto the new project","example":"12345"},"type":{"type":"string","description":"Resource class of the project content to be duplicated","example":"project-services"}}}}}},"relationships":{"type":"object","properties":{"source-project":{"$ref":"#/components/schemas/v2_relationships"},"target-project":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectExpenseResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"lid":{"type":"string","description":"Local ID of the record (used only when building blueprint payload). ID must be blank if provided"},"type":{"type":"string","example":"project-expenses"},"attributes":{"type":"object","required":["rate","quantity","description"],"properties":{"description":{"type":"string","example":"Travel to and from customer site"},"rate":{"type":"number","format":"double","example":"752.00"},"quantity":{"type":"number","format":"int32","example":"1"},"deleted-at":{"type":"string","format":"date-time"},"cost":{"type":"number","format":"double","example":"752.00"},"revenue":{"type":"number","format":"double","example":"752.00"},"markup":{"type":"number","format":"double","example":"752.00"},"variable":{"type":"boolean","description":"When true, the expense category of this project expense does not have a rate and does not use resource rates"}}},"relationships":{"type":"object","required":["project","resource","expense-category"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"project-phase":{"$ref":"#/components/schemas/v2_relationships"},"expense-category":{"$ref":"#/components/schemas/v2_relationships"},"project-resource":{"$ref":"#/components/schemas/v2_relationships_string"},"resource":{"$ref":"#/components/schemas/v2_relationships"},"resource-rate":{"$ref":"#/components/schemas/v2_relationships"},"project-service":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectGovernanceResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"lid":{"type":"string","description":"Local ID of the record (used only when building blueprint payload). ID must be blank if provided"},"type":{"type":"string","example":"project-governances"},"attributes":{"type":"object","properties":{"description":{"type":"string","example":"Project management"},"rate":{"type":"number","format":"double","example":"20.0"},"fixed_hours":{"type":"number","format":"double","example":null},"minimum-hours":{"type":"number","format":"double","readOnly":true,"description":"Snapshot of the catalog governance minimum at creation. Fixed hours may not be set below it; a percentage of total hours never computes below it","example":4.0},"hours":{"type":"number","format":"double","example":"20.5"},"calculation-type":{"type":"string","enum":["percent_of_total","fixed_hours"],"example":"percent_of_total","default":"percent_of_total"},"allocation-method":{"type":"string","enum":["prorate_phases_by_effort","select_phase","select_category","project_management_phase"],"example":"select_phase","default":"prorate_phases_by_effort"},"assign-effort-to-service":{"type":"boolean","description":"When true, the effort and resulting pricing of the effort will be assigned to the service rather than reported separately","example":false,"default":false},"filter-type":{"type":"string","description":"Determines how services are filtered before calculating the level of effort for this governance item","example":"all_services","enum":["all_services","filter_by_lob","filter_by_phase"]},"filter-id":{"type":"integer","description":"When filtering by phase or line-of-business (LOB), this is the ID of the phase or LOB that will scope the services","example":12345},"position":{"type":"integer","description":"Order in which governance should appear","example":1},"project-variables":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}},"rate-rules":{"type":"array","description":"Rules snapshotted from the catalog governance at creation; editable. See governances rate-rules","items":{"type":"object","properties":{"conditions":{"type":"array","items":{"type":"object","properties":{"fact":{"type":"string","example":"effort"},"op":{"type":"string","example":"lte"},"value":{"example":40.0}}}},"rate":{"type":"number","format":"double","example":0.15}}},"default":[]},"effective-rate":{"type":"number","format":"double","readOnly":true,"description":"Rate actually applied: the first matching rule's rate, else the base rate. Null for fixed_hours","example":"0.35","nullable":true},"applicable":{"type":"boolean","readOnly":true,"description":"False when the line has rate rules and its effective rate is 0; the line is then left out of generated documents, pricing, reports and PSA pushes","example":true}}},"relationships":{"type":"object","properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"project-phase":{"$ref":"#/components/schemas/v2_relationships"},"governance":{"$ref":"#/components/schemas/v2_relationships"},"project-resource":{"$ref":"#/components/schemas/v2_relationships_string"},"resource":{"$ref":"#/components/schemas/v2_relationships"},"allocationed-governances":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectLocationResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"project-locations"},"attributes":{"type":"object","required":["name","street","city","postal-code"],"properties":{"name":{"type":"string","example":"Headquarters"},"street":{"type":"string","example":"593 Summer Ave"},"street2":{"type":"string"},"city":{"type":"string","example":"Greenville"},"state":{"type":"string","example":"SC"},"postal-code":{"type":"string","example":"29615"},"country":{"type":"string","example":"US"},"deleted-at":{"type":"string","format":"date-time"},"crm-site-id":{"type":"string","writeOnly":true,"description":"Create-only: a ConnectWise site id on the client's company. The site is adopted as a client location and fills any blank address fields. Never returned.","example":"42"},"project-variables":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}}}},"relationships":{"type":"object","required":["project"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"client-location":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectPhaseResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"lid":{"type":"string","description":"Local ID of the record (used only when building blueprint payload). ID must be blank if provided"},"type":{"type":"string","example":"project-phases"},"attributes":{"type":"object","required":["name","sow-language"],"properties":{"name":{"type":"string","example":"Implementation"},"sow-language":{"type":"string","example":"implementation_language"},"active":{"type":"boolean","example":true},"position":{"type":"number","format":"int32","example":1}}},"relationships":{"type":"object","properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"phase":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectProductResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"lid":{"type":"string","description":"Local ID of the record (used only when building blueprint payload). ID must be blank if provided"},"type":{"type":"string","example":"project-products"},"attributes":{"type":"object","required":["name","quantity"],"properties":{"name":{"type":"string","example":"Microsoft Office 365 License"},"description":{"type":"string","example":"Annual Microsoft Office 365 License for up to 10 users"},"custom":{"type":"boolean","default":false,"example":false},"source":{"type":"string","enum":["standard","custom","imported","connectwise"]},"variable_rates":{"type":"object","example":{"hardware_price":[{"base_amount":"100.0","unit_amount":"8.0","minimum_quantity":11},{"base_amount":"0.0","unit_amount":"9.0","minimum_quantity":1}]}},"quantity":{"type":"integer","format":"int32","example":1},"sku":{"type":"string","example":"MS-365-10"},"product-id":{"type":"string","example":"MS-365-10"},"manufacturer-part-number":{"type":"string","example":"MS-365-10"},"unit-of-measure":{"type":"string","example":"each"},"category":{"type":"string","example":"Software"},"subcategory":{"type":"string","example":"License"},"unit-price":{"type":"number","format":"double"},"unit-cost":{"type":"number","format":"double"},"hardware-price":{"type":"number","format":"double"},"hardware-cost":{"type":"number","format":"double"},"line-number":{"type":"string","example":"1.0"},"list-price":{"type":"number","format":"double","example":"1000.0"},"vendor-discount":{"type":"number","format":"double","description":"Discount from list price as a percentage of the list price","example":"10.0"},"markup":{"type":"number","format":"double","description":"Markup as a percentage of the discounted list price","example":"20.0"},"billing-frequency":{"type":"string","enum":["one_time","monthly","bi-monthly","quarterly","semi-annual","yearly"],"example":"monthly"},"project-variables":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}}}},"relationships":{"type":"object","required":["project"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"product":{"$ref":"#/components/schemas/v2_relationships"},"project-location":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectResourceResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"lid":{"type":"string","description":"Local ID of the record (used only when building blueprint payload). ID must be blank if provided"},"type":{"type":"string","example":"project-resources"},"attributes":{"type":"object","required":["name","resource"],"properties":{"name":{"type":"string","example":"Senior Engineer"},"external-name":{"type":"string","example":"Engineering Staff"},"description":{"type":"string","example":"Senior Engineer"},"total-hours":{"type":"number","format":"double","example":"123.45","description":"Total hours assigned to this resource on this project"},"hourly-rate":{"type":"number","format":"double","example":"123.45","description":"Hourly rate charged to clients when the resource is delivering service work"},"hourly-cost":{"type":"number","format":"double","example":"102.34"},"expense-rate":{"type":"number","format":"double","example":"123.45","description":"Hourly rate charged to clients when the resource traveling."},"code":{"type":"string","example":"ABC123","description":"Accounting code for the project resource; set from the resource rate used to create the project resource"},"resource":{"oneOf":[{"$ref":"#/components/schemas/v2_StandardProjectResource"},{"$ref":"#/components/schemas/v2_VendorProjectResource"}]},"user-defined-fields":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}}}},"relationships":{"type":"object","required":["project","resource"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_StandardProjectResource":{"type":"object","required":["resource_id","resource_type"],"properties":{"resource_id":{"type":"integer","description":"ID of the Resource object"},"resource_type":{"type":"string","example":"resources"},"name":{"type":"string","example":"Senior Engineer"}}},"v2_VendorProjectResource":{"type":"object","required":["resource_id","resource_type"],"properties":{"resource_id":{"type":"integer","description":"ID of the Vendor object providing the resource"},"resource_type":{"type":"string","example":"vendors"},"name":{"type":"string","example":"Subcontractors Inc"}}},"v2_ProjectServiceResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"lid":{"type":"string","description":"Local ID of the record (used only when building blueprint payload). ID must be blank if provided"},"type":{"type":"string","example":"project-services"},"attributes":{"type":"object","required":["name","quantity","override-hours","service-type","lob-id","task-source"],"properties":{"name":{"type":"string","example":"Meraki 120-48"},"quantity":{"type":"number","format":"int32"},"override-hours":{"type":"number","format":"double","description":"The hours per service required for the top-level service"},"total-hours":{"type":"number","format":"double","description":"The total hours required for the service and all subservices"},"extended-hours":{"type":"number","format":"double","description":"The total hours required for the top-level service when taking into account the service quantity"},"actual-hours":{"type":"number","format":"double","description":"The total hours spent during implementation"},"position":{"type":"number","format":"int32"},"service-type":{"type":"string","example":"professional_services","enum":["professional_services","managed_services"]},"lob-id":{"type":"number","format":"int64"},"payment-frequency":{"type":"string","example":"one_time"},"task-source":{"type":"string","example":"standard"},"do-not-print":{"type":"boolean","default":false,"description":"Lets templates leave the service out of documents; still counts in hours and pricing"},"languages":{"type":"object"},"calculated-pricing":{"type":"object"},"notes":{"type":"array","items":{"type":"object","required":["content"],"properties":{"id":{"type":"integer","example":"12345","description":"If previously persisted, the ID of the note"},"name":{"type":"string","example":"Beware!","description":"If desired the name or headline for the note"},"content":{"type":"string","example":"If this service is removed then product SKU ABC-123 should also be removed","description":"The content of the note"},"username":{"type":"string","example":"Andy V","description":"The name of the user that created the note. This value is automatically added"},"created_at":{"type":"string","format":"datetime","example":"2025-12-03T11:56:58-04:00","description":"Automatically captured timestamp of when the note was created"},"updated_at":{"type":"string","format":"datetime","example":"2025-12-03T11:56:58-04:00","description":"Automatically captured timestamp of when the note was last updated"}}}}}},"relationships":{"type":"object","required":["project"],"description":"To set `lob`, send `type` `lobs`; `service-categories` and `sections` are rejected","properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"project-location":{"$ref":"#/components/schemas/v2_relationships"},"project-phase":{"$ref":"#/components/schemas/v2_relationships"},"project-resource":{"$ref":"#/components/schemas/v2_relationships_string"},"resource":{"$ref":"#/components/schemas/v2_relationships"},"service":{"$ref":"#/components/schemas/v2_relationships"},"lob":{"$ref":"#/components/schemas/v2_relationships"},"project-subservices":{"$ref":"#/components/schemas/v2_to_many_relationships"},"allocated-governances":{"$ref":"#/components/schemas/v2_relationships"},"source-project-service":{"$ref":"#/components/schemas/v2_relationships","description":"On a change-request child: the parent line this adjusts. Absent for a new line. Read-only"}}}}},"v2_ProjectSubserviceResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"lid":{"type":"string","description":"Local ID of the record (used only when building blueprint payload). ID must be blank if provided"},"type":{"type":"string","example":"project-subservices"},"attributes":{"type":"object","required":["name","quantity","override-hours"],"properties":{"name":{"type":"string","example":"Meraki 120-48 Rack and Stack"},"quantity":{"type":"number","format":"int32"},"override-hours":{"type":"number","format":"double"},"extended-hours":{"type":"number","format":"double"},"actual-hours":{"type":"number","format":"double"},"position":{"type":"number","format":"int32"},"service-type":{"type":"string","example":"professional_services"},"lob-id":{"type":"number","format":"int64"},"payment-frequency":{"type":"string","example":"one_time"},"task-source":{"type":"string","example":"standard"},"do-not-print":{"type":"boolean","default":false,"description":"Lets templates leave the subservice out of documents; still counts in hours and pricing"},"languages":{"type":"object"}}},"relationships":{"type":"object","properties":{"project-service":{"$ref":"#/components/schemas/v2_relationships"},"project-resource":{"$ref":"#/components/schemas/v2_relationships_string"},"resource":{"$ref":"#/components/schemas/v2_relationships"},"service":{"$ref":"#/components/schemas/v2_relationships"},"source-project-subservice":{"$ref":"#/components/schemas/v2_relationships","description":"On a change-request child: the parent line this adjusts. Absent for a new line. Read-only"}}}}},"v2_ProjectSurveyResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"project-surveys"},"relationships":{"type":"object","properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"survey":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ProjectVariableResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"project-variables"},"attributes":{"type":"object","required":["label","name"],"properties":{"label":{"type":"string","example":"MSA Date"},"name":{"type":"string","example":"msa-date"},"variable_type":{"type":"string","enum":["number","text","date"],"example":"date"},"context":{"type":"string","description":"The context in which the project variable will be used","enum":["client","crm_opportunity","project","governance","service_location","project_contact","product","resource","section","service","teammate"],"example":"project"},"minimum":{"type":"integer","format":"int32","description":"When variable-type is number, this is the minimum value allowed.  When variable-type is a string then this is the minimum length."},"maximum":{"type":"integer","format":"int32","description":"When variable-type is number, this is the maximum value allowed.  When variable-type is a string then this is the maximum length."},"required":{"type":"boolean"},"position":{"type":"integer","format":"int32","description":"Sort order for the project variable"},"select_options":{"type":"array","description":"When present, the user will be presented with a dropdown from which to pick values","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"default":{"type":"boolean"}}}}}},"relationships":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_embeddedProjectVariable":{"type":"object","required":["name","value"],"properties":{"name":{"type":"string","example":"msa-date"},"label":{"type":"string","example":"MSA Date"},"variable_type":{"type":"string","enum":["number","text","date"],"example":"date"},"minimum":{"type":"integer","format":"int32","description":"When variable-type is number, this is the minimum value allowed.  When variable-type is a string then this is the minimum length."},"maximum":{"type":"integer","format":"int32","description":"When variable-type is number, this is the maximum value allowed.  When variable-type is a string then this is the maximum length."},"required":{"type":"boolean"},"select_options":{"type":"array","description":"When present, the user will be presented with a dropdown from which to pick values","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"default":{"type":"boolean"}}}},"position":{"type":"integer","format":"int32","description":"Sort order for the project variable"},"context":{"type":"string","description":"The context in which the project variable will be used","enum":["client","crm_opportunity","project","governance","service_location","project_contact","product","resource","section","service","teammate"],"example":"project"},"uuid":{"type":"string","description":"a unique identifier for the variable defined by the API","example":"99673a0f-1234-5678-abcd-33c37416d028"},"value":{"type":"string","description":"The value for the variable on this project"}}},"v2_ProjectVersionResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"project-versions"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Version 1"},"comment":{"type":"string","example":"Project submitted for approval"},"username":{"type":"string","example":"Jon Smith"},"started-at":{"type":"string","format":"date-time","example":"2022-02-22T02:22:22Z"},"completed-at":{"type":"string","format":"date-time","example":"2022-02-22T02:22:22Z"},"updated-at":{"type":"string","format":"date-time","example":"2022-02-22T02:22:22Z"}}},"relationships":{"type":"object","required":["project"],"properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"approval-steps":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_ProjectResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"lid":{"type":"string","description":"Local ID of the record (used only when building blueprint payload) ID must be blank if provided"},"type":{"type":"string","example":"projects"},"attributes":{"type":"object","required":["project-name","price-adjustment"],"properties":{"project-name":{"type":"string"},"status":{"type":"string"},"created-at":{"type":"string","format":"date-time"},"updated-at":{"type":"string","format":"date-time"},"contract-margin":{"type":"number","nullable":true},"payment-schedule-status":{"type":"string","enum":["none","balanced","drifted"],"description":"none without a saved schedule; drifted when it no longer matches live pricing. Only computed on GET /v2/projects/{id}; null in the project list","nullable":true,"readOnly":true},"net-mrr":{"type":"number","nullable":true},"service-category":{"type":"string","nullable":true},"price-adjustment":{"type":"number","nullable":true},"ps-revenue-adjustment":{"type":"number","nullable":true},"ps-cost-adjustment":{"type":"number","nullable":true},"ms-revenue-adjustment":{"type":"number","nullable":true},"ms-cost-adjustment":{"type":"number","nullable":true},"executive-summary":{"type":"string"},"key-objectives":{"type":"string"},"our-responsibilities":{"type":"string"},"client-responsibilities":{"type":"string"},"solution-summary":{"type":"string"},"out-of-scope":{"type":"string"},"contract-revenue":{"type":"number","format":"double"},"contract-cost":{"type":"number","format":"double"},"total-effort":{"type":"number","format":"double"},"total-revenue":{"type":"number","format":"double"},"one-time-adjustment":{"type":"number","format":"double"},"ms-revenue":{"type":"number","format":"double"},"mrr-adjustment":{"type":"number","format":"double"},"mrr-terms":{"type":"number","format":"integer"},"cola":{"type":"number","format":"decimal","example":"0.78"},"recurring-billing-frequency":{"type":"string","enum":["monthly","quarterly","yearly"]},"include-ps-revenue-in-mrr":{"type":"string","enum":["do_not_include_ps_revenue","add_to_first_month","amortize_over_all_months"],"example":"add_to_first_month"},"service-start-date":{"type":"string","format":"date","example":"2026-11-18"},"third-party-revenue":{"type":"number","format":"double"},"travel-limit":{"type":"number","format":"double","description":"Maximum allowed value for the sum of all travel and expense items"},"submitted-at":{"type":"string","format":"date-time"},"approved-at":{"type":"string","format":"date-time"},"msa-date":{"type":"string","format":"date","example":"2026-11-18"},"storage-options":{"type":"object","example":"{\"12345\":{\"drive_id\":\"aaaaaaaa-bbbb-cccc-dddd-eeee-ffffffff\",\"filepath\":\"/some/place\",\"filename\":\"Proposal-for-Customer-X.docx\"}}"},"project-variables":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}},"field-labels":{"type":"object","properties":{"executive_summary":{"type":"string"},"solution_summary":{"type":"string"},"customer_summary":{"type":"string"},"customer_success":{"type":"string"},"sales_executive":{"type":"string"},"presales_engineer":{"type":"string"},"client":{"type":"string"},"request_approval":{"type":"string"},"business_unit":{"type":"string"},"location":{"type":"string"},"our_responsibilities":{"type":"string"},"client_responsibilities":{"type":"string"},"out_of_scope":{"type":"string"},"currency_unit":{"type":"string","description":"Currency symbol for all prices on the project","example":"$"}}},"tag-list":{"type":"array","items":{"type":"string"},"example":["demo","network"]},"payment-info":{"type":"object","properties":{"pricing-model":{"type":"string","enum":["other","fixed_fee","time_and_materials","mixed"],"example":"time_and_materials"},"include-expenses":{"type":"boolean"},"include-product":{"type":"boolean"},"rate-type":{"type":"string","enum":["hour","day","week"]}}},"change-order-summary":{"type":"object","nullable":true,"readOnly":true,"description":"Change-request roll-up for a parent project; null without projects.change_orders view. Money and hours count only change requests whose child is approved or won.","properties":{"count":{"type":"integer"},"counted_count":{"type":"integer"},"delta_revenue":{"type":"string","example":"12500.0"},"delta_cost":{"type":"string","example":"12500.0"},"delta_hours":{"type":"string","example":"12500.0"},"revenue_including_change_orders":{"type":"string","example":"12500.0"},"cost_including_change_orders":{"type":"string","example":"12500.0"}}},"change-order?":{"type":"boolean","readOnly":true,"description":"True when this project is the child project of a change request. Visible to anyone who can view the project, regardless of projects.change_orders."}}},"relationships":{"type":"object","required":["client","rate-table"],"description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"business-unit":{"$ref":"#/components/schemas/v2_relationships"},"client":{"$ref":"#/components/schemas/v2_relationships"},"document-template":{"$ref":"#/components/schemas/v2_relationships"},"external-request":{"$ref":"#/components/schemas/v2_relationships"},"sales-executive":{"$ref":"#/components/schemas/v2_relationships"},"presales-engineer":{"$ref":"#/components/schemas/v2_relationships"},"psa-project":{"$ref":"#/components/schemas/v2_relationships"},"crm-opportunity":{"$ref":"#/components/schemas/v2_relationships"},"payment-term":{"$ref":"#/components/schemas/v2_relationships"},"user":{"$ref":"#/components/schemas/v2_relationships"},"project-attachments":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-collaborators":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-contacts":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-conditions":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-credits":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-documents":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-expenses":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-governances":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-locations":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-materials":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-phases":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-products":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-resources":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-versions":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-services":{"$ref":"#/components/schemas/v2_to_many_relationships"},"rate-table":{"$ref":"#/components/schemas/v2_relationships"},"resource-plans":{"$ref":"#/components/schemas/v2_to_many_relationships"},"approval-steps":{"$ref":"#/components/schemas/v2_to_many_relationships"},"notes":{"$ref":"#/components/schemas/v2_to_many_relationships"},"quotes":{"$ref":"#/components/schemas/v2_to_many_relationships"},"partner-requests":{"$ref":"#/components/schemas/v2_to_many_relationships"},"audit-logs":{"$ref":"#/components/schemas/v2_to_many_relationships"},"customer-successes":{"$ref":"#/components/schemas/v2_to_many_relationships"},"change-orders":{"$ref":"#/components/schemas/v2_to_many_relationships"},"parent-change-order":{"$ref":"#/components/schemas/v2_relationships"},"change-order-projects":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_CreateProjectResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"integer"},"type":{"type":"string","example":"projects"},"attributes":{"type":"object","required":["project-name","price-adjustment"],"properties":{"project-name":{"type":"string"},"status":{"type":"string","description":"Settable on create only"},"executive-summary":{"type":"string"},"key-objectives":{"type":"string"},"our-responsibilities":{"type":"string"},"client-responsibilities":{"type":"string"},"solution-summary":{"type":"string"},"out-of-scope":{"type":"string"},"one-time-adjustment":{"type":"number","format":"double"},"mrr-adjustment":{"type":"number","format":"double"},"mrr-terms":{"type":"number","format":"integer"},"cola":{"type":"number","format":"decimal","example":"0.78"},"recurring-billing-frequency":{"type":"string","enum":["monthly","quarterly","yearly"]},"include-ps-revenue-in-mrr":{"type":"string","enum":["do_not_include_ps_revenue","add_to_first_month","amortize_over_all_months"],"example":"add_to_first_month"},"service-start-date":{"type":"string","format":"date","example":"2026-11-18"},"travel-limit":{"type":"number","format":"double","description":"Maximum allowed value for the sum of all travel and expense items"},"submitted-at":{"type":"string","format":"date-time"},"approved-at":{"type":"string","format":"date-time"},"msa-date":{"type":"string","format":"date","example":"2026-11-18"},"project-variables":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}},"field-labels":{"type":"object","properties":{"executive_summary":{"type":"string"},"solution_summary":{"type":"string"},"customer_summary":{"type":"string"},"customer_success":{"type":"string"},"sales_executive":{"type":"string"},"presales_engineer":{"type":"string"},"client":{"type":"string"},"business_unit":{"type":"string"},"location":{"type":"string"},"our_responsibilities":{"type":"string"},"client_responsibilities":{"type":"string"},"out_of_scope":{"type":"string"}}},"tag-list":{"type":"array","items":{"type":"string"},"example":["demo","network"]},"client-name":{"type":"string","description":"Name of the client for which the project is being created. A client resource will be created if necessary","example":"Big Company, Inc"},"sales-executive-name":{"type":"string","description":"Name of the sales executive for which the project is being created. A sales executive resource will be created if necessary","example":"Sammy Sales"},"presales-engineer-name":{"type":"string","description":"Name of the presales engineer for which the project is being created. A user configured for presales will be assigned (if possible)","example":"Pat Presales"},"payment-info":{"type":"object","properties":{"pricing-model":{"type":"string","enum":["other","fixed_fee","time_and_materials","mixed"],"example":"time_and_materials"},"include-expenses":{"type":"boolean"},"include-product":{"type":"boolean"},"rate-type":{"type":"string","enum":["hour","day","week"]}}}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored. Send `client` or the `client-name` attribute (which finds or creates a client by name). `rate-table` defaults to the account's default rate table","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"business-unit":{"$ref":"#/components/schemas/v2_relationships"},"client":{"$ref":"#/components/schemas/v2_relationships"},"document-template":{"$ref":"#/components/schemas/v2_relationships"},"external-request":{"$ref":"#/components/schemas/v2_relationships"},"sales-executive":{"$ref":"#/components/schemas/v2_relationships"},"presales-engineer":{"$ref":"#/components/schemas/v2_relationships"},"psa-project":{"$ref":"#/components/schemas/v2_relationships"},"crm-opportunity":{"$ref":"#/components/schemas/v2_relationships"},"payment-term":{"$ref":"#/components/schemas/v2_relationships"},"user":{"$ref":"#/components/schemas/v2_relationships"},"project-attachments":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-collaborators":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-contacts":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-conditions":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-credits":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-documents":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-expenses":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-governances":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-locations":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-materials":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-phases":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-products":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-resources":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-versions":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-services":{"$ref":"#/components/schemas/v2_to_many_relationships"},"rate-table":{"$ref":"#/components/schemas/v2_relationships"},"resource-plans":{"$ref":"#/components/schemas/v2_to_many_relationships"},"approval-steps":{"$ref":"#/components/schemas/v2_to_many_relationships"},"notes":{"$ref":"#/components/schemas/v2_to_many_relationships"},"quotes":{"$ref":"#/components/schemas/v2_to_many_relationships"},"partner-requests":{"$ref":"#/components/schemas/v2_to_many_relationships"},"audit-logs":{"$ref":"#/components/schemas/v2_to_many_relationships"},"customer-successes":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_PsaProjectOptions":{"type":"object","description":"Push settings for the PSA tool. Keys are snake_case. Which keys apply depends on the connection (ConnectWise, HaloPSA or Autotask) and on `import`. Values are passed as strings.","additionalProperties":true,"properties":{"import":{"type":"string","enum":["new","existing","service_ticket"],"description":"`new` creates a project in the PSA; `existing` pushes into the PSA project named by `project_id`; `service_ticket` (ConnectWise) is the service-ticket export, which uses `service_board`"},"company":{"type":"string","description":"ID of the company (client) in the PSA. If omitted, the ID mapped to the project's client for this connection is used","example":"250"},"board":{"type":"string","description":"ConnectWise: ID of the project board. Defaults to the first board on the connection","example":"3"},"template":{"type":"string","description":"ConnectWise / HaloPSA: ID of the PSA project template to create the project from"},"project_template_tickets":{"type":"array","description":"Used with `template`: pairs mapping a ScopeStack project service ID (`key`) to a ticket in the PSA template (`value`). ConnectWise: the template ticket's description; HaloPSA: the template ticket's ID","items":{"$ref":"#/components/schemas/v2_PsaProjectOptionPair"}},"project_id":{"type":"string","description":"Required when `import` is `existing`: ID of the existing project in the PSA","example":"1234"},"process":{"type":"string","enum":["current_process","task_as_ticket","phase_as_ticket"],"description":"Used when `import` is `existing`"},"task_mapping":{"type":"array","description":"Used when `process` is `task_as_ticket`: pairs mapping a ScopeStack project service ID (`key`) to an existing PSA ticket ID (`value`)","items":{"$ref":"#/components/schemas/v2_PsaProjectOptionPair"}},"phase_mapping":{"type":"array","description":"Used when `process` is `phase_as_ticket`: pairs mapping a ScopeStack project phase ID (`key`) to the ID of an existing phase in the PSA project (`value`): a ConnectWise phase or a HaloPSA milestone","items":{"$ref":"#/components/schemas/v2_PsaProjectOptionPair"}},"governance":{"type":"string","enum":["0","1"],"description":"`1` to add the project's governance to the PSA project; `0` (or omitted) to skip it"},"subtasks":{"type":"string","enum":["0","1","2","3","4"],"description":"How services and subservices become PSA items: `0` one per service, `1` one per service with subservices beneath it (Autotask: one per service, with the subservice descriptions added to it), `2` services and subservices with revenue greater than 0, `3` one per subservice, `4` (ConnectWise) a sub-phase per service with a ticket per subservice; only when ScopeStack creates the phases (`import` `new` without `template`, or `existing` with `process` `current_process`). Defaults to `0`. Cannot be changed after create"},"phases":{"type":"string","enum":["0","1","2"],"description":"Autotask: `0` no phases, `1` use the ScopeStack phase name, `2` use the service name"},"status":{"type":"string","description":"ID of the status to set in the PSA"},"priority":{"type":"string","description":"ID of the priority to set in the PSA"},"service_board":{"type":"string","description":"ConnectWise: ID of the service board, used when `import` is `service_ticket`"}}},"v2_PsaProjectOptionPair":{"type":"object","required":["key","value"],"properties":{"key":{"type":"string","description":"ScopeStack ID","example":"101"},"value":{"type":"string","description":"PSA ID (for ConnectWise template tickets, the ticket description). Pairs with a blank value are dropped","example":"5001"}}},"v2_PsaProjectCreateRequest":{"type":"object","required":["type","attributes","relationships"],"properties":{"type":{"type":"string","enum":["psa-projects"],"example":"psa-projects"},"attributes":{"type":"object","required":["start-on","end-on"],"properties":{"start-on":{"type":"string","format":"date","description":"Estimated start date of the project","example":"2023-10-01"},"end-on":{"type":"string","format":"date","description":"Estimated end date of the project","example":"2023-10-31"},"project-options":{"$ref":"#/components/schemas/v2_PsaProjectOptions"}}},"relationships":{"type":"object","required":["account-connection"],"description":"`account-connection` is the PSA connection to push to (`type` `account-connections`). It must belong to your account","properties":{"account-connection":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_PsaProjectUpdateRequest":{"type":"object","required":["type","id"],"properties":{"type":{"type":"string","enum":["psa-projects"],"example":"psa-projects"},"id":{"type":"string","description":"ID of the project's existing PSA project, as returned by GET. Required","example":"42"},"attributes":{"type":"object","description":"Optional. Send `{}` to resubmit with the stored settings. `project-options` replaces the stored options as sent: the pair arrays (`project_template_tickets`, `task_mapping`, `phase_mapping`) and `project_id` are only converted and applied on POST","properties":{"start-on":{"type":"string","format":"date","example":"2023-10-01"},"end-on":{"type":"string","format":"date","example":"2023-10-31"},"project-options":{"$ref":"#/components/schemas/v2_PsaProjectOptions"}}}}},"v2_PsaProjectResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"psa-projects"},"attributes":{"type":"object","properties":{"start-on":{"type":"string","format":"date","description":"Estimated start date of the project","example":"2023-10-01"},"end-on":{"type":"string","format":"date","description":"Estimated end date of the project","example":"2023-10-31"},"project-id":{"type":"string","readOnly":true,"description":"ID of the project in the PSA tool, set once the push creates or links it","example":"1234"},"error-message":{"type":"string","readOnly":true,"description":"Error from the last push to the PSA, if any. Cleared by PATCH","example":"Oops!"},"project-options":{"type":"object","description":"The stored settings. Mappings sent on POST are returned as objects keyed by ScopeStack ID, not as the key/value pairs sent on input (pair arrays sent on PATCH are stored as sent): `project_template_tickets` as `{ \"\u003cid\u003e\": \"\u003cvalue\u003e\" }`, `phase_mapping` as `{ \"\u003cid\u003e\": \u003cpsa id\u003e }` (numbers), `task_mapping` as `{ \"tickets\": { \"\u003cid\u003e\": \u003cpsa id\u003e } }`. After a push, template selections are replaced by the created ticket IDs","additionalProperties":true}}},"relationships":{"type":"object","description":"Linkage data is returned only for relationships named in `include=`","properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"account-connection":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_QuestionnaireSectionResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","format":"uuid"},"type":{"type":"string","example":"questionnaire-sections"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Big Client, Inc"},"position":{"type":"integer","description":"Order in which this section should be displayed in the sequence of sections for this survey"},"expression":{"type":"string","example":"question_1 == 1"},"introduction":{"type":"string","description":"Text displayed before the list of questions in this section of the survey"}}},"relationships":{"type":"object","required":["questionnaire"],"properties":{"questionnaire":{"$ref":"#/components/schemas/v2_relationships"},"questions":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_EvlauateStringAttributes":{"type":"object","required":["result"],"properties":{"result":{"type":"string","description":"The result of the evaluation, as a string"}}},"v2_EvlauateNumberAttributes":{"type":"object","required":["result"],"properties":{"result":{"type":"number","format":"double","description":"The result of the evaluation, as a number (decimal)"}}},"v2_EvlauateBooleanAttributes":{"type":"object","required":["result"],"properties":{"result":{"type":"boolean","description":"The result of the evaluation, as a boolean"}}},"v2_QuestionnaireResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"questionnaires"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Wireless Access Survey"},"published":{"type":"boolean","description":"True if this survey has been published in settings."},"created-at":{"type":"string","format":"datetime","example":"2019-01-01T00:00:00.000Z"},"slug":{"type":"string","example":"wireless-access-survey"},"introduction":{"type":"string","description":"Text to be displayed as a header above the questions.","example":"Lorem ipsum dollet..."},"thank_you":{"type":"string","description":"Text to be displayed after the user has completed the survey.","example":"Lorem ipsum dollet..."},"completion-url":{"type":"string","description":"URL to which the user should be directed after completing the survey.","example":"https://somepla.ce/else.html"},"questions":{"type":"array","items":{"properties":{"question":{"type":"string","description":"The question to ask the user","example":"What is the area of each floor in square feet?"},"slug":{"type":"string","example":"square-feet","description":"An identifier for the response value.  This MUST be copied to the survey response."},"postion":{"type":"integer","description":"Ascending sequence number indicating the order in which questions should be presented","format":"int32"},"value-type":{"type":"string","enum":["text","number","date","checkbox","email","phone"],"default":"text","example":"number"},"required":{"type":"boolean","description":"True if a response is required for this question in order to submit the survey"},"settings":{"type":"object","description":"Input field settings","properties":{"min":{"type":"string","description":"The minimum length of a string or the minimum value of a number input","example":"3"},"max":{"type":"string","description":"The maximum length of a string or the maximum value of a number input","example":"255"},"step":{"type":"integer","description":"The minimum value by which a number input may change (0.01, 0.1, 1, ...)","example":1}}},"select-options":{"type":"array","description":"List of permitted response values.  The key is the label for the value. If empty, any value is permitetd.","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}}}}}}},"sections":{"type":"array","description":"Sections of the survey into which questions are organized","items":{"type":"object","properties":{"name":{"type":"string","description":"Wiresless Access Survey"},"id":{"type":"string","format":"uuid"},"introduction":{"type":"string","description":"Text displayed before any of the questions in this section","example":"The following questions describe the environment that will be supported by the wireless network"},"expression":{"type":"string","description":"Expression to evaluate to determine if/when the section is displayed.  Leave blank to always display","example":"question_1 \u003e 2"},"position":{"type":"integer","description":"Order in which the sections should be displayed.  Lowest values shown first."}}}},"tag-list":{"type":"array","items":{"type":"string"},"example":["demo","network"]},"teams":{"type":"array","items":{"properties":{"id":{"type":"string","description":"ID of the team","example":"12345"},"name":{"type":"string","description":"name of the team","example":"Service Development"}}}}}},"relationships":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"questionnaire-sections":{"$ref":"#/components/schemas/v2_to_many_relationships"},"questions":{"$ref":"#/components/schemas/v2_to_many_relationships"},"calculations":{"$ref":"#/components/schemas/v2_to_many_relationships"},"lookups":{"$ref":"#/components/schemas/v2_to_many_relationships"},"recommendations":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_QuestionResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"questions"},"attributes":{"type":"object","properties":{"question":{"type":"string","description":"The question to ask the user","example":"What is the area of each floor in square feet?"},"name":{"type":"string","example":"square feet","description":"An identifier for the response value.  If slug is left blank then this value will be used to create it"},"slug":{"type":"string","example":"square_feet","description":"An identifier for the response value.  This MUST be copied to the survey response."},"questionnaire-position":{"type":"integer","description":"Sequence number indicating the order in which questions should be presented within the questionnaire as a whole","format":"int32"},"position":{"type":"integer","description":"Ascending sequence number indicating the order in which questions should be presented within a section","format":"int32"},"value-type":{"type":"string","enum":["text","number","date","checkbox","email","phone"],"default":"text","example":"number"},"required":{"type":"boolean","description":"True if a response is required for this question in order to submit the survey"},"settings":{"type":"object","description":"Input field settings","properties":{"min":{"type":"string","description":"The minimum length of a string or the minimum value of a number input","example":"3"},"max":{"type":"string","description":"The maximum length of a string or the maximum value of a number input","example":"255"},"step":{"type":"integer","description":"The minimum value by which a number input may change (0.01, 0.1, 1, ...)","example":1}}},"select-options":{"type":"array","description":"List of permitted response values.  The key is the label for the value. If empty, any value is permitetd.","items":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"},"default":{"type":"boolean"}}}}}},"relationships":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"questionnaire":{"$ref":"#/components/schemas/v2_relationships"},"questionnaire-section":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_QuestionnaireCalculationResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"questionnaire-calculations"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Total Square Feet"},"slug":{"type":"string","description":"Identifier used to reference this value. Derived from name if blank.","example":"total_square_feet"},"calculation-type":{"type":"string","description":"The operation to apply (e.g. add, subtract, multiply, divide).","example":"add"},"operand-1":{"type":"string","description":"The first operand: a literal value or the slug of a question/lookup/calculation.","example":"square_feet"},"value-type-1":{"type":"string","description":"How operand-1 is interpreted (number or selected_value).","example":"number"},"operand-2":{"type":"string","description":"The second operand: a literal value or a slug.","example":"2"},"value-type-2":{"type":"string","description":"How operand-2 is interpreted (number or selected_value).","example":"number"},"expression":{"type":"string","description":"Full expression evaluated for this calculation.","example":"square_feet * 2"},"active":{"type":"boolean","description":"True for active calculations, false for archived."}}},"relationships":{"type":"object","properties":{"questionnaire":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_QuestionnaireLookupResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"questionnaire-lookups"},"attributes":{"type":"object","required":["name","index-1"],"properties":{"name":{"type":"string","example":"Bandwidth By Tier"},"slug":{"type":"string","description":"Identifier used to reference this value. Derived from name if blank.","example":"bandwidth_by_tier"},"index-1":{"type":"string","description":"Slug of the question used as the primary lookup index.","example":"tier"},"index-2":{"type":"string","description":"Slug of the question used as the secondary lookup index (optional).","example":"region"},"value-type":{"type":"string","enum":["text","number","date","checkbox","email","phone"],"default":"number","example":"number"},"lookups":{"type":"object","description":"Nested map of index value(s) to resulting value.","example":{"1":100,"2":200}},"active":{"type":"boolean","description":"True for active lookups, false for archived."}}},"relationships":{"type":"object","properties":{"questionnaire":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_QuestionnaireRecommendationResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"questionnaire-recommendations"},"attributes":{"type":"object","required":["quantity-value","item-id"],"properties":{"condition-type":{"type":"string","enum":["always","greater_than","greater_than_or_equal_to","equal_to","less_than_or_equal_to","less_than"],"default":"always","example":"greater_than"},"conditional-value":{"type":"string","description":"Slug of the question whose answer is evaluated.","example":"square_feet"},"comparison-value":{"type":"string","description":"Value (or slug) the conditional value is compared against.","example":"100"},"comparison-value-type":{"type":"string","enum":["text","number","date","checkbox","email","phone","selected_value"],"example":"number"},"quantity-value":{"type":"string","description":"Slug of the question whose answer becomes the recommended quantity.","example":"square_feet"},"item-id":{"type":"integer","format":"int64","description":"ID of the recommended item (defaults to a Task/service)."},"item-type":{"type":"string","default":"Task","description":"Polymorphic type of the recommended item.","example":"Task","enum":["Task","Governance","Material"]},"position":{"type":"integer","description":"Order in which recommendations are evaluated."},"refinements":{"type":"array","description":"Per-subservice quantity refinements, managed inline as an array (full-set replace on write).","items":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Present on read; ignored on write (refinements are replaced as a set)."},"quantity-value":{"type":"string","description":"Slug of the question whose answer becomes this refinement quantity."},"task-id":{"type":"integer","format":"int64","description":"ID of the subservice Task this refinement applies to."}}}},"active":{"type":"boolean","description":"True for active recommendations, false for archived."}}},"relationships":{"type":"object","properties":{"questionnaire":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ScopeReviewSettingResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string"},"type":{"type":"string","example":"scope-review-settings"},"attributes":{"type":"object","properties":{"mode":{"type":"string","enum":["advisory","required"],"description":"advisory: the review is a signal only. required: submitting a project for approval regenerates the review and is refused below passing-grade unless a user with projects.scope_review override overrides it"},"passing-grade":{"type":"string","enum":["A","B","C","D"],"description":"Lowest grade that passes (A 90, B 75, C 60, D 45)"},"loe-high-hours":{"type":"integer","minimum":1,"description":"Hours above which a professional-services line gets the loe.high_hours finding"},"rules":{"type":"object","description":"Stored rule levels keyed by rule id. A PATCH merges into the stored rules, so send only the rules to change. Rules not stored use their default; see available-rules for every rule id on the account","example":{"service_language.assumptions":"warn","narrative.executive_summary":"fail"},"additionalProperties":{"type":"string","enum":["fail","warn","off"]}},"hints":{"type":"object","description":"Stored on/off switches for the ungraded hint sections, keyed by hint id. A PATCH merges into the stored hints","example":{"missing_services":false},"additionalProperties":{"type":"boolean"}},"available-rules":{"type":"array","readOnly":true,"description":"Every rule id that applies to this account (built from its language fields) with its effective level and default","items":{"type":"object","properties":{"id":{"type":"string","example":"service_language.deliverables"},"level":{"type":"string","enum":["fail","warn","off"]},"default":{"type":"string","enum":["fail","warn","off"]}}}},"available-hints":{"type":"array","readOnly":true,"items":{"type":"object","properties":{"id":{"type":"string","enum":["placeholders","missing_services","estimate_accuracy"]},"enabled":{"type":"boolean"},"default":{"type":"boolean"}}}}}}}},"v2_QuoteResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"quotes"},"attributes":{"type":"object","required":["description"],"properties":{"description":{"type":"string","example":"Do something as a subcontractor"},"service_type":{"type":"string","enum":["professional_services","managed_services"],"example":"professional_services"},"price-override":{"type":"number","format":"double","example":"1234.56"},"cost":{"type":"number","format":"double","example":"1234.56"},"mrr-override":{"type":"number","format":"double","example":"1234.56"},"recurring-cost":{"type":"number","format":"double","example":"234.56"},"billing-frequency":{"type":"string","enum":["one_time","monthly","quarterly","yearly"],"example":"monthly"},"revenue-calculation":{"type":"string","enum":["margin","markup"],"example":"margin"},"pricing-model":{"type":"string","enum":["time_and_materials","fixed_fee"],"example":"time_and_materials"},"markup":{"type":"number","format":"double","example":"0.35","description":"The percentage that one-time revenue should be increased based on the revenue calculation method"},"mrr-markup":{"type":"number","format":"double","example":"0.35","description":"The percentage that recurring revenue should be increased based on the revenue calculation method"},"price":{"type":"number","format":"double","example":"1666.66"},"service-pricing":{"type":"boolean","description":"True if the one-time and recurring costs are calculated from the services"},"vendor-document":{"type":"string","example":"Hello_I_Am_A_Document.pdf","description":"Base64-encoded string of the PDF file contents"},"vendor-document-status":{"type":"string","enum":["pending","submitted","processed","error","accepted","not_applicable"],"example":"Submitted"}}},"relationships":{"type":"object","required":["project","vendor"],"description":"To set `lob`, send `type` `lobs`; `service-categories` and `sections` are rejected","properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"lob":{"$ref":"#/components/schemas/v2_relationships"},"third-party-services":{"$ref":"#/components/schemas/v2_relationships"},"vendor":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_RateTableResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"rate-tables"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"USD Default"},"default":{"type":"boolean"}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"currency":{"$ref":"#/components/schemas/v2_relationships"},"clients":{"$ref":"#/components/schemas/v2_to_many_relationships"},"projects":{"$ref":"#/components/schemas/v2_to_many_relationships"},"users":{"$ref":"#/components/schemas/v2_to_many_relationships"},"resource-rates":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_ResourceAllocationResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"resource-allocations"},"attributes":{"type":"object","required":["personnel"],"properties":{"personnnel":{"type":"string","example":"Mark Zuckerberg"},"assigned-hours":{"type":"array","example":"[null, 10, 10, 10, 10]","items":{"type":"number","format":"double"}}}},"relationships":{"type":"object","properties":{"resource-plan":{"$ref":"#/components/schemas/v2_relationships"},"project-resource":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ResourcePlanResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"resource-plans"},"attributes":{"type":"object","required":["name","weeks"],"properties":{"name":{"type":"string","example":"Baseline 2022"},"description":{"type":"string","example":"Lorem ipsum dolot"},"start-on":{"type":"string","format":"date","example":"2022-09-12","description":"The start date of the plan"},"weeks":{"type":"number","format":"int32","description":"The number of weeks in the plan"},"sprints":{"type":"number","format":"int32","description":"The number of two-week sprints in the plan"},"baseline":{"type":"boolean","example":true},"phase-mapping":{"type":"array","items":{"type":"object","properties":{"date":{"type":"string","format":"date"},"project_phase_id":{"type":"integer","format":"int64"}}}},"allocated-hours":{"type":"array","items":{"type":"object","properties":{"hours":{"type":"number","format":"double"},"project_resource_id":{"type":"integer","format":"int64"}}}}}},"relationships":{"type":"object","properties":{"project":{"$ref":"#/components/schemas/v2_relationships"},"resource-allocations":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_ResourceRateResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"resource-rates"},"attributes":{"type":"object","required":["hourly-rate","hourly-cost"],"properties":{"name":{"type":"string","example":"Senior Engineer"},"external_name":{"type":"string","example":"Sr Engineer"},"description":{"type":"string","example":"Engineer with 10 or more years of experience"},"hourly-rate":{"type":"number","format":"double","example":"125.00"},"hourly-cost":{"type":"number","format":"double","example":"100.00"},"expense-rate":{"type":"number","description":"Rate used when charging for travel.  Triggered by Travel/Expense items with \"Use Resource Rate\" set to true","format":"double","example":"62.50"},"code":{"type":"string","example":"ABC123","description":"Accounting code for the resource rate"}}},"relationships":{"type":"object","required":["resource","rate-table"],"properties":{"rate-table":{"$ref":"#/components/schemas/v2_relationships"},"resource":{"$ref":"#/components/schemas/v2_relationships"},"line-of-business":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ResourceResource":{"type":"object","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"resources"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Senior Engineer (US)"},"active":{"type":"boolean","example":true},"external-name":{"type":"string","example":"Senior Engineer"},"description":{"type":"string","example":"Senior Engineer"},"default":{"type":"boolean","description":"When set, imported services with no matching resource are assigned to this resource","example":false},"hourly_rate":{"type":"number","format":"double","example":"200.00"},"hourly_cost":{"type":"number","format":"double","example":"i20.00"},"user-defined-fields":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}}}},"relationships":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"governances":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-governances":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-resources":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-services":{"$ref":"#/components/schemas/v2_to_many_relationships"},"project-subservices":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_RoleResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"roles"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Big Role, Inc"},"default":{"type":"boolean","description":"When true, this role will be assigned to users auto-provisioned via SSO"},"privileges":{"type":"array","description":"The set of privileges granted by this role.","items":{"type":"object","required":["privilege","access-level"],"properties":{"privilege":{"type":"string","enum":["projects.overview","projects.executive_summary","projects.request_approval","projects.scope_review","projects.change_orders","projects.psa","projects.terms_and_conditions","projects.notes","projects.locations","projects.attachments","projects.contacts","projects.collaborators","projects.versions","projects.outcomes","projects.success_strategy","projects.adoption_barriers","projects.project_phases","projects.tasks","projects.custom_tasks","projects.managed_services","projects.service_pricing","projects.managed_service_pricing","projects.pricing_adjustment","projects.costing_adjustment","projects.sow_language","projects.materials","projects.partner_requests","projects.vendor_quotes","projects.project_governance","projects.travel_and_expense","projects.payment_credits","projects.pricing","projects.service_margins","projects.resource_rates","projects.resource_costs","projects.vendor_resource_rates","projects.vendor_resource_costs","projects.work_breakdown","projects.resource_planning","projects.surveys","projects.merge_data","projects.duplicate","settings.account","settings.prompt_overrides","settings.scope_review","settings.billing","settings.connected_apps","settings.oauth","settings.webhooks","settings.access_tokens","settings.lines_of_business","settings.task_types","settings.language_fields","settings.tags","settings.tasks","settings.managed_services","settings.materials","settings.blueprints","settings.research_packages","settings.research_package_drafts","settings.text_blocks","settings.terms_and_conditions","settings.signature_types","settings.sow_templates","settings.attachment_types","settings.questionnaires","settings.resources","settings.travel_and_expense","settings.payment_terms","settings.notifications","settings.payment_credits","settings.currencies","settings.project_governance","settings.project_phases","settings.project_variables","settings.project_approval","settings.users","settings.user_preferences","settings.sales_executives","settings.roles","settings.teams","settings.business_units","settings.clients","settings.partnerships","settings.vendors","settings.audit_logs","reports.work_breakdown","reports.project_pricing","reports.autotask_psa"],"description":"Name of a specific privilege"},"access-level":{"type":"string","enum":["none","view","create","manage","purge","override","adjust_standards"],"description":"Acces levels that can be assiged.  Not all access levels available for each privilege"}}}}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_SalesExecutiveResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"sales-executives"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"John Doe"},"phone":{"type":"string","example":"555-321-7654"},"email":{"type":"string","example":"john.doe@mycompany.com"},"title":{"type":"string","example":"President"},"active":{"type":"boolean"}}},"relationships":{"type":"object","required":["account"],"properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ServiceCategoryResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"service-categories"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Routers"},"code":{"type":"string","example":"NET-201"},"lob-id":{"type":"integer","format":"int64","description":"ID of the parent line of business. Required on create; omit on update to leave the parent unchanged."},"nested-name":{"type":"string","example":"Networking \u003e Routers"},"has-parent?":{"type":"boolean","description":"True if the service category is scoped to a line of business"},"position":{"type":"integer","format":"int64","description":"The sequence of this service category within the list of categories beneath the line of business"}}},"relationships":{"type":"object","description":"On create, `account` is set from your API token and any account sent is ignored. Do not send `account` on update","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ServiceConditionResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"service-conditions"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Net 10"},"content":{"type":"string","example":"*All* payments are due within 10 days of the completion of the project"},"position":{"type":"integer","format":"int32","example":1},"status":{"type":"string","enum":["required","optional"],"example":"required"}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_SpecialConditionResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"special-conditions"},"attributes":{"type":"object","properties":{"content":{"type":"string","example":"All work is subject to the master services agreement."},"status":{"type":"string","enum":["active","skipped","optional"],"example":"active"}}},"relationships":{"type":"object","required":["service-condition"],"properties":{"owner":{"$ref":"#/components/schemas/v2_relationships"},"service-condition":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ServiceResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"services"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Medium Router Installation"},"sku":{"type":"string","example":"RTR-MD-INST"},"service-description":{"type":"string","example":"Set QoS policy"},"guidance":{"type":"string","description":"Optional help text to guide users as they choose and configure this service","example":"Lorem ipsum dollot..."},"ai-instructions":{"type":"string","description":"Internal directions for AI assistants on how to scope this service. Never rendered in customer documents. Max 4000 characters.","example":"Always ask how many sites are in scope before adding this service."},"languages":{"type":"object","example":{"out_of_scope":"We do not do Windows","customer_responsibility":"Lunch for implementation team"},"description":"A collection of service descriptions keyed by the slugs language fields"},"state":{"type":"string","enum":["pending","active","deleted","custom"],"example":"pending"},"position":{"type":"integer","format":"int32","example":1},"minimum-quantity":{"type":"integer","format":"int32","readOnly":true,"description":"Lowest minimum quantity across the service's rates, computed on read. Set it through the rates instead; sending it on create or update fails","example":1},"lob_id":{"type":"integer","format":"int32","example":1},"service-type":{"type":"string","enum":["professional_services","managed_services"],"example":"professional_services"},"payment-frequency":{"type":"string","enum":["one_time","monthly","quarterly","yearly"],"example":"one_time"},"suggested-hours":{"type":"number","format":"double","example":0},"total-hours":{"type":"number","format":"double","example":11.25},"tag-list":{"type":"array","items":{"type":"string"},"example":["demo","network"]},"teams":{"type":"array","items":{"properties":{"id":{"type":"string","description":"ID of the team","example":"12345"},"name":{"type":"string","description":"name of the team","example":"Service Development"}}}},"variables":{"type":"array","items":{"$ref":"#/components/schemas/v2_embeddedProjectVariable"}},"updated-at":{"type":"string","example":"2023-12-11T18:51:43.543Z"},"custom-service-cost?":{"type":"boolean"},"custom-service-price?":{"type":"boolean"},"custom-hours?":{"type":"boolean"},"approvable":{"type":"boolean","readOnly":true,"description":"Whether the requesting user may approve this service. False when the line of business has approvers configured and the user is not one of them."}}},"relationships":{"type":"object","required":["account"],"description":"`account` is required on create: its `id` is your numeric account ID (account-id from GET /v2/me), not the slug. A service created without it is saved outside your account and cannot be read back","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"phase":{"$ref":"#/components/schemas/v2_relationships"},"resource":{"$ref":"#/components/schemas/v2_relationships"},"service-category":{"$ref":"#/components/schemas/v2_relationships"},"products":{"$ref":"#/components/schemas/v2_to_many_relationships"},"subservices":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_ServiceApproverResource":{"type":"object","required":["type","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"service-approvers"},"attributes":{"type":"object","properties":{"name":{"type":"string","readOnly":true,"description":"Name of approver for this line of business","example":"George Washington"}}},"relationships":{"type":"object","required":["user","line-of-business"],"properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"user":{"$ref":"#/components/schemas/v2_relationships"},"line-of-business":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_SubcontractorResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"integer"},"type":{"type":"string","example":"subcontractors"},"attributes":{"type":"object","required":["slug","name"],"properties":{"slug":{"type":"string","pattern":"/^[a-z][a-z\\-]+$/","example":"my-company"},"subcontractor-id":{"type":"integer","description":"ID to use for suncontractor relationship of partner-requests","example":123},"name":{"type":"string","example":"My Company"},"street_adddress":{"type":"string","example":"123 Main St"},"city":{"type":"string","example":"Greenville"},"state":{"type":"string","example":"SC"},"postal_code":{"type":"string","example":"29615"},"country":{"type":"string","example":"US"}}},"links":{"type":"object","properties":{"projects":{"type":"string","format":"uri"},"business-unit":{"type":"string","format":"uri"},"clients":{"type":"string","format":"uri"},"crm-opportunities":{"type":"string","format":"uri"},"document-templates":{"type":"string","format":"uri"},"expense-categories":{"type":"string","format":"uri"},"governances":{"type":"string","format":"uri"},"payment-terms":{"type":"string","format":"uri"},"presales-engineers":{"type":"string","format":"uri"},"phases":{"type":"string","format":"uri"},"project-variables":{"type":"string","format":"uri"},"resources":{"type":"string","format":"uri"},"sales-executives":{"type":"string","format":"uri"},"services":{"type":"string","format":"uri"},"users":{"type":"string","format":"uri"},"self":{"type":"string","format":"uri"}}}}},"v2_SubserviceResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"subservices"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Set QoS policy"},"service-description":{"type":"string","example":"Set QoS policy"},"ai-instructions":{"type":"string","description":"Internal directions for AI assistants on how to scope this service. Never rendered in customer documents. Max 4000 characters.","example":"Always ask how many sites are in scope before adding this service."},"languages":{"type":"object","example":{"out_of_scope":"We do not do Windows","customer_responsibility":"Lunch for implementation team"},"description":"A collection of service descriptions keyed by the slugs language fields"},"state":{"type":"string","example":"pending","enum":["pending","active","deleted","custom"]},"active":{"type":"boolean"},"suggested-hours":{"type":"number","format":"double","example":0},"minimum-quantity":{"type":"integer","format":"int32","example":1},"quantity":{"type":"integer","format":"int32","example":1},"position":{"type":"integer","format":"int32","example":1},"custom-service-cost?":{"type":"boolean"},"custom-service-price?":{"type":"boolean"},"custom-hours?":{"type":"boolean"}}},"relationships":{"type":"object","required":["service"],"properties":{"resource":{"$ref":"#/components/schemas/v2_relationships"},"service":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_SurveyRecommendationResource":{"type":"object","required":["id","type"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"survey-recommendations"},"attributes":{"type":"object","properties":{"quantity":{"type":"number","example":2},"status":{"type":"string","example":"pending","enum":["pending","applied","inactive"]},"item-type":{"type":"string","example":"Task","description":"Class name of item being recommended"},"item-id":{"type":"string","example":"12345","description":"ID of item being recommended"},"refinements":{"type":"array","items":{"type":"object","description":"When the recommended item is a Service (Task) then refinements are the associated subservice recommendations","properties":{"quantity":{"type":"number","example":2},"status":{"type":"string","example":"pending","enum":["pending","applied"]},"item_type":{"type":"string","example":"Task","description":"Class name of item being recommended"},"item_id":{"type":"string","example":"12346","description":"ID of item being recommended"},"resource_id":{"type":"string","example":"12346","description":"ID of resource used with item being recommended"},"project_resource_id":{"type":"string","example":"12346","description":"ID of project resource used with item being recommended"}}}}}},"relationships":{"type":"object","properties":{"survey":{"$ref":"#/components/schemas/v2_relationships"},"resource":{"$ref":"#/components/schemas/v2_relationships"},"project-resource":{"$ref":"#/components/schemas/v2_relationships_string"}}}}},"v2_SurveyResponseResource":{"type":"object","required":["type","attributes"],"description":"Only `question` and `answer` can be written. The other attributes and both relationships are read-only; sending them returns 400","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"survey-responses"},"attributes":{"type":"object","required":["question","answer"],"properties":{"question":{"type":"string","description":"The prompt answered by the user","example":"What is the area of the building in square feet"},"answer":{"type":"string","description":"The response provided by the user (as a string)","example":"4500"},"value_name":{"type":"string","description":"If the answer provided by the user was picked from a list of select-options, then this represents the name of the value (the key from the select-options)","example":null},"value_type":{"type":"string","enum":["text","number","date","checkbox","email","phone"],"example":"number"},"slug":{"type":"string","example":"square-feet"},"settings":{"type":"object","description":"Input field settings","properties":{"min":{"type":"string","description":"The minimum length of a string or the minimum value of a number input","example":"3"},"max":{"type":"string","description":"The maximum length of a string or the maximum value of a number input","example":"255"},"step":{"type":"integer","description":"The minimum value by which a number input may change (0.01, 0.1, 1, ...)","example":1}}}}},"relationships":{"type":"object","properties":{"survey":{"$ref":"#/components/schemas/v2_relationships"},"source":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_SurveyResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"surveys"},"attributes":{"type":"object","required":["name","contact_name","contact_email"],"properties":{"name":{"type":"string","example":"Wireless Access Survey for Big Data Inc"},"status":{"type":"string","enum":["pending","shared","completed","applied","revised"],"example":"completed"},"contact-name":{"type":"string","example":"John Smith"},"contact-email":{"type":"string","example":"john.smith@bigdata.biz"},"responses":{"type":"array","items":{"type":"object","properties":{"survey-response-id":{"type":"integer","example":12345,"description":"(OPTIONAL) If the response has been persisted, then this is the ID of the response"},"question-id":{"type":"integer","example":123,"description":"ID of the question to which this response provides the answer"},"question":{"type":"string","example":"How many floors in the building?","description":"Text of the question to which this response provides the answer"},"answer":{"type":"string","example":"4","description":"Response to the question provided by the user"}}}},"calculations":{"type":"array","items":{"type":"object","properties":{"calculation_id":{"type":"string","example":"access_point_estimate","description":"The name of the calculation when results are accumulated"},"value":{"type":"string","example":"82.84325","description":"The value calculated based on survey responses, either through a lookup or survey calculation"}}}},"recommendations":{"type":"array","items":{"type":"object","properties":{"status":{"type":"string","enum":["pending","applied","inactive"]},"quantity":{"type":"number","format":"double"},"item_type":{"type":"string","enum":["Governance","Material","Task"],"description":"Class name of the item being recommended"},"item_id":{"type":"integer","description":"ID of the item being recommended"},"resource_id":{"type":"integer","description":"ID of the resource to be applied to item being recommended"},"target_type":{"type":"string","enum":["Governance","Material","Task"],"description":"Class name of the applied recommendation"},"target_id":{"type":"integer","description":"ID of the applied recommendedation"},"project_resource_id":{"type":"integer","description":"ID of the project-resource on the applied recommendation"},"refinements":{"type":"array","items":{"type":"object","description":"When the recommended item is a Service (Task) then refinements are the associated subservice recommendations","properties":{"quantity":{"type":"number","example":2},"status":{"type":"string","example":"pending","enum":["pending","applied"]},"item_type":{"type":"string","example":"Task","description":"Class name of item being recommended"},"item_id":{"type":"string","example":"12346","description":"ID of item being recommended"},"resource_id":{"type":"string","example":"12346","description":"ID of resource used with item being recommended"},"project_resource_id":{"type":"string","example":"12346","description":"ID of project resource used with item being recommended"}}}}}}},"updated-at":{"type":"string","format":"date-time"},"emails":{"type":"string","description":"Comma-separated list of emails associated with the shared surveys"},"sender":{"type":"string","description":"Comma-seperated list of sender emails of the shared surveys"},"sent_at":{"type":"string","format":"date-time"},"completed_by":{"type":"string","description":"String of characters indicating user name of completed shared survey"}}},"relationships":{"type":"object","required":["questionnaire"],"properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"questionnaire":{"$ref":"#/components/schemas/v2_relationships"},"project":{"$ref":"#/components/schemas/v2_relationships"},"survey-responses":{"$ref":"#/components/schemas/v2_to_many_relationships"},"survey-reommendations":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_TagResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"tags"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"networking"}}},"relationships":{"type":"object","required":["account"]}}},"v2_TaskRateResource":{"type":"object","required":["type","attributes"],"description":"The service, subservice or product is taken from the request path. This resource has no relationships; sending one returns 400","properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"task-rates"},"attributes":{"type":"object","properties":{"rate-type":{"type":"string","example":"service_cost","enum":["service_price","service_cost","hardware_price","hardware_cost"]},"minimum-quantity":{"type":"integer","example":"2.0"},"base-amount":{"type":"number","format":"float","example":14.256},"unit-amount":{"type":"number","format":"float","example":10.412}}}}},"v2_TeamResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"teams"},"attributes":{"type":"object","required":["name","created-at"],"properties":{"name":{"type":"string","example":"Big Team, Inc"},"created-at":{"type":"string","format":"datetime","example":"2019-01-01T00:00:00.000Z"},"document-templates":{"type":"array","items":{"properties":{"id":{"type":"string","description":"ID of the Document Template","example":"12345"},"name":{"type":"string","description":"Name of the Document Template","example":"PS Template"}}}},"questionnaires":{"type":"array","items":{"properties":{"id":{"type":"string","description":"ID of the questionnaire","example":"12345"},"name":{"type":"string","description":"Name of the questionnaire","example":"Wireless Survey"},"introduction":{"type":"string","description":"Description of the questionnaire","example":"Lorem ipsum dollot..."}}}},"services":{"type":"array","items":{"properties":{"id":{"type":"string","description":"ID of the service","example":"12345"},"name":{"type":"string","description":"Name of the service","example":"Rack and stack"},"service-catgory":{"type":"string","description":"Name of the service category to which the service is assigned","example":"Networking \u003e Controllers"},"phase":{"type":"string","description":"Name of the phase to which the service is assigned","example":"Installation"}}}}}},"relationships":{"type":"object","required":["account"],"properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"users":{"type":"object","properties":{"links":{"type":"object","properties":{"self":{"type":"string","format":"uri"},"related":{"type":"string","format":"uri"}}},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","description":"Name of resource collection"}}}}}}}}}},"v2_TextBlockResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"text-blocks"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Big Text Block"},"merge-block":{"type":"string","description":"Block of text supporting Markdown and {{merge-content}}","example":"This can be included in the *generated* document"},"slug":{"type":"string","description":"Reference for including in the merge data, typically a lower-case and underscore version of the name","example":"big_text_block"}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}},"v2_ThirdPartyServiceResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"third-party-services"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Plan the server installation"},"original-description":{"type":"string","example":"Lorem ipsum dolot..."},"service-description":{"type":"string","example":"Lorem ipsum dolot..."},"quantity":{"type":"integer","format":"int32"},"est-hours":{"type":"number","format":"double","example":"0.75"},"est-rate":{"type":"number","format":"double","example":"150.00"},"est-cost":{"type":"number","format":"double","example":"100.25"},"markup":{"type":"number","example":"100.25","description":"Either the (target) margin for the service OR the percentage markup, depending on the revenue calculation method"},"price-override":{"type":"number","format":"double","description":"Set a fixed hourly price charged to the client, overriding the margin/markup calculation. Leave null to allow the application to calculate the hourly price based on hourly cost and margin/markup.","example":"200.00"},"mrr-terms":{"type":"integer","example":36},"position":{"type":"integer","format":"int32"},"languages":{"type":"object"},"original-languages":{"type":"object"},"payment-frequency":{"type":"string","enum":["one_time","monthly","quarterly","yearly"],"example":"one_time","default":"one_time"},"source-type":{"type":"string","example":"Quote","enum":["Quote","ThirdPartyRequest","ThirdPartyService"],"description":"The name of the resoruce to which the Third Party Service is scoped"},"source-id":{"type":"integer","format":"int64","example":42},"shadow-service":{"type":"boolean","description":"READ ONLY. True if the service was created to link a subservice assigned to a vendor resource to the quote"},"vendor-resource":{"type":"boolean","description":"READ ONLY. True if the service was created to link a service that was assigned to vendor resource"}}},"relationships":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/v2_relationships"},"project-phase":{"$ref":"#/components/schemas/v2_relationships"},"project-task":{"$ref":"#/components/schemas/v2_relationships"},"subtasks":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_UserResource":{"type":"object","required":["type","attributes","relationships"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"users"},"attributes":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string","example":"John Doe"},"start-page":{"type":"string","enum":["Home","Projects","Approvals","Surveys","Settings"],"default":"Home"},"active":{"type":"boolean","example":"True for an active user"},"sso-provider":{"type":"string","example":"saml","description":"The name of the configured SSO provider for the user.  Will be blank when inheriting from the account"},"phone":{"type":"string","example":"212-555-1234"},"email":{"type":"string","example":"john.doe@madeup.com"},"title":{"type":"string","example":"Solution Architect"},"presales":{"type":"boolean","description":"When true, the user will appear in the list of presales engineers available to assign to a project"},"sales":{"type":"boolean","description":"When true, the user will appear in the list of sales executives available to assign to a project"},"roles":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","description":"ID of a role to be assigned to the user"},"name":{"type":"string","description":"Name of a role to be assigned to the user"}}}},"view-only":{"type":"boolean","example":"True for a view-only user, false for a licensed user"},"user-type":{"type":"string","description":"The type of license being consumed by this user","enum":["view_only","licensed","sales","service","approver"]},"privileges":{"type":"object","example":{"projects":{"overview":"manage"},"settings":{"account":"view"}},"description":"Privileges for the user derived from user roles.  Availability of this attribute depends on the role."},"guided-onboarding":{"type":"object","description":"Contains information about where a user is in their onboarding process as well as what modifications they have made.","properties":{"onboarding_status":{"type":"string","example":"Existing User","description":"The last step executed in the onboarding flow"},"skipped_onboarding":{"type":"boolean","description":"True if the user skipped onboarding at any point during the process"},"modified_governance":{"type":"boolean","description":"True if the user modified governance items during the process"},"modified_phases":{"type":"boolean","description":"True if the user modified project phases items during the process"},"modified_resources":{"type":"boolean","description":"True if the user modified resources or resource rates during the process"},"modified_services":{"type":"boolean","description":"True if the user imported from the service catalog during the process"}}},"preferred-rate-table":{"$ref":"#/components/schemas/v2_RateTableResource"}}},"relationships":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"rate-table":{"$ref":"#/components/schemas/v2_relationships"},"currency":{"$ref":"#/components/schemas/v2_relationships"},"teams":{"$ref":"#/components/schemas/v2_to_many_relationships"},"roles":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_UserResourceWrite":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"users"},"attributes":{"type":"object","required":["name","email"],"properties":{"name":{"type":"string","example":"John Doe"},"start-page":{"type":"string","enum":["Home","Projects","Approvals","Surveys","Settings"],"default":"Home"},"active":{"type":"boolean","example":"True for an active user"},"phone":{"type":"string","example":"212-555-1234"},"sso-provider":{"type":"string","example":"saml","description":"The name of the configured SSO provider for the user.  Will be blank when inheriting from the account"},"email":{"type":"string","example":"john.doe@madeup.com"},"title":{"type":"string","example":"Solution Architect"},"presales":{"type":"boolean","description":"When true, the user will appear in the list of presales engineers available to assign to a project"},"sales":{"type":"boolean","description":"When true, the user will appear in the list of sales executives available to assign to a project"},"password":{"type":"string","example":"PassW0rd!","description":"Desired password when changing passwords; must match password-confirmation if provided"},"password-confirmation":{"type":"string","example":"PassW0rd!","description":"Must be provided if changing password or email address.  If changing email address, this must match the password of the user identified by the Authorization token.  If changing the password, it must match the provided password"},"roles":{"type":"array","items":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","format":"int64","description":"ID of a role to be assigned to the user"},"name":{"type":"string","description":"Name of a role to be assigned to the user"}}}},"view-only":{"type":"boolean","example":"True for a view-only user, false for a licensed user"},"user-type":{"type":"string","description":"The type of license being consumed by this user","enum":["view_only","licensed","sales","service","approver"]},"guided-onboarding":{"type":"object","description":"Contains information about where a user is in their onboarding process as well as what modifications they have made.","properties":{"onboarding_status":{"type":"string","example":"Existing User","description":"The last step executed in the onboarding flow"},"skipped_onboarding":{"type":"boolean","description":"True if the user skipped onboarding at any point during the process"},"modified_governance":{"type":"boolean","description":"True if the user modified governance items during the process"},"modified_phases":{"type":"boolean","description":"True if the user modified project phases items during the process"},"modified_resources":{"type":"boolean","description":"True if the user modified resources or resource rates during the process"},"modified_services":{"type":"boolean","description":"True if the user imported from the service catalog during the process"}}},"preferred-rate-table":{"$ref":"#/components/schemas/v2_RateTableResource"}}},"relationships":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"rate-table":{"$ref":"#/components/schemas/v2_relationships"},"currency":{"$ref":"#/components/schemas/v2_relationships"},"roles":{"$ref":"#/components/schemas/v2_to_many_relationships"},"teams":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_VendorResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"vendors"},"attributes":{"type":"object","required":["name"],"properties":{"name":{"type":"string","example":"Acme Supply and Service, Inc"},"street-address":{"type":"string","example":"221 Baker Street"},"street2":{"type":"string","example":"Suite B"},"city":{"type":"string","example":"London"},"state":{"type":"string","example":null},"postal-code":{"type":"string","example":"NW1"},"country":{"type":"string","description":"Alpha-2 country code","example":"gb"},"project-count":{"type":"number","format":"int32"}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"},"quotes":{"$ref":"#/components/schemas/v2_to_many_relationships"}}}}},"v2_WebhookSubscriptionResource":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"ID of the record assigned by the application"},"type":{"type":"string","example":"webhook-subscriptions"},"attributes":{"type":"object","required":["webhook_url","event_type"],"properties":{"webhook-url":{"type":"string","example":"https://www.yourwebsite.com/webhook/callbacks"},"event-type":{"type":"string","example":"project_status_changed","enum":["project_status_changed","service_status_changed","document_status_changed"]},"signing-secret":{"type":"string","readOnly":true,"description":"Secret for verifying the webhook-signature header on deliveries (Standard Webhooks). Returned only to users with the Webhooks create privilege or higher."}}},"relationships":{"type":"object","description":"`account` is set from your API token; any account sent is ignored","properties":{"account":{"$ref":"#/components/schemas/v2_relationships"}}}}}},"parameters":{"slug_parameter":{"in":"path","name":"slug","description":"Slug of Account","required":true,"schema":{"type":"string"}},"id_parameter":{"name":"id","description":"ID of record","in":"path","required":true,"schema":{"type":"string","description":"ID of the record assigned by the application"}},"client_id_parameter":{"name":"client_id","description":"ID of client record","in":"path","required":true,"schema":{"type":"string","description":"ID of the record assigned by the application"}},"business_unit_id_parameter":{"name":"business_unit_id","description":"ID of business unit record","in":"path","required":true,"schema":{"type":"string","description":"ID of the record assigned by the application"}},"vendor_id_parameter":{"name":"vendor_id","description":"ID of vendor record","in":"path","required":true,"schema":{"type":"string","description":"ID of the record assigned by the application"}},"uuid_parameter":{"name":"id","description":"ID of record","in":"path","required":true,"schema":{"type":"string","format":"uuid","example":"12345678-1234-5678-90ab-1234567890ab"}},"project_id_parameter":{"name":"project_id","description":"ID of project to which the resource is associated","in":"path","required":true,"schema":{"type":"string","description":"ID of the record assigned by the application"}},"service_id_parameter":{"name":"service_id","description":"ID of service to which the resource is associated","in":"path","required":true,"schema":{"type":"string","description":"ID of the record assigned by the application"}},"subservice_id_parameter":{"name":"subservice_id","description":"ID of subservice to which the resource is associated","in":"path","required":true,"schema":{"type":"string","description":"ID of the record assigned by the application"}},"user_id_parameter":{"name":"user_id","description":"ID of user to which the resource is associated","in":"path","required":true,"schema":{"type":"string","description":"ID of the record assigned by the application"}},"service_account_credential_id_parameter":{"name":"service_account_credential_id","description":"ID of the parent service-account credential","in":"path","required":true,"schema":{"type":"string","description":"ID of the record assigned by the application"}},"current_page":{"name":"page[number]","in":"query","required":false,"description":"Current page of paginated data","schema":{"type":"integer","minimum":1}},"page_size":{"name":"page[size]","in":"query","required":false,"description":"When paginating data, this is the number of records per page","schema":{"type":"integer","minimum":1,"maximum":1000}},"pagination":{"in":"query","name":"page","description":"Pagination options","required":false,"schema":{"type":"object","properties":{"size":{"type":"integer","minimum":1,"maximum":1000},"number":{"type":"integer","minimum":1}}}}},"examples":{},"links":{},"requestBodies":{},"responses":{},"securitySchemes":{}}}