{ "openapi": "3.1.0", "info": { "title": "Sanka Public API", "version": "0.1.0", "description": "Public developer API contract for external integrations." }, "servers": [ { "url": "https://api.sanka.com" } ], "tags": [ { "name": "absences" }, { "name": "activity-logs" }, { "name": "ai" }, { "name": "approval-requests" }, { "name": "associations" }, { "name": "attendance-records" }, { "name": "bills" }, { "name": "companies" }, { "name": "contacts" }, { "name": "custom-objects" }, { "name": "deals" }, { "name": "disbursements" }, { "name": "employees" }, { "name": "estimates" }, { "name": "expenses" }, { "name": "exports" }, { "name": "ferry-diagrams" }, { "name": "ferry-programs" }, { "name": "files" }, { "name": "imports" }, { "name": "incentives" }, { "name": "inventories" }, { "name": "inventory-transactions" }, { "name": "invoices" }, { "name": "items" }, { "name": "journals" }, { "name": "locations" }, { "name": "lookout" }, { "name": "meters" }, { "name": "object-schemas" }, { "name": "orders" }, { "name": "payments" }, { "name": "payroll" }, { "name": "projects" }, { "name": "properties" }, { "name": "public-auth" }, { "name": "purchase-orders" }, { "name": "records" }, { "name": "reports" }, { "name": "revenues" }, { "name": "rule-settings" }, { "name": "sanka-buy" }, { "name": "subscriptions" }, { "name": "tasks" }, { "name": "tickets" }, { "name": "transfers" }, { "name": "views" }, { "name": "workflow-actions" }, { "name": "workflow-runs" }, { "name": "workflows" } ], "paths": { "/v2/public/absences": { "get": { "tags": [ "absences" ], "summary": "List Public Absences", "operationId": "list_public_absences_api_v2_public_absences_get", "parameters": [ { "name": "worker_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Worker Id" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "start_date_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date From" } }, { "name": "start_date_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Start Date To" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicAbsencesApiV2PublicAbsencesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "absences" ], "summary": "Create Public Absence", "operationId": "create_public_absence_api_v2_public_absences_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicAbsenceApiV2PublicAbsencesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/absences/{absence_id}": { "get": { "tags": [ "absences" ], "summary": "Get Public Absence", "operationId": "get_public_absence_api_v2_public_absences__absence_id__get", "parameters": [ { "name": "absence_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Absence Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicAbsenceApiV2PublicAbsencesAbsenceIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "absences" ], "summary": "Update Public Absence", "operationId": "update_public_absence_api_v2_public_absences__absence_id__put", "parameters": [ { "name": "absence_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Absence Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicAbsenceApiV2PublicAbsencesAbsenceIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "absences" ], "summary": "Delete Public Absence", "operationId": "delete_public_absence_api_v2_public_absences__absence_id__delete", "parameters": [ { "name": "absence_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Absence Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicAbsenceApiV2PublicAbsencesAbsenceIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/logs": { "get": { "tags": [ "activity-logs" ], "summary": "List Public Activity Logs", "operationId": "list_public_activity_logs_api_v2_public_logs_get", "parameters": [ { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "object_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Id" } }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" } }, { "name": "field_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Field Name" } }, { "name": "created_after", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created After" } }, { "name": "created_before", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Created Before" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicActivityLogsApiV2PublicLogsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/enrich": { "post": { "tags": [ "ai" ], "summary": "Enrich Record", "operationId": "enrich_record_api_v2_enrich_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichRecordApiV2EnrichPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/prospect/companies": { "post": { "tags": [ "ai" ], "summary": "Prospect Companies", "operationId": "prospect_companies_api_v2_prospect_companies_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProspectCompaniesRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProspectCompaniesApiV2ProspectCompaniesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/score": { "post": { "tags": [ "ai" ], "summary": "Score Record", "operationId": "score_record_api_v2_score_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScoreRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScoreRecordApiV2ScorePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/approval-requests": { "post": { "tags": [ "approval-requests" ], "summary": "Create Approval Request", "operationId": "create_approval_request_api_v2_public_approval_requests_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovalRequestCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApprovalRequestApiV2PublicApprovalRequestsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/approval-requests/{history_id}/approve": { "post": { "tags": [ "approval-requests" ], "summary": "Approve Approval Request", "operationId": "approve_approval_request_api_v2_public_approval_requests__history_id__approve_post", "parameters": [ { "name": "history_id", "in": "path", "required": true, "schema": { "type": "string", "title": "History Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproveApprovalRequestApiV2PublicApprovalRequestsHistoryIdApprovePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/approval-requests/{history_id}/reject": { "post": { "tags": [ "approval-requests" ], "summary": "Reject Approval Request", "operationId": "reject_approval_request_api_v2_public_approval_requests__history_id__reject_post", "parameters": [ { "name": "history_id", "in": "path", "required": true, "schema": { "type": "string", "title": "History Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectApprovalRequestApiV2PublicApprovalRequestsHistoryIdRejectPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/associations": { "get": { "tags": [ "associations" ], "summary": "List Public Associations", "operationId": "list_public_associations_api_v2_public_associations_get", "parameters": [ { "name": "source_object_type", "in": "query", "required": true, "schema": { "type": "string", "title": "Source Object Type" } }, { "name": "source_record_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Source Record Id" } }, { "name": "source_custom_object_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Custom Object Id" } }, { "name": "definition_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Definition Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicAssociationsApiV2PublicAssociationsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "associations" ], "summary": "Create Public Association", "operationId": "create_public_association_api_v2_public_associations_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicAssociationMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicAssociationApiV2PublicAssociationsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "associations" ], "summary": "Delete Public Association", "operationId": "delete_public_association_api_v2_public_associations_delete", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicAssociationMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicAssociationApiV2PublicAssociationsDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/attendance-records": { "get": { "tags": [ "attendance-records" ], "summary": "List Public Attendance Records", "operationId": "list_public_attendance_records_api_v2_public_attendance_records_get", "parameters": [ { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicAttendanceRecordsApiV2PublicAttendanceRecordsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "attendance-records" ], "summary": "Create Public Attendance Record", "operationId": "create_public_attendance_record_api_v2_public_attendance_records_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicAttendanceRecordApiV2PublicAttendanceRecordsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/attendance-records/{attendance_record_id}": { "get": { "tags": [ "attendance-records" ], "summary": "Get Public Attendance Record", "operationId": "get_public_attendance_record_api_v2_public_attendance_records__attendance_record_id__get", "parameters": [ { "name": "attendance_record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Attendance Record Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicAttendanceRecordApiV2PublicAttendanceRecordsAttendanceRecordIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "attendance-records" ], "summary": "Update Public Attendance Record", "operationId": "update_public_attendance_record_api_v2_public_attendance_records__attendance_record_id__put", "parameters": [ { "name": "attendance_record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Attendance Record Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicAttendanceRecordApiV2PublicAttendanceRecordsAttendanceRecordIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "attendance-records" ], "summary": "Delete Public Attendance Record", "operationId": "delete_public_attendance_record_api_v2_public_attendance_records__attendance_record_id__delete", "parameters": [ { "name": "attendance_record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Attendance Record Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicAttendanceRecordApiV2PublicAttendanceRecordsAttendanceRecordIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/buy/offers": { "get": { "tags": [ "sanka-buy" ], "summary": "List Public Buy Offers", "operationId": "list_public_buy_offers_api_v2_public_buy_offers_get", "parameters": [ { "name": "request_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Request Id" } }, { "name": "provider", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, { "name": "latest_only", "in": "query", "required": false, "schema": { "type": "boolean", "default": true, "title": "Latest Only" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Page Size" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicBuyOffersApiV2PublicBuyOffersGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/lookout/connectors/clay/signals": { "post": { "tags": [ "lookout" ], "summary": "Ingest Clay Signal", "operationId": "ingest_clay_signal_api_v2_lookout_connectors_clay_signals_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookoutSignalRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestClaySignalApiV2LookoutConnectorsClaySignalsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/lookout/connectors/{provider}/signals": { "post": { "tags": [ "lookout" ], "summary": "Ingest Provider Signal", "operationId": "ingest_provider_signal_api_v2_lookout_connectors__provider__signals_post", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string", "title": "Provider" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookoutSignalRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IngestProviderSignalApiV2LookoutConnectorsProviderSignalsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/lookout/ad-actions": { "get": { "tags": [ "lookout" ], "summary": "List Provider Actions", "operationId": "list_provider_actions_api_v2_lookout_ad_actions_get", "deprecated": true, "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "queued", "title": "Status" } }, { "name": "run_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProviderActionsApiV2LookoutAdActionsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/lookout/provider-actions": { "get": { "tags": [ "lookout" ], "summary": "List Provider Actions", "operationId": "list_provider_actions_api_v2_lookout_provider_actions_get", "parameters": [ { "name": "provider", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "queued", "title": "Status" } }, { "name": "run_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Run Id" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProviderActionsApiV2LookoutProviderActionsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/lookout/ad-actions/{action_id}/claim": { "post": { "tags": [ "lookout" ], "summary": "Claim Provider Action", "operationId": "claim_provider_action_api_v2_lookout_ad_actions__action_id__claim_post", "deprecated": true, "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Action Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClaimProviderActionApiV2LookoutAdActionsActionIdClaimPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/lookout/provider-actions/{action_id}/claim": { "post": { "tags": [ "lookout" ], "summary": "Claim Provider Action", "operationId": "claim_provider_action_api_v2_lookout_provider_actions__action_id__claim_post", "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Action Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClaimProviderActionApiV2LookoutProviderActionsActionIdClaimPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/lookout/ad-actions/{action_id}/complete": { "post": { "tags": [ "lookout" ], "summary": "Complete Provider Action", "operationId": "complete_provider_action_api_v2_lookout_ad_actions__action_id__complete_post", "deprecated": true, "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Action Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookoutProviderActionCompleteRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteProviderActionApiV2LookoutAdActionsActionIdCompletePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/lookout/provider-actions/{action_id}/complete": { "post": { "tags": [ "lookout" ], "summary": "Complete Provider Action", "operationId": "complete_provider_action_api_v2_lookout_provider_actions__action_id__complete_post", "parameters": [ { "name": "action_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Action Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LookoutProviderActionCompleteRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteProviderActionApiV2LookoutProviderActionsActionIdCompletePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/bills": { "get": { "tags": [ "bills" ], "summary": "List Public Bills", "operationId": "list_public_bills_api_v2_public_bills_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list or line-item-expanded list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicBillsApiV2PublicBillsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "bills" ], "summary": "Create Public Bill", "operationId": "create_public_bill_api_v2_public_bills_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicBillApiV2PublicBillsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/bills/files": { "post": { "tags": [ "bills" ], "summary": "Upload Public Bill File", "operationId": "upload_public_bill_file_api_v2_public_bills_files_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_public_bill_file_api_v2_public_bills_files_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPublicBillFileApiV2PublicBillsFilesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/bills/{bill_id}": { "get": { "tags": [ "bills" ], "summary": "Get Public Bill", "operationId": "get_public_bill_api_v2_public_bills__bill_id__get", "parameters": [ { "name": "bill_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Bill Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicBillApiV2PublicBillsBillIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "bills" ], "summary": "Update Public Bill", "operationId": "update_public_bill_api_v2_public_bills__bill_id__put", "parameters": [ { "name": "bill_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Bill Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicBillApiV2PublicBillsBillIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "bills" ], "summary": "Delete Public Bill", "operationId": "delete_public_bill_api_v2_public_bills__bill_id__delete", "parameters": [ { "name": "bill_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Bill Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicBillApiV2PublicBillsBillIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/companies": { "get": { "tags": [ "companies" ], "summary": "List Public Companies", "operationId": "list_public_companies_api_v2_public_companies_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicCompaniesApiV2PublicCompaniesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "companies" ], "summary": "Create Public Company", "operationId": "create_public_company_api_v2_public_companies_post", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicCompanyApiV2PublicCompaniesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/companies/{company_id}": { "get": { "tags": [ "companies" ], "summary": "Get Public Company", "operationId": "get_public_company_api_v2_public_companies__company_id__get", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicCompanyApiV2PublicCompaniesCompanyIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "companies" ], "summary": "Update Public Company", "operationId": "update_public_company_api_v2_public_companies__company_id__put", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicCompanyApiV2PublicCompaniesCompanyIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "companies" ], "summary": "Delete Public Company", "operationId": "delete_public_company_api_v2_public_companies__company_id__delete", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "target", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "sanka", "title": "Target" } }, { "name": "provider", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, { "name": "channel_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" } }, { "name": "external_object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Object Type" } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Dry Run" } }, { "name": "confirm", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Confirm" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicCompanyApiV2PublicCompaniesCompanyIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/companies/{company_id}/price-table": { "get": { "tags": [ "companies" ], "summary": "Get Public Company Price Table", "operationId": "get_public_company_price_table_api_v2_public_companies__company_id__price_table_get", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "field_ref", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Field Ref" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 30, "title": "Page Size" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicCompanyPriceTableApiV2PublicCompaniesCompanyIdPriceTableGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/companies/{company_id}/price-table/company": { "patch": { "tags": [ "companies" ], "summary": "Update Public Company Price Table Company", "operationId": "update_public_company_price_table_company_api_v2_public_companies__company_id__price_table_company_patch", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPriceTableCompanyUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicCompanyPriceTableCompanyApiV2PublicCompaniesCompanyIdPriceTableCompanyPatch200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/companies/{company_id}/price-table/items/apply-all": { "post": { "tags": [ "companies" ], "summary": "Apply Public Company Price Table Items", "operationId": "apply_public_company_price_table_items_api_v2_public_companies__company_id__price_table_items_apply_all_post", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPriceTableApplyAllRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyPublicCompanyPriceTableItemsApiV2PublicCompaniesCompanyIdPriceTableItemsApplyAllPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/companies/{company_id}/price-table/items/{item_id}": { "patch": { "tags": [ "companies" ], "summary": "Update Public Company Price Table Item", "operationId": "update_public_company_price_table_item_api_v2_public_companies__company_id__price_table_items__item_id__patch", "parameters": [ { "name": "company_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Company Id" } }, { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Item Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPriceTableItemUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicCompanyPriceTableItemApiV2PublicCompaniesCompanyIdPriceTableItemsItemIdPatch200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/contacts": { "get": { "tags": [ "contacts" ], "summary": "List Public Contacts", "operationId": "list_public_contacts_api_v2_public_contacts_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicContactsApiV2PublicContactsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "contacts" ], "summary": "Create Public Contact", "operationId": "create_public_contact_api_v2_public_contacts_post", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicObjectRecordMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicContactApiV2PublicContactsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/contacts/{contact_id}": { "get": { "tags": [ "contacts" ], "summary": "Get Public Contact", "operationId": "get_public_contact_api_v2_public_contacts__contact_id__get", "parameters": [ { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Contact Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicContactApiV2PublicContactsContactIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "contacts" ], "summary": "Update Public Contact", "operationId": "update_public_contact_api_v2_public_contacts__contact_id__put", "parameters": [ { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Contact Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicObjectRecordMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicContactApiV2PublicContactsContactIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "contacts" ], "summary": "Delete Public Contact", "operationId": "delete_public_contact_api_v2_public_contacts__contact_id__delete", "parameters": [ { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Contact Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "target", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "sanka", "title": "Target" } }, { "name": "provider", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, { "name": "channel_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" } }, { "name": "external_object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Object Type" } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Dry Run" } }, { "name": "confirm", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Confirm" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicContactApiV2PublicContactsContactIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/custom-objects/{custom_object_id}/records": { "get": { "tags": [ "custom-objects" ], "summary": "List Custom Object Records", "operationId": "list_public_custom_object_records_api_v2_public_custom_objects__custom_object_id__records_get", "parameters": [ { "name": "custom_object_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Custom Object Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicCustomObjectRecordsApiV2PublicCustomObjectsCustomObjectIdRecordsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "custom-objects" ], "summary": "Create Custom Object Record", "operationId": "create_public_custom_object_record_api_v2_public_custom_objects__custom_object_id__records_post", "parameters": [ { "name": "custom_object_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Custom Object Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicCustomObjectRecordApiV2PublicCustomObjectsCustomObjectIdRecordsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/custom-objects/{custom_object_id}/records/{record_id}": { "get": { "tags": [ "custom-objects" ], "summary": "Get Custom Object Record", "operationId": "get_public_custom_object_record_api_v2_public_custom_objects__custom_object_id__records__record_id__get", "parameters": [ { "name": "custom_object_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Custom Object Id" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicCustomObjectRecordApiV2PublicCustomObjectsCustomObjectIdRecordsRecordIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "custom-objects" ], "summary": "Update Custom Object Record", "operationId": "update_public_custom_object_record_api_v2_public_custom_objects__custom_object_id__records__record_id__put", "parameters": [ { "name": "custom_object_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Custom Object Id" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicCustomObjectRecordApiV2PublicCustomObjectsCustomObjectIdRecordsRecordIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "custom-objects" ], "summary": "Delete Custom Object Record", "operationId": "delete_public_custom_object_record_api_v2_public_custom_objects__custom_object_id__records__record_id__delete", "parameters": [ { "name": "custom_object_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Custom Object Id" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicCustomObjectRecordApiV2PublicCustomObjectsCustomObjectIdRecordsRecordIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/custom-objects/{custom_object_id}/records/{record_id}/archive": { "post": { "tags": [ "custom-objects" ], "summary": "Archive Custom Object Record", "operationId": "archive_public_custom_object_record_api_v2_public_custom_objects__custom_object_id__records__record_id__archive_post", "parameters": [ { "name": "custom_object_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Custom Object Id" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivePublicCustomObjectRecordApiV2PublicCustomObjectsCustomObjectIdRecordsRecordIdArchivePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/custom-objects/{custom_object_id}/records/{record_id}/activate": { "post": { "tags": [ "custom-objects" ], "summary": "Activate Custom Object Record", "operationId": "activate_public_custom_object_record_api_v2_public_custom_objects__custom_object_id__records__record_id__activate_post", "parameters": [ { "name": "custom_object_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Custom Object Id" } }, { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivatePublicCustomObjectRecordApiV2PublicCustomObjectsCustomObjectIdRecordsRecordIdActivatePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/records/custom-objects/records": { "post": { "tags": [ "custom-objects" ], "summary": "Create Public Custom Object Record Compatibility", "operationId": "create_public_custom_object_record_compatibility_api_v2_public_records_custom_objects_records_post", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCustomObjectRecordMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicCustomObjectRecordCompatibilityApiV2PublicRecordsCustomObjectsRecordsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/records/custom-objects/records/{record_id}": { "post": { "tags": [ "custom-objects" ], "summary": "Update Public Custom Object Record Compatibility", "operationId": "update_public_custom_object_record_compatibility_api_v2_public_records_custom_objects_records__record_id__post", "parameters": [ { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicCustomObjectRecordMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicCustomObjectRecordCompatibilityApiV2PublicRecordsCustomObjectsRecordsRecordIdPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/records/custom-objects/records/{record_id}/archive": { "post": { "tags": [ "custom-objects" ], "summary": "Archive Public Custom Object Record Compatibility", "operationId": "archive_public_custom_object_record_compatibility_api_v2_public_records_custom_objects_records__record_id__archive_post", "parameters": [ { "name": "record_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Record Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PublicCustomObjectRecordMutationRequest" }, { "type": "null" } ], "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivePublicCustomObjectRecordCompatibilityApiV2PublicRecordsCustomObjectsRecordsRecordIdArchivePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/deals": { "get": { "tags": [ "deals" ], "summary": "List Public Deals", "operationId": "list_public_deals_api_v2_public_deals_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicDealsApiV2PublicDealsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "deals" ], "summary": "Create Public Deal", "operationId": "create_public_deal_api_v2_public_deals_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicObjectRecordMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicDealApiV2PublicDealsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/deals/pipelines": { "get": { "tags": [ "deals" ], "summary": "List Public Deal Pipelines", "operationId": "list_public_deal_pipelines_api_v2_public_deals_pipelines_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicDealPipelinesApiV2PublicDealsPipelinesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/deals/{deal_id}": { "get": { "tags": [ "deals" ], "summary": "Get Public Deal", "operationId": "get_public_deal_api_v2_public_deals__deal_id__get", "parameters": [ { "name": "deal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deal Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicDealApiV2PublicDealsDealIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "deals" ], "summary": "Update Public Deal", "operationId": "update_public_deal_api_v2_public_deals__deal_id__put", "parameters": [ { "name": "deal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deal Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicObjectRecordMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicDealApiV2PublicDealsDealIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "deals" ], "summary": "Delete Public Deal", "operationId": "delete_public_deal_api_v2_public_deals__deal_id__delete", "parameters": [ { "name": "deal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Deal Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "target", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "default": "sanka", "title": "Target" } }, { "name": "provider", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, { "name": "channel_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" } }, { "name": "external_object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Object Type" } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Dry Run" } }, { "name": "confirm", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Confirm" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicDealApiV2PublicDealsDealIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/disbursements": { "get": { "tags": [ "disbursements" ], "summary": "List Public Disbursements", "operationId": "list_public_disbursements_api_v2_public_disbursements_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicDisbursementsApiV2PublicDisbursementsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "disbursements" ], "summary": "Create Public Disbursement", "operationId": "create_public_disbursement_api_v2_public_disbursements_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicDisbursementApiV2PublicDisbursementsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/disbursements/{disbursement_id}": { "get": { "tags": [ "disbursements" ], "summary": "Get Public Disbursement", "operationId": "get_public_disbursement_api_v2_public_disbursements__disbursement_id__get", "parameters": [ { "name": "disbursement_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Disbursement Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicDisbursementApiV2PublicDisbursementsDisbursementIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "disbursements" ], "summary": "Update Public Disbursement", "operationId": "update_public_disbursement_api_v2_public_disbursements__disbursement_id__put", "parameters": [ { "name": "disbursement_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Disbursement Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicDisbursementApiV2PublicDisbursementsDisbursementIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "disbursements" ], "summary": "Delete Public Disbursement", "operationId": "delete_public_disbursement_api_v2_public_disbursements__disbursement_id__delete", "parameters": [ { "name": "disbursement_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Disbursement Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicDisbursementApiV2PublicDisbursementsDisbursementIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/disbursements/{disbursement_id}/allocations": { "get": { "tags": [ "disbursements" ], "summary": "List Public Disbursement Allocations", "operationId": "list_public_disbursement_allocations_api_v2_public_disbursements__disbursement_id__allocations_get", "parameters": [ { "name": "disbursement_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Disbursement Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "lang", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lang" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicDisbursementAllocationsApiV2PublicDisbursementsDisbursementIdAllocationsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "disbursements" ], "summary": "Create Public Disbursement Allocation", "operationId": "create_public_disbursement_allocation_api_v2_public_disbursements__disbursement_id__allocations_post", "parameters": [ { "name": "disbursement_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Disbursement Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "lang", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lang" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisbursementAllocationCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicDisbursementAllocationApiV2PublicDisbursementsDisbursementIdAllocationsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/disbursements/{disbursement_id}/allocations/{allocation_id}": { "patch": { "tags": [ "disbursements" ], "summary": "Update Public Disbursement Allocation", "operationId": "update_public_disbursement_allocation_api_v2_public_disbursements__disbursement_id__allocations__allocation_id__patch", "parameters": [ { "name": "disbursement_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Disbursement Id" } }, { "name": "allocation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Allocation Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "lang", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lang" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisbursementAllocationPatchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicDisbursementAllocationApiV2PublicDisbursementsDisbursementIdAllocationsAllocationIdPatch200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "disbursements" ], "summary": "Delete Public Disbursement Allocation", "operationId": "delete_public_disbursement_allocation_api_v2_public_disbursements__disbursement_id__allocations__allocation_id__delete", "parameters": [ { "name": "disbursement_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Disbursement Id" } }, { "name": "allocation_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Allocation Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "lang", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lang" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicDisbursementAllocationApiV2PublicDisbursementsDisbursementIdAllocationsAllocationIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/employees": { "get": { "tags": [ "employees" ], "summary": "List Public Employees", "operationId": "list_public_employees_api_v2_public_employees_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicEmployeesApiV2PublicEmployeesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/estimates": { "get": { "tags": [ "estimates" ], "summary": "List Public Estimates", "operationId": "list_public_estimates_api_v2_public_estimates_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list or line-item-expanded list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicEstimatesApiV2PublicEstimatesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "estimates" ], "summary": "Create Public Estimate", "operationId": "create_public_estimate_api_v2_public_estimates_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicEstimateApiV2PublicEstimatesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/estimates/files": { "post": { "tags": [ "estimates" ], "summary": "Upload Public Estimate File", "operationId": "upload_public_estimate_file_api_v2_public_estimates_files_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_public_estimate_file_api_v2_public_estimates_files_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPublicEstimateFileApiV2PublicEstimatesFilesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/estimates/{estimate_id}": { "get": { "tags": [ "estimates" ], "summary": "Get Public Estimate", "operationId": "get_public_estimate_api_v2_public_estimates__estimate_id__get", "parameters": [ { "name": "estimate_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Estimate Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicEstimateApiV2PublicEstimatesEstimateIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "estimates" ], "summary": "Update Public Estimate", "operationId": "update_public_estimate_api_v2_public_estimates__estimate_id__put", "parameters": [ { "name": "estimate_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Estimate Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicEstimateApiV2PublicEstimatesEstimateIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "estimates" ], "summary": "Delete Public Estimate", "operationId": "delete_public_estimate_api_v2_public_estimates__estimate_id__delete", "parameters": [ { "name": "estimate_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Estimate Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicEstimateApiV2PublicEstimatesEstimateIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/estimates/{estimate_id}/pdf": { "get": { "tags": [ "estimates" ], "summary": "Download Public Estimate Pdf", "operationId": "download_public_estimate_pdf_api_v2_public_estimates__estimate_id__pdf_get", "parameters": [ { "name": "estimate_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Estimate Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "template_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" } }, { "name": "template_select", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Select" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "PDF document", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/expenses": { "get": { "tags": [ "expenses" ], "summary": "List Public Expenses", "operationId": "list_public_expenses_api_v2_public_expenses_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicExpensesApiV2PublicExpensesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "expenses" ], "summary": "Create Public Expense", "operationId": "create_public_expense_api_v2_public_expenses_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicExpenseMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicExpenseApiV2PublicExpensesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/expenses/files": { "post": { "tags": [ "expenses" ], "summary": "Upload Public Expense File", "operationId": "upload_public_expense_file_api_v2_public_expenses_files_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_public_expense_file_api_v2_public_expenses_files_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPublicExpenseFileApiV2PublicExpensesFilesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/expenses/{expense_id}": { "get": { "tags": [ "expenses" ], "summary": "Get Public Expense", "operationId": "get_public_expense_api_v2_public_expenses__expense_id__get", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicExpenseApiV2PublicExpensesExpenseIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "expenses" ], "summary": "Update Public Expense", "operationId": "update_public_expense_api_v2_public_expenses__expense_id__put", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicExpenseMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicExpenseApiV2PublicExpensesExpenseIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "expenses" ], "summary": "Delete Public Expense", "operationId": "delete_public_expense_api_v2_public_expenses__expense_id__delete", "parameters": [ { "name": "expense_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Expense Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicExpenseApiV2PublicExpensesExpenseIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/exports": { "get": { "tags": [ "exports" ], "summary": "List Public Export Jobs Compat", "operationId": "list_public_export_jobs_compat_api_v2_public_exports_get", "parameters": [ { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "search_query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search Query" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicExportJobsCompatApiV2PublicExportsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "exports" ], "summary": "Create Public Export Job Compat", "description": "Create an export job.\n\nIntegration-destination exports are validated against the runnable\ndelivery matrix. HubSpot Company, Contact, Custom Object, Deal, Invoice,\nItem, Order, Subscription, and Ticket exports use the dedicated Hatchet\nbulk workflow, bounded CSV chunks, and HubSpot's Imports API. Invoice\nrequires an explicitly selected HubSpot custom-object type id. NextEngine\nItem and Order exports keep their dedicated Hatchet pipelines. Provider and\nobject pairs without a working delivery pipeline are rejected with HTTP\n400 and error code ``INTEGRATION_EXPORT_NOT_SUPPORTED`` before any job\nhistory row is created. Empty or unknown provider slugs are rejected with\n``INTEGRATION_EXPORT_UNKNOWN_PROVIDER``. Accepted jobs stay queued or\nrunning until provider completion and required post-processing finish.", "operationId": "create_public_export_job_compat_api_v2_public_exports_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportJobCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicExportJobCompatApiV2PublicExportsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "400": { "$ref": "#/components/responses/ErrorResponse" }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/exports/{job_id}": { "get": { "tags": [ "exports" ], "summary": "Get Public Export Job Compat", "operationId": "get_public_export_job_compat_api_v2_public_exports__job_id__get", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Job Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicExportJobCompatApiV2PublicExportsJobIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/exports/{job_id}/cancel": { "post": { "tags": [ "exports" ], "summary": "Cancel Public Export Job Compat", "operationId": "cancel_public_export_job_compat_api_v2_public_exports__job_id__cancel_post", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Job Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelPublicExportJobCompatApiV2PublicExportsJobIdCancelPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/ferry/diagrams": { "get": { "tags": [ "ferry-diagrams" ], "summary": "List Public Ferry Diagrams", "operationId": "list_public_ferry_diagrams_api_v2_public_ferry_diagrams_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicFerryDiagramsApiV2PublicFerryDiagramsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "ferry-diagrams" ], "summary": "Create Public Ferry Diagram", "operationId": "create_public_ferry_diagram_api_v2_public_ferry_diagrams_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FerryDiagramCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicFerryDiagramApiV2PublicFerryDiagramsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/ferry/diagrams/{diagram_id}": { "get": { "tags": [ "ferry-diagrams" ], "summary": "Get Public Ferry Diagram", "operationId": "get_public_ferry_diagram_api_v2_public_ferry_diagrams__diagram_id__get", "parameters": [ { "name": "diagram_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Diagram Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicFerryDiagramApiV2PublicFerryDiagramsDiagramIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "ferry-diagrams" ], "summary": "Update Public Ferry Diagram", "operationId": "update_public_ferry_diagram_api_v2_public_ferry_diagrams__diagram_id__put", "parameters": [ { "name": "diagram_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Diagram Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FerryDiagramUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicFerryDiagramApiV2PublicFerryDiagramsDiagramIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "ferry-diagrams" ], "summary": "Delete Public Ferry Diagram", "operationId": "delete_public_ferry_diagram_api_v2_public_ferry_diagrams__diagram_id__delete", "parameters": [ { "name": "diagram_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Diagram Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicFerryDiagramApiV2PublicFerryDiagramsDiagramIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/ferry/programs": { "get": { "tags": [ "ferry-programs" ], "summary": "List Public Ferry Programs", "operationId": "list_public_ferry_programs_api_v2_public_ferry_programs_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicFerryProgramsApiV2PublicFerryProgramsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/ferry/programs/{program_id}": { "get": { "tags": [ "ferry-programs" ], "summary": "Get Public Ferry Program", "operationId": "get_public_ferry_program_api_v2_public_ferry_programs__program_id__get", "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Program Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicFerryProgramApiV2PublicFerryProgramsProgramIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/ferry/programs/{program_id}/meetings": { "get": { "tags": [ "ferry-programs" ], "summary": "List Public Ferry Program Meetings", "operationId": "list_public_ferry_program_meetings_api_v2_public_ferry_programs__program_id__meetings_get", "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Program Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicFerryProgramMeetingsApiV2PublicFerryProgramsProgramIdMeetingsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "ferry-programs" ], "summary": "Create Public Ferry Program Meeting", "operationId": "create_public_ferry_program_meeting_api_v2_public_ferry_programs__program_id__meetings_post", "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Program Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FerryProgramMeetingCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicFerryProgramMeetingApiV2PublicFerryProgramsProgramIdMeetingsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/ferry/programs/{program_id}/meetings/{meeting_id}": { "patch": { "tags": [ "ferry-programs" ], "summary": "Update Public Ferry Program Meeting", "operationId": "update_public_ferry_program_meeting_api_v2_public_ferry_programs__program_id__meetings__meeting_id__patch", "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Program Id" } }, { "name": "meeting_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Meeting Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FerryProgramMeetingUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicFerryProgramMeetingApiV2PublicFerryProgramsProgramIdMeetingsMeetingIdPatch200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/ferry/programs/{program_id}/todos": { "post": { "tags": [ "ferry-programs" ], "summary": "Create Public Ferry Program Todo", "operationId": "create_public_ferry_program_todo_api_v2_public_ferry_programs__program_id__todos_post", "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Program Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FerryProgramTodoCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicFerryProgramTodoApiV2PublicFerryProgramsProgramIdTodosPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/ferry/programs/{program_id}/todos/batch-upsert": { "post": { "tags": [ "ferry-programs" ], "summary": "Batch Upsert Public Ferry Program Todos", "operationId": "batch_upsert_public_ferry_program_todos_api_v2_public_ferry_programs__program_id__todos_batch_upsert_post", "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Program Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FerryProgramTodoBatchUpsertRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchUpsertPublicFerryProgramTodosApiV2PublicFerryProgramsProgramIdTodosBatchUpsertPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/ferry/programs/{program_id}/todos/{todo_id}": { "patch": { "tags": [ "ferry-programs" ], "summary": "Update Public Ferry Program Todo", "operationId": "update_public_ferry_program_todo_api_v2_public_ferry_programs__program_id__todos__todo_id__patch", "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Program Id" } }, { "name": "todo_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Todo Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FerryProgramTodoUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicFerryProgramTodoApiV2PublicFerryProgramsProgramIdTodosTodoIdPatch200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "ferry-programs" ], "summary": "Delete Public Ferry Program Todo", "operationId": "delete_public_ferry_program_todo_api_v2_public_ferry_programs__program_id__todos__todo_id__delete", "parameters": [ { "name": "program_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Program Id" } }, { "name": "todo_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Todo Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicFerryProgramTodoApiV2PublicFerryProgramsProgramIdTodosTodoIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/files": { "post": { "tags": [ "files" ], "summary": "Upload Public File", "operationId": "upload_public_file_api_v2_public_files_post", "parameters": [ { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_public_file_api_v2_public_files_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPublicFileApiV2PublicFilesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/inventories": { "get": { "tags": [ "inventories" ], "summary": "List Public Inventories", "operationId": "list_public_inventories_api_v2_public_inventories_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicInventoriesApiV2PublicInventoriesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "inventories" ], "summary": "Create Public Inventory", "operationId": "create_public_inventory_api_v2_public_inventories_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicObjectRecordMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicInventoryApiV2PublicInventoriesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/inventories/{inventory_id}": { "get": { "tags": [ "inventories" ], "summary": "Get Public Inventory", "operationId": "get_public_inventory_api_v2_public_inventories__inventory_id__get", "parameters": [ { "name": "inventory_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Inventory Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicInventoryApiV2PublicInventoriesInventoryIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "inventories" ], "summary": "Update Public Inventory", "operationId": "update_public_inventory_api_v2_public_inventories__inventory_id__put", "parameters": [ { "name": "inventory_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Inventory Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicObjectRecordMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicInventoryApiV2PublicInventoriesInventoryIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "inventories" ], "summary": "Delete Public Inventory", "operationId": "delete_public_inventory_api_v2_public_inventories__inventory_id__delete", "parameters": [ { "name": "inventory_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Inventory Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicInventoryApiV2PublicInventoriesInventoryIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/inventory-transactions": { "get": { "tags": [ "inventory-transactions" ], "summary": "List Public Inventory Transactions", "operationId": "list_public_inventory_transactions_api_v2_public_inventory_transactions_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicInventoryTransactionsApiV2PublicInventoryTransactionsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "inventory-transactions" ], "summary": "Create Public Inventory Transaction", "operationId": "create_public_inventory_transaction_api_v2_public_inventory_transactions_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicObjectRecordMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicInventoryTransactionApiV2PublicInventoryTransactionsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/inventory-transactions/{transaction_id}": { "get": { "tags": [ "inventory-transactions" ], "summary": "Get Public Inventory Transaction", "operationId": "get_public_inventory_transaction_api_v2_public_inventory_transactions__transaction_id__get", "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Transaction Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicInventoryTransactionApiV2PublicInventoryTransactionsTransactionIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "inventory-transactions" ], "summary": "Update Public Inventory Transaction", "operationId": "update_public_inventory_transaction_api_v2_public_inventory_transactions__transaction_id__put", "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Transaction Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicObjectRecordMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicInventoryTransactionApiV2PublicInventoryTransactionsTransactionIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "inventory-transactions" ], "summary": "Delete Public Inventory Transaction", "operationId": "delete_public_inventory_transaction_api_v2_public_inventory_transactions__transaction_id__delete", "parameters": [ { "name": "transaction_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Transaction Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicInventoryTransactionApiV2PublicInventoryTransactionsTransactionIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices": { "get": { "tags": [ "invoices" ], "summary": "List Public Invoices", "operationId": "list_public_invoices_api_v2_public_invoices_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list or line-item-expanded list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicInvoicesApiV2PublicInvoicesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "invoices" ], "summary": "Create Public Invoice", "operationId": "create_public_invoice_api_v2_public_invoices_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicInvoiceApiV2PublicInvoicesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/files": { "post": { "tags": [ "invoices" ], "summary": "Upload Public Invoice File", "operationId": "upload_public_invoice_file_api_v2_public_invoices_files_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_public_invoice_file_api_v2_public_invoices_files_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPublicInvoiceFileApiV2PublicInvoicesFilesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/bulk-update": { "post": { "tags": [ "invoices" ], "summary": "Bulk Update Public Invoices", "operationId": "bulk_update_public_invoices_api_v2_public_invoices_bulk_update_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordBulkActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdatePublicInvoicesApiV2PublicInvoicesBulkUpdatePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdatePublicInvoicesApiV2PublicInvoicesBulkUpdatePost202Envelope" } } }, "description": "Accepted", "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/overdue": { "get": { "tags": [ "invoices" ], "summary": "List Public Overdue Invoices", "operationId": "list_public_overdue_invoices_api_v2_public_invoices_overdue_get", "parameters": [ { "name": "as_of_date", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "As Of Date" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "page_size", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 50, "title": "Page Size" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicOverdueInvoicesApiV2PublicInvoicesOverdueGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/{invoice_id}": { "get": { "tags": [ "invoices" ], "summary": "Get Public Invoice", "operationId": "get_public_invoice_api_v2_public_invoices__invoice_id__get", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicInvoiceApiV2PublicInvoicesInvoiceIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "invoices" ], "summary": "Update Public Invoice", "operationId": "update_public_invoice_api_v2_public_invoices__invoice_id__put", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicInvoiceApiV2PublicInvoicesInvoiceIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "invoices" ], "summary": "Delete Public Invoice", "operationId": "delete_public_invoice_api_v2_public_invoices__invoice_id__delete", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicInvoiceApiV2PublicInvoicesInvoiceIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/{invoice_id}/pdf": { "get": { "tags": [ "invoices" ], "summary": "Download Public Invoice Pdf", "operationId": "download_public_invoice_pdf_api_v2_public_invoices__invoice_id__pdf_get", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "template_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" } }, { "name": "template_select", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Select" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "PDF document", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/{invoice_id}/email": { "post": { "tags": [ "invoices" ], "summary": "Send Public Invoice Email", "operationId": "send_public_invoice_email_api_v2_public_invoices__invoice_id__email_post", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "lang", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lang" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicInvoiceEmailRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendPublicInvoiceEmailApiV2PublicInvoicesInvoiceIdEmailPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/{invoice_id}/permanent-delete": { "delete": { "tags": [ "invoices" ], "summary": "Permanent Delete Public Invoice", "operationId": "permanent_delete_public_invoice_api_v2_public_invoices__invoice_id__permanent_delete_delete", "parameters": [ { "name": "invoice_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Invoice Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "confirm", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Confirm" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PermanentDeletePublicInvoiceApiV2PublicInvoicesInvoiceIdPermanentDeleteDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives": { "get": { "tags": [ "incentives" ], "summary": "List Public Incentives", "operationId": "list_public_incentives_api_v2_public_incentives_get", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/IncentivesListQuery" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicIncentivesApiV2PublicIncentivesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives/company-options": { "get": { "tags": [ "incentives" ], "summary": "List Public Incentive Company Options", "operationId": "list_public_incentive_company_options_api_v2_public_incentives_company_options_get", "parameters": [ { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Q" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 30, "title": "Limit" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicIncentiveCompanyOptionsApiV2PublicIncentivesCompanyOptionsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives/plans": { "get": { "tags": [ "incentives" ], "summary": "List Public Incentive Plans", "operationId": "list_public_incentive_plans_api_v2_public_incentives_plans_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicIncentivePlansApiV2PublicIncentivesPlansGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "incentives" ], "summary": "Create Public Incentive Plan", "operationId": "create_public_incentive_plan_api_v2_public_incentives_plans_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncentivePlanCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicIncentivePlanApiV2PublicIncentivesPlansPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives/plans/{plan_id}": { "patch": { "tags": [ "incentives" ], "summary": "Update Public Incentive Plan", "operationId": "update_public_incentive_plan_api_v2_public_incentives_plans__plan_id__patch", "parameters": [ { "name": "plan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Plan Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncentivePlanUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicIncentivePlanApiV2PublicIncentivesPlansPlanIdPatch200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "incentives" ], "summary": "Delete Public Incentive Plan", "operationId": "delete_public_incentive_plan_api_v2_public_incentives_plans__plan_id__delete", "parameters": [ { "name": "plan_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Plan Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicIncentivePlanApiV2PublicIncentivesPlansPlanIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives/allocations": { "get": { "tags": [ "incentives" ], "summary": "List Public Incentive Allocations", "operationId": "list_public_incentive_allocations_api_v2_public_incentives_allocations_get", "parameters": [ { "name": "source_object_type", "in": "query", "required": true, "schema": { "type": "string", "title": "Source Object Type" } }, { "name": "source_record_id", "in": "query", "required": true, "schema": { "type": "string", "title": "Source Record Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicIncentiveAllocationsApiV2PublicIncentivesAllocationsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "incentives" ], "summary": "Replace Public Incentive Allocations", "operationId": "replace_public_incentive_allocations_api_v2_public_incentives_allocations_put", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncentiveAllocationsReplaceRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplacePublicIncentiveAllocationsApiV2PublicIncentivesAllocationsPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives/calculate": { "post": { "tags": [ "incentives" ], "summary": "Calculate Public Incentives", "operationId": "calculate_public_incentives_api_v2_public_incentives_calculate_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncentiveCalculateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculatePublicIncentivesApiV2PublicIncentivesCalculatePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives/approve-bulk": { "post": { "tags": [ "incentives" ], "summary": "Approve Public Incentives Bulk", "operationId": "approve_public_incentives_bulk_api_v2_public_incentives_approve_bulk_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncentiveApproveBulkRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovePublicIncentivesBulkApiV2PublicIncentivesApproveBulkPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives/batches": { "get": { "tags": [ "incentives" ], "summary": "List Public Incentive Batches", "operationId": "list_public_incentive_batches_api_v2_public_incentives_batches_get", "parameters": [ { "name": "query", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/IncentiveBatchesListQuery" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicIncentiveBatchesApiV2PublicIncentivesBatchesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "incentives" ], "summary": "Create Public Incentive Batch", "operationId": "create_public_incentive_batch_api_v2_public_incentives_batches_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IncentiveBatchCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicIncentiveBatchApiV2PublicIncentivesBatchesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives/batches/{batch_id}": { "get": { "tags": [ "incentives" ], "summary": "Get Public Incentive Batch", "operationId": "get_public_incentive_batch_api_v2_public_incentives_batches__batch_id__get", "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Batch Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicIncentiveBatchApiV2PublicIncentivesBatchesBatchIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives/batches/{batch_id}/approve": { "post": { "tags": [ "incentives" ], "summary": "Approve Public Incentive Batch", "operationId": "approve_public_incentive_batch_api_v2_public_incentives_batches__batch_id__approve_post", "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Batch Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovePublicIncentiveBatchApiV2PublicIncentivesBatchesBatchIdApprovePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives/batches/{batch_id}/mark-paid": { "post": { "tags": [ "incentives" ], "summary": "Mark Public Incentive Batch Paid", "operationId": "mark_public_incentive_batch_paid_api_v2_public_incentives_batches__batch_id__mark_paid_post", "parameters": [ { "name": "batch_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Batch Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarkPublicIncentiveBatchPaidApiV2PublicIncentivesBatchesBatchIdMarkPaidPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives/{incentive_id}/approve": { "post": { "tags": [ "incentives" ], "summary": "Approve Public Incentive", "operationId": "approve_public_incentive_api_v2_public_incentives__incentive_id__approve_post", "parameters": [ { "name": "incentive_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Incentive Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovePublicIncentiveApiV2PublicIncentivesIncentiveIdApprovePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/imports": { "get": { "tags": [ "imports" ], "summary": "List Public Import Jobs Compat", "operationId": "list_public_import_jobs_compat_api_v2_public_imports_get", "parameters": [ { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 200, "minimum": 1, "default": 50, "title": "Limit" } }, { "name": "search_query", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search Query" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicImportJobsCompatApiV2PublicImportsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "imports" ], "summary": "Create Public Import Job Compat", "operationId": "create_public_import_job_compat_api_v2_public_imports_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportJobCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicImportJobCompatApiV2PublicImportsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/imports/{job_id}": { "get": { "tags": [ "imports" ], "summary": "Get Public Import Job Compat", "operationId": "get_public_import_job_compat_api_v2_public_imports__job_id__get", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Job Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicImportJobCompatApiV2PublicImportsJobIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/imports/{job_id}/cancel": { "post": { "tags": [ "imports" ], "summary": "Cancel Public Import Job Compat", "operationId": "cancel_public_import_job_compat_api_v2_public_imports__job_id__cancel_post", "parameters": [ { "name": "job_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Job Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelPublicImportJobCompatApiV2PublicImportsJobIdCancelPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/items": { "get": { "tags": [ "items" ], "summary": "List Public Items", "operationId": "list_public_items_api_v2_public_items_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicItemsApiV2PublicItemsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "items" ], "summary": "Create Public Item", "operationId": "create_public_item_api_v2_public_items_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicItemApiV2PublicItemsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/items/{item_id}": { "get": { "tags": [ "items" ], "summary": "Get Public Item", "operationId": "get_public_item_api_v2_public_items__item_id__get", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Item Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicItemApiV2PublicItemsItemIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "items" ], "summary": "Update Public Item", "operationId": "update_public_item_api_v2_public_items__item_id__put", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Item Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicItemApiV2PublicItemsItemIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "items" ], "summary": "Delete Public Item", "operationId": "delete_public_item_api_v2_public_items__item_id__delete", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Item Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicItemApiV2PublicItemsItemIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/journals": { "get": { "tags": [ "journals" ], "summary": "List Journal Entries", "operationId": "list_public_journals_api_v2_public_journals_get", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "Accept-Language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" }, "x-fern-parameter-name": "accept_language_query" }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" }, "x-fern-parameter-name": "accept_language_header" }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicJournalsApiV2PublicJournalsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "journals" ], "summary": "Create Journal Entry", "operationId": "create_public_journal_api_v2_public_journals_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicJournalApiV2PublicJournalsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/journals/views": { "post": { "tags": [ "journals" ], "summary": "Create Financial Statement View", "operationId": "create_public_financial_statement_view_api_v2_public_journals_views_post", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "Accept-Language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" }, "x-fern-parameter-name": "accept_language_query" }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" }, "x-fern-parameter-name": "accept_language_header" }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalStatementViewCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicFinancialStatementViewApiV2PublicJournalsViewsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/journals/{journal_id}": { "get": { "tags": [ "journals" ], "summary": "Get Journal Entry", "operationId": "get_public_journal_api_v2_public_journals__journal_id__get", "parameters": [ { "name": "journal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Journal Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicJournalApiV2PublicJournalsJournalIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "journals" ], "summary": "Update Journal Entry", "operationId": "update_public_journal_api_v2_public_journals__journal_id__put", "parameters": [ { "name": "journal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Journal Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicJournalApiV2PublicJournalsJournalIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "journals" ], "summary": "Delete Journal Entry", "operationId": "delete_public_journal_api_v2_public_journals__journal_id__delete", "parameters": [ { "name": "journal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Journal Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicJournalApiV2PublicJournalsJournalIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/journals/{journal_id}/archive": { "post": { "tags": [ "journals" ], "summary": "Archive Journal Entry", "operationId": "archive_public_journal_api_v2_public_journals__journal_id__archive_post", "parameters": [ { "name": "journal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Journal Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchivePublicJournalApiV2PublicJournalsJournalIdArchivePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/journals/{journal_id}/activate": { "post": { "tags": [ "journals" ], "summary": "Activate Journal Entry", "operationId": "activate_public_journal_api_v2_public_journals__journal_id__activate_post", "parameters": [ { "name": "journal_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Journal Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivatePublicJournalApiV2PublicJournalsJournalIdActivatePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/locations": { "get": { "tags": [ "locations" ], "summary": "List Public Locations", "operationId": "list_public_locations_api_v2_public_locations_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicLocationsApiV2PublicLocationsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "locations" ], "summary": "Create Public Location", "operationId": "create_public_location_api_v2_public_locations_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicLocationApiV2PublicLocationsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/locations/{location_id}": { "get": { "tags": [ "locations" ], "summary": "Get Public Location", "operationId": "get_public_location_api_v2_public_locations__location_id__get", "parameters": [ { "name": "location_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Location Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicLocationApiV2PublicLocationsLocationIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "locations" ], "summary": "Update Public Location", "operationId": "update_public_location_api_v2_public_locations__location_id__put", "parameters": [ { "name": "location_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Location Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicLocationApiV2PublicLocationsLocationIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "locations" ], "summary": "Delete Public Location", "operationId": "delete_public_location_api_v2_public_locations__location_id__delete", "parameters": [ { "name": "location_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Location Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicLocationApiV2PublicLocationsLocationIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/meters": { "get": { "tags": [ "meters" ], "summary": "List Public Meters", "operationId": "list_public_meters_api_v2_public_meters_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicMetersApiV2PublicMetersGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "meters" ], "summary": "Create Public Meter", "operationId": "create_public_meter_api_v2_public_meters_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicObjectRecordMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicMeterApiV2PublicMetersPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/meters/{meter_id}": { "get": { "tags": [ "meters" ], "summary": "Get Public Meter", "operationId": "get_public_meter_api_v2_public_meters__meter_id__get", "parameters": [ { "name": "meter_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Meter Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicMeterApiV2PublicMetersMeterIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "meters" ], "summary": "Update Public Meter", "operationId": "update_public_meter_api_v2_public_meters__meter_id__put", "parameters": [ { "name": "meter_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Meter Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicObjectRecordMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicMeterApiV2PublicMetersMeterIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "meters" ], "summary": "Delete Public Meter", "operationId": "delete_public_meter_api_v2_public_meters__meter_id__delete", "parameters": [ { "name": "meter_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Meter Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicMeterApiV2PublicMetersMeterIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/object-schemas": { "get": { "tags": [ "object-schemas" ], "summary": "List Public Object Schemas", "operationId": "list_public_object_schemas_api_v2_public_object_schemas_get", "parameters": [ { "name": "scope", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scope" } }, { "name": "source", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 200, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicObjectSchemasApiV2PublicObjectSchemasGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "object-schemas" ], "summary": "Mutate Public Object Schema", "operationId": "mutate_public_object_schema_api_v2_public_object_schemas_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectSchemaMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MutatePublicObjectSchemaApiV2PublicObjectSchemasPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/orders": { "get": { "tags": [ "orders" ], "summary": "List Public Orders", "operationId": "list_public_orders_api_v2_public_orders_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list or line-item-expanded list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicOrdersApiV2PublicOrdersGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "orders" ], "summary": "Create Public Order", "operationId": "create_public_order_api_v2_public_orders_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicOrderApiV2PublicOrdersPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/orders/bulk": { "post": { "tags": [ "orders" ], "summary": "Bulk Create Public Orders", "operationId": "bulk_create_public_orders_api_v2_public_orders_bulk_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderBulkCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkCreatePublicOrdersApiV2PublicOrdersBulkPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/orders/files": { "post": { "tags": [ "orders" ], "summary": "Upload Public Order File", "operationId": "upload_public_order_file_api_v2_public_orders_files_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_public_order_file_api_v2_public_orders_files_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPublicOrderFileApiV2PublicOrdersFilesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/orders/{order_id}": { "get": { "tags": [ "orders" ], "summary": "Get Public Order", "operationId": "get_public_order_api_v2_public_orders__order_id__get", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Order Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicOrderApiV2PublicOrdersOrderIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "orders" ], "summary": "Update Public Order", "operationId": "update_public_order_api_v2_public_orders__order_id__put", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Order Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicOrderApiV2PublicOrdersOrderIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "orders" ], "summary": "Delete Public Order", "operationId": "delete_public_order_api_v2_public_orders__order_id__delete", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Order Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicOrderApiV2PublicOrdersOrderIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/orders/{order_id}/pdf": { "get": { "tags": [ "orders" ], "summary": "Download Public Order Pdf", "operationId": "download_public_order_pdf_api_v2_public_orders__order_id__pdf_get", "parameters": [ { "name": "order_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Order Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "template_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" } }, { "name": "template_select", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Select" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "PDF document", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/payments": { "get": { "tags": [ "payments" ], "summary": "List Public Payments", "operationId": "list_public_payments_api_v2_public_payments_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicPaymentsApiV2PublicPaymentsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "payments" ], "summary": "Create Public Payment", "operationId": "create_public_payment_api_v2_public_payments_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicPaymentApiV2PublicPaymentsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/payments/{payment_id}": { "get": { "tags": [ "payments" ], "summary": "Get Public Payment", "operationId": "get_public_payment_api_v2_public_payments__payment_id__get", "parameters": [ { "name": "payment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Payment Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicPaymentApiV2PublicPaymentsPaymentIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "payments" ], "summary": "Update Public Payment", "operationId": "update_public_payment_api_v2_public_payments__payment_id__put", "parameters": [ { "name": "payment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Payment Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicPaymentApiV2PublicPaymentsPaymentIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "payments" ], "summary": "Delete Public Payment", "operationId": "delete_public_payment_api_v2_public_payments__payment_id__delete", "parameters": [ { "name": "payment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Payment Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicPaymentApiV2PublicPaymentsPaymentIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/payments/{payment_id}/pdf": { "get": { "tags": [ "payments" ], "summary": "Download Public Payment Pdf", "operationId": "download_public_payment_pdf_api_v2_public_payments__payment_id__pdf_get", "parameters": [ { "name": "payment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Payment Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "template_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" } }, { "name": "template_select", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Select" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "PDF document", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/payments/{payment_id}/allocations": { "get": { "tags": [ "payments" ], "summary": "List Public Payment Allocations", "operationId": "list_public_payment_allocations_api_v2_public_payments__payment_id__allocations_get", "parameters": [ { "name": "payment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Payment Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "lang", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lang" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicPaymentAllocationsApiV2PublicPaymentsPaymentIdAllocationsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "payments" ], "summary": "Update Public Payment Allocations", "operationId": "update_public_payment_allocations_api_v2_public_payments__payment_id__allocations_put", "parameters": [ { "name": "payment_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Payment Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "lang", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lang" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentAllocationsUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicPaymentAllocationsApiV2PublicPaymentsPaymentIdAllocationsPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/payroll/profiles": { "get": { "tags": [ "payroll" ], "summary": "List Public Payroll Profiles", "operationId": "list_public_payroll_profiles_api_v2_public_payroll_profiles_get", "parameters": [ { "name": "employee_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Employee Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicPayrollProfilesApiV2PublicPayrollProfilesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "payroll" ], "summary": "Upsert Public Payroll Profile", "operationId": "upsert_public_payroll_profile_api_v2_public_payroll_profiles_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollProfileUpsertRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertPublicPayrollProfileApiV2PublicPayrollProfilesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/payroll/runs": { "get": { "tags": [ "payroll" ], "summary": "List Public Payroll Runs", "operationId": "list_public_payroll_runs_api_v2_public_payroll_runs_get", "parameters": [ { "name": "period", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicPayrollRunsApiV2PublicPayrollRunsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/payroll/runs/calculate": { "post": { "tags": [ "payroll" ], "summary": "Calculate Public Payroll Run", "operationId": "calculate_public_payroll_run_api_v2_public_payroll_runs_calculate_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollRunCalculateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalculatePublicPayrollRunApiV2PublicPayrollRunsCalculatePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/payroll/runs/{run_id}": { "get": { "tags": [ "payroll" ], "summary": "Get Public Payroll Run", "operationId": "get_public_payroll_run_api_v2_public_payroll_runs__run_id__get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicPayrollRunApiV2PublicPayrollRunsRunIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/payroll/runs/{run_id}/approve": { "post": { "tags": [ "payroll" ], "summary": "Approve Public Payroll Run", "operationId": "approve_public_payroll_run_api_v2_public_payroll_runs__run_id__approve_post", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApprovePublicPayrollRunApiV2PublicPayrollRunsRunIdApprovePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/payroll/runs/{run_id}/journal-entry": { "post": { "tags": [ "payroll" ], "summary": "Create Public Payroll Journal Entry", "operationId": "create_public_payroll_journal_entry_api_v2_public_payroll_runs__run_id__journal_entry_post", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PayrollJournalEntryRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicPayrollJournalEntryApiV2PublicPayrollRunsRunIdJournalEntryPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/payroll/runs/{run_id}/payslips/pdf": { "get": { "tags": [ "payroll" ], "summary": "Download Public Payroll Payslip Pdf", "operationId": "download_public_payroll_payslip_pdf_api_v2_public_payroll_runs__run_id__payslips_pdf_get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Run Id" } }, { "name": "result_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result Id" } }, { "name": "employee_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Employee Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownloadPublicPayrollPayslipPdfApiV2PublicPayrollRunsRunIdPayslipsPdfGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/properties/{object_name}": { "get": { "tags": [ "properties" ], "summary": "List Public Developer Properties", "operationId": "list_public_developer_properties_api_v2_public_properties__object_name__get", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Object Name" } }, { "name": "custom_object_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Id" } }, { "name": "q", "in": "query", "required": false, "schema": { "type": "string", "default": "", "title": "Q" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 200, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "lang", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lang" } }, { "name": "scope", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scope" } }, { "name": "source", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" } }, { "name": "provider", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, { "name": "channel_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" } }, { "name": "external_object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Object Type" } }, { "name": "custom_object_slug", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Slug" } }, { "name": "custom_object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicDeveloperPropertiesApiV2PublicPropertiesObjectNameGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "properties" ], "summary": "Create Public Developer Property", "operationId": "create_public_developer_property_api_v2_public_properties__object_name__post", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Object Name" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPropertyMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicDeveloperPropertyApiV2PublicPropertiesObjectNamePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/properties/{object_name}/{property_ref}": { "get": { "tags": [ "properties" ], "summary": "Retrieve Public Developer Property", "operationId": "retrieve_public_developer_property_api_v2_public_properties__object_name___property_ref__get", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Object Name" } }, { "name": "property_ref", "in": "path", "required": true, "schema": { "type": "string", "title": "Property Ref" } }, { "name": "custom_object_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "lang", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lang" } }, { "name": "scope", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scope" } }, { "name": "source", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" } }, { "name": "provider", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, { "name": "channel_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" } }, { "name": "external_object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Object Type" } }, { "name": "custom_object_slug", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Slug" } }, { "name": "custom_object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievePublicDeveloperPropertyApiV2PublicPropertiesObjectNamePropertyRefGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "properties" ], "summary": "Update Public Developer Property", "operationId": "update_public_developer_property_api_v2_public_properties__object_name___property_ref__put", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Object Name" } }, { "name": "property_ref", "in": "path", "required": true, "schema": { "type": "string", "title": "Property Ref" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicPropertyMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicDeveloperPropertyApiV2PublicPropertiesObjectNamePropertyRefPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "properties" ], "summary": "Delete Public Developer Property", "operationId": "delete_public_developer_property_api_v2_public_properties__object_name___property_ref__delete", "parameters": [ { "name": "object_name", "in": "path", "required": true, "schema": { "type": "string", "title": "Object Name" } }, { "name": "property_ref", "in": "path", "required": true, "schema": { "type": "string", "title": "Property Ref" } }, { "name": "custom_object_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Id" } }, { "name": "target", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target" } }, { "name": "source", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" } }, { "name": "scope", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scope" } }, { "name": "provider", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" } }, { "name": "channel_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" } }, { "name": "external_object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Object Type" } }, { "name": "dry_run", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Dry Run" } }, { "name": "confirm", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Confirm" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "custom_object_slug", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Slug" } }, { "name": "custom_object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicDeveloperPropertyApiV2PublicPropertiesObjectNamePropertyRefDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/auth/whoami": { "get": { "tags": [ "public-auth" ], "summary": "Get Current Public Developer Auth Identity", "operationId": "get_public_auth_whoami_api_v2_public_auth_whoami_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Authenticated public developer identity.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicAuthWhoamiApiV2PublicAuthWhoamiGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/auth/session": { "get": { "tags": [ "public-auth" ], "summary": "Get Current Public OAuth Session", "operationId": "get_public_auth_session_api_v2_public_auth_session_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicAuthSessionApiV2PublicAuthSessionGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/auth/session/switch-workspace": { "post": { "tags": [ "public-auth" ], "summary": "Switch Current Public OAuth Session Workspace", "operationId": "switch_public_auth_session_workspace_api_v2_public_auth_session_switch_workspace_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthWorkspaceSwitchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchPublicAuthSessionWorkspaceApiV2PublicAuthSessionSwitchWorkspacePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/auth/mcp-session/switch-workspace": { "post": { "tags": [ "public-auth" ], "summary": "Switch Current Public MCP OAuth Session Workspace", "operationId": "switch_public_auth_mcp_session_workspace_api_v2_public_auth_mcp_session_switch_workspace_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "X-Sanka-MCP-Session-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Sanka-Mcp-Session-Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthWorkspaceSwitchRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SwitchPublicAuthMcpSessionWorkspaceApiV2PublicAuthMcpSessionSwitchWorkspacePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/auth/mcp-session/tool-call-log": { "post": { "tags": [ "public-auth" ], "summary": "Record Public MCP Tool Call", "operationId": "record_public_auth_mcp_tool_call_api_v2_public_auth_mcp_session_tool_call_log_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "X-Sanka-MCP-Session-ID", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Sanka-Mcp-Session-Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McpToolCallLogRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RecordPublicAuthMcpToolCallApiV2PublicAuthMcpSessionToolCallLogPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/auth/session/revoke": { "post": { "tags": [ "public-auth" ], "summary": "Revoke Current Public OAuth Session", "operationId": "revoke_public_auth_session_api_v2_public_auth_session_revoke_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokePublicAuthSessionApiV2PublicAuthSessionRevokePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/reports": { "get": { "tags": [ "reports" ], "summary": "List Public Reports", "operationId": "list_public_reports_api_v2_public_reports_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicReportsApiV2PublicReportsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "reports" ], "summary": "Create Public Report", "operationId": "create_public_report_api_v2_public_reports_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicReportApiV2PublicReportsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/reports/{report_id}": { "get": { "tags": [ "reports" ], "summary": "Get Public Report", "operationId": "get_public_report_api_v2_public_reports__report_id__get", "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Report Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicReportApiV2PublicReportsReportIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "reports" ], "summary": "Update Public Report", "operationId": "update_public_report_api_v2_public_reports__report_id__put", "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Report Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReportUpdateMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicReportApiV2PublicReportsReportIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "reports" ], "summary": "Delete Public Report", "operationId": "delete_public_report_api_v2_public_reports__report_id__delete", "parameters": [ { "name": "report_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Report Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicReportApiV2PublicReportsReportIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/purchase-orders": { "get": { "tags": [ "purchase-orders" ], "summary": "List Public Purchase Orders", "operationId": "list_public_purchase_orders_api_v2_public_purchase_orders_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list or line-item-expanded list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicPurchaseOrdersApiV2PublicPurchaseOrdersGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "purchase-orders" ], "summary": "Create Public Purchase Order", "operationId": "create_public_purchase_order_api_v2_public_purchase_orders_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicPurchaseOrderApiV2PublicPurchaseOrdersPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/purchase-orders/files": { "post": { "tags": [ "purchase-orders" ], "summary": "Upload Public Purchase Order File", "operationId": "upload_public_purchase_order_file_api_v2_public_purchase_orders_files_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_public_purchase_order_file_api_v2_public_purchase_orders_files_post" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadPublicPurchaseOrderFileApiV2PublicPurchaseOrdersFilesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/purchase-orders/{purchase_order_id}": { "get": { "tags": [ "purchase-orders" ], "summary": "Get Public Purchase Order", "operationId": "get_public_purchase_order_api_v2_public_purchase_orders__purchase_order_id__get", "parameters": [ { "name": "purchase_order_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Purchase Order Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicPurchaseOrderApiV2PublicPurchaseOrdersPurchaseOrderIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "purchase-orders" ], "summary": "Update Public Purchase Order", "operationId": "update_public_purchase_order_api_v2_public_purchase_orders__purchase_order_id__put", "parameters": [ { "name": "purchase_order_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Purchase Order Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicPurchaseOrderApiV2PublicPurchaseOrdersPurchaseOrderIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "purchase-orders" ], "summary": "Delete Public Purchase Order", "operationId": "delete_public_purchase_order_api_v2_public_purchase_orders__purchase_order_id__delete", "parameters": [ { "name": "purchase_order_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Purchase Order Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicPurchaseOrderApiV2PublicPurchaseOrdersPurchaseOrderIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/purchase-orders/{purchase_order_id}/pdf": { "get": { "tags": [ "purchase-orders" ], "summary": "Download Public Purchase Order Pdf", "operationId": "download_public_purchase_order_pdf_api_v2_public_purchase_orders__purchase_order_id__pdf_get", "parameters": [ { "name": "purchase_order_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Purchase Order Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "template_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" } }, { "name": "template_select", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Select" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "PDF document", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/records/query": { "post": { "tags": [ "records" ], "summary": "Query Public Records", "operationId": "query_public_records_api_v2_public_records_query_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicRecordQueryRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QueryPublicRecordsApiV2PublicRecordsQueryPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/records/aggregate": { "post": { "tags": [ "records" ], "summary": "Aggregate Public Records", "operationId": "aggregate_public_records_api_v2_public_records_aggregate_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicRecordAggregateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AggregatePublicRecordsApiV2PublicRecordsAggregatePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/slips": { "get": { "tags": [ "revenues" ], "summary": "List Public Slips", "operationId": "list_public_slips_api_v2_public_slips_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicSlipsApiV2PublicSlipsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "revenues" ], "summary": "Create Public Slip", "operationId": "create_public_slip_api_v2_public_slips_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicSlipApiV2PublicSlipsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/slips/{revenue_id}": { "get": { "tags": [ "revenues" ], "summary": "Get Public Slip", "operationId": "get_public_slip_api_v2_public_slips__revenue_id__get", "parameters": [ { "name": "revenue_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Revenue Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicSlipApiV2PublicSlipsRevenueIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "revenues" ], "summary": "Update Public Slip", "operationId": "update_public_slip_api_v2_public_slips__revenue_id__put", "parameters": [ { "name": "revenue_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Revenue Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicSlipApiV2PublicSlipsRevenueIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "revenues" ], "summary": "Delete Public Slip", "operationId": "delete_public_slip_api_v2_public_slips__revenue_id__delete", "parameters": [ { "name": "revenue_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Revenue Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicSlipApiV2PublicSlipsRevenueIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/slips/{revenue_id}/pdf": { "get": { "tags": [ "revenues" ], "summary": "Download Public Slip Pdf", "operationId": "download_public_slip_pdf_api_v2_public_slips__revenue_id__pdf_get", "parameters": [ { "name": "revenue_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Revenue Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "template_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" } }, { "name": "template_select", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Select" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "PDF document", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/approval-rules": { "get": { "tags": [ "rule-settings" ], "summary": "List Public Approval Rules", "operationId": "list_public_approval_rules_api_v2_public_approval_rules_get", "parameters": [ { "name": "object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" } }, { "name": "object_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Name" } }, { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "setting_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setting Type" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicApprovalRulesApiV2PublicApprovalRulesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "rule-settings" ], "summary": "Upsert Public Approval Rule", "operationId": "upsert_public_approval_rule_api_v2_public_approval_rules_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicApprovalRuleSaveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertPublicApprovalRuleApiV2PublicApprovalRulesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/approval-rules/options": { "get": { "tags": [ "rule-settings" ], "summary": "Get Public Approval Rule Options", "operationId": "get_public_approval_rule_options_api_v2_public_approval_rules_options_get", "parameters": [ { "name": "object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" } }, { "name": "object_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Name" } }, { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "setting_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setting Type" } }, { "name": "rule_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rule Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicApprovalRuleOptionsApiV2PublicApprovalRulesOptionsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/approval-rules/{rule_id}": { "delete": { "tags": [ "rule-settings" ], "summary": "Delete Public Approval Rule", "operationId": "delete_public_approval_rule_api_v2_public_approval_rules__rule_id__delete", "parameters": [ { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Rule Id" } }, { "name": "object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" } }, { "name": "object_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Name" } }, { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "setting_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setting Type" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicApprovalRuleApiV2PublicApprovalRulesRuleIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/lock-rules": { "get": { "tags": [ "rule-settings" ], "summary": "List Public Lock Rules", "operationId": "list_public_lock_rules_api_v2_public_lock_rules_get", "parameters": [ { "name": "object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" } }, { "name": "object_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Name" } }, { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "setting_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setting Type" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicLockRulesApiV2PublicLockRulesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "rule-settings" ], "summary": "Upsert Public Lock Rule", "operationId": "upsert_public_lock_rule_api_v2_public_lock_rules_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicLockRuleSaveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertPublicLockRuleApiV2PublicLockRulesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/lock-rules/options": { "get": { "tags": [ "rule-settings" ], "summary": "Get Public Lock Rule Options", "operationId": "get_public_lock_rule_options_api_v2_public_lock_rules_options_get", "parameters": [ { "name": "object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" } }, { "name": "object_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Name" } }, { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "setting_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setting Type" } }, { "name": "rule_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rule Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicLockRuleOptionsApiV2PublicLockRulesOptionsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/lock-rules/{rule_id}": { "delete": { "tags": [ "rule-settings" ], "summary": "Delete Public Lock Rule", "operationId": "delete_public_lock_rule_api_v2_public_lock_rules__rule_id__delete", "parameters": [ { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Rule Id" } }, { "name": "object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" } }, { "name": "object_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Name" } }, { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "setting_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setting Type" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicLockRuleApiV2PublicLockRulesRuleIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/delivery-rules": { "get": { "tags": [ "rule-settings" ], "summary": "List Public Delivery Rules", "operationId": "list_public_delivery_rules_api_v2_public_delivery_rules_get", "parameters": [ { "name": "object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" } }, { "name": "object_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Name" } }, { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "setting_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setting Type" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicDeliveryRulesApiV2PublicDeliveryRulesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "rule-settings" ], "summary": "Upsert Public Delivery Rule", "operationId": "upsert_public_delivery_rule_api_v2_public_delivery_rules_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicDeliveryRuleSaveRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertPublicDeliveryRuleApiV2PublicDeliveryRulesPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/delivery-rules/options": { "get": { "tags": [ "rule-settings" ], "summary": "Get Public Delivery Rule Options", "operationId": "get_public_delivery_rule_options_api_v2_public_delivery_rules_options_get", "parameters": [ { "name": "object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" } }, { "name": "object_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Name" } }, { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "setting_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setting Type" } }, { "name": "rule_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rule Id" } }, { "name": "action", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicDeliveryRuleOptionsApiV2PublicDeliveryRulesOptionsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/delivery-rules/{rule_id}": { "delete": { "tags": [ "rule-settings" ], "summary": "Delete Public Delivery Rule", "operationId": "delete_public_delivery_rule_api_v2_public_delivery_rules__rule_id__delete", "parameters": [ { "name": "rule_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Rule Id" } }, { "name": "object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" } }, { "name": "object_name", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Name" } }, { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "setting_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Setting Type" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicDeliveryRuleApiV2PublicDeliveryRulesRuleIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/subscriptions": { "get": { "tags": [ "subscriptions" ], "summary": "List Public Subscriptions", "operationId": "list_public_subscriptions_api_v2_public_subscriptions_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list or line-item-expanded list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicSubscriptionsApiV2PublicSubscriptionsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "subscriptions" ], "summary": "Create Public Subscription", "operationId": "create_public_subscription_api_v2_public_subscriptions_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicSubscriptionApiV2PublicSubscriptionsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/subscriptions/bulk-update": { "post": { "tags": [ "subscriptions" ], "summary": "Bulk Update Public Subscriptions", "operationId": "bulk_update_public_subscriptions_api_v2_public_subscriptions_bulk_update_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordBulkActionRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdatePublicSubscriptionsApiV2PublicSubscriptionsBulkUpdatePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpdatePublicSubscriptionsApiV2PublicSubscriptionsBulkUpdatePost202Envelope" } } }, "description": "Accepted", "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/subscriptions/{subscription_id}": { "get": { "tags": [ "subscriptions" ], "summary": "Get Public Subscription", "operationId": "get_public_subscription_api_v2_public_subscriptions__subscription_id__get", "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Subscription Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicSubscriptionApiV2PublicSubscriptionsSubscriptionIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "subscriptions" ], "summary": "Update Public Subscription", "operationId": "update_public_subscription_api_v2_public_subscriptions__subscription_id__put", "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Subscription Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicSubscriptionApiV2PublicSubscriptionsSubscriptionIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "subscriptions" ], "summary": "Delete Public Subscription", "operationId": "delete_public_subscription_api_v2_public_subscriptions__subscription_id__delete", "parameters": [ { "name": "subscription_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Subscription Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicSubscriptionApiV2PublicSubscriptionsSubscriptionIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/tasks": { "get": { "tags": [ "tasks" ], "summary": "List Public Tasks", "operationId": "list_public_tasks_api_v2_public_tasks_get", "parameters": [ { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "p_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "P Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicTasksApiV2PublicTasksGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "tasks" ], "summary": "Create Public Task", "operationId": "create_public_task_api_v2_public_tasks_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicTaskApiV2PublicTasksPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/tasks/{task_id}": { "get": { "tags": [ "tasks" ], "summary": "Get Public Task", "operationId": "get_public_task_api_v2_public_tasks__task_id__get", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicTaskApiV2PublicTasksTaskIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "tasks" ], "summary": "Update Public Task", "operationId": "update_public_task_api_v2_public_tasks__task_id__put", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicTaskApiV2PublicTasksTaskIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "tasks" ], "summary": "Delete Public Task", "operationId": "delete_public_task_api_v2_public_tasks__task_id__delete", "parameters": [ { "name": "task_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Task Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicTaskApiV2PublicTasksTaskIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/projects": { "get": { "tags": [ "projects" ], "summary": "List Public Projects", "operationId": "list_public_projects_api_v2_public_projects_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 100, "title": "Limit" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "default", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Default" } }, { "name": "lang", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lang" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicProjectsApiV2PublicProjectsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "projects" ], "summary": "Create Public Project", "operationId": "create_public_project_api_v2_public_projects_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicProjectRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicProjectApiV2PublicProjectsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/projects/{project_id}": { "get": { "tags": [ "projects" ], "summary": "Get Public Project", "operationId": "get_public_project_api_v2_public_projects__project_id__get", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicProjectApiV2PublicProjectsProjectIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "projects" ], "summary": "Update Public Project", "operationId": "update_public_project_api_v2_public_projects__project_id__put", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicProjectRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicProjectApiV2PublicProjectsProjectIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "projects" ], "summary": "Delete Public Project", "operationId": "delete_public_project_api_v2_public_projects__project_id__delete", "parameters": [ { "name": "project_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Project Id" } }, { "name": "replacement_project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Replacement Project Id" } }, { "name": "clear_task_project", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Clear Task Project" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicProjectApiV2PublicProjectsProjectIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/tickets": { "get": { "tags": [ "tickets" ], "summary": "List Public Tickets", "operationId": "list_public_tickets_api_v2_public_tickets_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "search", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "usage_status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" } }, { "name": "filters", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filters" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "integer", "maximum": 100, "minimum": 1 }, { "type": "null" } ], "title": "Limit" } }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, { "name": "sort", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" } }, { "name": "created_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At From" } }, { "name": "created_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At To" } }, { "name": "updated_at_from", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At From" } }, { "name": "updated_at_to", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At To" } }, { "$ref": "#/components/parameters/XWorkspaceCode" }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } } ], "responses": { "200": { "description": "Object record list response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicTicketsApiV2PublicTicketsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "tickets" ], "summary": "Create Public Ticket", "operationId": "create_public_ticket_api_v2_public_tickets_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicTicketApiV2PublicTicketsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/tickets/pipelines": { "get": { "tags": [ "tickets" ], "summary": "List Public Ticket Pipelines", "operationId": "list_public_ticket_pipelines_api_v2_public_tickets_pipelines_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicTicketPipelinesApiV2PublicTicketsPipelinesGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/tickets/{ticket_id}": { "get": { "tags": [ "tickets" ], "summary": "Get Public Ticket", "operationId": "get_public_ticket_api_v2_public_tickets__ticket_id__get", "parameters": [ { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Ticket Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, { "name": "form_view_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Object record detail response. The base detail payload is intentionally thin; drawer sections load through scoped endpoints.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicTicketApiV2PublicTicketsTicketIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "put": { "tags": [ "tickets" ], "summary": "Update Public Ticket", "operationId": "update_public_ticket_api_v2_public_tickets__ticket_id__put", "parameters": [ { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Ticket Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectRecordUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicTicketApiV2PublicTicketsTicketIdPut200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "tickets" ], "summary": "Delete Public Ticket", "operationId": "delete_public_ticket_api_v2_public_tickets__ticket_id__delete", "parameters": [ { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Ticket Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicTicketApiV2PublicTicketsTicketIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/tickets/{ticket_id}/status": { "patch": { "tags": [ "tickets" ], "summary": "Update Public Ticket Status", "operationId": "update_public_ticket_status_api_v2_public_tickets__ticket_id__status_patch", "parameters": [ { "name": "ticket_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Ticket Id" } }, { "name": "external_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, { "name": "stage_key", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Stage Key" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^(active|archived)$" }, { "type": "null" } ], "title": "Status" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicTicketStatusApiV2PublicTicketsTicketIdStatusPatch200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/transfers/{history_id}": { "get": { "tags": [ "transfers" ], "summary": "Get Public Transfer History", "operationId": "get_public_transfer_history_api_v2_public_transfers__history_id__get", "parameters": [ { "name": "history_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "title": "History Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicTransferHistoryApiV2PublicTransfersHistoryIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/views": { "get": { "tags": [ "views" ], "summary": "List Public Views", "operationId": "list_public_views_api_v2_public_views_get", "parameters": [ { "name": "object_type", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" } }, { "name": "object", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" } }, { "name": "custom_object_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Id" } }, { "name": "project_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicViewsApiV2PublicViewsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "views" ], "summary": "Create Public View", "operationId": "create_public_view_api_v2_public_views_post", "parameters": [ { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewCreateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicViewApiV2PublicViewsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/views/{view_id}": { "get": { "tags": [ "views" ], "summary": "Get Public View", "operationId": "get_public_view_api_v2_public_views__view_id__get", "parameters": [ { "name": "view_id", "in": "path", "required": true, "schema": { "type": "string", "title": "View Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicViewApiV2PublicViewsViewIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "views" ], "summary": "Update Public View", "operationId": "update_public_view_api_v2_public_views__view_id__patch", "parameters": [ { "name": "view_id", "in": "path", "required": true, "schema": { "type": "string", "title": "View Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViewUpdateRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicViewApiV2PublicViewsViewIdPatch200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "views" ], "summary": "Delete Public View", "operationId": "delete_public_view_api_v2_public_views__view_id__delete", "parameters": [ { "name": "view_id", "in": "path", "required": true, "schema": { "type": "string", "title": "View Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicViewApiV2PublicViewsViewIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/views/{view_id}/columns": { "get": { "tags": [ "views" ], "summary": "Get Public View Columns", "description": "Return saved view columns as canonical V2 field ids. Legacy raw UUID columns and stale `standard:` columns are normalized to `custom_property:`, standard aliases are resolved for compatible objects, and labels honor the requested language when localized metadata or compatibility fallbacks are available.", "operationId": "get_public_view_columns_api_v2_public_views__view_id__columns_get", "parameters": [ { "name": "view_id", "in": "path", "required": true, "schema": { "type": "string", "title": "View Id" } }, { "name": "language", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "name": "X-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X-Language" }, "x-fern-parameter-name": "x_language" }, { "name": "Accept-Language", "in": "header", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Accept-Language" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicViewColumnsApiV2PublicViewsViewIdColumnsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/workflows/actions": { "get": { "tags": [ "workflow-actions" ], "summary": "List Public Workflow Actions Compat", "operationId": "list_public_workflow_actions_compat_api_v2_public_workflows_actions_get", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicWorkflowActionsCompatApiV2PublicWorkflowsActionsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/workflows": { "get": { "tags": [ "workflows" ], "summary": "List Public Workflows", "operationId": "list_public_workflows_api_v2_public_workflows_get", "parameters": [ { "name": "page", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "default": 1, "title": "Page" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "maximum": 100, "minimum": 1, "default": 25, "title": "Limit" } }, { "name": "q", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, { "name": "status", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, { "name": "include_lookout", "in": "query", "required": false, "schema": { "type": "boolean", "default": false, "title": "Include Lookout" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPublicWorkflowsApiV2PublicWorkflowsGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "post": { "tags": [ "workflows" ], "summary": "Create Public Workflow", "operationId": "create_public_workflow_api_v2_public_workflows_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorkflowMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePublicWorkflowApiV2PublicWorkflowsPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/workflows/{workflow_id}": { "get": { "tags": [ "workflows" ], "summary": "Get Public Workflow", "operationId": "get_public_workflow_api_v2_public_workflows__workflow_id__get", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicWorkflowApiV2PublicWorkflowsWorkflowIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "patch": { "tags": [ "workflows" ], "summary": "Update Public Workflow", "operationId": "update_public_workflow_api_v2_public_workflows__workflow_id__patch", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorkflowMutationRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatePublicWorkflowApiV2PublicWorkflowsWorkflowIdPatch200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "workflows" ], "summary": "Delete Public Workflow", "operationId": "delete_public_workflow_api_v2_public_workflows__workflow_id__delete", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeletePublicWorkflowApiV2PublicWorkflowsWorkflowIdDelete200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/workflows/{workflow_id}/run": { "post": { "tags": [ "workflows" ], "summary": "Run Public Workflow", "operationId": "run_public_workflow_api_v2_public_workflows__workflow_id__run_post", "parameters": [ { "name": "workflow_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Workflow Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/PublicWorkflowRunRequest" }, { "type": "null" } ], "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunPublicWorkflowApiV2PublicWorkflowsWorkflowIdRunPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/workflow-runs/{run_id}": { "get": { "tags": [ "workflow-runs" ], "summary": "Get Public Workflow Run", "operationId": "get_public_workflow_run_api_v2_public_workflow_runs__run_id__get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Run Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicWorkflowRunApiV2PublicWorkflowRunsRunIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/workflows/runs/{run_id}": { "get": { "tags": [ "workflow-runs" ], "summary": "Get Public Workflow Run Nested Compat", "operationId": "get_public_workflow_run_nested_compat_api_v2_public_workflows_runs__run_id__get", "parameters": [ { "name": "run_id", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "title": "Run Id" } }, { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetPublicWorkflowRunNestedCompatApiV2PublicWorkflowsRunsRunIdGet200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/workflow-runs/resolve-record": { "post": { "tags": [ "workflow-runs" ], "summary": "Resolve Public Workflow Record", "operationId": "resolve_public_workflow_record_api_v2_public_workflow_runs_resolve_record_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorkflowResolveRecordRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolvePublicWorkflowRecordApiV2PublicWorkflowRunsResolveRecordPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/workflow-runs/preview": { "post": { "tags": [ "workflow-runs" ], "summary": "Preview Public Workflow Compat", "operationId": "preview_public_workflow_compat_api_v2_public_workflow_runs_preview_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorkflowRuntimeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewPublicWorkflowCompatApiV2PublicWorkflowRunsPreviewPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/drafts/hubspot/preview": { "post": { "tags": [ "workflow-runs" ], "summary": "Preview Public Hubspot Invoice Draft", "operationId": "preview_public_hubspot_invoice_draft_api_v2_public_invoices_drafts_hubspot_preview_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewPublicHubspotInvoiceDraftApiV2PublicInvoicesDraftsHubspotPreviewPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/exports/freee/preview": { "post": { "tags": [ "workflow-runs" ], "summary": "Preview Public Freee Invoice Export", "operationId": "preview_public_freee_invoice_export_api_v2_public_invoices_exports_freee_preview_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewPublicFreeeInvoiceExportApiV2PublicInvoicesExportsFreeePreviewPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/exports/moneyforward/preview": { "post": { "tags": [ "workflow-runs" ], "summary": "Preview Public Moneyforward Invoice Export", "operationId": "preview_public_moneyforward_invoice_export_api_v2_public_invoices_exports_moneyforward_preview_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewPublicMoneyforwardInvoiceExportApiV2PublicInvoicesExportsMoneyforwardPreviewPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/estimates/drafts/hubspot/preview": { "post": { "tags": [ "workflow-runs" ], "summary": "Preview Public Hubspot Estimate Draft", "operationId": "preview_public_hubspot_estimate_draft_api_v2_public_estimates_drafts_hubspot_preview_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewPublicHubspotEstimateDraftApiV2PublicEstimatesDraftsHubspotPreviewPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/orders/handoffs/hubspot/preview": { "post": { "tags": [ "workflow-runs" ], "summary": "Preview Public Hubspot Order Handoff", "operationId": "preview_public_hubspot_order_handoff_api_v2_public_orders_handoffs_hubspot_preview_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewPublicHubspotOrderHandoffApiV2PublicOrdersHandoffsHubspotPreviewPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/incentives/commission/hubspot/preview": { "post": { "tags": [ "workflow-runs" ], "summary": "Preview Public Hubspot Commission Incentive", "operationId": "preview_public_hubspot_commission_incentive_api_v2_public_incentives_commission_hubspot_preview_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewPublicHubspotCommissionIncentiveApiV2PublicIncentivesCommissionHubspotPreviewPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/cpq/quote-readiness/salesforce/preview": { "post": { "tags": [ "workflow-runs" ], "summary": "Preview Public Salesforce Quote Readiness", "operationId": "preview_public_salesforce_quote_readiness_api_v2_public_cpq_quote_readiness_salesforce_preview_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewPublicSalesforceQuoteReadinessApiV2PublicCpqQuoteReadinessSalesforcePreviewPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/cpq/quote-readiness/salesforce/summary": { "post": { "tags": [ "workflow-runs" ], "summary": "Summarize Public Salesforce Quote Readiness", "operationId": "summarize_public_salesforce_quote_readiness_api_v2_public_cpq_quote_readiness_salesforce_summary_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SummarizePublicSalesforceQuoteReadinessApiV2PublicCpqQuoteReadinessSalesforceSummaryPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/workflow-runs/start": { "post": { "tags": [ "workflow-runs" ], "summary": "Start Public Workflow Compat", "operationId": "start_public_workflow_compat_api_v2_public_workflow_runs_start_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublicWorkflowRuntimeRequest" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartPublicWorkflowCompatApiV2PublicWorkflowRunsStartPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/drafts/hubspot": { "post": { "tags": [ "workflow-runs" ], "summary": "Start Public Hubspot Invoice Draft", "operationId": "start_public_hubspot_invoice_draft_api_v2_public_invoices_drafts_hubspot_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartPublicHubspotInvoiceDraftApiV2PublicInvoicesDraftsHubspotPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/exports/freee": { "post": { "tags": [ "workflow-runs" ], "summary": "Start Public Freee Invoice Export", "operationId": "start_public_freee_invoice_export_api_v2_public_invoices_exports_freee_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartPublicFreeeInvoiceExportApiV2PublicInvoicesExportsFreeePost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/invoices/exports/moneyforward": { "post": { "tags": [ "workflow-runs" ], "summary": "Start Public Moneyforward Invoice Export", "operationId": "start_public_moneyforward_invoice_export_api_v2_public_invoices_exports_moneyforward_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartPublicMoneyforwardInvoiceExportApiV2PublicInvoicesExportsMoneyforwardPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/estimates/drafts/hubspot": { "post": { "tags": [ "workflow-runs" ], "summary": "Start Public Hubspot Estimate Draft", "operationId": "start_public_hubspot_estimate_draft_api_v2_public_estimates_drafts_hubspot_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartPublicHubspotEstimateDraftApiV2PublicEstimatesDraftsHubspotPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/orders/handoffs/hubspot": { "post": { "tags": [ "workflow-runs" ], "summary": "Start Public Hubspot Order Handoff", "operationId": "start_public_hubspot_order_handoff_api_v2_public_orders_handoffs_hubspot_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartPublicHubspotOrderHandoffApiV2PublicOrdersHandoffsHubspotPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/reports/revenue-control/hubspot": { "post": { "tags": [ "workflow-runs" ], "summary": "Start Public Hubspot Revenue Control Report", "operationId": "start_public_hubspot_revenue_control_report_api_v2_public_reports_revenue_control_hubspot_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartPublicHubspotRevenueControlReportApiV2PublicReportsRevenueControlHubspotPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } }, "/v2/public/cpq/quote-readiness/salesforce/writeback": { "post": { "tags": [ "workflow-runs" ], "summary": "Writeback Public Salesforce Quote Readiness", "operationId": "writeback_public_salesforce_quote_readiness_api_v2_public_cpq_quote_readiness_salesforce_writeback_post", "parameters": [ { "name": "workspace_id", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" } }, { "$ref": "#/components/parameters/XWorkspaceCode" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "title": "Payload" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WritebackPublicSalesforceQuoteReadinessApiV2PublicCpqQuoteReadinessSalesforceWritebackPost200Envelope" } } }, "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } } }, "422": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" } }, "x-sanka-surface": "public_developer", "x-sanka-api-version": "v2", "x-sanka-auth": "developer_bearer", "security": [ { "bearerAuth": [] } ] } } }, "components": { "headers": { "XCtxId": { "description": "Request context identifier for log correlation.", "schema": { "type": "string" } } }, "parameters": { "XWorkspaceCode": { "name": "X-Workspace-Code", "in": "header", "required": false, "schema": { "type": "string" } } }, "responses": { "ErrorResponse": { "description": "Error response", "headers": { "x-ctx-id": { "$ref": "#/components/headers/XCtxId" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "schemas": { "ActivatePublicCustomObjectRecordApiV2PublicCustomObjectsCustomObjectIdRecordsRecordIdActivatePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Activate Public Custom Object Record Api V2 Public Custom Objects Custom Object Id Records Record Id Activate Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ActivatePublicJournalApiV2PublicJournalsJournalIdActivatePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Activate Public Journal Api V2 Public Journals Journal Id Activate Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "AggregatePublicRecordsApiV2PublicRecordsAggregatePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Aggregate Public Records Api V2 Public Records Aggregate Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ApplyPublicCompanyPriceTableItemsApiV2PublicCompaniesCompanyIdPriceTableItemsApplyAllPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Apply Public Company Price Table Items Api V2 Public Companies Company Id Price Table Items Apply All Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ApprovalRequestCreateRequest": { "properties": { "object_type": { "type": "string", "title": "Object Type" }, "record_id": { "type": "string", "title": "Record Id" }, "approver_user_ids": { "items": { "type": "string" }, "type": "array", "title": "Approver User Ids" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "block_targets": { "items": { "type": "string" }, "type": "array", "title": "Block Targets" }, "requested_action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Requested Action" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key" } }, "additionalProperties": false, "type": "object", "required": [ "object_type", "record_id", "approver_user_ids" ], "title": "ApprovalRequestCreateRequest" }, "ApproveApprovalRequestApiV2PublicApprovalRequestsHistoryIdApprovePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Approve Approval Request Api V2 Public Approval Requests History Id Approve Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ApprovePublicIncentiveApiV2PublicIncentivesIncentiveIdApprovePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Approve Public Incentive Api V2 Public Incentives Incentive Id Approve Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ApprovePublicIncentiveBatchApiV2PublicIncentivesBatchesBatchIdApprovePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Approve Public Incentive Batch Api V2 Public Incentives Batches Batch Id Approve Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ApprovePublicIncentivesBulkApiV2PublicIncentivesApproveBulkPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Approve Public Incentives Bulk Api V2 Public Incentives Approve Bulk Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ApprovePublicPayrollRunApiV2PublicPayrollRunsRunIdApprovePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Approve Public Payroll Run Api V2 Public Payroll Runs Run Id Approve Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ArchivePublicCustomObjectRecordApiV2PublicCustomObjectsCustomObjectIdRecordsRecordIdArchivePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Archive Public Custom Object Record Api V2 Public Custom Objects Custom Object Id Records Record Id Archive Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ArchivePublicCustomObjectRecordCompatibilityApiV2PublicRecordsCustomObjectsRecordsRecordIdArchivePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Archive Public Custom Object Record Compatibility Api V2 Public Records Custom Objects Records Record Id Archive Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ArchivePublicJournalApiV2PublicJournalsJournalIdArchivePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Archive Public Journal Api V2 Public Journals Journal Id Archive Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "AuthWorkspaceSwitchRequest": { "properties": { "workspace_id": { "type": "string", "minLength": 1, "title": "Workspace Id" } }, "type": "object", "required": [ "workspace_id" ], "title": "AuthWorkspaceSwitchRequest" }, "BatchUpsertPublicFerryProgramTodosApiV2PublicFerryProgramsProgramIdTodosBatchUpsertPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryProgramTodoBatchUpsertData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "Body_upload_public_bill_file_api_v2_public_bills_files_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_public_bill_file_api_v2_public_bills_files_post" }, "Body_upload_public_estimate_file_api_v2_public_estimates_files_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_public_estimate_file_api_v2_public_estimates_files_post" }, "Body_upload_public_expense_file_api_v2_public_expenses_files_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_public_expense_file_api_v2_public_expenses_files_post" }, "Body_upload_public_file_api_v2_public_files_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_public_file_api_v2_public_files_post" }, "Body_upload_public_invoice_file_api_v2_public_invoices_files_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_public_invoice_file_api_v2_public_invoices_files_post" }, "Body_upload_public_order_file_api_v2_public_orders_files_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_public_order_file_api_v2_public_orders_files_post" }, "Body_upload_public_purchase_order_file_api_v2_public_purchase_orders_files_post": { "properties": { "file": { "type": "string", "contentMediaType": "application/octet-stream", "title": "File" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_public_purchase_order_file_api_v2_public_purchase_orders_files_post" }, "BulkCreatePublicOrdersApiV2PublicOrdersBulkPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Bulk Create Public Orders Api V2 Public Orders Bulk Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "BulkUpdatePublicInvoicesApiV2PublicInvoicesBulkUpdatePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordBulkActionData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "BulkUpdatePublicInvoicesApiV2PublicInvoicesBulkUpdatePost202Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordBulkActionData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "BulkUpdatePublicSubscriptionsApiV2PublicSubscriptionsBulkUpdatePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordBulkActionData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "BulkUpdatePublicSubscriptionsApiV2PublicSubscriptionsBulkUpdatePost202Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordBulkActionData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CalculatePublicIncentivesApiV2PublicIncentivesCalculatePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Calculate Public Incentives Api V2 Public Incentives Calculate Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CalculatePublicPayrollRunApiV2PublicPayrollRunsCalculatePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Calculate Public Payroll Run Api V2 Public Payroll Runs Calculate Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CancelPublicExportJobCompatApiV2PublicExportsJobIdCancelPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Cancel Public Export Job Compat Api V2 Public Exports Job Id Cancel Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CancelPublicImportJobCompatApiV2PublicImportsJobIdCancelPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Cancel Public Import Job Compat Api V2 Public Imports Job Id Cancel Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ClaimProviderActionApiV2LookoutAdActionsActionIdClaimPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/LookoutProviderActionData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ClaimProviderActionApiV2LookoutProviderActionsActionIdClaimPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/LookoutProviderActionData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CompanyMutationRequest": { "properties": { "view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" }, "form_view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" }, "properties": { "additionalProperties": true, "type": "object", "title": "Properties" }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target", "default": "sanka" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" }, "external_object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Object Type" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Operation" }, "dry_run": { "type": "boolean", "title": "Dry Run", "default": false }, "confirm": { "type": "boolean", "title": "Confirm", "default": false }, "billing_cycle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Billing Cycle", "description": "Company billing cycle. Accepted values include 'end' for month-end or '1' through '31' for a closing day." }, "payment_cycle": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payment Cycle", "description": "Company payment cycle. Accepted values include 'cmonth_end', 'nmonth_end', or net terms such as 'net_30'." } }, "additionalProperties": true, "type": "object", "title": "CompanyMutationRequest" }, "CompanyPriceTableApplyAllRequest": { "properties": { "price_precentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Precentage" }, "field_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Field Ref" }, "mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mode" }, "exclude_item_ids": { "items": { "type": "string" }, "type": "array", "title": "Exclude Item Ids" } }, "type": "object", "title": "CompanyPriceTableApplyAllRequest" }, "CompanyPriceTableCompanyUpdateRequest": { "properties": { "price_precentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Precentage" }, "field_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Field Ref" }, "mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mode" } }, "type": "object", "title": "CompanyPriceTableCompanyUpdateRequest" }, "CompanyPriceTableItemUpdateRequest": { "properties": { "price_precentage": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Price Precentage" }, "field_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Field Ref" }, "discount_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Discount Price" } }, "type": "object", "title": "CompanyPriceTableItemUpdateRequest" }, "CompleteProviderActionApiV2LookoutAdActionsActionIdCompletePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/LookoutProviderActionData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CompleteProviderActionApiV2LookoutProviderActionsActionIdCompletePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/LookoutProviderActionData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreateApprovalRequestApiV2PublicApprovalRequestsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Approval Request Api V2 Public Approval Requests Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicAbsenceApiV2PublicAbsencesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Absence Api V2 Public Absences Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicAssociationApiV2PublicAssociationsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/AssociationEdgeMutationData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicAttendanceRecordApiV2PublicAttendanceRecordsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Attendance Record Api V2 Public Attendance Records Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicBillApiV2PublicBillsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Bill Api V2 Public Bills Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicCompanyApiV2PublicCompaniesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Company Api V2 Public Companies Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicContactApiV2PublicContactsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Contact Api V2 Public Contacts Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicCustomObjectRecordApiV2PublicCustomObjectsCustomObjectIdRecordsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Custom Object Record Api V2 Public Custom Objects Custom Object Id Records Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicCustomObjectRecordCompatibilityApiV2PublicRecordsCustomObjectsRecordsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Custom Object Record Compatibility Api V2 Public Records Custom Objects Records Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicDealApiV2PublicDealsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Deal Api V2 Public Deals Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicDeveloperPropertyApiV2PublicPropertiesObjectNamePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Developer Property Api V2 Public Properties Object Name Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicDisbursementAllocationApiV2PublicDisbursementsDisbursementIdAllocationsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Disbursement Allocation Api V2 Public Disbursements Disbursement Id Allocations Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicDisbursementApiV2PublicDisbursementsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Disbursement Api V2 Public Disbursements Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicEstimateApiV2PublicEstimatesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Estimate Api V2 Public Estimates Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicExpenseApiV2PublicExpensesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Expense Api V2 Public Expenses Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicExportJobCompatApiV2PublicExportsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Export Job Compat Api V2 Public Exports Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicFerryDiagramApiV2PublicFerryDiagramsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryDiagramData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicFerryProgramMeetingApiV2PublicFerryProgramsProgramIdMeetingsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryProgramMeetingData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicFerryProgramTodoApiV2PublicFerryProgramsProgramIdTodosPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryProgramData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicFinancialStatementViewApiV2PublicJournalsViewsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Financial Statement View Api V2 Public Journals Views Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicImportJobCompatApiV2PublicImportsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Import Job Compat Api V2 Public Imports Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicIncentiveBatchApiV2PublicIncentivesBatchesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Incentive Batch Api V2 Public Incentives Batches Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicIncentivePlanApiV2PublicIncentivesPlansPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Incentive Plan Api V2 Public Incentives Plans Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicInventoryApiV2PublicInventoriesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Inventory Api V2 Public Inventories Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicInventoryTransactionApiV2PublicInventoryTransactionsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Inventory Transaction Api V2 Public Inventory Transactions Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicInvoiceApiV2PublicInvoicesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Invoice Api V2 Public Invoices Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicItemApiV2PublicItemsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Item Api V2 Public Items Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicJournalApiV2PublicJournalsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Journal Api V2 Public Journals Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicLocationApiV2PublicLocationsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Location Api V2 Public Locations Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicMeterApiV2PublicMetersPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Meter Api V2 Public Meters Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicOrderApiV2PublicOrdersPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Order Api V2 Public Orders Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicPaymentApiV2PublicPaymentsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Payment Api V2 Public Payments Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicPayrollJournalEntryApiV2PublicPayrollRunsRunIdJournalEntryPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Payroll Journal Entry Api V2 Public Payroll Runs Run Id Journal Entry Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicProjectApiV2PublicProjectsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/PublicProjectMutationData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicPurchaseOrderApiV2PublicPurchaseOrdersPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Purchase Order Api V2 Public Purchase Orders Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicReportApiV2PublicReportsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Report Api V2 Public Reports Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicSlipApiV2PublicSlipsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Slip Api V2 Public Slips Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicSubscriptionApiV2PublicSubscriptionsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Subscription Api V2 Public Subscriptions Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicTaskApiV2PublicTasksPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Task Api V2 Public Tasks Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicTicketApiV2PublicTicketsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Ticket Api V2 Public Tickets Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicViewApiV2PublicViewsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public View Api V2 Public Views Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "CreatePublicWorkflowApiV2PublicWorkflowsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Create Public Workflow Api V2 Public Workflows Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicAbsenceApiV2PublicAbsencesAbsenceIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Absence Api V2 Public Absences Absence Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicApprovalRuleApiV2PublicApprovalRulesRuleIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Approval Rule Api V2 Public Approval Rules Rule Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicAssociationApiV2PublicAssociationsDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/AssociationEdgeMutationData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicAttendanceRecordApiV2PublicAttendanceRecordsAttendanceRecordIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Attendance Record Api V2 Public Attendance Records Attendance Record Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicBillApiV2PublicBillsBillIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Bill Api V2 Public Bills Bill Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicCompanyApiV2PublicCompaniesCompanyIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Company Api V2 Public Companies Company Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicContactApiV2PublicContactsContactIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Contact Api V2 Public Contacts Contact Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicCustomObjectRecordApiV2PublicCustomObjectsCustomObjectIdRecordsRecordIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Custom Object Record Api V2 Public Custom Objects Custom Object Id Records Record Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicDealApiV2PublicDealsDealIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Deal Api V2 Public Deals Deal Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicDeliveryRuleApiV2PublicDeliveryRulesRuleIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Delivery Rule Api V2 Public Delivery Rules Rule Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicDeveloperPropertyApiV2PublicPropertiesObjectNamePropertyRefDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Developer Property Api V2 Public Properties Object Name Property Ref Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicDisbursementAllocationApiV2PublicDisbursementsDisbursementIdAllocationsAllocationIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Disbursement Allocation Api V2 Public Disbursements Disbursement Id Allocations Allocation Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicDisbursementApiV2PublicDisbursementsDisbursementIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Disbursement Api V2 Public Disbursements Disbursement Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicEstimateApiV2PublicEstimatesEstimateIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Estimate Api V2 Public Estimates Estimate Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicExpenseApiV2PublicExpensesExpenseIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Expense Api V2 Public Expenses Expense Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicFerryDiagramApiV2PublicFerryDiagramsDiagramIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryDiagramDeleteData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicFerryProgramTodoApiV2PublicFerryProgramsProgramIdTodosTodoIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryProgramData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicIncentivePlanApiV2PublicIncentivesPlansPlanIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Incentive Plan Api V2 Public Incentives Plans Plan Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicInventoryApiV2PublicInventoriesInventoryIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Inventory Api V2 Public Inventories Inventory Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicInventoryTransactionApiV2PublicInventoryTransactionsTransactionIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Inventory Transaction Api V2 Public Inventory Transactions Transaction Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicInvoiceApiV2PublicInvoicesInvoiceIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Invoice Api V2 Public Invoices Invoice Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicItemApiV2PublicItemsItemIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Item Api V2 Public Items Item Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicJournalApiV2PublicJournalsJournalIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Journal Api V2 Public Journals Journal Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicLocationApiV2PublicLocationsLocationIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Location Api V2 Public Locations Location Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicLockRuleApiV2PublicLockRulesRuleIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Lock Rule Api V2 Public Lock Rules Rule Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicMeterApiV2PublicMetersMeterIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Meter Api V2 Public Meters Meter Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicOrderApiV2PublicOrdersOrderIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Order Api V2 Public Orders Order Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicPaymentApiV2PublicPaymentsPaymentIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Payment Api V2 Public Payments Payment Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicProjectApiV2PublicProjectsProjectIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/PublicProjectDeleteData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicPurchaseOrderApiV2PublicPurchaseOrdersPurchaseOrderIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Purchase Order Api V2 Public Purchase Orders Purchase Order Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicReportApiV2PublicReportsReportIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Report Api V2 Public Reports Report Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicSlipApiV2PublicSlipsRevenueIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Slip Api V2 Public Slips Revenue Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicSubscriptionApiV2PublicSubscriptionsSubscriptionIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Subscription Api V2 Public Subscriptions Subscription Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicTaskApiV2PublicTasksTaskIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Task Api V2 Public Tasks Task Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicTicketApiV2PublicTicketsTicketIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Ticket Api V2 Public Tickets Ticket Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicViewApiV2PublicViewsViewIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public View Api V2 Public Views View Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DeletePublicWorkflowApiV2PublicWorkflowsWorkflowIdDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Delete Public Workflow Api V2 Public Workflows Workflow Id Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "DisbursementAllocationCreateRequest": { "properties": { "payable_type": { "anyOf": [ { "type": "string", "enum": [ "bill", "expense" ] }, { "type": "null" } ], "title": "Payable Type" }, "payable_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payable Id" }, "bill_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bill Id" }, "expense_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expense Id" }, "amount": { "type": "number", "exclusiveMinimum": 0.0, "title": "Amount" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "source": { "type": "string", "enum": [ "manual", "bank_statement", "api", "migration" ], "title": "Source", "default": "manual" }, "notes": { "type": "string", "title": "Notes", "default": "" } }, "type": "object", "required": [ "amount" ], "title": "DisbursementAllocationCreateRequest" }, "DisbursementAllocationPatchRequest": { "properties": { "payable_type": { "anyOf": [ { "type": "string", "enum": [ "bill", "expense" ] }, { "type": "null" } ], "title": "Payable Type" }, "payable_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payable Id" }, "bill_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Bill Id" }, "expense_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expense Id" }, "amount": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0.0 }, { "type": "null" } ], "title": "Amount" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "source": { "anyOf": [ { "type": "string", "enum": [ "manual", "bank_statement", "api", "migration" ] }, { "type": "null" } ], "title": "Source" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" } }, "type": "object", "title": "DisbursementAllocationPatchRequest" }, "DownloadPublicPayrollPayslipPdfApiV2PublicPayrollRunsRunIdPayslipsPdfGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": {}, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "EnrichRecordApiV2EnrichPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/EnrichData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "EnrichRequest": { "properties": { "object_type": { "type": "string", "title": "Object Type" }, "record_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Record Id" }, "seed": { "anyOf": [ { "$ref": "#/components/schemas/EnrichCompanySeed" }, { "type": "null" } ] }, "custom_field_map": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Custom Field Map" }, "dry_run": { "type": "boolean", "title": "Dry Run", "default": false }, "force_refresh": { "type": "boolean", "title": "Force Refresh", "default": false } }, "type": "object", "required": [ "object_type" ], "title": "EnrichRequest" }, "ExportJobCreateRequest": { "properties": { "object_type": { "type": "string", "title": "Object Type" }, "destination_kind": { "type": "string", "title": "Destination Kind", "default": "integration" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "target_system": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target System" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" }, "mapping_template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mapping Template Id" }, "mapping_template_revision": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Mapping Template Revision" }, "mapping_template_state": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Mapping Template State" }, "operation": { "type": "string", "title": "Operation", "default": "update" }, "request_invoice": { "type": "boolean", "title": "Request Invoice", "default": false }, "record_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Record Ids" }, "workspace_scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Scope" }, "view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" }, "search_query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search Query" }, "filter_fields": { "items": { "$ref": "#/components/schemas/ExportTemplateFilterFieldInput" }, "type": "array", "title": "Filter Fields" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key" }, "custom_object_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Id" }, "limit": { "type": "integer", "title": "Limit", "default": 200 }, "file_format": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Format" }, "dry_run": { "type": "boolean", "title": "Dry Run", "default": false }, "workflow_action_tracker_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Action Tracker Id" }, "action_tracker_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Tracker Id" }, "workflow_language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Language" }, "key_field": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key Field" }, "export_set_items": { "type": "boolean", "title": "Export Set Items", "default": false }, "set_code_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Set Code Source" }, "mapping_custom_fields": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Mapping Custom Fields" }, "mapping_custom_fields_conditional": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Mapping Custom Fields Conditional" }, "update_hubspot": { "anyOf": [ {}, { "type": "null" } ], "title": "Update Hubspot" }, "hubspot_follow_up_channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hubspot Follow Up Channel Id" }, "hubspot_follow_up_deal_stage": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hubspot Follow Up Deal Stage" }, "mapping_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mapping Type" }, "selected_custom_object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Selected Custom Object" } }, "type": "object", "required": [ "object_type" ], "title": "ExportJobCreateRequest" }, "FerryDiagramCreateRequest": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "description": { "type": "string", "maxLength": 500, "title": "Description", "default": "" }, "nodes": { "items": { "$ref": "#/components/schemas/FerryDiagramNode" }, "type": "array", "maxItems": 250, "title": "Nodes" }, "edges": { "items": { "$ref": "#/components/schemas/FerryDiagramEdge" }, "type": "array", "maxItems": 500, "title": "Edges" }, "viewport": { "$ref": "#/components/schemas/FerryDiagramViewport" } }, "additionalProperties": false, "type": "object", "required": [ "name" ], "title": "FerryDiagramCreateRequest" }, "FerryDiagramUpdateRequest": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "description": { "type": "string", "maxLength": 500, "title": "Description", "default": "" }, "nodes": { "items": { "$ref": "#/components/schemas/FerryDiagramNode" }, "type": "array", "maxItems": 250, "title": "Nodes" }, "edges": { "items": { "$ref": "#/components/schemas/FerryDiagramEdge" }, "type": "array", "maxItems": 500, "title": "Edges" }, "viewport": { "$ref": "#/components/schemas/FerryDiagramViewport" }, "revision": { "type": "integer", "minimum": 1.0, "title": "Revision" } }, "additionalProperties": false, "type": "object", "required": [ "name", "revision" ], "title": "FerryDiagramUpdateRequest" }, "FerryProgramMeetingCreateRequest": { "properties": { "title": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Title" }, "meetingAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Meetingat" }, "contentMarkdown": { "type": "string", "maxLength": 200000, "title": "Contentmarkdown", "default": "" }, "sourceRef": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Sourceref" } }, "type": "object", "required": [ "title" ], "title": "FerryProgramMeetingCreateRequest" }, "FerryProgramMeetingUpdateRequest": { "properties": { "title": { "anyOf": [ { "type": "string", "maxLength": 255, "minLength": 1 }, { "type": "null" } ], "title": "Title" }, "meetingAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Meetingat" }, "contentMarkdown": { "anyOf": [ { "type": "string", "maxLength": 200000 }, { "type": "null" } ], "title": "Contentmarkdown" } }, "type": "object", "title": "FerryProgramMeetingUpdateRequest" }, "FerryProgramTodoBatchUpsertRequest": { "properties": { "todos": { "items": { "$ref": "#/components/schemas/FerryProgramTodoBatchUpsertItem" }, "type": "array", "maxItems": 100, "minItems": 1, "title": "Todos" } }, "type": "object", "required": [ "todos" ], "title": "FerryProgramTodoBatchUpsertRequest" }, "FerryProgramTodoCreateRequest": { "properties": { "title": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Title" }, "titleJa": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Titleja" }, "description": { "type": "string", "maxLength": 20000, "title": "Description", "default": "" }, "descriptionJa": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ], "title": "Descriptionja" }, "category": { "type": "string", "maxLength": 100, "title": "Category", "default": "custom" }, "required": { "type": "boolean", "title": "Required", "default": false }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "completed", "blocked" ], "title": "Status", "default": "not_started" }, "notes": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ], "title": "Notes" }, "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Startdate" }, "dueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duedate" }, "priority": { "type": "string", "enum": [ "P0", "P1", "P2", "P3", "P4" ], "title": "Priority", "default": "P2" }, "sourceRef": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Sourceref" }, "phaseId": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Phaseid" }, "parentTodoId": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Parenttodoid" }, "sortOrder": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Sortorder" } }, "type": "object", "required": [ "title" ], "title": "FerryProgramTodoCreateRequest" }, "FerryProgramTodoUpdateRequest": { "properties": { "title": { "anyOf": [ { "type": "string", "maxLength": 500, "minLength": 1 }, { "type": "null" } ], "title": "Title" }, "titleJa": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Titleja" }, "description": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ], "title": "Description" }, "descriptionJa": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ], "title": "Descriptionja" }, "category": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Category" }, "required": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Required" }, "status": { "anyOf": [ { "type": "string", "enum": [ "not_started", "in_progress", "completed", "blocked" ] }, { "type": "null" } ], "title": "Status" }, "notes": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ], "title": "Notes" }, "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Startdate" }, "dueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duedate" }, "priority": { "anyOf": [ { "type": "string", "enum": [ "P0", "P1", "P2", "P3", "P4" ] }, { "type": "null" } ], "title": "Priority" }, "sourceRef": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Sourceref" }, "phaseId": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Phaseid" }, "parentTodoId": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Parenttodoid" }, "sortOrder": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Sortorder" } }, "type": "object", "title": "FerryProgramTodoUpdateRequest" }, "GetPublicAbsenceApiV2PublicAbsencesAbsenceIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicApprovalRuleOptionsApiV2PublicApprovalRulesOptionsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Approval Rule Options Api V2 Public Approval Rules Options Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicAttendanceRecordApiV2PublicAttendanceRecordsAttendanceRecordIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicAuthSessionApiV2PublicAuthSessionGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Auth Session Api V2 Public Auth Session Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicAuthWhoamiApiV2PublicAuthWhoamiGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "PublicDeveloperWhoamiData", "properties": { "user_id": { "title": "User Id", "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Username" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "workspace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" }, "workspace_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Code" }, "workspace_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Name" }, "auth_mode": { "enum": [ "developer_api_token", "oauth_app" ], "title": "Auth Mode", "type": "string" }, "principal_key": { "title": "Principal Key", "type": "string" }, "token_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Token Id" }, "token_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Token Name" }, "permission_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Permission Level" }, "permissions": { "items": { "type": "string" }, "title": "Permissions", "type": "array" }, "scopes": { "items": { "type": "string" }, "title": "Scopes", "type": "array" }, "oauth_app_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Oauth App Id" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "message": { "default": "OK", "title": "Message", "type": "string" } }, "required": [ "user_id", "auth_mode", "principal_key" ] }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicBillApiV2PublicBillsBillIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicCompanyApiV2PublicCompaniesCompanyIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicCompanyPriceTableApiV2PublicCompaniesCompanyIdPriceTableGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Company Price Table Api V2 Public Companies Company Id Price Table Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicContactApiV2PublicContactsContactIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicCustomObjectRecordApiV2PublicCustomObjectsCustomObjectIdRecordsRecordIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicDealApiV2PublicDealsDealIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicDeliveryRuleOptionsApiV2PublicDeliveryRulesOptionsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Delivery Rule Options Api V2 Public Delivery Rules Options Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicDisbursementApiV2PublicDisbursementsDisbursementIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicEstimateApiV2PublicEstimatesEstimateIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicExpenseApiV2PublicExpensesExpenseIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicExportJobCompatApiV2PublicExportsJobIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Export Job Compat Api V2 Public Exports Job Id Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicFerryDiagramApiV2PublicFerryDiagramsDiagramIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryDiagramData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicFerryProgramApiV2PublicFerryProgramsProgramIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryProgramData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicImportJobCompatApiV2PublicImportsJobIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Import Job Compat Api V2 Public Imports Job Id Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicIncentiveBatchApiV2PublicIncentivesBatchesBatchIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Incentive Batch Api V2 Public Incentives Batches Batch Id Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicInventoryApiV2PublicInventoriesInventoryIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicInventoryTransactionApiV2PublicInventoryTransactionsTransactionIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicInvoiceApiV2PublicInvoicesInvoiceIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicItemApiV2PublicItemsItemIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicJournalApiV2PublicJournalsJournalIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicLocationApiV2PublicLocationsLocationIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicLockRuleOptionsApiV2PublicLockRulesOptionsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Lock Rule Options Api V2 Public Lock Rules Options Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicMeterApiV2PublicMetersMeterIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicOrderApiV2PublicOrdersOrderIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicPaymentApiV2PublicPaymentsPaymentIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicPayrollRunApiV2PublicPayrollRunsRunIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Payroll Run Api V2 Public Payroll Runs Run Id Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicProjectApiV2PublicProjectsProjectIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/PublicProject" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicPurchaseOrderApiV2PublicPurchaseOrdersPurchaseOrderIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicReportApiV2PublicReportsReportIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Report Api V2 Public Reports Report Id Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicSlipApiV2PublicSlipsRevenueIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicSubscriptionApiV2PublicSubscriptionsSubscriptionIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicTaskApiV2PublicTasksTaskIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicTicketApiV2PublicTicketsTicketIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicTransferHistoryApiV2PublicTransfersHistoryIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Transfer History Api V2 Public Transfers History Id Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicViewApiV2PublicViewsViewIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public View Api V2 Public Views View Id Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicViewColumnsApiV2PublicViewsViewIdColumnsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public View Columns Api V2 Public Views View Id Columns Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicWorkflowApiV2PublicWorkflowsWorkflowIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/WorkflowDetailData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicWorkflowRunApiV2PublicWorkflowRunsRunIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Workflow Run Api V2 Public Workflow Runs Run Id Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "GetPublicWorkflowRunNestedCompatApiV2PublicWorkflowsRunsRunIdGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Get Public Workflow Run Nested Compat Api V2 Public Workflows Runs Run Id Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ImportJobCreateRequest": { "properties": { "object_type": { "type": "string", "title": "Object Type" }, "source_kind": { "type": "string", "title": "Source Kind", "default": "file" }, "file_format": { "type": "string", "title": "File Format", "default": "csv" }, "file_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "File Id" }, "custom_object_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Id" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" }, "mapping_template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mapping Template Id" }, "mapping_template_revision": { "anyOf": [ { "type": "integer", "minimum": 1.0 }, { "type": "null" } ], "title": "Mapping Template Revision" }, "mapping_template_state": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Mapping Template State" }, "record_ids": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Record Ids" }, "source_record": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Source Record", "description": "Provider-specific source metadata. For Stripe invoice/subscription backfills, use scope=all with optional days_ago, created_gte, and limit; bounded synchronous backfills support up to 200 records." }, "operation": { "type": "string", "title": "Operation", "default": "upsert" }, "mapping_mode": { "type": "string", "title": "Mapping Mode", "default": "auto" }, "key_field": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Key Field" }, "relation_key_map": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Relation Key Map" }, "column_mappings": { "items": { "$ref": "#/components/schemas/TransferColumnMapping" }, "type": "array", "title": "Column Mappings" }, "dry_run": { "type": "boolean", "title": "Dry Run", "default": false }, "idempotency_key": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Idempotency Key" }, "workflow_action_tracker_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Action Tracker Id" }, "action_tracker_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Tracker Id" }, "workflow_language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workflow Language" } }, "type": "object", "required": [ "object_type" ], "title": "ImportJobCreateRequest" }, "IncentiveAllocationsReplaceRequest": { "properties": { "source_object_type": { "type": "string", "title": "Source Object Type" }, "source_record_id": { "type": "string", "title": "Source Record Id" }, "allocations": { "items": { "$ref": "#/components/schemas/IncentiveAllocationLine" }, "type": "array", "title": "Allocations" } }, "type": "object", "required": [ "source_object_type", "source_record_id" ], "title": "IncentiveAllocationsReplaceRequest" }, "IncentiveApproveBulkRequest": { "properties": { "incentive_ids": { "items": { "type": "string" }, "type": "array", "title": "Incentive Ids" } }, "type": "object", "title": "IncentiveApproveBulkRequest" }, "IncentiveBatchCreateRequest": { "properties": { "period": { "type": "string", "title": "Period" } }, "type": "object", "required": [ "period" ], "title": "IncentiveBatchCreateRequest" }, "IncentiveBatchesListQuery": { "properties": { "page": { "type": "integer", "minimum": 1.0, "title": "Page", "default": 1 }, "limit": { "type": "integer", "maximum": 200.0, "minimum": 1.0, "title": "Limit", "default": 50 }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" } }, "type": "object", "title": "IncentiveBatchesListQuery" }, "IncentiveCalculateRequest": { "properties": { "period": { "type": "string", "title": "Period" }, "plan_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Plan Id" }, "owner_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner User Id" }, "dry_run": { "type": "boolean", "title": "Dry Run", "default": false } }, "type": "object", "required": [ "period" ], "title": "IncentiveCalculateRequest" }, "IncentivePlanCreateRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "base_event": { "type": "string", "title": "Base Event" }, "rate_type": { "type": "string", "title": "Rate Type" }, "rate_value": { "type": "number", "title": "Rate Value" }, "effective_from": { "type": "string", "format": "date", "title": "Effective From" }, "effective_to": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Effective To" }, "status": { "type": "string", "title": "Status", "default": "active" }, "source_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Status" }, "source_company_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Company Id" }, "payee_type": { "type": "string", "title": "Payee Type", "default": "user" }, "payee_company_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payee Company Id" }, "amount_basis": { "type": "string", "title": "Amount Basis", "default": "tax_exclusive" }, "min_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Min Amount" }, "max_payout_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max Payout Amount" } }, "type": "object", "required": [ "name", "base_event", "rate_type", "rate_value", "effective_from" ], "title": "IncentivePlanCreateRequest" }, "IncentivePlanUpdateRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "base_event": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Base Event" }, "source_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Status" }, "source_company_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Company Id" }, "payee_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payee Type" }, "payee_company_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Payee Company Id" }, "amount_basis": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Amount Basis" }, "rate_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rate Type" }, "rate_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Rate Value" }, "effective_from": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Effective From" }, "effective_to": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Effective To" }, "min_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Min Amount" }, "max_payout_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Max Payout Amount" } }, "type": "object", "title": "IncentivePlanUpdateRequest" }, "IncentivesListQuery": { "properties": { "page": { "type": "integer", "minimum": 1.0, "title": "Page", "default": 1 }, "limit": { "type": "integer", "maximum": 200.0, "minimum": 1.0, "title": "Limit", "default": 50 }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Period" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "owner_user_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner User Id" }, "source_object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Object Type" }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" }, "sort": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" }, "sort_direction": { "anyOf": [ { "type": "string", "enum": [ "asc", "desc" ] }, { "type": "null" } ], "title": "Sort Direction" } }, "type": "object", "title": "IncentivesListQuery" }, "IngestClaySignalApiV2LookoutConnectorsClaySignalsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/LookoutSignalData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "IngestProviderSignalApiV2LookoutConnectorsProviderSignalsPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/LookoutSignalData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "JournalCreateRequest": { "properties": { "data": { "additionalProperties": true, "type": "object", "title": "Data" }, "journal_transactions": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Journal Transactions" }, "form_set_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form Set Id" }, "view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, "type": "object", "title": "JournalCreateRequest" }, "JournalStatementViewCreateRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "view_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Type", "default": "profit_and_loss" }, "is_private": { "type": "boolean", "title": "Is Private", "default": false }, "balance_sheet_display": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Balance Sheet Display" }, "balance_sheet_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Balance Sheet Type" }, "date_range": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Date Range" }, "include_preview": { "type": "boolean", "title": "Include Preview", "default": true }, "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 25 } }, "type": "object", "title": "JournalStatementViewCreateRequest" }, "ListProviderActionsApiV2LookoutAdActionsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/LookoutProviderActionListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListProviderActionsApiV2LookoutProviderActionsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/LookoutProviderActionListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicAbsencesApiV2PublicAbsencesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicActivityLogsApiV2PublicLogsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ActivityLogListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicApprovalRulesApiV2PublicApprovalRulesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Approval Rules Api V2 Public Approval Rules Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicAssociationsApiV2PublicAssociationsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/RecordAssociationListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicAttendanceRecordsApiV2PublicAttendanceRecordsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicBillsApiV2PublicBillsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response 200 List Public Bills Api V2 Public Bills Get", "anyOf": [ { "$ref": "#/components/schemas/ObjectRecordListData" }, { "$ref": "#/components/schemas/ObjectRecordLineItemListData" } ] }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicBuyOffersApiV2PublicBuyOffersGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/OfferSnapshotListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicCompaniesApiV2PublicCompaniesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicContactsApiV2PublicContactsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicCustomObjectRecordsApiV2PublicCustomObjectsCustomObjectIdRecordsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicDealPipelinesApiV2PublicDealsPipelinesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Deal Pipelines Api V2 Public Deals Pipelines Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicDealsApiV2PublicDealsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicDeliveryRulesApiV2PublicDeliveryRulesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Delivery Rules Api V2 Public Delivery Rules Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicDeveloperPropertiesApiV2PublicPropertiesObjectNameGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Developer Properties Api V2 Public Properties Object Name Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicDisbursementAllocationsApiV2PublicDisbursementsDisbursementIdAllocationsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Disbursement Allocations Api V2 Public Disbursements Disbursement Id Allocations Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicDisbursementsApiV2PublicDisbursementsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicEmployeesApiV2PublicEmployeesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicEstimatesApiV2PublicEstimatesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response 200 List Public Estimates Api V2 Public Estimates Get", "anyOf": [ { "$ref": "#/components/schemas/ObjectRecordListData" }, { "$ref": "#/components/schemas/ObjectRecordLineItemListData" } ] }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicExpensesApiV2PublicExpensesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicExportJobsCompatApiV2PublicExportsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Export Jobs Compat Api V2 Public Exports Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicFerryDiagramsApiV2PublicFerryDiagramsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryDiagramListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicFerryProgramMeetingsApiV2PublicFerryProgramsProgramIdMeetingsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryProgramMeetingListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicFerryProgramsApiV2PublicFerryProgramsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryProgramListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicImportJobsCompatApiV2PublicImportsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Import Jobs Compat Api V2 Public Imports Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicIncentiveAllocationsApiV2PublicIncentivesAllocationsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Incentive Allocations Api V2 Public Incentives Allocations Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicIncentiveBatchesApiV2PublicIncentivesBatchesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Incentive Batches Api V2 Public Incentives Batches Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicIncentiveCompanyOptionsApiV2PublicIncentivesCompanyOptionsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Incentive Company Options Api V2 Public Incentives Company Options Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicIncentivePlansApiV2PublicIncentivesPlansGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Incentive Plans Api V2 Public Incentives Plans Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicIncentivesApiV2PublicIncentivesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Incentives Api V2 Public Incentives Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicInventoriesApiV2PublicInventoriesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicInventoryTransactionsApiV2PublicInventoryTransactionsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicInvoicesApiV2PublicInvoicesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response 200 List Public Invoices Api V2 Public Invoices Get", "anyOf": [ { "$ref": "#/components/schemas/ObjectRecordListData" }, { "$ref": "#/components/schemas/ObjectRecordLineItemListData" } ] }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicItemsApiV2PublicItemsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicJournalsApiV2PublicJournalsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicLocationsApiV2PublicLocationsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicLockRulesApiV2PublicLockRulesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Lock Rules Api V2 Public Lock Rules Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicMetersApiV2PublicMetersGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicObjectSchemasApiV2PublicObjectSchemasGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Object Schemas Api V2 Public Object Schemas Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicOrdersApiV2PublicOrdersGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response 200 List Public Orders Api V2 Public Orders Get", "anyOf": [ { "$ref": "#/components/schemas/ObjectRecordListData" }, { "$ref": "#/components/schemas/ObjectRecordLineItemListData" } ] }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicOverdueInvoicesApiV2PublicInvoicesOverdueGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Overdue Invoices Api V2 Public Invoices Overdue Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicPaymentAllocationsApiV2PublicPaymentsPaymentIdAllocationsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Payment Allocations Api V2 Public Payments Payment Id Allocations Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicPaymentsApiV2PublicPaymentsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicPayrollProfilesApiV2PublicPayrollProfilesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Payroll Profiles Api V2 Public Payroll Profiles Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicPayrollRunsApiV2PublicPayrollRunsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Payroll Runs Api V2 Public Payroll Runs Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicProjectsApiV2PublicProjectsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/PublicProjectListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicPurchaseOrdersApiV2PublicPurchaseOrdersGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response 200 List Public Purchase Orders Api V2 Public Purchase Orders Get", "anyOf": [ { "$ref": "#/components/schemas/ObjectRecordListData" }, { "$ref": "#/components/schemas/ObjectRecordLineItemListData" } ] }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicReportsApiV2PublicReportsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Reports Api V2 Public Reports Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicSlipsApiV2PublicSlipsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicSubscriptionsApiV2PublicSubscriptionsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response 200 List Public Subscriptions Api V2 Public Subscriptions Get", "anyOf": [ { "$ref": "#/components/schemas/ObjectRecordListData" }, { "$ref": "#/components/schemas/ObjectRecordLineItemListData" } ] }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicTasksApiV2PublicTasksGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicTicketPipelinesApiV2PublicTicketsPipelinesGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Ticket Pipelines Api V2 Public Tickets Pipelines Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicTicketsApiV2PublicTicketsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ObjectRecordListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicViewsApiV2PublicViewsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Views Api V2 Public Views Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicWorkflowActionsCompatApiV2PublicWorkflowsActionsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response List Public Workflow Actions Compat Api V2 Public Workflows Actions Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ListPublicWorkflowsApiV2PublicWorkflowsGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/WorkflowListData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "LookoutProviderActionCompleteRequest": { "properties": { "status": { "type": "string", "enum": [ "succeeded", "failed" ], "title": "Status" }, "provider_response": { "additionalProperties": true, "type": "object", "title": "Provider Response" }, "error": { "anyOf": [ { "type": "string", "maxLength": 4000 }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "status" ], "title": "LookoutProviderActionCompleteRequest" }, "LookoutSignalRequest": { "properties": { "provider": { "type": "string", "title": "Provider", "default": "lookout" }, "signal_type": { "type": "string", "title": "Signal Type" }, "dedupe_key": { "type": "string", "title": "Dedupe Key" }, "occurred_at": { "type": "string", "format": "date-time", "title": "Occurred At" }, "account": { "additionalProperties": true, "type": "object", "title": "Account" }, "contact": { "additionalProperties": true, "type": "object", "title": "Contact" }, "attributes": { "additionalProperties": true, "type": "object", "title": "Attributes" }, "source_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Url" }, "confidence": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Confidence" }, "raw_payload": { "additionalProperties": true, "type": "object", "title": "Raw Payload" } }, "additionalProperties": true, "type": "object", "required": [ "signal_type", "dedupe_key" ], "title": "LookoutSignalRequest" }, "MarkPublicIncentiveBatchPaidApiV2PublicIncentivesBatchesBatchIdMarkPaidPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Mark Public Incentive Batch Paid Api V2 Public Incentives Batches Batch Id Mark Paid Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "McpToolCallLogRequest": { "properties": { "tool_name": { "type": "string", "title": "Tool Name" }, "tool_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tool Title" }, "resource": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Resource" }, "operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Operation" }, "success": { "type": "boolean", "title": "Success", "default": true }, "duration_ms": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Duration Ms" }, "client_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Name" }, "client_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Version" }, "source_ip_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Ip Address" }, "source_user_agent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source User Agent" }, "source_browser": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Browser" }, "source_os": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Os" }, "source_device_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Device Type" }, "mcp_protocol_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mcp Protocol Version" }, "mcp_server_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mcp Server Name" }, "mcp_server_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mcp Server Version" }, "model_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Provider" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Name" }, "result_summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Result Summary" }, "record_ids": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Record Ids" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" } }, "type": "object", "required": [ "tool_name" ], "title": "McpToolCallLogRequest" }, "MutatePublicObjectSchemaApiV2PublicObjectSchemasPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Mutate Public Object Schema Api V2 Public Object Schemas Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ObjectRecordBulkActionRequest": { "properties": { "ids": { "items": { "type": "string" }, "type": "array", "title": "Ids" }, "flag_all": { "type": "boolean", "title": "Flag All", "default": false }, "properties": { "additionalProperties": true, "type": "object", "title": "Properties" }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "usage_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" }, "view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" } }, "type": "object", "title": "ObjectRecordBulkActionRequest" }, "ObjectRecordCreateRequest": { "properties": { "view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" }, "form_view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" }, "cost_line_items": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Cost Line Items" }, "line_items": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Line Items" }, "properties": { "additionalProperties": { "anyOf": [ {}, { "type": "null" } ] }, "type": "object", "minProperties": 1, "title": "Properties" } }, "type": "object", "title": "ObjectRecordCreateRequest" }, "ObjectRecordUpdateRequest": { "properties": { "view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" }, "form_view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" }, "associations": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Associations" }, "cost_line_items": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Cost Line Items" }, "files": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Files" }, "line_items": { "anyOf": [ { "items": {}, "type": "array" }, { "type": "null" } ], "title": "Line Items" }, "properties": { "additionalProperties": { "anyOf": [ {}, { "type": "null" } ] }, "type": "object", "title": "Properties" } }, "type": "object", "title": "ObjectRecordUpdateRequest" }, "ObjectSchemaMutationRequest": { "properties": { "operation": { "type": "string", "title": "Operation", "default": "create" }, "target": { "type": "string", "title": "Target", "default": "sanka" }, "schema_ref": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Schema Ref" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Slug" }, "dry_run": { "type": "boolean", "title": "Dry Run", "default": false }, "confirm": { "type": "boolean", "title": "Confirm", "default": false }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" } }, "additionalProperties": true, "type": "object", "title": "ObjectSchemaMutationRequest" }, "OrderBulkCreateRequest": { "properties": { "orders": { "items": { "$ref": "#/components/schemas/OrderBulkOrderRequest" }, "type": "array", "minItems": 1, "title": "Orders" }, "create_missing_items": { "type": "boolean", "title": "Create Missing Items", "default": false }, "trigger_workflows": { "type": "boolean", "title": "Trigger Workflows", "default": false } }, "type": "object", "title": "OrderBulkCreateRequest" }, "PaymentAllocationsUpdateRequest": { "properties": { "allocations": { "items": { "$ref": "#/components/schemas/PaymentAllocationSaveInput" }, "type": "array", "title": "Allocations" } }, "type": "object", "title": "PaymentAllocationsUpdateRequest" }, "PayrollJournalEntryRequest": { "properties": { "debit_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Debit Account" }, "credit_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Credit Account" }, "deductions_account": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deductions Account" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" } }, "type": "object", "title": "PayrollJournalEntryRequest" }, "PayrollProfileUpsertRequest": { "properties": { "employee_id": { "type": "string", "title": "Employee Id" }, "jurisdiction_country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Jurisdiction Country Code" }, "pay_type": { "type": "string", "title": "Pay Type", "default": "monthly" }, "base_salary": { "type": "number", "title": "Base Salary", "default": 0.0 }, "hourly_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Hourly Rate" }, "scheduled_monthly_hours": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Scheduled Monthly Hours" }, "tax_table_type": { "type": "string", "title": "Tax Table Type", "default": "ko" }, "dependent_count": { "type": "integer", "title": "Dependent Count", "default": 0 }, "resident_tax_monthly_amount": { "type": "number", "title": "Resident Tax Monthly Amount", "default": 0.0 }, "standard_monthly_remuneration": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Standard Monthly Remuneration" }, "health_insurance_prefecture_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Health Insurance Prefecture Code" }, "is_health_insurance_enrolled": { "type": "boolean", "title": "Is Health Insurance Enrolled", "default": false }, "is_care_insurance_enrolled": { "type": "boolean", "title": "Is Care Insurance Enrolled", "default": false }, "is_pension_enrolled": { "type": "boolean", "title": "Is Pension Enrolled", "default": false }, "is_employment_insurance_enrolled": { "type": "boolean", "title": "Is Employment Insurance Enrolled", "default": false }, "effective_from": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Effective From" }, "effective_to": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Effective To" }, "extra_settings": { "additionalProperties": true, "type": "object", "title": "Extra Settings" } }, "type": "object", "required": [ "employee_id" ], "title": "PayrollProfileUpsertRequest" }, "PayrollRunCalculateRequest": { "properties": { "period": { "type": "string", "title": "Period" }, "pay_date": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Pay Date" }, "country_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country Code" } }, "type": "object", "required": [ "period" ], "title": "PayrollRunCalculateRequest" }, "PermanentDeletePublicInvoiceApiV2PublicInvoicesInvoiceIdPermanentDeleteDelete200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Permanent Delete Public Invoice Api V2 Public Invoices Invoice Id Permanent Delete Delete" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "PreviewPublicFreeeInvoiceExportApiV2PublicInvoicesExportsFreeePreviewPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Preview Public Freee Invoice Export Api V2 Public Invoices Exports Freee Preview Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "PreviewPublicHubspotCommissionIncentiveApiV2PublicIncentivesCommissionHubspotPreviewPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Preview Public Hubspot Commission Incentive Api V2 Public Incentives Commission Hubspot Preview Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "PreviewPublicHubspotEstimateDraftApiV2PublicEstimatesDraftsHubspotPreviewPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Preview Public Hubspot Estimate Draft Api V2 Public Estimates Drafts Hubspot Preview Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "PreviewPublicHubspotInvoiceDraftApiV2PublicInvoicesDraftsHubspotPreviewPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Preview Public Hubspot Invoice Draft Api V2 Public Invoices Drafts Hubspot Preview Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "PreviewPublicHubspotOrderHandoffApiV2PublicOrdersHandoffsHubspotPreviewPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Preview Public Hubspot Order Handoff Api V2 Public Orders Handoffs Hubspot Preview Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "PreviewPublicMoneyforwardInvoiceExportApiV2PublicInvoicesExportsMoneyforwardPreviewPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Preview Public Moneyforward Invoice Export Api V2 Public Invoices Exports Moneyforward Preview Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "PreviewPublicSalesforceQuoteReadinessApiV2PublicCpqQuoteReadinessSalesforcePreviewPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Preview Public Salesforce Quote Readiness Api V2 Public Cpq Quote Readiness Salesforce Preview Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "PreviewPublicWorkflowCompatApiV2PublicWorkflowRunsPreviewPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Preview Public Workflow Compat Api V2 Public Workflow Runs Preview Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ProspectCompaniesApiV2ProspectCompaniesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/ProspectCompaniesData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ProspectCompaniesRequest": { "properties": { "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry" }, "min_employee_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Min Employee Count" }, "max_employee_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Employee Count" }, "limit": { "type": "integer", "title": "Limit", "default": 10 }, "sources": { "items": { "type": "string" }, "type": "array", "title": "Sources" } }, "type": "object", "title": "ProspectCompaniesRequest" }, "PublicApprovalRuleSaveRequest": { "properties": { "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" }, "rule_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rule Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "default": "" }, "is_active": { "type": "boolean", "title": "Is Active", "default": true }, "order": { "type": "integer", "title": "Order", "default": 0 }, "conditions": { "additionalProperties": true, "type": "object", "title": "Conditions" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "block_save": { "type": "boolean", "title": "Block Save", "default": false }, "block_targets": { "items": { "type": "string" }, "type": "array", "title": "Block Targets" }, "approver_user_ids": { "items": { "type": "string" }, "type": "array", "title": "Approver User Ids" }, "worker_scope_type": { "type": "string", "title": "Worker Scope Type", "default": "all" }, "worker_ids": { "items": { "type": "string" }, "type": "array", "title": "Worker Ids" } }, "additionalProperties": true, "type": "object", "required": [ "name" ], "title": "PublicApprovalRuleSaveRequest" }, "PublicAssociationMutationRequest": { "properties": { "source_ref": { "$ref": "#/components/schemas/RecordRef" }, "target_ref": { "$ref": "#/components/schemas/RecordRef" }, "definition_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Definition Id" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key" }, "confirm_association_warnings": { "type": "boolean", "title": "Confirm Association Warnings", "default": false } }, "type": "object", "required": [ "source_ref", "target_ref" ], "title": "PublicAssociationMutationRequest" }, "PublicCustomObjectRecordMutationRequest": { "properties": { "external_object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Object Type" }, "data": { "additionalProperties": { "anyOf": [ {}, { "type": "null" } ] }, "type": "object", "title": "Data" }, "view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" }, "form_view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" } }, "type": "object", "title": "PublicCustomObjectRecordMutationRequest" }, "PublicDeliveryRuleSaveRequest": { "properties": { "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" }, "rule_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rule Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "default": "" }, "is_active": { "type": "boolean", "title": "Is Active", "default": true }, "order": { "type": "integer", "title": "Order", "default": 0 }, "conditions": { "additionalProperties": true, "type": "object", "title": "Conditions" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "action": { "type": "string", "title": "Action", "default": "send" }, "required_fields": { "items": { "type": "string" }, "type": "array", "title": "Required Fields" } }, "additionalProperties": true, "type": "object", "required": [ "name" ], "title": "PublicDeliveryRuleSaveRequest" }, "PublicExpenseMutationRequest": { "properties": { "view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" }, "form_view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" }, "properties": { "additionalProperties": true, "type": "object", "title": "Properties" }, "base_currency": { "anyOf": [ { "type": "number", "minimum": 0.0 }, { "type": "null" } ], "title": "Base Currency", "description": "Explicit amount in the workspace base currency. When omitted, Sanka calculates the value from the expense amount and currency. A provided value takes precedence over automatic conversion." } }, "additionalProperties": true, "type": "object", "title": "PublicExpenseMutationRequest", "description": "Public expense mutation envelope with typed SDK-friendly overrides." }, "PublicInvoiceEmailRequest": { "properties": { "action": { "type": "string", "enum": [ "draft", "send", "schedule" ], "title": "Action", "default": "send" }, "to": { "items": { "type": "string" }, "type": "array", "title": "To" }, "cc": { "items": { "type": "string" }, "type": "array", "title": "Cc" }, "subject": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Subject" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Body" }, "scheduled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Scheduled At" }, "template_select": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Select" }, "additional_pdf_attachments": { "items": { "$ref": "#/components/schemas/PublicInvoiceEmailPdfAttachment" }, "type": "array", "title": "Additional Pdf Attachments" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, "type": "object", "title": "PublicInvoiceEmailRequest" }, "PublicLockRuleSaveRequest": { "properties": { "object": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object" }, "rule_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Rule Id" }, "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description", "default": "" }, "is_active": { "type": "boolean", "title": "Is Active", "default": true }, "order": { "type": "integer", "title": "Order", "default": 0 }, "conditions": { "additionalProperties": true, "type": "object", "title": "Conditions" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "lock_scope": { "type": "string", "title": "Lock Scope", "default": "full_record" }, "lock_config": { "additionalProperties": true, "type": "object", "title": "Lock Config" } }, "additionalProperties": true, "type": "object", "required": [ "name" ], "title": "PublicLockRuleSaveRequest" }, "PublicObjectRecordMutationRequest": { "properties": { "view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" }, "form_view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" }, "properties": { "additionalProperties": true, "type": "object", "title": "Properties" }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target", "default": "sanka" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" }, "external_object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Object Type" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "operation": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Operation" }, "dry_run": { "type": "boolean", "title": "Dry Run", "default": false }, "confirm": { "type": "boolean", "title": "Confirm", "default": false } }, "additionalProperties": true, "type": "object", "title": "PublicObjectRecordMutationRequest" }, "PublicProjectRequest": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "default": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Default" }, "statuses": { "anyOf": [ { "items": { "$ref": "#/components/schemas/PublicProjectStatusRequest" }, "type": "array" }, { "type": "null" } ], "title": "Statuses" } }, "type": "object", "title": "PublicProjectRequest" }, "PublicPropertyMutationRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type" }, "internal_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Internal Name" }, "choice_values": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "title": "Choice Values" }, "choice_labels": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Choice Labels" }, "choice_colors": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Choice Colors" }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target", "default": "sanka" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "custom_object_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Id" }, "custom_object_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Slug" }, "editor_variant": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Editor Variant" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scope" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" }, "external_object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Object Type" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "field_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Field Type" }, "group_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Name" }, "options": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Options" }, "dry_run": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Dry Run" }, "confirm": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Confirm" } }, "additionalProperties": true, "type": "object", "title": "PublicPropertyMutationRequest" }, "PublicRecordAggregateRequest": { "properties": { "object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" }, "scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scope", "default": "sanka" }, "external_object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Object Type" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" }, "select": { "items": { "type": "string" }, "type": "array", "title": "Select" }, "match_fields": { "items": { "type": "string" }, "type": "array", "title": "Match Fields" }, "min_count": { "type": "integer", "minimum": 2.0, "title": "Min Count", "default": 2 }, "scan_limit": { "type": "integer", "maximum": 500.0, "minimum": 1.0, "title": "Scan Limit", "default": 250 }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" }, "q": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" }, "sort": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" }, "filters": { "items": { "$ref": "#/components/schemas/RecordFilterRequest" }, "type": "array", "title": "Filters" }, "mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mode" }, "page": { "type": "integer", "minimum": 1.0, "title": "Page", "default": 1 }, "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 25 }, "metrics": { "items": { "type": "string" }, "type": "array", "title": "Metrics" }, "group_by": { "items": { "type": "string" }, "type": "array", "title": "Group By" } }, "additionalProperties": true, "type": "object", "title": "PublicRecordAggregateRequest" }, "PublicRecordQueryRequest": { "properties": { "object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" }, "scope": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Scope", "default": "sanka" }, "external_object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Object Type" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" }, "select": { "items": { "type": "string" }, "type": "array", "title": "Select" }, "match_fields": { "items": { "type": "string" }, "type": "array", "title": "Match Fields" }, "min_count": { "type": "integer", "minimum": 2.0, "title": "Min Count", "default": 2 }, "scan_limit": { "type": "integer", "maximum": 500.0, "minimum": 1.0, "title": "Scan Limit", "default": 250 }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Search" }, "q": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" }, "sort": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" }, "filters": { "items": { "$ref": "#/components/schemas/RecordFilterRequest" }, "type": "array", "title": "Filters" }, "mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mode" }, "page": { "type": "integer", "minimum": 1.0, "title": "Page", "default": 1 }, "limit": { "type": "integer", "maximum": 100.0, "minimum": 1.0, "title": "Limit", "default": 25 }, "cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cursor" } }, "additionalProperties": true, "type": "object", "title": "PublicRecordQueryRequest" }, "PublicWorkflowMutationRequest": { "properties": { "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "trigger_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trigger Type" }, "trigger_every": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Trigger Every" }, "is_trigger_active": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Trigger Active" }, "object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" }, "trigger": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Trigger" }, "actions": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Actions" }, "nodes": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Nodes" }, "config": { "additionalProperties": true, "type": "object", "title": "Config" }, "platform_payload": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Platform Payload" }, "dry_run": { "type": "boolean", "title": "Dry Run", "default": false }, "confirm": { "type": "boolean", "title": "Confirm", "default": false }, "revision_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Revision Id" } }, "additionalProperties": true, "type": "object", "title": "PublicWorkflowMutationRequest" }, "PublicWorkflowResolveRecordRequest": { "properties": { "query": { "type": "string", "title": "Query" }, "object_type": { "type": "string", "title": "Object Type", "default": "deal" }, "source_system": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source System" }, "limit": { "type": "integer", "maximum": 20.0, "minimum": 1.0, "title": "Limit", "default": 5 } }, "type": "object", "required": [ "query" ], "title": "PublicWorkflowResolveRecordRequest" }, "PublicWorkflowRunRequest": { "properties": { "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "channel_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channel Id" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" }, "options": { "additionalProperties": true, "type": "object", "title": "Options" }, "payload": { "additionalProperties": true, "type": "object", "title": "Payload" }, "dry_run": { "type": "boolean", "title": "Dry Run", "default": false }, "confirm": { "type": "boolean", "title": "Confirm", "default": false } }, "type": "object", "title": "PublicWorkflowRunRequest" }, "PublicWorkflowRuntimeRequest": { "properties": { "workflow_type": { "type": "string", "title": "Workflow Type" }, "source_record": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Source Record" }, "options": { "additionalProperties": true, "type": "object", "title": "Options" }, "idempotency_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency Key" }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Language" }, "lang": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lang" } }, "type": "object", "required": [ "workflow_type" ], "title": "PublicWorkflowRuntimeRequest" }, "QueryPublicRecordsApiV2PublicRecordsQueryPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Query Public Records Api V2 Public Records Query Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "RecordPublicAuthMcpToolCallApiV2PublicAuthMcpSessionToolCallLogPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Record Public Auth Mcp Tool Call Api V2 Public Auth Mcp Session Tool Call Log Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "RejectApprovalRequestApiV2PublicApprovalRequestsHistoryIdRejectPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Reject Approval Request Api V2 Public Approval Requests History Id Reject Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ReplacePublicIncentiveAllocationsApiV2PublicIncentivesAllocationsPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Replace Public Incentive Allocations Api V2 Public Incentives Allocations Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ReportMutationRequest": { "properties": { "name": { "type": "string", "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "description_ja": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description Ja" }, "panel_type": { "type": "string", "title": "Panel Type" }, "data_source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Source Type" }, "object_sources": { "items": { "type": "string" }, "type": "array", "title": "Object Sources" }, "breakdown": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Breakdown" }, "x_axis": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X Axis" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "dashboard_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dashboard Id" }, "update_dashboard_assignment": { "type": "boolean", "title": "Update Dashboard Assignment", "default": false }, "is_forecast": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Forecast" }, "is_stacked_chart": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Stacked Chart" }, "is_realtime": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Realtime" }, "ratio": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ratio" }, "filter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filter" }, "meta_data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta Data" }, "metrics": { "items": { "$ref": "#/components/schemas/ReportMetricMutationItem" }, "type": "array", "title": "Metrics" }, "advanced": { "additionalProperties": true, "type": "object", "title": "Advanced" } }, "type": "object", "required": [ "name", "panel_type" ], "title": "ReportMutationRequest" }, "ReportUpdateMutationRequest": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "description_ja": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description Ja" }, "panel_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Panel Type" }, "data_source_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Source Type" }, "object_sources": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Object Sources" }, "breakdown": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Breakdown" }, "x_axis": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "X Axis" }, "owner_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Owner Id" }, "dashboard_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Dashboard Id" }, "update_dashboard_assignment": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Update Dashboard Assignment" }, "is_forecast": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Forecast" }, "is_stacked_chart": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Stacked Chart" }, "is_realtime": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Realtime" }, "ratio": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Ratio" }, "filter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filter" }, "meta_data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta Data" }, "metrics": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ReportMetricMutationItem" }, "type": "array" }, { "type": "null" } ], "title": "Metrics" }, "advanced": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Advanced" } }, "type": "object", "title": "ReportUpdateMutationRequest" }, "ResolvePublicWorkflowRecordApiV2PublicWorkflowRunsResolveRecordPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Resolve Public Workflow Record Api V2 Public Workflow Runs Resolve Record Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "RetrievePublicDeveloperPropertyApiV2PublicPropertiesObjectNamePropertyRefGet200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Retrieve Public Developer Property Api V2 Public Properties Object Name Property Ref Get" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "RevokePublicAuthSessionApiV2PublicAuthSessionRevokePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Revoke Public Auth Session Api V2 Public Auth Session Revoke Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "RunPublicWorkflowApiV2PublicWorkflowsWorkflowIdRunPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Run Public Workflow Api V2 Public Workflows Workflow Id Run Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ScoreRecordApiV2ScorePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Score Record Api V2 Score Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ScoreRequest": { "properties": { "object_type": { "type": "string", "title": "Object Type" }, "record_id": { "type": "string", "format": "uuid", "title": "Record Id" }, "score_model_id": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ], "title": "Score Model Id" } }, "type": "object", "required": [ "object_type", "record_id" ], "title": "ScoreRequest" }, "SendPublicInvoiceEmailApiV2PublicInvoicesInvoiceIdEmailPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/PublicInvoiceEmailData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "StartPublicFreeeInvoiceExportApiV2PublicInvoicesExportsFreeePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Start Public Freee Invoice Export Api V2 Public Invoices Exports Freee Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "StartPublicHubspotEstimateDraftApiV2PublicEstimatesDraftsHubspotPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Start Public Hubspot Estimate Draft Api V2 Public Estimates Drafts Hubspot Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "StartPublicHubspotInvoiceDraftApiV2PublicInvoicesDraftsHubspotPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Start Public Hubspot Invoice Draft Api V2 Public Invoices Drafts Hubspot Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "StartPublicHubspotOrderHandoffApiV2PublicOrdersHandoffsHubspotPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Start Public Hubspot Order Handoff Api V2 Public Orders Handoffs Hubspot Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "StartPublicHubspotRevenueControlReportApiV2PublicReportsRevenueControlHubspotPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Start Public Hubspot Revenue Control Report Api V2 Public Reports Revenue Control Hubspot Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "StartPublicMoneyforwardInvoiceExportApiV2PublicInvoicesExportsMoneyforwardPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Start Public Moneyforward Invoice Export Api V2 Public Invoices Exports Moneyforward Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "StartPublicWorkflowCompatApiV2PublicWorkflowRunsStartPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Start Public Workflow Compat Api V2 Public Workflow Runs Start Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "SummarizePublicSalesforceQuoteReadinessApiV2PublicCpqQuoteReadinessSalesforceSummaryPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Summarize Public Salesforce Quote Readiness Api V2 Public Cpq Quote Readiness Salesforce Summary Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "SwitchPublicAuthMcpSessionWorkspaceApiV2PublicAuthMcpSessionSwitchWorkspacePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Switch Public Auth Mcp Session Workspace Api V2 Public Auth Mcp Session Switch Workspace Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "SwitchPublicAuthSessionWorkspaceApiV2PublicAuthSessionSwitchWorkspacePost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Switch Public Auth Session Workspace Api V2 Public Auth Session Switch Workspace Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicAbsenceApiV2PublicAbsencesAbsenceIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Absence Api V2 Public Absences Absence Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicAttendanceRecordApiV2PublicAttendanceRecordsAttendanceRecordIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Attendance Record Api V2 Public Attendance Records Attendance Record Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicBillApiV2PublicBillsBillIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Bill Api V2 Public Bills Bill Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicCompanyApiV2PublicCompaniesCompanyIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Company Api V2 Public Companies Company Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicCompanyPriceTableCompanyApiV2PublicCompaniesCompanyIdPriceTableCompanyPatch200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Company Price Table Company Api V2 Public Companies Company Id Price Table Company Patch" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicCompanyPriceTableItemApiV2PublicCompaniesCompanyIdPriceTableItemsItemIdPatch200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Company Price Table Item Api V2 Public Companies Company Id Price Table Items Item Id Patch" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicContactApiV2PublicContactsContactIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Contact Api V2 Public Contacts Contact Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicCustomObjectRecordApiV2PublicCustomObjectsCustomObjectIdRecordsRecordIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Custom Object Record Api V2 Public Custom Objects Custom Object Id Records Record Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicCustomObjectRecordCompatibilityApiV2PublicRecordsCustomObjectsRecordsRecordIdPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Custom Object Record Compatibility Api V2 Public Records Custom Objects Records Record Id Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicDealApiV2PublicDealsDealIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Deal Api V2 Public Deals Deal Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicDeveloperPropertyApiV2PublicPropertiesObjectNamePropertyRefPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Developer Property Api V2 Public Properties Object Name Property Ref Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicDisbursementAllocationApiV2PublicDisbursementsDisbursementIdAllocationsAllocationIdPatch200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Disbursement Allocation Api V2 Public Disbursements Disbursement Id Allocations Allocation Id Patch" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicDisbursementApiV2PublicDisbursementsDisbursementIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Disbursement Api V2 Public Disbursements Disbursement Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicEstimateApiV2PublicEstimatesEstimateIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Estimate Api V2 Public Estimates Estimate Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicExpenseApiV2PublicExpensesExpenseIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Expense Api V2 Public Expenses Expense Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicFerryDiagramApiV2PublicFerryDiagramsDiagramIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryDiagramData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicFerryProgramMeetingApiV2PublicFerryProgramsProgramIdMeetingsMeetingIdPatch200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryProgramMeetingData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicFerryProgramTodoApiV2PublicFerryProgramsProgramIdTodosTodoIdPatch200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/FerryProgramData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicIncentivePlanApiV2PublicIncentivesPlansPlanIdPatch200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Incentive Plan Api V2 Public Incentives Plans Plan Id Patch" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicInventoryApiV2PublicInventoriesInventoryIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Inventory Api V2 Public Inventories Inventory Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicInventoryTransactionApiV2PublicInventoryTransactionsTransactionIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Inventory Transaction Api V2 Public Inventory Transactions Transaction Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicInvoiceApiV2PublicInvoicesInvoiceIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Invoice Api V2 Public Invoices Invoice Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicItemApiV2PublicItemsItemIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Item Api V2 Public Items Item Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicJournalApiV2PublicJournalsJournalIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Journal Api V2 Public Journals Journal Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicLocationApiV2PublicLocationsLocationIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Location Api V2 Public Locations Location Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicMeterApiV2PublicMetersMeterIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Meter Api V2 Public Meters Meter Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicOrderApiV2PublicOrdersOrderIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Order Api V2 Public Orders Order Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicPaymentAllocationsApiV2PublicPaymentsPaymentIdAllocationsPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Payment Allocations Api V2 Public Payments Payment Id Allocations Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicPaymentApiV2PublicPaymentsPaymentIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Payment Api V2 Public Payments Payment Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicProjectApiV2PublicProjectsProjectIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "$ref": "#/components/schemas/PublicProjectMutationData" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicPurchaseOrderApiV2PublicPurchaseOrdersPurchaseOrderIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Purchase Order Api V2 Public Purchase Orders Purchase Order Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicReportApiV2PublicReportsReportIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Report Api V2 Public Reports Report Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicSlipApiV2PublicSlipsRevenueIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Slip Api V2 Public Slips Revenue Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicSubscriptionApiV2PublicSubscriptionsSubscriptionIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Subscription Api V2 Public Subscriptions Subscription Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicTaskApiV2PublicTasksTaskIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Task Api V2 Public Tasks Task Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicTicketApiV2PublicTicketsTicketIdPut200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Ticket Api V2 Public Tickets Ticket Id Put" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicTicketStatusApiV2PublicTicketsTicketIdStatusPatch200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Ticket Status Api V2 Public Tickets Ticket Id Status Patch" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicViewApiV2PublicViewsViewIdPatch200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public View Api V2 Public Views View Id Patch" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpdatePublicWorkflowApiV2PublicWorkflowsWorkflowIdPatch200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Update Public Workflow Api V2 Public Workflows Workflow Id Patch" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UploadPublicBillFileApiV2PublicBillsFilesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Upload Public Bill File Api V2 Public Bills Files Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UploadPublicEstimateFileApiV2PublicEstimatesFilesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Upload Public Estimate File Api V2 Public Estimates Files Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UploadPublicExpenseFileApiV2PublicExpensesFilesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Upload Public Expense File Api V2 Public Expenses Files Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UploadPublicFileApiV2PublicFilesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Upload Public File Api V2 Public Files Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UploadPublicInvoiceFileApiV2PublicInvoicesFilesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Upload Public Invoice File Api V2 Public Invoices Files Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UploadPublicOrderFileApiV2PublicOrdersFilesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Upload Public Order File Api V2 Public Orders Files Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UploadPublicPurchaseOrderFileApiV2PublicPurchaseOrdersFilesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Upload Public Purchase Order File Api V2 Public Purchase Orders Files Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpsertPublicApprovalRuleApiV2PublicApprovalRulesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Upsert Public Approval Rule Api V2 Public Approval Rules Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpsertPublicDeliveryRuleApiV2PublicDeliveryRulesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Upsert Public Delivery Rule Api V2 Public Delivery Rules Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpsertPublicLockRuleApiV2PublicLockRulesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Upsert Public Lock Rule Api V2 Public Lock Rules Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "UpsertPublicPayrollProfileApiV2PublicPayrollProfilesPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Upsert Public Payroll Profile Api V2 Public Payroll Profiles Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ViewCreateRequest": { "properties": { "title": { "type": "string", "title": "Title" }, "object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" }, "custom_object_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Id" }, "form_view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Form View Id" }, "visibility": { "type": "string", "enum": [ "workspace", "private" ], "title": "Visibility", "default": "workspace" }, "mode": { "type": "string", "enum": [ "table", "component", "component_table", "item_list", "kanban", "calendar", "project", "forecast", "group", "receivable_balance", "payable_balance", "pnl", "balance_sheet" ], "title": "Mode", "default": "table" }, "group_field_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Field Id" }, "column_field_ids": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "title": "Column Field Ids" }, "subtotal_calculations": { "items": { "$ref": "#/components/schemas/ViewSubtotalCalculation" }, "type": "array", "maxItems": 100, "title": "Subtotal Calculations" } }, "type": "object", "required": [ "title" ], "title": "ViewCreateRequest" }, "ViewUpdateRequest": { "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "visibility": { "anyOf": [ { "type": "string", "enum": [ "workspace", "private" ] }, { "type": "null" } ], "title": "Visibility" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "table", "component", "component_table", "item_list", "kanban", "calendar", "project", "forecast", "group", "receivable_balance", "payable_balance", "pnl", "balance_sheet" ] }, { "type": "null" } ], "title": "Mode" }, "group_field_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Group Field Id" } }, "type": "object", "title": "ViewUpdateRequest" }, "WritebackPublicSalesforceQuoteReadinessApiV2PublicCpqQuoteReadinessSalesforceWritebackPost200Envelope": { "type": "object", "required": [ "success", "data", "meta" ], "properties": { "success": { "type": "boolean", "const": true }, "data": { "type": "object", "additionalProperties": true, "title": "Response Writeback Public Salesforce Quote Readiness Api V2 Public Cpq Quote Readiness Salesforce Writeback Post" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "ErrorEnvelope": { "type": "object", "required": [ "success", "error", "meta" ], "properties": { "success": { "type": "boolean", "const": false }, "error": { "$ref": "#/components/schemas/ErrorBody" }, "meta": { "$ref": "#/components/schemas/EnvelopeMeta" } } }, "EnvelopeMeta": { "type": "object", "required": [ "ctx_id" ], "properties": { "ctx_id": { "type": "string" }, "pagination": { "$ref": "#/components/schemas/PaginationMeta" }, "toast": { "$ref": "#/components/schemas/ToastMessage" } } }, "FerryProgramTodoBatchUpsertData": { "properties": { "program": { "$ref": "#/components/schemas/FerryProgramData" }, "createdCount": { "type": "integer", "title": "Createdcount" }, "updatedCount": { "type": "integer", "title": "Updatedcount" } }, "type": "object", "required": [ "program", "createdCount", "updatedCount" ], "title": "FerryProgramTodoBatchUpsertData" }, "ObjectRecordBulkActionData": { "properties": { "operation": { "type": "string", "enum": [ "edit", "archive", "activate", "permanent_delete" ], "title": "Operation" }, "object_type": { "type": "string", "title": "Object Type" }, "ids": { "items": { "type": "string" }, "type": "array", "title": "Ids" }, "affected_ids": { "items": { "type": "string" }, "type": "array", "title": "Affected Ids" }, "failed_ids": { "items": { "type": "string" }, "type": "array", "title": "Failed Ids" }, "count": { "type": "integer", "title": "Count", "default": 0 }, "failed_count": { "type": "integer", "title": "Failed Count", "default": 0 }, "queued": { "type": "boolean", "title": "Queued", "default": false }, "background_job_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Background Job Id" }, "message": { "type": "string", "title": "Message" }, "toast": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Toast" } }, "type": "object", "required": [ "operation", "object_type", "message" ], "title": "ObjectRecordBulkActionData" }, "LookoutProviderActionData": { "properties": { "id": { "type": "string", "title": "Id" }, "workspace_id": { "type": "string", "title": "Workspace Id" }, "run_id": { "type": "string", "title": "Run Id" }, "provider": { "type": "string", "enum": [ "google_ads", "meta_ads", "hubspot" ], "title": "Provider" }, "action_slug": { "type": "string", "title": "Action Slug" }, "target_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target Id" }, "campaign_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Campaign Id" }, "input_data": { "additionalProperties": true, "type": "object", "title": "Input Data" }, "safety": { "additionalProperties": true, "type": "object", "title": "Safety" }, "status": { "type": "string", "enum": [ "queued", "claimed", "succeeded", "failed" ], "title": "Status" }, "provider_response": { "additionalProperties": true, "type": "object", "title": "Provider Response" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Error" }, "claimed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Claimed At" }, "completed_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Completed At" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At" } }, "type": "object", "required": [ "id", "workspace_id", "run_id", "provider", "action_slug", "status", "created_at", "updated_at" ], "title": "LookoutProviderActionData" }, "AssociationEdgeMutationData": { "properties": { "edge": { "anyOf": [ { "$ref": "#/components/schemas/AssociationEdge" }, { "type": "null" } ] }, "edges": { "items": { "$ref": "#/components/schemas/AssociationEdge" }, "type": "array", "title": "Edges" }, "edge_ids": { "items": { "type": "string" }, "type": "array", "title": "Edge Ids" }, "created": { "type": "boolean", "title": "Created", "default": false }, "deleted": { "type": "boolean", "title": "Deleted", "default": false }, "replaced": { "type": "boolean", "title": "Replaced", "default": false }, "ctx_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ctx Id" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "title": "AssociationEdgeMutationData" }, "FerryDiagramData": { "properties": { "name": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Name" }, "description": { "type": "string", "maxLength": 500, "title": "Description", "default": "" }, "nodes": { "items": { "$ref": "#/components/schemas/FerryDiagramNode" }, "type": "array", "maxItems": 250, "title": "Nodes" }, "edges": { "items": { "$ref": "#/components/schemas/FerryDiagramEdge" }, "type": "array", "maxItems": 500, "title": "Edges" }, "viewport": { "$ref": "#/components/schemas/FerryDiagramViewport" }, "id": { "type": "string", "title": "Id" }, "workspaceId": { "type": "string", "title": "Workspaceid" }, "revision": { "type": "integer", "title": "Revision" }, "createdById": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Createdbyid" }, "updatedById": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updatedbyid" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "Createdat" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "Updatedat" } }, "additionalProperties": false, "type": "object", "required": [ "name", "id", "workspaceId", "revision" ], "title": "FerryDiagramData" }, "FerryProgramMeetingData": { "properties": { "id": { "type": "string", "title": "Id" }, "programId": { "type": "string", "title": "Programid" }, "workspaceId": { "type": "string", "title": "Workspaceid" }, "title": { "type": "string", "title": "Title" }, "meetingAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "Meetingat" }, "contentMarkdown": { "type": "string", "title": "Contentmarkdown", "default": "" }, "sourceRef": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sourceref" }, "createdById": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Createdbyid" }, "updatedById": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updatedbyid" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "Createdat" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "Updatedat" } }, "type": "object", "required": [ "id", "programId", "workspaceId", "title" ], "title": "FerryProgramMeetingData" }, "FerryProgramData": { "properties": { "id": { "type": "string", "title": "Id" }, "workspaceId": { "type": "string", "title": "Workspaceid" }, "templateSlug": { "type": "string", "title": "Templateslug" }, "status": { "type": "string", "enum": [ "draft", "active", "ready", "completed", "archived" ], "title": "Status" }, "plan": { "type": "string", "enum": [ "self_serve", "sakura_led", "expert_led" ], "title": "Plan", "default": "self_serve" }, "planChangeLocked": { "type": "boolean", "title": "Planchangelocked", "default": false }, "paymentState": { "type": "string", "enum": [ "draft", "awaiting_payment", "active" ], "title": "Paymentstate", "default": "active" }, "billingCurrency": { "type": "string", "enum": [ "jpy", "usd" ], "title": "Billingcurrency", "default": "jpy" }, "recordCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Recordcount" }, "listPrice": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Listprice" }, "quotedPrice": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Quotedprice" }, "feeWaived": { "type": "boolean", "title": "Feewaived", "default": false }, "feeWaiverReason": { "type": "string", "title": "Feewaiverreason", "default": "" }, "description": { "type": "string", "title": "Description", "default": "" }, "expertUserId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Expertuserid" }, "expertReviewThreadId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Expertreviewthreadid" }, "expertSettings": { "additionalProperties": true, "type": "object", "title": "Expertsettings" }, "entitlements": { "additionalProperties": true, "type": "object", "title": "Entitlements" }, "name": { "type": "string", "title": "Name" }, "updatesMarkdown": { "type": "string", "title": "Updatesmarkdown", "default": "" }, "sources": { "items": { "$ref": "#/components/schemas/FerryProgramEndpoint" }, "type": "array", "title": "Sources" }, "destinations": { "items": { "$ref": "#/components/schemas/FerryProgramEndpoint" }, "type": "array", "title": "Destinations" }, "todos": { "items": { "$ref": "#/components/schemas/FerryProgramTodo" }, "type": "array", "title": "Todos" }, "taskPhases": { "items": { "$ref": "#/components/schemas/FerryProgramPhase" }, "type": "array", "title": "Taskphases" }, "linkedRunIds": { "items": { "type": "string" }, "type": "array", "title": "Linkedrunids" }, "createdById": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Createdbyid" }, "updatedById": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updatedbyid" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "Createdat" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "Updatedat" } }, "type": "object", "required": [ "id", "workspaceId", "templateSlug", "status", "name" ], "title": "FerryProgramData" }, "PublicProjectMutationData": { "properties": { "ok": { "type": "boolean", "title": "Ok" }, "status": { "type": "string", "title": "Status" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "project": { "anyOf": [ { "$ref": "#/components/schemas/PublicProject" }, { "type": "null" } ] }, "ctx_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ctx Id" }, "advisories": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Advisories" } }, "type": "object", "required": [ "ok", "status" ], "title": "PublicProjectMutationData" }, "FerryDiagramDeleteData": { "properties": { "id": { "type": "string", "title": "Id" }, "deleted": { "type": "boolean", "title": "Deleted" } }, "type": "object", "required": [ "id", "deleted" ], "title": "FerryDiagramDeleteData" }, "PublicProjectDeleteData": { "properties": { "ok": { "type": "boolean", "title": "Ok" }, "status": { "type": "string", "title": "Status" }, "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Project Id" }, "replacement_project_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Replacement Project Id" }, "cleared_task_count": { "type": "integer", "title": "Cleared Task Count", "default": 0 }, "reassigned_task_count": { "type": "integer", "title": "Reassigned Task Count", "default": 0 }, "ctx_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ctx Id" }, "advisories": { "anyOf": [ { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, { "type": "null" } ], "title": "Advisories" } }, "type": "object", "required": [ "ok", "status" ], "title": "PublicProjectDeleteData" }, "EnrichData": { "properties": { "company_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Id" }, "seed_external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Seed External Id" }, "run_id": { "type": "string", "title": "Run Id" }, "pipeline_version": { "type": "string", "title": "Pipeline Version" }, "request_hash": { "type": "string", "title": "Request Hash" }, "updated_builtin_fields": { "additionalProperties": true, "type": "object", "title": "Updated Builtin Fields" }, "updated_custom_fields": { "additionalProperties": true, "type": "object", "title": "Updated Custom Fields" }, "proposed_fields": { "additionalProperties": true, "type": "object", "title": "Proposed Fields" }, "field_evidence": { "additionalProperties": true, "type": "object", "title": "Field Evidence" }, "skipped_fields": { "additionalProperties": true, "type": "object", "title": "Skipped Fields" }, "provider_meta": { "additionalProperties": true, "type": "object", "title": "Provider Meta" } }, "type": "object", "required": [ "run_id", "pipeline_version", "request_hash" ], "title": "EnrichData" }, "EnrichCompanySeed": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "External Id" } }, "type": "object", "title": "EnrichCompanySeed" }, "ExportTemplateFilterFieldInput": { "properties": { "filter_type": { "type": "string", "title": "Filter Type", "default": "" }, "filter_option": { "type": "string", "title": "Filter Option", "default": "is" }, "filter_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter Value" } }, "type": "object", "title": "ExportTemplateFilterFieldInput" }, "FerryDiagramEdge": { "properties": { "id": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Id" }, "source": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Source" }, "target": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Target" }, "label": { "type": "string", "maxLength": 255, "title": "Label", "default": "" }, "type": { "type": "string", "enum": [ "default", "smoothstep" ], "title": "Type", "default": "smoothstep" }, "sourceHandle": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Sourcehandle" }, "targetHandle": { "anyOf": [ { "type": "string", "maxLength": 120 }, { "type": "null" } ], "title": "Targethandle" } }, "additionalProperties": false, "type": "object", "required": [ "id", "source", "target" ], "title": "FerryDiagramEdge" }, "FerryDiagramNode": { "properties": { "id": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Id" }, "type": { "type": "string", "enum": [ "objectTable", "process", "note" ], "title": "Type" }, "position": { "$ref": "#/components/schemas/FerryDiagramPosition" }, "data": { "$ref": "#/components/schemas/FerryDiagramNodeData" } }, "additionalProperties": false, "type": "object", "required": [ "id", "type", "position", "data" ], "title": "FerryDiagramNode" }, "FerryDiagramViewport": { "properties": { "x": { "type": "number", "maximum": 1000000.0, "minimum": -1000000.0, "title": "X", "default": 0 }, "y": { "type": "number", "maximum": 1000000.0, "minimum": -1000000.0, "title": "Y", "default": 0 }, "zoom": { "type": "number", "maximum": 4.0, "minimum": 0.1, "title": "Zoom", "default": 1 } }, "additionalProperties": false, "type": "object", "title": "FerryDiagramViewport" }, "FerryProgramTodoBatchUpsertItem": { "properties": { "title": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Title" }, "titleJa": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Titleja" }, "description": { "type": "string", "maxLength": 20000, "title": "Description", "default": "" }, "descriptionJa": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ], "title": "Descriptionja" }, "category": { "type": "string", "maxLength": 100, "title": "Category", "default": "custom" }, "required": { "type": "boolean", "title": "Required", "default": false }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "completed", "blocked" ], "title": "Status", "default": "not_started" }, "notes": { "anyOf": [ { "type": "string", "maxLength": 20000 }, { "type": "null" } ], "title": "Notes" }, "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Startdate" }, "dueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duedate" }, "priority": { "type": "string", "enum": [ "P0", "P1", "P2", "P3", "P4" ], "title": "Priority", "default": "P2" }, "sourceRef": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Sourceref" }, "phaseId": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Phaseid" }, "parentTodoId": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Parenttodoid" }, "sortOrder": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Sortorder" }, "id": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Id" } }, "type": "object", "required": [ "title" ], "title": "FerryProgramTodoBatchUpsertItem" }, "ObjectRecordData": { "properties": { "id": { "type": "string", "title": "Id" }, "record_id": { "type": "string", "title": "Record Id" }, "object_type": { "type": "string", "title": "Object Type" }, "custom_object_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Id" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "usage_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Usage Status" }, "properties": { "additionalProperties": { "anyOf": [ {}, { "type": "null" } ] }, "type": "object", "title": "Properties" }, "display_properties": { "additionalProperties": { "$ref": "#/components/schemas/ObjectRecordDisplayValue" }, "type": "object", "title": "Display Properties" } }, "type": "object", "required": [ "id", "record_id", "object_type" ], "title": "ObjectRecordData" }, "PublicProject": { "properties": { "id": { "type": "string", "title": "Id" }, "project_id": { "type": "string", "title": "Project Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "default": { "type": "boolean", "title": "Default", "default": false }, "statuses": { "items": { "$ref": "#/components/schemas/PublicProjectStatus" }, "type": "array", "title": "Statuses" }, "task_count": { "type": "integer", "title": "Task Count", "default": 0 }, "active_task_count": { "type": "integer", "title": "Active Task Count", "default": 0 }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" } }, "type": "object", "required": [ "id", "project_id" ], "title": "PublicProject" }, "WorkflowDetailData": { "properties": { "workflow": { "$ref": "#/components/schemas/WorkflowListItem" }, "permission": { "type": "string", "title": "Permission", "default": "read" }, "classifications": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Classifications" }, "message": { "type": "string", "title": "Message", "default": "OK" } }, "type": "object", "required": [ "workflow" ], "title": "WorkflowDetailData" }, "TransferColumnMapping": { "properties": { "source_header": { "type": "string", "title": "Source Header" }, "target_field": { "type": "string", "title": "Target Field" } }, "type": "object", "required": [ "source_header", "target_field" ], "title": "TransferColumnMapping" }, "IncentiveAllocationLine": { "properties": { "owner_id": { "type": "string", "title": "Owner Id" }, "allocation_percent": { "type": "number", "title": "Allocation Percent" } }, "type": "object", "required": [ "owner_id", "allocation_percent" ], "title": "IncentiveAllocationLine" }, "LookoutSignalData": { "properties": { "provider": { "type": "string", "title": "Provider", "default": "lookout" }, "signal_type": { "type": "string", "title": "Signal Type" }, "dedupe_key": { "type": "string", "title": "Dedupe Key" }, "occurred_at": { "type": "string", "format": "date-time", "title": "Occurred At" }, "account": { "additionalProperties": true, "type": "object", "title": "Account" }, "contact": { "additionalProperties": true, "type": "object", "title": "Contact" }, "attributes": { "additionalProperties": true, "type": "object", "title": "Attributes" }, "source_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source Url" }, "confidence": { "anyOf": [ { "type": "number", "maximum": 1.0, "minimum": 0.0 }, { "type": "null" } ], "title": "Confidence" }, "raw_payload": { "additionalProperties": true, "type": "object", "title": "Raw Payload" }, "id": { "type": "string", "title": "Id" }, "workspace_id": { "type": "string", "title": "Workspace Id" }, "status": { "type": "string", "title": "Status", "default": "received" }, "received_at": { "type": "string", "format": "date-time", "title": "Received At" }, "duplicate": { "type": "boolean", "title": "Duplicate", "default": false }, "dispatched_motion_ids": { "items": { "type": "string" }, "type": "array", "title": "Dispatched Motion Ids" } }, "additionalProperties": true, "type": "object", "required": [ "signal_type", "dedupe_key", "id", "workspace_id", "received_at" ], "title": "LookoutSignalData" }, "LookoutProviderActionListData": { "properties": { "items": { "items": { "$ref": "#/components/schemas/LookoutProviderActionData" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total", "default": 0 } }, "type": "object", "title": "LookoutProviderActionListData" }, "ObjectRecordListData": { "properties": { "object_type": { "type": "string", "title": "Object Type" }, "view": { "$ref": "#/components/schemas/ObjectRecordViewData" }, "columns": { "items": { "type": "string" }, "type": "array", "title": "Columns" }, "column_labels": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Column Labels" }, "items": { "items": { "$ref": "#/components/schemas/ObjectRecordData" }, "type": "array", "title": "Items" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total": { "type": "integer", "title": "Total" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "subtotals": { "items": { "$ref": "#/components/schemas/ObjectRecordSubtotalResult" }, "type": "array", "title": "Subtotals" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "required": [ "object_type", "view", "columns", "page", "page_size", "total" ], "title": "ObjectRecordListData" }, "ActivityLogListData": { "properties": { "logs": { "items": { "$ref": "#/components/schemas/ActivityLogItem" }, "type": "array", "title": "Logs" }, "page": { "type": "integer", "title": "Page" }, "limit": { "type": "integer", "title": "Limit" }, "count": { "type": "integer", "title": "Count" }, "total": { "type": "integer", "title": "Total" }, "has_next": { "type": "boolean", "title": "Has Next" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Page" }, "pagination": { "$ref": "#/components/schemas/ActivityLogPagination" }, "message": { "type": "string", "title": "Message", "default": "OK" } }, "type": "object", "required": [ "page", "limit", "count", "total", "has_next", "pagination" ], "title": "ActivityLogListData" }, "RecordAssociationListData": { "properties": { "record_ref": { "$ref": "#/components/schemas/RecordRef" }, "items": { "items": { "$ref": "#/components/schemas/AssociationEdge" }, "type": "array", "title": "Items" }, "page": { "type": "integer", "title": "Page", "default": 1 }, "page_size": { "type": "integer", "title": "Page Size", "default": 50 }, "total": { "type": "integer", "title": "Total", "default": 0 }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "required": [ "record_ref" ], "title": "RecordAssociationListData" }, "ObjectRecordLineItemListData": { "properties": { "object_type": { "type": "string", "title": "Object Type" }, "view": { "$ref": "#/components/schemas/ObjectRecordViewData" }, "columns": { "items": { "type": "string" }, "type": "array", "title": "Columns" }, "column_labels": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Column Labels" }, "items": { "items": { "$ref": "#/components/schemas/ObjectRecordLineItemRowData" }, "type": "array", "title": "Items" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total": { "type": "integer", "title": "Total" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "required": [ "object_type", "view", "columns", "page", "page_size", "total" ], "title": "ObjectRecordLineItemListData" }, "OfferSnapshotListData": { "properties": { "items": { "items": { "$ref": "#/components/schemas/OfferSnapshotData" }, "type": "array", "title": "Items" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total": { "type": "integer", "title": "Total" }, "message": { "type": "string", "title": "Message", "default": "OK" } }, "type": "object", "required": [ "items", "page", "page_size", "total" ], "title": "OfferSnapshotListData" }, "FerryDiagramListData": { "properties": { "diagrams": { "items": { "$ref": "#/components/schemas/FerryDiagramSummary" }, "type": "array", "title": "Diagrams" }, "count": { "type": "integer", "title": "Count" } }, "type": "object", "required": [ "diagrams", "count" ], "title": "FerryDiagramListData" }, "FerryProgramMeetingListData": { "properties": { "meetings": { "items": { "$ref": "#/components/schemas/FerryProgramMeetingData" }, "type": "array", "title": "Meetings" }, "count": { "type": "integer", "title": "Count" } }, "type": "object", "required": [ "meetings", "count" ], "title": "FerryProgramMeetingListData" }, "FerryProgramListData": { "properties": { "programs": { "items": { "$ref": "#/components/schemas/FerryProgramData" }, "type": "array", "title": "Programs" }, "count": { "type": "integer", "title": "Count" } }, "type": "object", "required": [ "programs", "count" ], "title": "FerryProgramListData" }, "PublicProjectListData": { "properties": { "items": { "items": { "$ref": "#/components/schemas/PublicProject" }, "type": "array", "title": "Items" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "total": { "type": "integer", "title": "Total" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "required": [ "items", "page", "page_size", "total" ], "title": "PublicProjectListData" }, "WorkflowListData": { "properties": { "items": { "items": { "$ref": "#/components/schemas/WorkflowListItem" }, "type": "array", "title": "Items" }, "total": { "type": "integer", "title": "Total" }, "page": { "type": "integer", "title": "Page" }, "page_size": { "type": "integer", "title": "Page Size" }, "has_next_page": { "type": "boolean", "title": "Has Next Page" }, "permission": { "type": "string", "title": "Permission", "default": "read" }, "columns": { "items": { "$ref": "#/components/schemas/WorkflowColumn" }, "type": "array", "title": "Columns" }, "classifications": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Classifications" }, "message": { "type": "string", "title": "Message", "default": "OK" } }, "type": "object", "required": [ "total", "page", "page_size", "has_next_page" ], "title": "WorkflowListData" }, "OrderBulkOrderRequest": { "properties": { "external_id": { "type": "string", "title": "External Id" }, "items": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OrderLineItemMutationRequest" }, "type": "array" }, { "type": "null" } ], "title": "Items" }, "line_items": { "anyOf": [ { "items": { "$ref": "#/components/schemas/OrderLineItemMutationRequest" }, "type": "array" }, { "type": "null" } ], "title": "Line Items" }, "company_external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company External Id" }, "company_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Company Id" }, "delivery_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery Status" }, "order_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Order At" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" } }, "type": "object", "required": [ "external_id" ], "title": "OrderBulkOrderRequest" }, "PaymentAllocationSaveInput": { "properties": { "invoice_id": { "type": "string", "title": "Invoice Id" }, "amount": { "type": "number", "title": "Amount" }, "adjustment_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Adjustment Amount", "default": 0 }, "adjustment_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Adjustment Type" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source", "default": "manual" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes", "default": "" } }, "type": "object", "required": [ "invoice_id", "amount" ], "title": "PaymentAllocationSaveInput" }, "ProspectCompaniesData": { "properties": { "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" }, "parsed_filters": { "$ref": "#/components/schemas/ProspectCompaniesFilters" }, "results": { "items": { "$ref": "#/components/schemas/ProspectCompanyData" }, "type": "array", "title": "Results" }, "count": { "type": "integer", "title": "Count" }, "provider_meta": { "additionalProperties": true, "type": "object", "title": "Provider Meta" } }, "type": "object", "required": [ "parsed_filters", "count" ], "title": "ProspectCompaniesData" }, "RecordRef": { "properties": { "object_type": { "type": "string", "title": "Object Type" }, "record_id": { "type": "string", "title": "Record Id" }, "custom_object_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Object Id" } }, "type": "object", "required": [ "object_type", "record_id" ], "title": "RecordRef" }, "PublicInvoiceEmailPdfAttachment": { "properties": { "object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" }, "record_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Record Id" }, "template_select": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Select" }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filename" } }, "type": "object", "title": "PublicInvoiceEmailPdfAttachment" }, "PublicProjectStatusRequest": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "internal_value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Internal Value" }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" } }, "type": "object", "title": "PublicProjectStatusRequest" }, "RecordFilterRequest": { "properties": { "field": { "type": "string", "title": "Field" }, "operator": { "type": "string", "title": "Operator", "default": "equals" }, "value": { "title": "Value" } }, "type": "object", "required": [ "field" ], "title": "RecordFilterRequest" }, "ReportMetricMutationItem": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "role": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Role" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "metric": { "type": "string", "title": "Metric" }, "metric_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Metric Type" }, "order": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Order" }, "filter": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Filter" }, "data_source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Data Source" }, "sort": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sort" }, "meta_data": { "anyOf": [ { "additionalProperties": true, "type": "object" }, { "type": "null" } ], "title": "Meta Data" }, "raw_sql": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Raw Sql" }, "display_result": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Result" } }, "type": "object", "required": [ "metric" ], "title": "ReportMetricMutationItem" }, "PublicInvoiceEmailData": { "properties": { "workspace_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Id" }, "workspace_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Workspace Code" }, "app_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "App Url" }, "invoice_id": { "type": "string", "title": "Invoice Id" }, "formatted_invoice_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Formatted Invoice Id" }, "action": { "type": "string", "enum": [ "draft", "send", "schedule" ], "title": "Action" }, "status": { "type": "string", "title": "Status" }, "thread_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Thread Id" }, "message_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message Id" }, "to": { "items": { "type": "string" }, "type": "array", "title": "To" }, "cc": { "items": { "type": "string" }, "type": "array", "title": "Cc" }, "scheduled_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Scheduled At" }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider" }, "provider_message_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider Message Id" }, "attachment_count": { "type": "integer", "title": "Attachment Count", "default": 0 }, "attachments": { "items": { "$ref": "#/components/schemas/PublicInvoiceEmailAttachmentData" }, "type": "array", "title": "Attachments" }, "message": { "type": "string", "title": "Message", "default": "OK" } }, "type": "object", "required": [ "invoice_id", "action", "status" ], "title": "PublicInvoiceEmailData" }, "ViewSubtotalCalculation": { "properties": { "field_id": { "type": "string", "title": "Field Id" }, "operation": { "type": "string", "enum": [ "count", "sum", "avg", "median", "min", "max" ], "title": "Operation" }, "scope": { "type": "string", "enum": [ "page", "view" ], "title": "Scope", "default": "view" } }, "type": "object", "required": [ "field_id", "operation" ], "title": "ViewSubtotalCalculation" }, "ErrorBody": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": {} } }, "PaginationMeta": { "type": "object", "required": [ "page", "page_size", "total" ], "properties": { "page": { "type": "integer", "minimum": 1 }, "page_size": { "type": "integer", "minimum": 1, "maximum": 500 }, "total": { "type": "integer", "minimum": 0 }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "ToastMessage": { "type": "object", "required": [ "variant", "code", "message", "i18n" ], "properties": { "variant": { "type": "string", "enum": [ "success", "error", "info", "warning" ] }, "code": { "type": "string" }, "message": { "type": "string" }, "i18n": { "$ref": "#/components/schemas/ToastMessageI18n" } } }, "AssociationEdge": { "properties": { "id": { "type": "string", "title": "Id" }, "workspace_id": { "type": "string", "title": "Workspace Id" }, "definition_id": { "type": "string", "title": "Definition Id" }, "source_ref": { "$ref": "#/components/schemas/RecordRef" }, "target_ref": { "$ref": "#/components/schemas/RecordRef" }, "direction": { "type": "string", "enum": [ "source", "target" ], "title": "Direction", "default": "source" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "display_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Label" }, "reverse_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Reverse Label" }, "is_default_definition": { "type": "boolean", "title": "Is Default Definition", "default": false }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created By" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "deleted_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Deleted At" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "required": [ "id", "workspace_id", "definition_id", "source_ref", "target_ref" ], "title": "AssociationEdge" }, "FerryProgramEndpoint": { "properties": { "id": { "type": "string", "title": "Id" }, "kind": { "type": "string", "title": "Kind" }, "label": { "type": "string", "title": "Label" }, "labelJa": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Labelja" }, "role": { "type": "string", "enum": [ "source", "destination" ], "title": "Role" }, "integrationSlug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Integrationslug" }, "channelId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Channelid" }, "sourceType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sourcetype" }, "objectTypes": { "items": { "type": "string" }, "type": "array", "title": "Objecttypes" }, "metadata": { "additionalProperties": true, "type": "object", "title": "Metadata" } }, "type": "object", "required": [ "id", "kind", "label", "role" ], "title": "FerryProgramEndpoint" }, "FerryProgramPhase": { "properties": { "id": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Id" }, "name": { "type": "string", "maxLength": 200, "minLength": 1, "title": "Name" }, "nameJa": { "anyOf": [ { "type": "string", "maxLength": 200 }, { "type": "null" } ], "title": "Nameja" }, "sortOrder": { "type": "integer", "minimum": 0.0, "title": "Sortorder", "default": 0 } }, "type": "object", "required": [ "id", "name" ], "title": "FerryProgramPhase" }, "FerryProgramTodo": { "properties": { "id": { "type": "string", "title": "Id" }, "title": { "type": "string", "title": "Title" }, "titleJa": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Titleja" }, "description": { "type": "string", "title": "Description", "default": "" }, "descriptionJa": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Descriptionja" }, "category": { "type": "string", "title": "Category", "default": "planning" }, "required": { "type": "boolean", "title": "Required", "default": true }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "completed", "blocked" ], "title": "Status", "default": "not_started" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Notes" }, "startDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Startdate" }, "dueDate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Duedate" }, "priority": { "type": "string", "enum": [ "P0", "P1", "P2", "P3", "P4" ], "title": "Priority", "default": "P2" }, "sourceRef": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Sourceref" }, "phaseId": { "anyOf": [ { "type": "string", "maxLength": 100 }, { "type": "null" } ], "title": "Phaseid" }, "parentTodoId": { "anyOf": [ { "type": "string", "maxLength": 500 }, { "type": "null" } ], "title": "Parenttodoid" }, "sortOrder": { "anyOf": [ { "type": "integer", "minimum": 0.0 }, { "type": "null" } ], "title": "Sortorder" } }, "type": "object", "required": [ "id", "title" ], "title": "FerryProgramTodo" }, "FerryDiagramNodeData": { "properties": { "label": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Label" }, "description": { "type": "string", "maxLength": 4000, "title": "Description", "default": "" }, "fields": { "items": { "type": "string" }, "type": "array", "maxItems": 100, "title": "Fields" }, "moduleName": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Modulename" }, "objectKey": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Objectkey" }, "objectSlug": { "anyOf": [ { "type": "string", "maxLength": 255 }, { "type": "null" } ], "title": "Objectslug" }, "color": { "type": "string", "enum": [ "default", "brand", "success", "warning", "danger" ], "title": "Color", "default": "default" } }, "additionalProperties": false, "type": "object", "required": [ "label" ], "title": "FerryDiagramNodeData" }, "FerryDiagramPosition": { "properties": { "x": { "type": "number", "maximum": 1000000.0, "minimum": -1000000.0, "title": "X" }, "y": { "type": "number", "maximum": 1000000.0, "minimum": -1000000.0, "title": "Y" } }, "additionalProperties": false, "type": "object", "required": [ "x", "y" ], "title": "FerryDiagramPosition" }, "ObjectRecordDisplayValue": { "properties": { "type": { "type": "string", "title": "Type" }, "value": { "title": "Value" }, "display": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "values": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Values" }, "files": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Files" }, "images": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Images" }, "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Count" }, "multiple": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Multiple" }, "show_badge": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Show Badge" }, "badge_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Badge Color" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" }, "table_cell": { "anyOf": [ { "$ref": "#/components/schemas/ObjectRecordTableCellPayload" }, { "type": "null" } ] } }, "type": "object", "required": [ "type" ], "title": "ObjectRecordDisplayValue" }, "PublicProjectStatus": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "name": { "type": "string", "title": "Name" }, "internal_value": { "type": "string", "title": "Internal Value" }, "order": { "type": "integer", "title": "Order", "default": 0 } }, "type": "object", "required": [ "name", "internal_value" ], "title": "PublicProjectStatus" }, "WorkflowListItem": { "properties": { "id": { "type": "string", "title": "Id" }, "workflow_id": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Workflow Id" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title" }, "title_ja": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Title Ja" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "description_ja": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description Ja" }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status" }, "status_display": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Display" }, "emoji": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Emoji" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "is_trigger_active": { "type": "boolean", "title": "Is Trigger Active", "default": false }, "trigger_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Trigger Type" }, "valid_to_run": { "type": "boolean", "title": "Valid To Run", "default": false }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" }, "updated_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Updated At" }, "last_run": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Last Run" }, "total_history": { "type": "integer", "title": "Total History", "default": 0 }, "total_review": { "type": "integer", "title": "Total Review", "default": 0 }, "owner": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowUserSummary" }, { "type": "null" } ] }, "created_by": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowUserSummary" }, { "type": "null" } ] }, "last_updated_by": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowUserSummary" }, { "type": "null" } ] }, "trigger_node": { "anyOf": [ { "$ref": "#/components/schemas/WorkflowTriggerNode" }, { "type": "null" } ] } }, "type": "object", "required": [ "id" ], "title": "WorkflowListItem" }, "ObjectRecordSubtotalResult": { "properties": { "field_id": { "type": "string", "title": "Field Id" }, "operation": { "type": "string", "enum": [ "count", "sum", "avg", "median", "min", "max" ], "title": "Operation" }, "value": { "title": "Value" }, "value_type": { "type": "string", "title": "Value Type" }, "count": { "type": "integer", "title": "Count", "default": 0 }, "formatted": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Formatted" }, "scope": { "type": "string", "enum": [ "page", "view" ], "title": "Scope", "default": "page" } }, "type": "object", "required": [ "field_id", "operation", "value_type" ], "title": "ObjectRecordSubtotalResult" }, "ObjectRecordViewData": { "properties": { "view_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "View Id" }, "view_type": { "type": "string", "title": "View Type", "default": "list" } }, "type": "object", "title": "ObjectRecordViewData" }, "ActivityLogItem": { "properties": { "id": { "type": "string", "title": "Id" }, "display_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Id" }, "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action" }, "target": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Target" }, "object_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Type" }, "object_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Id" }, "object_display": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Object Display" }, "field_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Field Name" }, "old_value": { "title": "Old Value" }, "new_value": { "title": "New Value" }, "action_uid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Uid" }, "actor": { "anyOf": [ { "$ref": "#/components/schemas/ActivityLogActor" }, { "type": "null" } ] }, "environment": { "anyOf": [ { "$ref": "#/components/schemas/ActivityLogEnvironment" }, { "type": "null" } ] }, "governance_execution_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Governance Execution Id" }, "created_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Created At" } }, "type": "object", "required": [ "id" ], "title": "ActivityLogItem" }, "ActivityLogPagination": { "properties": { "page": { "type": "integer", "title": "Page" }, "limit": { "type": "integer", "title": "Limit" }, "has_next": { "type": "boolean", "title": "Has Next" }, "next_page": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Page" }, "total": { "type": "integer", "title": "Total" } }, "type": "object", "required": [ "page", "limit", "has_next", "total" ], "title": "ActivityLogPagination" }, "ObjectRecordLineItemRowData": { "properties": { "row_id": { "type": "string", "title": "Row Id" }, "record_id": { "type": "string", "title": "Record Id" }, "record_number": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Record Number" }, "display_properties": { "additionalProperties": { "$ref": "#/components/schemas/ObjectRecordDisplayValue" }, "type": "object", "title": "Display Properties" } }, "type": "object", "required": [ "row_id", "record_id" ], "title": "ObjectRecordLineItemRowData" }, "OfferSnapshotData": { "properties": { "id": { "type": "string", "title": "Id" }, "buy_request_id": { "type": "string", "title": "Buy Request Id" }, "buy_request_line_id": { "type": "string", "title": "Buy Request Line Id" }, "sourcing_run_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Sourcing Run Id" }, "provider": { "type": "string", "title": "Provider" }, "merchant_key": { "type": "string", "title": "Merchant Key" }, "merchant_name": { "type": "string", "title": "Merchant Name" }, "merchant_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Merchant Domain" }, "provider_product_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Provider Product Id" }, "upid": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Upid" }, "title": { "type": "string", "title": "Title" }, "variant_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Variant Title" }, "product_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Product Url" }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Image Url" }, "quantity": { "type": "number", "title": "Quantity" }, "unit_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Price" }, "shipping_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Shipping Amount" }, "tax_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tax Amount" }, "total_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Amount" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "availability": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Availability" }, "delivery_estimate": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Delivery Estimate" }, "raw_snapshot": { "additionalProperties": true, "type": "object", "title": "Raw Snapshot" }, "snapshot_hash": { "type": "string", "title": "Snapshot Hash" }, "snapshot_version": { "type": "integer", "title": "Snapshot Version" }, "captured_at": { "type": "string", "format": "date-time", "title": "Captured At" }, "expires_at": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "title": "Expires At" } }, "type": "object", "required": [ "id", "buy_request_id", "buy_request_line_id", "provider", "merchant_key", "merchant_name", "title", "quantity", "snapshot_hash", "snapshot_version", "captured_at" ], "title": "OfferSnapshotData" }, "FerryDiagramSummary": { "properties": { "id": { "type": "string", "title": "Id" }, "name": { "type": "string", "title": "Name" }, "description": { "type": "string", "title": "Description", "default": "" }, "nodeCount": { "type": "integer", "title": "Nodecount", "default": 0 }, "edgeCount": { "type": "integer", "title": "Edgecount", "default": 0 }, "revision": { "type": "integer", "title": "Revision" }, "createdById": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Createdbyid" }, "updatedById": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Updatedbyid" }, "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "Createdat" }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "string" }, { "type": "null" } ], "title": "Updatedat" } }, "type": "object", "required": [ "id", "name", "revision" ], "title": "FerryDiagramSummary" }, "WorkflowColumn": { "properties": { "key": { "type": "string", "title": "Key" }, "label": { "type": "string", "title": "Label" } }, "type": "object", "required": [ "key", "label" ], "title": "WorkflowColumn" }, "OrderLineItemMutationRequest": { "properties": { "line_item_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Line Item Id" }, "item_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Item Id" }, "item_external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Item External Id" }, "custom_item_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Item Name" }, "quantity": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Quantity" }, "unit_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Unit Price" }, "tax_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Tax Rate" }, "tax_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tax Type" }, "total_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Price" }, "total_price_without_tax": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Total Price Without Tax" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Currency" }, "row_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Row Type" }, "section_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Section Label" }, "section_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Section Type" }, "custom_fields": { "additionalProperties": true, "type": "object", "title": "Custom Fields" } }, "type": "object", "title": "OrderLineItemMutationRequest" }, "ProspectCompaniesFilters": { "properties": { "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Query" }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry" }, "min_employee_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Min Employee Count" }, "max_employee_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Max Employee Count" } }, "type": "object", "title": "ProspectCompaniesFilters" }, "ProspectCompanyData": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Url" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "industry": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Industry" }, "employee_count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Employee Count" }, "employee_count_display": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Employee Count Display" }, "address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Address" }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Email" }, "phone_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone Number" }, "linkedin_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Linkedin Url" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "source_urls": { "items": { "type": "string" }, "type": "array", "title": "Source Urls" }, "sources": { "items": { "type": "string" }, "type": "array", "title": "Sources" }, "relevance_score": { "type": "number", "title": "Relevance Score", "default": 0.0 }, "match_reasons": { "items": { "type": "string" }, "type": "array", "title": "Match Reasons" }, "provider_meta": { "additionalProperties": true, "type": "object", "title": "Provider Meta" } }, "type": "object", "title": "ProspectCompanyData" }, "PublicInvoiceEmailAttachmentData": { "properties": { "object_type": { "type": "string", "title": "Object Type" }, "record_id": { "type": "string", "title": "Record Id" }, "filename": { "type": "string", "title": "Filename" }, "template_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Template Id" } }, "type": "object", "required": [ "object_type", "record_id", "filename" ], "title": "PublicInvoiceEmailAttachmentData" }, "ToastMessageI18n": { "type": "object", "required": [ "en", "ja" ], "properties": { "en": { "type": "string" }, "ja": { "type": "string" } } }, "ObjectRecordTableCellPayload": { "properties": { "cell_type": { "type": "string", "title": "Cell Type" }, "renderer_type": { "type": "string", "title": "Renderer Type" }, "field_id": { "type": "string", "title": "Field Id" }, "property_key": { "type": "string", "title": "Property Key" }, "source": { "type": "string", "title": "Source" }, "property_type": { "type": "string", "title": "Property Type" }, "custom_property_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Custom Property Type" }, "raw_value": { "title": "Raw Value" }, "display": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "values": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Values" }, "files": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Files" }, "images": { "items": { "additionalProperties": true, "type": "object" }, "type": "array", "title": "Images" }, "count": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Count" }, "multiple": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Multiple" }, "empty": { "type": "boolean", "title": "Empty", "default": false }, "show_badge": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Show Badge" }, "badge_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Badge Color" }, "color": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Color" }, "meta": { "additionalProperties": true, "type": "object", "title": "Meta" } }, "type": "object", "required": [ "cell_type", "renderer_type", "field_id", "property_key", "source", "property_type" ], "title": "ObjectRecordTableCellPayload" }, "WorkflowTriggerNode": { "properties": { "id": { "type": "string", "title": "Id" }, "action_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Slug" }, "action_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Title" }, "action_title_ja": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Action Title Ja" } }, "type": "object", "required": [ "id" ], "title": "WorkflowTriggerNode" }, "WorkflowUserSummary": { "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Id" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" } }, "type": "object", "title": "WorkflowUserSummary" }, "ActivityLogActor": { "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Name" } }, "type": "object", "title": "ActivityLogActor" }, "ActivityLogEnvironment": { "properties": { "source": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Source" }, "ip_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ip Address" }, "user_agent": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User Agent" }, "browser": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Browser" }, "os": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Os" }, "device_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Device Type" }, "mcp_session_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mcp Session Id" }, "mcp_protocol_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mcp Protocol Version" }, "mcp_server_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mcp Server Name" }, "mcp_server_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Mcp Server Version" }, "client_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Name" }, "client_version": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Client Version" }, "model_provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Provider" }, "model_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Model Name" } }, "type": "object", "title": "ActivityLogEnvironment" } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "opaque token", "description": "Send Authorization: Bearer for developer API tokens." } } }, "security": [ { "bearerAuth": [] } ] }