> ## Documentation Index > Fetch the complete documentation index at: https://docs.api.stuut.co/llms.txt > Use this file to discover all available pages before exploring further. # Create a Connection > Create an integration connection. Body varies by integration provider. ## OpenAPI ````yaml https://api.stuut.ai/openapi.json post /v2/integrations/connections openapi: 3.1.0 info: title: Stuut API termsOfService: https://stuut.ai/terms-and-conditions contact: name: Stuut Support url: https://stuut.ai/ email: devs@stuut.co version: 2.0.0 servers: [] security: - HTTPBearer: [] tags: - name: adjustments description: Operations for managing payment adjustments (fees, discounts, write-offs). x-displayName: Adjustments - name: aether description: Operations for aether. x-displayName: Aether - name: analytics description: Operations for retrieving analytics and dashboard data. x-displayName: Analytics - name: assistant description: Operations for the in-app chat assistant. x-displayName: Assistant - name: audit-log description: Operations for retrieving the organization's audit log. x-displayName: Audit Log - name: bank-accounts description: Operations for retrieving and managing bank accounts. x-displayName: Bank Accounts - name: bank-statements description: Operations for retrieving and managing bank statements. x-displayName: Bank Statements - name: bank-transactions description: Operations for retrieving and managing bank transactions. x-displayName: Bank Transactions - name: business-units description: Operations for listing and managing business units. x-displayName: Business Units - name: call-agent description: >- Operations for initiating and managing real-time voice calls with partners. x-displayName: Call Agent - name: calls description: Operations for retrieving and managing voice call records. x-displayName: Calls - name: cash-app description: Operations for cash application — matching incoming payments to invoices. x-displayName: Cash Application - name: chats description: Operations for managing chat conversations. x-displayName: Chats - name: cnam-registration description: Operations for managing CNAM (caller ID name) registration. x-displayName: CNAM Registration - name: credit-memos description: Operations for retrieving and searching credit memos. x-displayName: Credit Memos - name: custom-table-templates description: >- Operations for managing custom table templates used in email template variables. x-displayName: Custom Table Templates - name: customer-segments description: Operations for managing customer segments. x-displayName: Customer Segments - name: deductions-knowledge description: Operations for managing deduction processing knowledge entries. x-displayName: Deductions Knowledge - name: email-threads description: Operations for managing email threads. x-displayName: Email Threads - name: emails description: Operations for retrieving and managing emails. x-displayName: Emails - name: exports description: Operations for requesting and retrieving async data exports. x-displayName: Exports - name: integrations description: >- Operations for managing integrations with external systems (e.g. ERP, CRM, etc.). x-displayName: Integrations - name: internal-contacts description: >- Operations for managing internal contacts (CSMs, account managers, etc.) and their assignments to partners. x-displayName: Internal Contacts - name: invoices description: Operations for retrieving and managing invoices. x-displayName: Invoices - name: kyb description: Operations for Know Your Business (KYB) verification. x-displayName: KYB - name: ledger-accounts description: Operations for retrieving and managing ledger accounts. x-displayName: Ledger Accounts - name: mailbox-settings description: >- Operations for an organization's mailbox provider configuration: Microsoft admin consent, shared-mailbox discovery, and provider health. x-displayName: Mailbox Settings - name: mailboxes description: >- Operations for connecting, listing, updating, and archiving user and shared mailboxes, including delegated OAuth sign-in. x-displayName: Mailboxes - name: media description: >- Operations for signing direct-to-storage media uploads (e.g. signature images). x-displayName: Media - name: organizations description: Operations for retrieving and managing the current organization. x-displayName: Organizations - name: outreach-workflows description: Operations for managing automated collections outreach workflows. x-displayName: Outreach Workflows - name: partners description: Operations for retrieving and managing customers. x-displayName: Partners - name: payments description: Operations for approving and managing payments. x-displayName: Payments - name: report-configs description: >- Operations for managing report configurations (frequency, recipients, schedule). x-displayName: Report Configs - name: sms-campaign-registration description: Operations for managing A2P 10DLC SMS campaign registration. x-displayName: SMS Campaign Registration - name: sms-templates description: >- Operations for defining, storing, and managing parameterized SMS message templates. x-displayName: SMS Templates - name: sms-threads description: Operations for retrieving and managing SMS conversation threads. x-displayName: SMS Threads - name: users description: Operations for retrieving and managing users. x-displayName: Users - name: users-ooo description: Operations for managing user out-of-office (OOO) status and coverage. x-displayName: Users OOO paths: /v2/integrations/connections: post: tags: - integrations summary: Create a Connection description: Create an integration connection. Body varies by integration provider. operationId: PostIntegrationsConnections requestBody: content: application/json: schema: $ref: '#/components/schemas/IntegrationConnectionCreateBody' required: true responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/IntegrationConnection' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - HTTPBearer: [] components: schemas: IntegrationConnectionCreateBody: oneOf: - $ref: '#/components/schemas/AcumaticaConnectionCreateBody' - $ref: '#/components/schemas/BillingPlatformConnectionCreateBody' - $ref: '#/components/schemas/BoomiConnectionCreateBody' - $ref: '#/components/schemas/ChargebeeConnectionCreateBody' - $ref: '#/components/schemas/CitiConnectionCreateBody' - $ref: '#/components/schemas/JpmcConnectionCreateBody' - $ref: '#/components/schemas/KyribaConnectionCreateBody' - $ref: '#/components/schemas/MSDynamicsBCConnectionCreateBody' - $ref: '#/components/schemas/MSDynamicsFOConnectionCreateBody' - $ref: '#/components/schemas/NetsuiteConnectionCreateBody' - $ref: '#/components/schemas/OdooConnectionCreateBody' - $ref: '#/components/schemas/OracleFusionConnectionCreateBody' - $ref: '#/components/schemas/SalesforceConnectionCreateBody' - $ref: '#/components/schemas/SampleDataGeneratorConnectionCreateBody' - $ref: '#/components/schemas/ServiceNowConnectionCreateBody' - $ref: '#/components/schemas/ServiceTitanConnectionCreateBody' - $ref: '#/components/schemas/WorkdayConnectionCreateBody' - $ref: '#/components/schemas/ZendeskConnectionCreateBody' - $ref: '#/components/schemas/ZuoraConnectionCreateBody' discriminator: propertyName: provider_name mapping: acumatica: $ref: '#/components/schemas/AcumaticaConnectionCreateBody' billingplatform: $ref: '#/components/schemas/BillingPlatformConnectionCreateBody' boomi: $ref: '#/components/schemas/BoomiConnectionCreateBody' chargebee: $ref: '#/components/schemas/ChargebeeConnectionCreateBody' citi: $ref: '#/components/schemas/CitiConnectionCreateBody' jpmc: $ref: '#/components/schemas/JpmcConnectionCreateBody' kyriba: $ref: '#/components/schemas/KyribaConnectionCreateBody' ms-dynamics-bc: $ref: '#/components/schemas/MSDynamicsBCConnectionCreateBody' ms-dynamics-fo: $ref: '#/components/schemas/MSDynamicsFOConnectionCreateBody' netsuite: $ref: '#/components/schemas/NetsuiteConnectionCreateBody' odoo: $ref: '#/components/schemas/OdooConnectionCreateBody' oracle-fusion: $ref: '#/components/schemas/OracleFusionConnectionCreateBody' salesforce-accountingseed: $ref: '#/components/schemas/SalesforceConnectionCreateBody' sample-data-generator: $ref: '#/components/schemas/SampleDataGeneratorConnectionCreateBody' servicenow: $ref: '#/components/schemas/ServiceNowConnectionCreateBody' servicetitan: $ref: '#/components/schemas/ServiceTitanConnectionCreateBody' workday: $ref: '#/components/schemas/WorkdayConnectionCreateBody' zendesk: $ref: '#/components/schemas/ZendeskConnectionCreateBody' zuora: $ref: '#/components/schemas/ZuoraConnectionCreateBody' IntegrationConnection: oneOf: - $ref: '#/components/schemas/AcumaticaConnection' - $ref: '#/components/schemas/BillingPlatformConnection' - $ref: '#/components/schemas/BoomiConnection' - $ref: '#/components/schemas/ChargebeeConnection' - $ref: '#/components/schemas/CitiConnection' - $ref: '#/components/schemas/JpmcConnection' - $ref: '#/components/schemas/KyribaConnection' - $ref: '#/components/schemas/MSDynamicsBCConnection' - $ref: '#/components/schemas/MSDynamicsFOConnection' - $ref: '#/components/schemas/NetsuiteConnection' - $ref: '#/components/schemas/OdooConnection' - $ref: '#/components/schemas/OracleFusionConnection' - $ref: '#/components/schemas/QuickbooksConnection' - $ref: '#/components/schemas/QuickbooksDesktopConnection' - $ref: '#/components/schemas/SageIntacctConnection' - $ref: '#/components/schemas/SalesforceConnection' - $ref: '#/components/schemas/SampleDataGeneratorConnection' - $ref: '#/components/schemas/ServiceNowConnection' - $ref: '#/components/schemas/ServiceTitanConnection' - $ref: '#/components/schemas/WorkdayConnection' - $ref: '#/components/schemas/ZendeskConnection' - $ref: '#/components/schemas/ZuoraConnection' title: IntegrationConnection discriminator: propertyName: provider_name mapping: acumatica: $ref: '#/components/schemas/AcumaticaConnection' billingplatform: $ref: '#/components/schemas/BillingPlatformConnection' boomi: $ref: '#/components/schemas/BoomiConnection' chargebee: $ref: '#/components/schemas/ChargebeeConnection' citi: $ref: '#/components/schemas/CitiConnection' jpmc: $ref: '#/components/schemas/JpmcConnection' kyriba: $ref: '#/components/schemas/KyribaConnection' ms-dynamics-bc: $ref: '#/components/schemas/MSDynamicsBCConnection' ms-dynamics-fo: $ref: '#/components/schemas/MSDynamicsFOConnection' netsuite: $ref: '#/components/schemas/NetsuiteConnection' odoo: $ref: '#/components/schemas/OdooConnection' oracle-fusion: $ref: '#/components/schemas/OracleFusionConnection' quickbooks: $ref: '#/components/schemas/QuickbooksConnection' quickbooks-desktop: $ref: '#/components/schemas/QuickbooksDesktopConnection' sage-intacct: $ref: '#/components/schemas/SageIntacctConnection' salesforce-accountingseed: $ref: '#/components/schemas/SalesforceConnection' sample-data-generator: $ref: '#/components/schemas/SampleDataGeneratorConnection' servicenow: $ref: '#/components/schemas/ServiceNowConnection' servicetitan: $ref: '#/components/schemas/ServiceTitanConnection' workday: $ref: '#/components/schemas/WorkdayConnection' zendesk: $ref: '#/components/schemas/ZendeskConnection' zuora: $ref: '#/components/schemas/ZuoraConnection' HTTPValidationError: $defs: ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Type type: string required: - loc - msg - type title: ValidationError type: object x-speakeasy-include: true properties: type: const: request-validation title: Type type: string detail: anyOf: - type: string - type: 'null' default: null description: Human-readable description of this specific problem. title: Detail x-speakeasy-error-message: true status: const: 422 title: Status type: integer title: description: Short human-readable summary of the problem. title: Title type: string x-speakeasy-error-message: true errors: items: $ref: '#/components/schemas/ValidationError' title: Errors type: array required: - type - status - title - errors title: APIError type: object AcumaticaConnectionCreateBody: properties: provider_name: type: string const: acumatica title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. base_url: type: string title: '' description: >- Acumatica instance base URL including the IIS instance segment (e.g. https://erpsandbox.example.com/AcumaticaSandbox). tenant: type: string title: '' description: >- Acumatica tenant (company) login name as it appears on the Tenants form (SM203520). For multi-company installs this is also the suffix appended to ``client_id`` after ``@``. endpoint_name: anyOf: - type: string - type: 'null' title: '' description: >- Web service endpoint name (default 'Default'; custom endpoints supported). endpoint_version: anyOf: - type: string - type: 'null' title: '' description: >- Endpoint version string (e.g. '24.200.001'). Mirrors Acumatica release. scope: anyOf: - type: string - type: 'null' title: '' description: >- OAuth scope string. 'api' for single-session, 'api offline_access' to get a refresh token, 'api:concurrent_access' to allow multiple simultaneous tokens for the same client. client_id: type: string format: password title: '' description: >- OAuth client ID from the Connected Application (includes '@TenantName' suffix). writeOnly: true client_secret: type: string format: password title: '' description: OAuth shared secret. Encrypted at rest via AWS KMS. writeOnly: true username: type: string format: password title: '' description: Acumatica API user (resource-owner credentials). writeOnly: true password: type: string format: password title: '' description: Acumatica API user password. Encrypted at rest via AWS KMS. writeOnly: true branches: items: type: string type: array title: '' description: >- Branches the connection is authorized to sync. Each value is a BranchCD code (e.g. 'STSMC') that is sent in the ``PX-CbApiBranch`` header on AR transactional reads. default_currency: anyOf: - type: string - type: 'null' title: '' description: >- ISO-4217 currency code used as the fallback when Acumatica's Default endpoint omits ``CurrencyID`` on AR documents — Invoice and CreditMemo entities do not expose a currency field in the current contract, so per-tenant single-currency installs need to set this on the connection. Payment rows carry ``CurrencyID`` directly and ignore this. Mapper fails loudly if neither the row nor this column carries a currency. type: object required: - provider_name - base_url - tenant - client_id - client_secret - username - password - branches title: AcumaticaConnectionCreateBody description: Create schema for Acumatica ERP connections. BillingPlatformConnectionCreateBody: properties: provider_name: type: string const: billingplatform title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. api_url: type: string title: '' username: type: string title: '' password: type: string format: password title: '' writeOnly: true type: object required: - provider_name - api_url - username - password title: BillingPlatformConnectionCreateBody description: Create schema for BillingPlatform connections. BoomiConnectionCreateBody: properties: provider_name: type: string const: boomi title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. type: object required: - provider_name title: BoomiConnectionCreateBody description: Create schema for Boomi connections. ChargebeeConnectionCreateBody: properties: provider_name: type: string const: chargebee title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. site: type: string title: '' description: Chargebee site name (e.g. 'hibid' for hibid.chargebee.com). api_key: type: string format: password title: '' writeOnly: true type: object required: - provider_name - site - api_key title: ChargebeeConnectionCreateBody description: Create schema for Chargebee connections. CitiConnectionCreateBody: properties: provider_name: type: string const: citi title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. account_id: anyOf: - type: string - type: 'null' title: '' description: The Citi TTS account identifier. client_id: anyOf: - type: string - type: 'null' title: '' description: >- OAuth2 client ID for Citi API access. Falls back to env var if not set. client_secret: anyOf: - type: string format: password writeOnly: true - type: 'null' title: '' description: >- OAuth2 client secret for Citi API access. Falls back to env var if not set. type: object required: - provider_name title: CitiConnectionCreateBody description: Create schema for Citi connections. JpmcConnectionCreateBody: properties: provider_name: type: string const: jpmc title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. multi_tenant_client_id: type: string title: '' description: JPMC multi-tenant child profile identifier (ClientID header). account_ids: anyOf: - items: type: string type: array - type: 'null' title: '' description: List of bank account IDs to sync transactions for. lockbox_enabled: type: boolean title: '' description: Whether lockbox file sync is enabled for this connection. default: false lockbox_sftp_username: anyOf: - type: string - type: 'null' title: '' description: SFTP username for lockbox file retrieval. lockbox_sftp_data_path: anyOf: - type: string - type: 'null' title: '' description: >- SFTP path for CSV/LDT data files (e.g. /outbound/LBX02). Falls back to JpmcConfig.LOCKBOX_SFTP_PATH. lockbox_sftp_img_path: anyOf: - type: string - type: 'null' title: '' description: >- SFTP path for IMG zip files (e.g. /outbound/IMG01). Falls back to JpmcConfig.LOCKBOX_SFTP_PATH. type: object required: - provider_name - multi_tenant_client_id title: JpmcConnectionCreateBody description: Create schema for JPMC connections. KyribaConnectionCreateBody: properties: provider_name: type: string const: kyriba title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. api_url: type: string title: '' token_endpoint: type: string title: '' client_id: type: string title: '' client_secret: type: string format: password title: '' writeOnly: true templates: items: type: string type: array title: '' description: Get configured template codes from settings. default: [] type: object required: - provider_name - api_url - token_endpoint - client_id - client_secret title: KyribaConnectionCreateBody description: Create schema for Kyriba connections. MSDynamicsBCConnectionCreateBody: properties: provider_name: type: string const: ms-dynamics-bc title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. api_url: anyOf: - type: string - type: 'null' title: '' description: >- The base URL for the Business Central API. Only used for on premise instances. is_on_premise: type: boolean title: '' description: Whether the MS Dynamics BC instance is on-premise or cloud-based. default: false auth_method: type: string enum: - oauth2 - basic title: '' description: >- Auth scheme used for payment posting. 'oauth2' (default) uses the existing S2S client-credentials path; 'basic' uses HTTP Basic with the connection's username/password and is the only path that supports posting to closed periods on on-prem BC where the elevated permission cannot be granted to a service principal. Phase 1 only affects payment posting; other operations remain on OAuth2 regardless of this field. default: oauth2 x-speakeasy-enum-format: union username: anyOf: - type: string - type: 'null' title: '' password: anyOf: - type: string format: password writeOnly: true - type: 'null' title: '' type: object required: - provider_name title: MSDynamicsBCConnectionCreateBody MSDynamicsFOConnectionCreateBody: properties: provider_name: type: string const: ms-dynamics-fo title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. api_url: type: string format: uri title: '' description: >- Your Microsoft Dynamics 365 F&O instance URL (e.g., https://yourcompany.operations.dynamics.com) x-ui-label: Instance URL x-ui-placeholder: https://yourcompany.operations.dynamics.com type: object required: - provider_name - api_url title: MSDynamicsFOConnectionCreateBody NetsuiteConnectionCreateBody: properties: provider_name: type: string const: netsuite title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. account_id: type: string title: '' description: The NetSuite account ID associated with the connection. auth_method: $ref: '#/components/schemas/NetsuiteAuthMethod' title: '' description: >- Authentication method: 'oauth2' (authorization code flow) or 'm2m' (client credentials with JWT). default: oauth2 m2m_client_id: anyOf: - type: string - type: 'null' title: '' description: Client ID from the customer's NetSuite M2M integration record. m2m_certificate_id: anyOf: - type: string - type: 'null' title: '' description: >- Certificate ID (kid) from the customer's certificate upload in NetSuite. m2m_private_key: anyOf: - type: string format: password writeOnly: true - type: 'null' title: '' description: PEM-encoded private key for signing M2M JWT assertions. type: object required: - provider_name - account_id title: NetsuiteConnectionCreateBody description: Create schema for Netsuite connections. OdooConnectionCreateBody: properties: provider_name: type: string const: odoo title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. subdomain: type: string title: '' description: >- Odoo subdomain for your instance (e.g., 'company' for company.odoo.com). Required. database: type: string title: '' description: Odoo database name. Required for XML-RPC authentication. username: type: string title: '' description: User email address for Odoo authentication. Required. api_key: type: string format: password title: '' description: Odoo API key for authentication. Required. writeOnly: true payment_journal_id: anyOf: - type: integer - type: 'null' title: '' description: Default journal ID for creating payments in Odoo. Optional. payment_method_line_id: anyOf: - type: integer - type: 'null' title: '' description: Default payment method line ID for creating payments. Optional. type: object required: - provider_name - subdomain - database - username - api_key title: OdooConnectionCreateBody description: Create schema for Odoo connections. OracleFusionConnectionCreateBody: properties: provider_name: type: string const: oracle-fusion title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. base_url: type: string title: '' description: >- Fusion REST base URL (e.g. https://fa-exut-dev2-saasfaprod1.fa.ocs.oraclecloud.com). token_endpoint: type: string title: '' description: >- IDCS / OCI IAM token endpoint (e.g. https://idcs-XXXX.identity.oraclecloud.com/oauth2/v1/token). scope: type: string title: '' description: >- OAuth scope string (e.g. urn:opc:resource:fa:instanceid=812709832urn:opc:resource:consumer::all). client_id: type: string format: password title: '' description: IDCS confidential application client ID. writeOnly: true client_secret: type: string format: password title: '' description: >- IDCS confidential application client secret. Encrypted at rest via AWS KMS. writeOnly: true private_key: type: string format: password title: '' description: >- PEM-encoded RSA private key used to sign the JWT user assertion. Encrypted at rest via AWS KMS. Never log or expose. writeOnly: true public_cert: anyOf: - type: string - type: 'null' title: '' description: >- PEM-encoded X.509 certificate matching ``private_key``. Stored for rotation tracking. cert_alias: type: string title: '' description: >- Certificate alias the customer used when uploading our cert to IDCS (used as JWT ``kid``). fusion_user: type: string title: '' description: >- Fusion service-account username that JWT-issued tokens act as (e.g. SVC_INT_STUUT). business_units: anyOf: - items: type: string type: array - type: 'null' title: '' description: >- Business Units this connection is authorized for (informational; data security is enforced on Oracle side). type: object required: - provider_name - base_url - token_endpoint - scope - client_id - client_secret - private_key - cert_alias - fusion_user title: OracleFusionConnectionCreateBody description: Create schema for Oracle Fusion Cloud connections. SalesforceConnectionCreateBody: properties: provider_name: type: string const: salesforce-accountingseed title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. instance_url: type: string title: '' description: >- The Salesforce instance URL. Provided by user during connection setup. client_id: type: string title: '' description: The Salesforce Connected App Client ID (Consumer Key). client_secret: type: string title: '' description: The Salesforce Connected App Client Secret (Consumer Secret). is_pkce_enabled: type: boolean title: '' description: Whether PKCE (RFC 7636) is used during OAuth2 authorization. default: false is_writeback_enabled: type: boolean title: '' description: Whether payment writebacks to Salesforce are enabled. default: false type: object required: - provider_name - instance_url - client_id - client_secret title: SalesforceConnectionCreateBody SampleDataGeneratorConnectionCreateBody: properties: provider_name: type: string const: sample-data-generator title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. type: object required: - provider_name title: SampleDataGeneratorConnectionCreateBody description: Update schema for Sample Data Generator connections. ServiceNowConnectionCreateBody: properties: provider_name: type: string const: servicenow title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. instance_url: type: string title: '' description: ServiceNow instance URL (e.g. https://dev12345.service-now.com) username: type: string title: '' description: ServiceNow username for basic auth password: type: string format: password title: '' description: ServiceNow password for basic auth writeOnly: true type: object required: - provider_name - instance_url - username - password title: ServiceNowConnectionCreateBody description: Create schema for ServiceNow connections. ServiceTitanConnectionCreateBody: properties: provider_name: type: string const: servicetitan title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. tenant_id: type: string title: '' description: The ServiceTitan tenant id used in API request paths. currency: type: string title: '' description: ISO 4217 currency code for this tenant's monetary values (e.g. USD). client_id: type: string title: '' description: >- ServiceTitan tenant-specific OAuth2 client ID (from API Application Access). client_secret: type: string format: password title: '' description: >- ServiceTitan tenant-specific OAuth2 client secret. Encrypted at rest via AWS KMS. writeOnly: true type: object required: - provider_name - tenant_id - currency - client_id - client_secret title: ServiceTitanConnectionCreateBody description: Create schema for ServiceTitan connections. WorkdayConnectionCreateBody: properties: provider_name: type: string const: workday title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. base_url: type: string title: '' description: Workday services base URL (e.g., https://services1.myworkday.com). tenant_id: type: string title: '' description: Workday tenant identifier used in report and SOAP URLs. username: type: string title: '' password: type: string format: password title: '' writeOnly: true report_owner: type: string title: '' description: ISU report owner used in RaaS report URLs (e.g., ISU_FINT6024). customers_report_path: type: string title: '' description: >- FINT report path for customers/contacts (e.g., FINT6024a_Stuut_Customer_Outbound). invoices_report_path: type: string title: '' description: >- FINT report path for invoices/credit memos (e.g., FINT6024b_Stuut_Customer_Invoice_Data_Outbound). payments_report_path: type: string title: '' description: >- FINT report path for payments (e.g., FINT6024c_Stuut_Customer_Payments_Outbound). type: object required: - provider_name - base_url - tenant_id - username - password - report_owner - customers_report_path - invoices_report_path - payments_report_path title: WorkdayConnectionCreateBody description: Create schema for Workday connections. ZendeskConnectionCreateBody: properties: provider_name: type: string const: zendesk title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. subdomain: type: string title: '' description: >- Zendesk subdomain (e.g. 'charteruphelp' for charteruphelp.zendesk.com). email: type: string title: '' description: >- Email of the Zendesk agent that owns the API token. Half of the auth credential pair (/token:), so treat as sensitive. api_token: type: string format: password title: '' description: Zendesk API token. writeOnly: true type: object required: - provider_name - subdomain - email - api_token title: ZendeskConnectionCreateBody description: Create schema for Zendesk connections. ZuoraConnectionCreateBody: properties: provider_name: type: string const: zuora title: '' name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. base_url: type: string title: '' description: >- Zuora API base URL provided by client during connection setup. Required. client_id: type: string title: '' description: OAuth2 client ID for Zuora API access. Required. client_secret: type: string format: password title: '' description: OAuth2 client secret for Zuora API access. Required. writeOnly: true type: object required: - provider_name - base_url - client_id - client_secret title: ZuoraConnectionCreateBody description: Create schema for Zuora connections. AcumaticaConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: acumatica title: '' base_url: type: string title: '' description: >- Acumatica instance base URL including the IIS instance segment (e.g. https://erpsandbox.example.com/AcumaticaSandbox). tenant: type: string title: '' description: >- Acumatica tenant (company) login name as it appears on the Tenants form (SM203520). For multi-company installs this is also the suffix appended to ``client_id`` after ``@``. endpoint_name: type: string title: '' description: >- Web service endpoint name (default 'Default'; custom endpoints supported). endpoint_version: type: string title: '' description: >- Endpoint version string (e.g. '24.200.001'). Mirrors Acumatica release. scope: anyOf: - type: string - type: 'null' title: '' description: >- OAuth scope string. 'api' for single-session, 'api offline_access' to get a refresh token, 'api:concurrent_access' to allow multiple simultaneous tokens for the same client. branches: anyOf: - items: type: string type: array - type: 'null' title: '' description: >- Branches the connection is authorized to sync. Each value is a BranchCD code (e.g. 'STSMC') that is sent in the ``PX-CbApiBranch`` header on AR transactional reads. default_currency: anyOf: - type: string - type: 'null' title: '' description: >- ISO-4217 currency code used as the fallback when Acumatica's Default endpoint omits ``CurrencyID`` on AR documents — Invoice and CreditMemo entities do not expose a currency field in the current contract, so per-tenant single-currency installs need to set this on the connection. Payment rows carry ``CurrencyID`` directly and ignore this. Mapper fails loudly if neither the row nor this column carries a currency. object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - base_url - tenant - endpoint_name - endpoint_version - scope - branches - default_currency - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: AcumaticaConnection description: Acumatica ERP integration connection. BillingPlatformConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: billingplatform title: '' api_url: anyOf: - type: string - type: 'null' title: '' username: anyOf: - type: string - type: 'null' title: '' object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - api_url - username - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: BillingPlatformConnection description: BillingPlatform integration connection. BoomiConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: boomi title: '' api_key: anyOf: - type: string - type: 'null' title: '' object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - api_key - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: BoomiConnection description: |- Boomi integration connection. Unlike other providers, `api_key` is generated server-side on create and must be readable on subsequent fetches — Boomi cannot push data without it, and the only way to share it with the Boomi team is to read it back from this response. Visibility is restricted to authenticated users with access to the connection's tenant. ChargebeeConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: chargebee title: '' site: type: string title: '' description: Chargebee site name (e.g. 'hibid' for hibid.chargebee.com). api_key: type: string format: password title: '' writeOnly: true object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - site - api_key - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: ChargebeeConnection description: Chargebee integration connection. CitiConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: citi title: '' account_id: anyOf: - type: string - type: 'null' title: '' description: The Citi TTS account identifier. client_id: anyOf: - type: string - type: 'null' title: '' description: >- OAuth2 client ID for Citi API access. Falls back to env var if not set. object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - account_id - client_id - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: CitiConnection description: Citi Treasury and Trade Solutions integration connection. JpmcConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: jpmc title: '' multi_tenant_client_id: type: string title: '' description: JPMC multi-tenant child profile identifier (ClientID header). account_ids: anyOf: - items: type: string type: array - type: 'null' title: '' description: List of bank account IDs to sync transactions for. lockbox_enabled: type: boolean title: '' description: Whether lockbox file sync is enabled for this connection. lockbox_sftp_username: anyOf: - type: string - type: 'null' title: '' description: SFTP username for lockbox file retrieval. lockbox_sftp_data_path: anyOf: - type: string - type: 'null' title: '' description: >- SFTP path for CSV/LDT data files (e.g. /outbound/LBX02). Falls back to JpmcConfig.LOCKBOX_SFTP_PATH. lockbox_sftp_img_path: anyOf: - type: string - type: 'null' title: '' description: >- SFTP path for IMG zip files (e.g. /outbound/IMG01). Falls back to JpmcConfig.LOCKBOX_SFTP_PATH. object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - multi_tenant_client_id - account_ids - lockbox_enabled - lockbox_sftp_username - lockbox_sftp_data_path - lockbox_sftp_img_path - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: JpmcConnection description: JP Morgan Chase integration connection. KyribaConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: kyriba title: '' api_url: type: string title: '' token_endpoint: type: string title: '' client_id: type: string title: '' templates: items: type: string type: array title: '' description: Get configured template codes from settings. default: [] object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - api_url - token_endpoint - client_id - templates - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: KyribaConnection description: Kyriba integration connection. MSDynamicsBCConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: ms-dynamics-bc title: '' api_url: anyOf: - type: string - type: 'null' title: '' description: >- The base URL for the Business Central API. Only used for on premise instances. auth_method: type: string enum: - oauth2 - basic title: '' description: >- Auth scheme used for payment posting. 'oauth2' (default) uses the existing S2S client-credentials path; 'basic' uses HTTP Basic with the connection's username/password and is the only path that supports posting to closed periods on on-prem BC where the elevated permission cannot be granted to a service principal. Phase 1 only affects payment posting; other operations remain on OAuth2 regardless of this field. x-speakeasy-enum-format: union company: anyOf: - type: string - type: 'null' title: '' description: >- The company id associated with the Business Central connection. This is used to identify the specific company within the Business Central environment. company_name: anyOf: - type: string - type: 'null' title: '' description: The company name associated with the Business Central connection. environment: anyOf: - type: string - type: 'null' title: '' description: >- The name of the Business Central environment this connection is using. include_dimension_lines: type: boolean title: '' description: Whether querying dimension lines is supported. is_bc_extension_installed: type: boolean title: '' description: Whether the Stuut Business Central extension has been installed. is_on_premise: type: boolean title: '' description: Whether the MS Dynamics BC instance is on-premise or cloud-based. tenant_id: anyOf: - type: string - type: 'null' title: '' description: The tenant ID associated with the MS Dynamics BC connection. username: anyOf: - type: string - type: 'null' title: '' object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - api_url - auth_method - company - company_name - environment - include_dimension_lines - is_bc_extension_installed - is_on_premise - tenant_id - username - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: MSDynamicsBCConnection description: Microsoft Dynamics Business Central integration connection. MSDynamicsFOConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: ms-dynamics-fo title: '' api_url: type: string title: '' description: >- The base URL for the MS Dynamics F&O instance (e.g., https://yourinstance.operations.dynamics.com). Required. tenant_id: anyOf: - type: string - type: 'null' title: '' description: >- The Azure AD tenant ID associated with the MS Dynamics F&O connection. legal_entity: anyOf: - type: string - type: 'null' title: '' description: >- The legal entity (dataAreaId) to scope all operations. Required for syncing data. Create separate integrations for multiple legal entities. object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - api_url - tenant_id - legal_entity - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: MSDynamicsFOConnection description: Microsoft Dynamics 365 Finance & Operations integration connection. NetsuiteConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: netsuite title: '' account_id: anyOf: - type: string - type: 'null' title: '' description: The NetSuite account ID associated with the connection. auth_method: $ref: '#/components/schemas/NetsuiteAuthMethod' title: '' description: >- Authentication method: 'oauth2' (authorization code flow) or 'm2m' (client credentials with JWT). object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - account_id - auth_method - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: NetsuiteConnection description: Netsuite integration connection. OdooConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: odoo title: '' subdomain: type: string title: '' description: >- Odoo subdomain for your instance (e.g., 'company' for company.odoo.com). Required. database: type: string title: '' description: Odoo database name. Required for XML-RPC authentication. username: type: string title: '' description: User email address for Odoo authentication. Required. payment_journal_id: anyOf: - type: integer - type: 'null' title: '' description: Default journal ID for creating payments in Odoo. Optional. payment_method_line_id: anyOf: - type: integer - type: 'null' title: '' description: Default payment method line ID for creating payments. Optional. object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - subdomain - database - username - payment_journal_id - payment_method_line_id - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: OdooConnection description: Odoo integration connection. OracleFusionConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: oracle-fusion title: '' base_url: type: string title: '' description: >- Fusion REST base URL (e.g. https://fa-exut-dev2-saasfaprod1.fa.ocs.oraclecloud.com). token_endpoint: type: string title: '' description: >- IDCS / OCI IAM token endpoint (e.g. https://idcs-XXXX.identity.oraclecloud.com/oauth2/v1/token). scope: type: string title: '' description: >- OAuth scope string (e.g. urn:opc:resource:fa:instanceid=812709832urn:opc:resource:consumer::all). fusion_user: type: string title: '' description: >- Fusion service-account username that JWT-issued tokens act as (e.g. SVC_INT_STUUT). cert_alias: type: string title: '' description: >- Certificate alias the customer used when uploading our cert to IDCS (used as JWT ``kid``). cert_thumbprint: anyOf: - type: string - type: 'null' title: '' description: >- SHA-1 thumbprint of ``public_cert`` (uppercase hex, no separators). Used as JWT ``x5t`` fallback. business_units: anyOf: - items: type: string type: array - type: 'null' title: '' description: >- Business Units this connection is authorized for (informational; data security is enforced on Oracle side). object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - base_url - token_endpoint - scope - fusion_user - cert_alias - cert_thumbprint - business_units - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: OracleFusionConnection description: Oracle Fusion Cloud integration connection. QuickbooksConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: quickbooks title: '' realm_id: anyOf: - type: string - type: 'null' title: '' description: >- The QuickBooks realm ID associated with the connection. This is retrieved during the OAuth2 flow and is used to identify the QuickBooks company. object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - realm_id - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: QuickbooksConnection description: Quickbooks integration connection. QuickbooksDesktopConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: quickbooks-desktop title: '' end_user_id: anyOf: - type: string - type: 'null' title: '' description: The end user ID associated with the QuickBooks Desktop connection. timezone: anyOf: - $ref: '#/components/schemas/Timezone' - type: 'null' title: '' description: The timezone of the QuickBooks Desktop instance. object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - end_user_id - timezone - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: QuickbooksDesktopConnection description: Quickbooks Desktop integration connection. SageIntacctConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: sage-intacct title: '' base_url: anyOf: - type: string - type: 'null' title: '' description: Sage Intacct API base URL company_id: anyOf: - type: string - type: 'null' title: '' description: Sage Intacct company ID extracted from JWT token sender_id: anyOf: - type: string - type: 'null' title: '' description: Sage Intacct sender ID extracted from JWT token client_id: anyOf: - type: string - type: 'null' title: '' description: OAuth2 client ID for Sage Intacct API access object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - base_url - company_id - sender_id - client_id - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: SageIntacctConnection description: Sage Intacct integration connection. SalesforceConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: salesforce-accountingseed title: '' instance_url: anyOf: - type: string - type: 'null' title: '' description: >- The Salesforce instance URL. Provided by user during connection setup. is_writeback_enabled: type: boolean title: '' description: Whether payment writebacks to Salesforce are enabled. is_pkce_enabled: type: boolean title: '' description: Whether PKCE (RFC 7636) is used during OAuth2 authorization. org_id: anyOf: - type: string - type: 'null' title: '' description: The Salesforce Organization ID associated with the connection. client_id: anyOf: - type: string - type: 'null' title: '' description: The Salesforce Connected App Client ID (Consumer Key). object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true has_client_secret: type: boolean title: '' readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - instance_url - is_writeback_enabled - is_pkce_enabled - org_id - client_id - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id - has_client_secret title: SalesforceConnection description: Salesforce (AccountingSeed) integration connection. SampleDataGeneratorConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: sample-data-generator title: '' google_sheets_url: anyOf: - type: string - type: 'null' title: '' description: >- URL of the Google Sheets document containing sample data. The sheet must have tabs named: Customers, Contacts, Invoices google_drive_folder_url: anyOf: - type: string - type: 'null' title: '' description: >- URL of a shared Google Drive folder containing PDF remittance files. All PDFs in this folder will be imported as remittances during sync. object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - google_sheets_url - google_drive_folder_url - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: SampleDataGeneratorConnection description: Sample Data Generator integration connection. ServiceNowConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: servicenow title: '' instance_url: type: string title: '' description: ServiceNow instance URL (e.g. https://dev12345.service-now.com) username: type: string title: '' description: ServiceNow username for basic auth object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - instance_url - username - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: ServiceNowConnection description: ServiceNow integration connection. ServiceTitanConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: servicetitan title: '' tenant_id: type: string title: '' description: The ServiceTitan tenant id used in API request paths. currency: type: string title: '' description: ISO 4217 currency code for this tenant's monetary values (e.g. USD). client_id: anyOf: - type: string - type: 'null' title: '' description: >- ServiceTitan tenant-specific OAuth2 client ID (from API Application Access). object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - tenant_id - currency - client_id - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: ServiceTitanConnection description: ServiceTitan integration connection. WorkdayConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: workday title: '' base_url: type: string title: '' description: Workday services base URL (e.g., https://services1.myworkday.com). tenant_id: type: string title: '' description: Workday tenant identifier used in report and SOAP URLs. username: type: string title: '' report_owner: anyOf: - type: string - type: 'null' title: '' description: ISU report owner used in RaaS report URLs (e.g., ISU_FINT6024). customers_report_path: anyOf: - type: string - type: 'null' title: '' description: >- FINT report path for customers/contacts (e.g., FINT6024a_Stuut_Customer_Outbound). invoices_report_path: anyOf: - type: string - type: 'null' title: '' description: >- FINT report path for invoices/credit memos (e.g., FINT6024b_Stuut_Customer_Invoice_Data_Outbound). payments_report_path: anyOf: - type: string - type: 'null' title: '' description: >- FINT report path for payments (e.g., FINT6024c_Stuut_Customer_Payments_Outbound). object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - base_url - tenant_id - username - report_owner - customers_report_path - invoices_report_path - payments_report_path - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: WorkdayConnection description: Workday integration connection. ZendeskConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: zendesk title: '' subdomain: type: string title: '' description: >- Zendesk subdomain (e.g. 'charteruphelp' for charteruphelp.zendesk.com). email: type: string title: '' description: >- Email of the Zendesk agent that owns the API token. Half of the auth credential pair (/token:), so treat as sensitive. object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - subdomain - email - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: ZendeskConnection description: Zendesk integration connection. ZuoraConnection: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' is_authentication_pending: type: boolean title: '' description: >- Whether this connection is still pending authentication. This is normally only used for oauth2 connections. is_running_setup: type: boolean title: '' is_sync_disabled: type: boolean title: '' description: >- Whether sync tasks are disabled. The intent of this column is to temporarily pause sync tasks for maintenance/deploys/etc. health: anyOf: - $ref: '#/components/schemas/IntegrationConnectionHealth' - type: 'null' title: '' models: items: $ref: '#/components/schemas/IntegrationConnectionModel' type: array title: '' description: List of unified models synced through this connection next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: When the next sync is scheduled to run. name: anyOf: - type: string - type: 'null' title: '' description: User defined name of the linked integration. owner_id: anyOf: - type: string - type: 'null' title: '' requires_setup: type: boolean title: '' provider_name: type: string const: zuora title: '' base_url: type: string title: '' description: >- Zuora API base URL provided by client during connection setup. Required. client_id: type: string title: '' description: OAuth2 client ID for Zuora API access. Required. client_secret: type: string format: password title: '' description: OAuth2 client secret for Zuora API access. Required. writeOnly: true object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true authorization_url: anyOf: - type: string - type: 'null' title: '' description: The authorization url for this connection. readOnly: true provider: $ref: '#/components/schemas/IntegrationProvider' title: '' description: The integration provider for this connection. readOnly: true is_configured: type: boolean title: '' description: Whether the integration connection is configured. readOnly: true missing_settings: items: type: string type: array title: '' description: List of missing settings. readOnly: true is_healthy: type: boolean title: '' description: >- Whether the integration connection is healthy. This is determined based on a few checks: 1. Configuration (e.g. settings) 2. Connection 3. Permissions readOnly: true linked_integration_id: anyOf: - type: string - type: 'null' title: '' description: The v1 linked integration id. readOnly: true type: object required: - created_at - modified_at - id - is_authentication_pending - is_running_setup - is_sync_disabled - health - models - next_sync_at - name - owner_id - requires_setup - provider_name - base_url - client_id - client_secret - object - authorization_url - provider - is_configured - missing_settings - is_healthy - linked_integration_id title: ZuoraConnection description: Zuora integration connection. ValidationError: properties: loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: type: string title: Type required: - loc - msg - type title: ValidationError type: object x-speakeasy-include: true NetsuiteAuthMethod: type: string enum: - oauth2 - m2m title: NetsuiteAuthMethod IntegrationConnectionHealth: properties: authentication_required: type: boolean title: '' description: Whether or not authentication is required to resolve the error. message: anyOf: - type: string - type: 'null' title: '' description: Human-readable error message. healthy: type: boolean title: '' status_code: $ref: '#/components/schemas/IntegrationHealthStatusCode' title: '' description: A list of error codes. suggested_resolution: anyOf: - type: string - type: 'null' title: '' description: Suggested resolution. timestamp: $ref: '#/components/schemas/UTCDateTime' title: '' description: The time the health status was set. readOnly: true type: object required: - authentication_required - message - healthy - status_code - suggested_resolution - timestamp title: IntegrationConnectionHealth IntegrationConnectionModel: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' name: type: string title: '' is_read_enabled: type: boolean title: '' is_write_enabled: type: boolean title: '' is_custom_object: type: boolean title: '' description: Whether this model is a custom object. is_file_upload_enabled: type: boolean title: '' is_webhooks_setup: type: boolean title: '' next_sync_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' connection_id: type: string title: '' last_sync: anyOf: - $ref: '#/components/schemas/IntegrationConnectionModelSync' - type: 'null' title: '' object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true display_name: type: string title: '' readOnly: true is_read_supported: type: boolean title: '' readOnly: true is_write_supported: type: boolean title: '' readOnly: true is_sync_supported: type: boolean title: '' readOnly: true type: object required: - created_at - modified_at - id - name - is_read_enabled - is_write_enabled - is_custom_object - is_file_upload_enabled - is_webhooks_setup - next_sync_at - connection_id - last_sync - object - display_name - is_read_supported - is_write_supported - is_sync_supported title: IntegrationConnectionModel UTCDateTime: type: string format: date-time IntegrationProvider: properties: name: $ref: '#/components/schemas/IntegrationProviderName' description: >- Unique name for the integration provider. Note: must contain only alphanumeric characters and dashes(-) auth_type: anyOf: - $ref: '#/components/schemas/IntegrationAuthType' - type: 'null' cash_app_features: $ref: '#/components/schemas/CashAppIntegrationFeatures' categories: items: $ref: '#/components/schemas/IntegrationCategory' type: array title: Categories color: anyOf: - type: string - type: 'null' title: Color connection_guide_url: anyOf: - type: string - type: 'null' title: Connection Guide Url connection_instructions: anyOf: - items: type: string type: array - type: 'null' title: Connection Instructions documentation_url: anyOf: - type: string - type: 'null' title: Documentation Url description: Provider documentation. description: anyOf: - type: string - type: 'null' title: Description display_name: type: string title: Display Name is_api_connection: type: boolean title: Is Api Connection description: >- Whether connection to this integration provider is done through an API. is_enabled: type: boolean title: Is Enabled default: true is_manual_sync_supported: type: boolean title: Is Manual Sync Supported description: Whether this integration supports manually triggering sync. default: true is_webhooks_supported: type: boolean title: Is Webhooks Supported description: Whether or not the integration is enabled logo: anyOf: - type: string - type: 'null' title: Logo description: URL to the provider's logo. logo_square: anyOf: - type: string - type: 'null' title: Logo Square description: URL to the provider's square logo. required_settings: items: type: string type: array title: Required Settings short_description: anyOf: - type: string - type: 'null' title: Short Description website: anyOf: - type: string - type: 'null' title: Website type: object required: - name - categories - display_name - is_api_connection - is_webhooks_supported title: IntegrationProvider Timezone: type: string enum: - Africa/Abidjan - Africa/Cairo - Africa/Johannesburg - Africa/Lagos - Africa/Maputo - Africa/Nairobi - Africa/Tripoli - America/Adak - America/Anchorage - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/Mendoza - America/Chicago - America/Denver - America/Detroit - America/Edmonton - America/Halifax - America/Havana - America/Indiana/Indianapolis - America/Indiana/Knox - America/Iqaluit - America/Jamaica - America/Kentucky/Louisville - America/Los_Angeles - America/Manaus - America/Mazatlan - America/Mexico_City - America/New_York - America/Noronha - America/Nuuk - America/Panama - America/Phoenix - America/Puerto_Rico - America/Regina - America/Rio_Branco - America/Santiago - America/Sao_Paulo - America/St_Johns - America/Tijuana - America/Toronto - America/Vancouver - America/Whitehorse - America/Winnipeg - Asia/Ashgabat - Asia/Bangkok - Asia/Dhaka - Asia/Dubai - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Jerusalem - Asia/Kathmandu - Asia/Kolkata - Asia/Kuching - Asia/Macau - Asia/Makassar - Asia/Nicosia - Asia/Qatar - Asia/Riyadh - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Taipei - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Yangon - Atlantic/Faroe - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Darwin - Australia/Hobart - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Etc/GMT - Etc/UTC - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Brussels - Europe/Chisinau - Europe/Dublin - Europe/Helsinki - Europe/Istanbul - Europe/Kyiv - Europe/Lisbon - Europe/London - Europe/Moscow - Europe/Paris - Europe/Prague - Europe/Rome - Europe/Warsaw - Europe/Zurich - Indian/Maldives - Pacific/Auckland - Pacific/Chatham - Pacific/Easter - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Kanton - Pacific/Kwajalein - Pacific/Pago_Pago - Pacific/Port_Moresby - Pacific/Tarawa minLength: 1 title: Timezone description: IANA canonical timezone. IntegrationHealthStatusCode: type: string enum: - healthy - invalid_credentials - missing_permission - missing_settings - unknown_error - connection_issue - timeout x-speakeasy-enum-format: union IntegrationConnectionModelSync: properties: created_at: type: string format: date-time title: '' modified_at: anyOf: - type: string format: date-time - type: 'null' title: '' id: type: string title: '' status: $ref: '#/components/schemas/IntegrationSyncStatus' title: '' attempt: type: integer title: '' description: >- Number of attempts made to run this sync. 0 means no attempts have been made. batch_id: anyOf: - type: string format: uuid - type: 'null' title: '' completed_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' entity_id: anyOf: - type: string - type: 'null' title: '' error: anyOf: - type: string - type: 'null' title: '' description: Error message if the sync failed. file_id: anyOf: - type: string - type: 'null' title: '' is_initial_sync: type: boolean title: '' is_one_off: type: boolean title: '' description: Whether or not this is a one off sync model_id: type: string title: '' pagination_state: anyOf: - additionalProperties: true type: object - type: 'null' title: '' started_at: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' timerange_end: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: End of the time range for which data is being synced. timerange_start: anyOf: - $ref: '#/components/schemas/UTCDateTime' - type: 'null' title: '' description: Start of the time range for which data is being synced. object: type: string title: '' description: >- String representing the object's type. Objects of the same type share the same value. readOnly: true type: object required: - created_at - modified_at - id - status - attempt - batch_id - completed_at - entity_id - error - file_id - is_initial_sync - is_one_off - model_id - pagination_state - started_at - timerange_end - timerange_start - object title: IntegrationConnectionModelSync IntegrationProviderName: type: string enum: - acumatica - bill - billingplatform - boomi - chargebee - citi - jpmc - kyriba - maxio-legacy - ms-dynamics-bc - ms-dynamics-fo - netsuite - odoo - oracle-fusion - quickbooks - quickbooks-desktop - sage-intacct - salesforce-accountingseed - sample-data-generator - servicenow - servicetitan - stripe - workday - zendesk - zuora x-speakeasy-enum-format: union IntegrationAuthType: type: string enum: - api_key - basic - custom - oauth1 - oauth2 - oauth2_cc title: IntegrationAuthType CashAppIntegrationFeatures: properties: can_unpost_payment: type: boolean title: Can Unpost Payment default: false can_post_on_account_payment: type: boolean title: Can Post On Account Payment default: false type: object title: CashAppIntegrationFeatures IntegrationCategory: type: string enum: - accounting - banking - communication - crm - file-storage x-speakeasy-enum-format: union IntegrationSyncStatus: type: string enum: - scheduled - queued - running - cancelled - failed - pending_retry - complete title: IntegrationSyncStatus securitySchemes: HTTPBearer: type: http scheme: bearer ````