--- title: "Activate Workflow" method: POST path: "/v2/workflows/{workflow_id}/activate" tags: ["workflows"] --- # Activate Workflow `POST /v2/workflows/{workflow_id}/activate` ## Request - Base URL: `https://api.stuut.ai` (the document declares no server; this is the origin it was published from) - URL: `https://api.stuut.ai/v2/workflows/{workflow_id}/activate` - Auth: HTTP bearer Validate a workflow and mark it active when there are no activation errors. ## Path parameters - `workflow_id` string, required ## Response `200` Successful Response - WorkflowActivationResponse - `workflow` Workflow, required - `created_at` string, date-time, required - `modified_at` string, date-time, nullable, required - `id` string, required - `name` string, required: Admin-facing workflow name. - `description` string, nullable, required: Optional notes describing the workflow purpose. - `status` 'draft' | 'paused' | 'finished' | 'active', required - `action_execution_strategy` 'sequential' | 'parallel' | 'percentage', required - `segment_matching_mode` 'any' | 'highest_priority' - `business_unit_id` string, nullable, required: Optional business unit assigned to this workflow. - `workflow_group_id` string, nullable, required: Optional collection coordinating independent workflows. - `segments` WorkflowSegment[], required - `created_at` string, date-time, required - `modified_at` string, date-time, nullable, required - `id` string, required - `name` string, required: The name of the segment (case-insensitive unique per org). - `object` string, required: String representing the object's type. Objects of the same type share the same value. - `triggers` WorkflowTrigger[], required - `created_at` string, date-time, required - `modified_at` string, date-time, nullable, required - `id` string, required - `trigger_type` 'event' | 'schedule', required - `event_name` string, nullable, required: Canonical event identity for EVENT triggers (matches Event.name), such as invoice.created. The entity and action are derived from it — see event_entity / event_action. - `schedule_config` object, nullable, required: Scheduled/date-based trigger configuration. - `clause` WorkflowClauseOutput, required: A recursive FQL clause over concrete workflow context entities. - `and` WorkflowClauseOutput[]: Additional filters that must all match. - `or` WorkflowClauseOutput[]: Alternative filters where at least one must match. - `event` EventWorkflowFilterOutput: Stable fields from the event envelope available to workflow clauses. - `and` EventWorkflowFilterOutput[]: Additional filters that must all match. - `or` EventWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `name` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `entityType` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `entityId` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `occurredAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `triggerAdjustment` AdjustmentWorkflowFilterOutput - `and` AdjustmentWorkflowFilterOutput[]: Additional filters that must all match. - `or` AdjustmentWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `name` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `isActive` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isSystem` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `automated` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `description` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `ledgerAccountId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerBankStatement` BankStatementWorkflowFilterOutput - `and` BankStatementWorkflowFilterOutput[]: Additional filters that must all match. - `or` BankStatementWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `periodEnd` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `periodStart` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `status` EqualityComparatorStatus - `eq` 'submitted' | 'processing' | 'invalid' | 'pending_approval' | 'approved' | 'split' | 'synced' - `neq` 'submitted' | 'processing' | 'invalid' | 'pending_approval' | 'approved' | 'split' | 'synced' - `in` Status[] - `nin` Status[] - `accountId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `approverId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `uploaderId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `agentConfidenceScore` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `agentErrorCode` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerBankTransaction` BankTransactionWorkflowFilterOutput - `and` BankTransactionWorkflowFilterOutput[]: Additional filters that must all match. - `or` BankTransactionWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `amount` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `authorizedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `checkNumber` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `counterpartyEmail` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `counterpartyName` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `customerReference` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `currency` union - EqualityComparatorCurrency - … - NullComparator: Test whether a nullable scalar field is null. - … - `description` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `isDraft` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `amountHandledOutside` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `handledOutsideReason` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `isPayment` union - EqualityComparatorBool - … - NullComparator: Test whether a nullable scalar field is null. - … - `nonPaymentReason` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `paymentMethod` union - EqualityComparatorPaymentMethodType - … - NullComparator: Test whether a nullable scalar field is null. - … - `posted` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `referenceNumber` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `remoteId` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `timestamp` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `type` EqualityComparatorBankTransactionType - `eq` 'deposit' | 'withdrawal' - `neq` 'deposit' | 'withdrawal' - `in` BankTransactionType[] - `nin` BankTransactionType[] - `accountId` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `partnerId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `payoutId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `statementId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerCall` CallWorkflowFilterOutput - `and` CallWorkflowFilterOutput[]: Additional filters that must all match. - `or` CallWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `callReason` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `direction` EqualityComparatorCallDirection - `eq` 'inbound' | 'outbound' - `neq` 'inbound' | 'outbound' - `in` CallDirection[] - `nin` CallDirection[] - `disconnectionReason` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `endTime` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `inVoicemail` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isAutomated` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `recordingConsentGranted` union - EqualityComparatorBool - … - NullComparator: Test whether a nullable scalar field is null. - … - `sentiment` union - EqualityComparatorCallSentiment - … - NullComparator: Test whether a nullable scalar field is null. - … - `startTime` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `status` EqualityComparatorCallStatus - `eq` 'pending_approval' | 'queued' | 'registered' | 'initiated' | 'ringing' | 'canceled' | 'in_progress' | 'completed' | 'busy' | 'no_answer' | 'failed' | 'awaiting_post_processing' - `neq` 'pending_approval' | 'queued' | 'registered' | 'initiated' | 'ringing' | 'canceled' | 'in_progress' | 'completed' | 'busy' | 'no_answer' | 'failed' | 'awaiting_post_processing' - `in` CallStatus[] - `nin` CallStatus[] - `callAgentId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `partnerId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerContact` ContactWorkflowFilterOutput - `and` ContactWorkflowFilterOutput[]: Additional filters that must all match. - `or` ContactWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `customFields` DynamicFieldsOutput: Arbitrary JSON-backed field names with structurally typed comparators. - `email` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `familyName` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `givenName` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `isEmailDisabled` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isPhoneDisabled` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isSmsDisabled` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isPrimary` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isPrimaryEmail` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isPrimaryPhone` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `name` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `phone` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `jobTitle` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `internalRole` union - EqualityComparatorInternalContactType - … - NullComparator: Test whether a nullable scalar field is null. - … - `externalRole` union - EqualityComparatorExternalContactType - … - NullComparator: Test whether a nullable scalar field is null. - … - `addressId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `partnerId` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `remoteId` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerDispute` DisputeWorkflowFilterOutput: Typed dispute fields available to workflow conditions, including the SLA tier a Kaseya-style follow-up cadence branches on. - `and` DisputeWorkflowFilterOutput[]: Additional filters that must all match. - `or` DisputeWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `status` EqualityComparatorDisputeStatus - `eq` 'proposed' | 'in_process' | 'needs_review' | 'resolved' | 'closed': Status of a dispute in the resolution workflow. - `neq` 'proposed' | 'in_process' | 'needs_review' | 'resolved' | 'closed': Status of a dispute in the resolution workflow. - `in` DisputeStatus[] - `nin` DisputeStatus[] - `priority` EqualityComparatorDisputePriority - `eq` 'low' | 'medium' | 'high' | 'urgent': Priority level for dispute resolution. - `neq` 'low' | 'medium' | 'high' | 'urgent': Priority level for dispute resolution. - `in` DisputePriority[] - `nin` DisputePriority[] - `amount` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `currency` union - EqualityComparatorCurrency - … - NullComparator: Test whether a nullable scalar field is null. - … - `reasonCode` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `isOriginatedInStuut` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `assigneeId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `partnerId` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `triggerEmail` EmailWorkflowFilterOutput - `and` EmailWorkflowFilterOutput[]: Additional filters that must all match. - `or` EmailWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `direction` EqualityComparatorRequestDirection - `eq` 'inbound' | 'outbound' - `neq` 'inbound' | 'outbound' - `in` RequestDirection[] - `nin` RequestDirection[] - `emailReason` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `errorMessage` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `isGenerated` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isInternal` union - EqualityComparatorBool - … - NullComparator: Test whether a nullable scalar field is null. - … - `isAutomated` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isOriginatedInStuut` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isUnread` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `sentAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `status` EqualityComparatorEmailStatus - `eq` 'draft' | 'pending' | 'sending' | 'sent' | 'error' - `neq` 'draft' | 'pending' | 'sending' | 'sent' | 'error' - `in` EmailStatus[] - `nin` EmailStatus[] - `subject` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `authorId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `emailSenderId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `sentById` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `threadId` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `triggerExport` ExportWorkflowFilterOutput - `and` ExportWorkflowFilterOutput[]: Additional filters that must all match. - `or` ExportWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `exportType` EqualityComparatorExportType - `eq` 'invoice' | 'partner' | 'payment' | 'analytics' | 'bank_transaction' | 'credit_memo' | 'customer_transaction' | 'invoice_pdf' | 'audit_log' | 'ask_stuut_table' | 'journal_entry' | 'ar_aging' | 'collections_readiness' - `neq` 'invoice' | 'partner' | 'payment' | 'analytics' | 'bank_transaction' | 'credit_memo' | 'customer_transaction' | 'invoice_pdf' | 'audit_log' | 'ask_stuut_table' | 'journal_entry' | 'ar_aging' | 'collections_readiness' - `in` ExportType[] - `nin` ExportType[] - `status` EqualityComparatorExportStatus - `eq` 'pending' | 'processing' | 'completed' | 'failed' - `neq` 'pending' | 'processing' | 'completed' | 'failed' - `in` ExportStatus[] - `nin` ExportStatus[] - `recordCount` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `startedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `completedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `userId` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `triggerInvoice` InvoiceWorkflowFilterOutput: Typed invoice fields that can be compiled directly to SQLAlchemy. - `and` InvoiceWorkflowFilterOutput[]: Additional filters that must all match. - `or` InvoiceWorkflowFilterOutput[]: Alternative filters where at least one must match. - `customFields` DynamicFieldsOutput: Arbitrary JSON-backed field names with structurally typed comparators. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `number` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `currency` EqualityComparatorCurrency - `eq` 'ADP' | 'AED' | 'AFA' | 'AFN' | 'ALK' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'AOK' | 'AON' | 'AOR' | 'ARA' | 'ARL' | 'ARM' | 'ARP' | 'ARS' | 'ATS' | 'AUD' | 'AWG' | 'AZM' | 'AZN' | 'BAD' | 'BAM' | 'BAN' | 'BBD' | 'BDT' | 'BEC' | 'BEF' | 'BEL' | 'BGL' | 'BGM' | 'BGN' | 'BGO' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOL' | 'BOP' | 'BOV' | 'BRB' | 'BRC' | 'BRE' | 'BRL' | 'BRN' | 'BRR' | 'BRZ' | 'BSD' | 'BTN' | 'BUK' | 'BWP' | 'BYB' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLE' | 'CLF' | 'CLP' | 'CNH' | 'CNX' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CSD' | 'CSK' | 'CUC' | 'CUP' | 'CVE' | 'CYP' | 'CZK' | 'DDM' | 'DEM' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'ECS' | 'ECV' | 'EEK' | 'EGP' | 'ERN' | 'ESA' | 'ESB' | 'ESP' | 'ETB' | 'EUR' | 'FIM' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEK' | 'GEL' | 'GHC' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GNS' | 'GQE' | 'GRD' | 'GTQ' | 'GWE' | 'GWP' | 'GYD' | 'HKD' | 'HNL' | 'HRD' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'IEP' | 'ILP' | 'ILR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISJ' | 'ISK' | 'ITL' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRH' | 'KRO' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LTT' | 'LUC' | 'LUF' | 'LUL' | 'LVL' | 'LVR' | 'LYD' | 'MAD' | 'MAF' | 'MCF' | 'MDC' | 'MDL' | 'MGA' | 'MGF' | 'MKD' | 'MKN' | 'MLF' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MTL' | 'MTP' | 'MUR' | 'MVP' | 'MVR' | 'MWK' | 'MXN' | 'MXP' | 'MXV' | 'MYR' | 'MZE' | 'MZM' | 'MZN' | 'NAD' | 'NGN' | 'NIC' | 'NIO' | 'NLG' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEI' | 'PEN' | 'PES' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PLZ' | 'PTE' | 'PYG' | 'QAR' | 'RHD' | 'ROL' | 'RON' | 'RSD' | 'RUB' | 'RUR' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDD' | 'SDG' | 'SDP' | 'SEK' | 'SGD' | 'SHP' | 'SIT' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SRG' | 'SSP' | 'STD' | 'STN' | 'SUR' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJR' | 'TJS' | 'TMM' | 'TMT' | 'TND' | 'TOP' | 'TPE' | 'TRL' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UAK' | 'UGS' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYP' | 'UYU' | 'UYW' | 'UZS' | 'VEB' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VNN' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XEU' | 'XFO' | 'XFU' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XRE' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YDD' | 'YER' | 'YUD' | 'YUM' | 'YUN' | 'YUR' | 'ZAL' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZRN' | 'ZRZ' | 'ZWD' | 'ZWL' | 'ZWR': The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. - `neq` 'ADP' | 'AED' | 'AFA' | 'AFN' | 'ALK' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'AOK' | 'AON' | 'AOR' | 'ARA' | 'ARL' | 'ARM' | 'ARP' | 'ARS' | 'ATS' | 'AUD' | 'AWG' | 'AZM' | 'AZN' | 'BAD' | 'BAM' | 'BAN' | 'BBD' | 'BDT' | 'BEC' | 'BEF' | 'BEL' | 'BGL' | 'BGM' | 'BGN' | 'BGO' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOL' | 'BOP' | 'BOV' | 'BRB' | 'BRC' | 'BRE' | 'BRL' | 'BRN' | 'BRR' | 'BRZ' | 'BSD' | 'BTN' | 'BUK' | 'BWP' | 'BYB' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLE' | 'CLF' | 'CLP' | 'CNH' | 'CNX' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CSD' | 'CSK' | 'CUC' | 'CUP' | 'CVE' | 'CYP' | 'CZK' | 'DDM' | 'DEM' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'ECS' | 'ECV' | 'EEK' | 'EGP' | 'ERN' | 'ESA' | 'ESB' | 'ESP' | 'ETB' | 'EUR' | 'FIM' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEK' | 'GEL' | 'GHC' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GNS' | 'GQE' | 'GRD' | 'GTQ' | 'GWE' | 'GWP' | 'GYD' | 'HKD' | 'HNL' | 'HRD' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'IEP' | 'ILP' | 'ILR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISJ' | 'ISK' | 'ITL' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRH' | 'KRO' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LTT' | 'LUC' | 'LUF' | 'LUL' | 'LVL' | 'LVR' | 'LYD' | 'MAD' | 'MAF' | 'MCF' | 'MDC' | 'MDL' | 'MGA' | 'MGF' | 'MKD' | 'MKN' | 'MLF' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MTL' | 'MTP' | 'MUR' | 'MVP' | 'MVR' | 'MWK' | 'MXN' | 'MXP' | 'MXV' | 'MYR' | 'MZE' | 'MZM' | 'MZN' | 'NAD' | 'NGN' | 'NIC' | 'NIO' | 'NLG' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEI' | 'PEN' | 'PES' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PLZ' | 'PTE' | 'PYG' | 'QAR' | 'RHD' | 'ROL' | 'RON' | 'RSD' | 'RUB' | 'RUR' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDD' | 'SDG' | 'SDP' | 'SEK' | 'SGD' | 'SHP' | 'SIT' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SRG' | 'SSP' | 'STD' | 'STN' | 'SUR' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJR' | 'TJS' | 'TMM' | 'TMT' | 'TND' | 'TOP' | 'TPE' | 'TRL' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UAK' | 'UGS' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYP' | 'UYU' | 'UYW' | 'UZS' | 'VEB' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VNN' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XEU' | 'XFO' | 'XFU' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XRE' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YDD' | 'YER' | 'YUD' | 'YUM' | 'YUN' | 'YUR' | 'ZAL' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZRN' | 'ZRZ' | 'ZWD' | 'ZWL' | 'ZWR': The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. - `in` Currency[] - `nin` Currency[] - `amountDue` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `amountPaid` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `amountRemaining` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `totalAmount` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `dueDate` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `issuedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `paidAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `promisedToPayDate` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `purchaseOrderNumber` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `orderNumber` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `lastOutreachAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `lastOutreachTo` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `inDispute` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isOpen` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `remotePaymentStatus` union - EqualityComparatorPaymentStatus - … - NullComparator: Test whether a nullable scalar field is null. - … - `status` EqualityComparatorInvoiceStatus - `eq` 'draft' | 'open' | 'uncollectible' | 'paid' | 'void': Invoice status. - `neq` 'draft' | 'open' | 'uncollectible' | 'paid' | 'void': Invoice status. - `in` InvoiceStatus[] - `nin` InvoiceStatus[] - `virtualStatus` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `daysOverdue` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `daysUntilDue` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerOrganization` OrganizationWorkflowFilterOutput - `and` OrganizationWorkflowFilterOutput[]: Additional filters that must all match. - `or` OrganizationWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `name` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `displayName` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `currency` EqualityComparatorCurrency - `eq` 'ADP' | 'AED' | 'AFA' | 'AFN' | 'ALK' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'AOK' | 'AON' | 'AOR' | 'ARA' | 'ARL' | 'ARM' | 'ARP' | 'ARS' | 'ATS' | 'AUD' | 'AWG' | 'AZM' | 'AZN' | 'BAD' | 'BAM' | 'BAN' | 'BBD' | 'BDT' | 'BEC' | 'BEF' | 'BEL' | 'BGL' | 'BGM' | 'BGN' | 'BGO' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOL' | 'BOP' | 'BOV' | 'BRB' | 'BRC' | 'BRE' | 'BRL' | 'BRN' | 'BRR' | 'BRZ' | 'BSD' | 'BTN' | 'BUK' | 'BWP' | 'BYB' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLE' | 'CLF' | 'CLP' | 'CNH' | 'CNX' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CSD' | 'CSK' | 'CUC' | 'CUP' | 'CVE' | 'CYP' | 'CZK' | 'DDM' | 'DEM' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'ECS' | 'ECV' | 'EEK' | 'EGP' | 'ERN' | 'ESA' | 'ESB' | 'ESP' | 'ETB' | 'EUR' | 'FIM' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEK' | 'GEL' | 'GHC' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GNS' | 'GQE' | 'GRD' | 'GTQ' | 'GWE' | 'GWP' | 'GYD' | 'HKD' | 'HNL' | 'HRD' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'IEP' | 'ILP' | 'ILR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISJ' | 'ISK' | 'ITL' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRH' | 'KRO' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LTT' | 'LUC' | 'LUF' | 'LUL' | 'LVL' | 'LVR' | 'LYD' | 'MAD' | 'MAF' | 'MCF' | 'MDC' | 'MDL' | 'MGA' | 'MGF' | 'MKD' | 'MKN' | 'MLF' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MTL' | 'MTP' | 'MUR' | 'MVP' | 'MVR' | 'MWK' | 'MXN' | 'MXP' | 'MXV' | 'MYR' | 'MZE' | 'MZM' | 'MZN' | 'NAD' | 'NGN' | 'NIC' | 'NIO' | 'NLG' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEI' | 'PEN' | 'PES' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PLZ' | 'PTE' | 'PYG' | 'QAR' | 'RHD' | 'ROL' | 'RON' | 'RSD' | 'RUB' | 'RUR' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDD' | 'SDG' | 'SDP' | 'SEK' | 'SGD' | 'SHP' | 'SIT' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SRG' | 'SSP' | 'STD' | 'STN' | 'SUR' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJR' | 'TJS' | 'TMM' | 'TMT' | 'TND' | 'TOP' | 'TPE' | 'TRL' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UAK' | 'UGS' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYP' | 'UYU' | 'UYW' | 'UZS' | 'VEB' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VNN' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XEU' | 'XFO' | 'XFU' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XRE' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YDD' | 'YER' | 'YUD' | 'YUM' | 'YUN' | 'YUR' | 'ZAL' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZRN' | 'ZRZ' | 'ZWD' | 'ZWL' | 'ZWR': The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. - `neq` 'ADP' | 'AED' | 'AFA' | 'AFN' | 'ALK' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'AOK' | 'AON' | 'AOR' | 'ARA' | 'ARL' | 'ARM' | 'ARP' | 'ARS' | 'ATS' | 'AUD' | 'AWG' | 'AZM' | 'AZN' | 'BAD' | 'BAM' | 'BAN' | 'BBD' | 'BDT' | 'BEC' | 'BEF' | 'BEL' | 'BGL' | 'BGM' | 'BGN' | 'BGO' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOL' | 'BOP' | 'BOV' | 'BRB' | 'BRC' | 'BRE' | 'BRL' | 'BRN' | 'BRR' | 'BRZ' | 'BSD' | 'BTN' | 'BUK' | 'BWP' | 'BYB' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLE' | 'CLF' | 'CLP' | 'CNH' | 'CNX' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CSD' | 'CSK' | 'CUC' | 'CUP' | 'CVE' | 'CYP' | 'CZK' | 'DDM' | 'DEM' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'ECS' | 'ECV' | 'EEK' | 'EGP' | 'ERN' | 'ESA' | 'ESB' | 'ESP' | 'ETB' | 'EUR' | 'FIM' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEK' | 'GEL' | 'GHC' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GNS' | 'GQE' | 'GRD' | 'GTQ' | 'GWE' | 'GWP' | 'GYD' | 'HKD' | 'HNL' | 'HRD' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'IEP' | 'ILP' | 'ILR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISJ' | 'ISK' | 'ITL' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRH' | 'KRO' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LTT' | 'LUC' | 'LUF' | 'LUL' | 'LVL' | 'LVR' | 'LYD' | 'MAD' | 'MAF' | 'MCF' | 'MDC' | 'MDL' | 'MGA' | 'MGF' | 'MKD' | 'MKN' | 'MLF' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MTL' | 'MTP' | 'MUR' | 'MVP' | 'MVR' | 'MWK' | 'MXN' | 'MXP' | 'MXV' | 'MYR' | 'MZE' | 'MZM' | 'MZN' | 'NAD' | 'NGN' | 'NIC' | 'NIO' | 'NLG' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEI' | 'PEN' | 'PES' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PLZ' | 'PTE' | 'PYG' | 'QAR' | 'RHD' | 'ROL' | 'RON' | 'RSD' | 'RUB' | 'RUR' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDD' | 'SDG' | 'SDP' | 'SEK' | 'SGD' | 'SHP' | 'SIT' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SRG' | 'SSP' | 'STD' | 'STN' | 'SUR' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJR' | 'TJS' | 'TMM' | 'TMT' | 'TND' | 'TOP' | 'TPE' | 'TRL' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UAK' | 'UGS' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYP' | 'UYU' | 'UYW' | 'UZS' | 'VEB' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VNN' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XEU' | 'XFO' | 'XFU' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XRE' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YDD' | 'YER' | 'YUD' | 'YUM' | 'YUN' | 'YUR' | 'ZAL' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZRN' | 'ZRZ' | 'ZWD' | 'ZWL' | 'ZWR': The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. - `in` Currency[] - `nin` Currency[] - `timezone` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `triggerPartner` PartnerWorkflowFilterOutput: Typed customer fields that can be compiled directly to SQLAlchemy. - `and` PartnerWorkflowFilterOutput[]: Additional filters that must all match. - `or` PartnerWorkflowFilterOutput[]: Alternative filters where at least one must match. - `customFields` DynamicFieldsOutput: Arbitrary JSON-backed field names with structurally typed comparators. - `address` AddressFilterOutput - `and` AddressFilterOutput[]: Additional filters that must all match. - `or` AddressFilterOutput[]: Alternative filters where at least one must match. - `country` EqualityComparatorCountryCode - … - `region` EqualityComparatorRegion - … - `creditMemos` CollectionCreditMemoWorkflowFilterOutput - `and` CollectionCreditMemoWorkflowFilterOutput[]: Additional filters that must all match. - `or` CollectionCreditMemoWorkflowFilterOutput[]: Alternative filters where at least one must match. - `some` CreditMemoWorkflowFilterOutput: Typed credit-memo fields used to scope account statement contents. - … - `none` CreditMemoWorkflowFilterOutput: Typed credit-memo fields used to scope account statement contents. - … - `every` CreditMemoWorkflowFilterOutput: Typed credit-memo fields used to scope account statement contents. - … - `length` union - … - `exists` boolean - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `accountNumber` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `assigneeId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `businessUnitId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `currency` union - EqualityComparatorCurrency - … - NullComparator: Test whether a nullable scalar field is null. - … - `email` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `invoices` CollectionInvoiceWorkflowFilterOutput - `and` CollectionInvoiceWorkflowFilterOutput[]: Additional filters that must all match. - `or` CollectionInvoiceWorkflowFilterOutput[]: Alternative filters where at least one must match. - `some` InvoiceWorkflowFilterOutput: Typed invoice fields that can be compiled directly to SQLAlchemy. - … - `none` InvoiceWorkflowFilterOutput: Typed invoice fields that can be compiled directly to SQLAlchemy. - … - `every` InvoiceWorkflowFilterOutput: Typed invoice fields that can be compiled directly to SQLAlchemy. - … - `length` union - … - `exists` boolean - `name` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `legalName` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `phone` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `parentId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `remoteId` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `stats` PartnerStatsFilterOutput - `and` PartnerStatsFilterOutput[]: Additional filters that must all match. - `or` PartnerStatsFilterOutput[]: Alternative filters where at least one must match. - `totalBalance` union: The customer's total outstanding invoice balance. - … - `netAccountBalance` union: The customer's total outstanding invoice balance minus credits and unapplied payments. - … - `invoicedLast12Months` union: The total of the customer's open, paid, and uncollectible invoices issued in the last 12 months, in the organization's currency. Invoices dated after today are not counted. - … - `overdueBalance` union: The customer's total overdue invoice balance. - … - `openInvoiceCount` union: The customer's number of open invoices. - … - `overdueInvoiceCount` union: The customer's number of overdue invoices. - … - `oldestOpenInvoiceDueDate` union: The earliest due date among the customer's open invoices, or whether one exists. Accepts a date or a relative ISO 8601 duration: lte -P60D matches customers whose oldest open invoice is at least 60 days past due. - … - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerPayment` PaymentWorkflowFilterOutput: Typed payment fields that can be compiled directly to SQLAlchemy. - `and` PaymentWorkflowFilterOutput[]: Additional filters that must all match. - `or` PaymentWorkflowFilterOutput[]: Alternative filters where at least one must match. - `customFields` DynamicFieldsOutput: Arbitrary JSON-backed field names with structurally typed comparators. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `partnerId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `amount` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `amountRefunded` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `currency` EqualityComparatorCurrency - `eq` 'ADP' | 'AED' | 'AFA' | 'AFN' | 'ALK' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'AOK' | 'AON' | 'AOR' | 'ARA' | 'ARL' | 'ARM' | 'ARP' | 'ARS' | 'ATS' | 'AUD' | 'AWG' | 'AZM' | 'AZN' | 'BAD' | 'BAM' | 'BAN' | 'BBD' | 'BDT' | 'BEC' | 'BEF' | 'BEL' | 'BGL' | 'BGM' | 'BGN' | 'BGO' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOL' | 'BOP' | 'BOV' | 'BRB' | 'BRC' | 'BRE' | 'BRL' | 'BRN' | 'BRR' | 'BRZ' | 'BSD' | 'BTN' | 'BUK' | 'BWP' | 'BYB' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLE' | 'CLF' | 'CLP' | 'CNH' | 'CNX' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CSD' | 'CSK' | 'CUC' | 'CUP' | 'CVE' | 'CYP' | 'CZK' | 'DDM' | 'DEM' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'ECS' | 'ECV' | 'EEK' | 'EGP' | 'ERN' | 'ESA' | 'ESB' | 'ESP' | 'ETB' | 'EUR' | 'FIM' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEK' | 'GEL' | 'GHC' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GNS' | 'GQE' | 'GRD' | 'GTQ' | 'GWE' | 'GWP' | 'GYD' | 'HKD' | 'HNL' | 'HRD' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'IEP' | 'ILP' | 'ILR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISJ' | 'ISK' | 'ITL' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRH' | 'KRO' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LTT' | 'LUC' | 'LUF' | 'LUL' | 'LVL' | 'LVR' | 'LYD' | 'MAD' | 'MAF' | 'MCF' | 'MDC' | 'MDL' | 'MGA' | 'MGF' | 'MKD' | 'MKN' | 'MLF' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MTL' | 'MTP' | 'MUR' | 'MVP' | 'MVR' | 'MWK' | 'MXN' | 'MXP' | 'MXV' | 'MYR' | 'MZE' | 'MZM' | 'MZN' | 'NAD' | 'NGN' | 'NIC' | 'NIO' | 'NLG' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEI' | 'PEN' | 'PES' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PLZ' | 'PTE' | 'PYG' | 'QAR' | 'RHD' | 'ROL' | 'RON' | 'RSD' | 'RUB' | 'RUR' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDD' | 'SDG' | 'SDP' | 'SEK' | 'SGD' | 'SHP' | 'SIT' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SRG' | 'SSP' | 'STD' | 'STN' | 'SUR' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJR' | 'TJS' | 'TMM' | 'TMT' | 'TND' | 'TOP' | 'TPE' | 'TRL' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UAK' | 'UGS' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYP' | 'UYU' | 'UYW' | 'UZS' | 'VEB' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VNN' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XEU' | 'XFO' | 'XFU' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XRE' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YDD' | 'YER' | 'YUD' | 'YUM' | 'YUN' | 'YUR' | 'ZAL' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZRN' | 'ZRZ' | 'ZWD' | 'ZWL' | 'ZWR': The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. - `neq` 'ADP' | 'AED' | 'AFA' | 'AFN' | 'ALK' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'AOK' | 'AON' | 'AOR' | 'ARA' | 'ARL' | 'ARM' | 'ARP' | 'ARS' | 'ATS' | 'AUD' | 'AWG' | 'AZM' | 'AZN' | 'BAD' | 'BAM' | 'BAN' | 'BBD' | 'BDT' | 'BEC' | 'BEF' | 'BEL' | 'BGL' | 'BGM' | 'BGN' | 'BGO' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOL' | 'BOP' | 'BOV' | 'BRB' | 'BRC' | 'BRE' | 'BRL' | 'BRN' | 'BRR' | 'BRZ' | 'BSD' | 'BTN' | 'BUK' | 'BWP' | 'BYB' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLE' | 'CLF' | 'CLP' | 'CNH' | 'CNX' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CSD' | 'CSK' | 'CUC' | 'CUP' | 'CVE' | 'CYP' | 'CZK' | 'DDM' | 'DEM' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'ECS' | 'ECV' | 'EEK' | 'EGP' | 'ERN' | 'ESA' | 'ESB' | 'ESP' | 'ETB' | 'EUR' | 'FIM' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEK' | 'GEL' | 'GHC' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GNS' | 'GQE' | 'GRD' | 'GTQ' | 'GWE' | 'GWP' | 'GYD' | 'HKD' | 'HNL' | 'HRD' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'IEP' | 'ILP' | 'ILR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISJ' | 'ISK' | 'ITL' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRH' | 'KRO' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LTT' | 'LUC' | 'LUF' | 'LUL' | 'LVL' | 'LVR' | 'LYD' | 'MAD' | 'MAF' | 'MCF' | 'MDC' | 'MDL' | 'MGA' | 'MGF' | 'MKD' | 'MKN' | 'MLF' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MTL' | 'MTP' | 'MUR' | 'MVP' | 'MVR' | 'MWK' | 'MXN' | 'MXP' | 'MXV' | 'MYR' | 'MZE' | 'MZM' | 'MZN' | 'NAD' | 'NGN' | 'NIC' | 'NIO' | 'NLG' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEI' | 'PEN' | 'PES' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PLZ' | 'PTE' | 'PYG' | 'QAR' | 'RHD' | 'ROL' | 'RON' | 'RSD' | 'RUB' | 'RUR' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDD' | 'SDG' | 'SDP' | 'SEK' | 'SGD' | 'SHP' | 'SIT' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SRG' | 'SSP' | 'STD' | 'STN' | 'SUR' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJR' | 'TJS' | 'TMM' | 'TMT' | 'TND' | 'TOP' | 'TPE' | 'TRL' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UAK' | 'UGS' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYP' | 'UYU' | 'UYW' | 'UZS' | 'VEB' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VNN' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XEU' | 'XFO' | 'XFU' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XRE' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YDD' | 'YER' | 'YUD' | 'YUM' | 'YUN' | 'YUR' | 'ZAL' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZRN' | 'ZRZ' | 'ZWD' | 'ZWL' | 'ZWR': The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. - `in` Currency[] - `nin` Currency[] - `paymentMethod` union - EqualityComparatorPaymentMethodType - … - NullComparator: Test whether a nullable scalar field is null. - … - `referenceNumber` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `remoteId` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `timestamp` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `approvedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `postedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerPaymentPlan` PaymentPlanWorkflowFilterOutput: Typed payment-plan fields that can be compiled directly to SQLAlchemy. - `and` PaymentPlanWorkflowFilterOutput[]: Additional filters that must all match. - `or` PaymentPlanWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `partnerId` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contactId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `status` EqualityComparatorPaymentPlanStatus - `eq` 'draft' | 'active' | 'completed' | 'canceled' - `neq` 'draft' | 'active' | 'completed' | 'canceled' - `in` PaymentPlanStatus[] - `nin` PaymentPlanStatus[] - `currency` EqualityComparatorCurrency - `eq` 'ADP' | 'AED' | 'AFA' | 'AFN' | 'ALK' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'AOK' | 'AON' | 'AOR' | 'ARA' | 'ARL' | 'ARM' | 'ARP' | 'ARS' | 'ATS' | 'AUD' | 'AWG' | 'AZM' | 'AZN' | 'BAD' | 'BAM' | 'BAN' | 'BBD' | 'BDT' | 'BEC' | 'BEF' | 'BEL' | 'BGL' | 'BGM' | 'BGN' | 'BGO' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOL' | 'BOP' | 'BOV' | 'BRB' | 'BRC' | 'BRE' | 'BRL' | 'BRN' | 'BRR' | 'BRZ' | 'BSD' | 'BTN' | 'BUK' | 'BWP' | 'BYB' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLE' | 'CLF' | 'CLP' | 'CNH' | 'CNX' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CSD' | 'CSK' | 'CUC' | 'CUP' | 'CVE' | 'CYP' | 'CZK' | 'DDM' | 'DEM' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'ECS' | 'ECV' | 'EEK' | 'EGP' | 'ERN' | 'ESA' | 'ESB' | 'ESP' | 'ETB' | 'EUR' | 'FIM' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEK' | 'GEL' | 'GHC' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GNS' | 'GQE' | 'GRD' | 'GTQ' | 'GWE' | 'GWP' | 'GYD' | 'HKD' | 'HNL' | 'HRD' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'IEP' | 'ILP' | 'ILR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISJ' | 'ISK' | 'ITL' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRH' | 'KRO' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LTT' | 'LUC' | 'LUF' | 'LUL' | 'LVL' | 'LVR' | 'LYD' | 'MAD' | 'MAF' | 'MCF' | 'MDC' | 'MDL' | 'MGA' | 'MGF' | 'MKD' | 'MKN' | 'MLF' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MTL' | 'MTP' | 'MUR' | 'MVP' | 'MVR' | 'MWK' | 'MXN' | 'MXP' | 'MXV' | 'MYR' | 'MZE' | 'MZM' | 'MZN' | 'NAD' | 'NGN' | 'NIC' | 'NIO' | 'NLG' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEI' | 'PEN' | 'PES' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PLZ' | 'PTE' | 'PYG' | 'QAR' | 'RHD' | 'ROL' | 'RON' | 'RSD' | 'RUB' | 'RUR' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDD' | 'SDG' | 'SDP' | 'SEK' | 'SGD' | 'SHP' | 'SIT' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SRG' | 'SSP' | 'STD' | 'STN' | 'SUR' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJR' | 'TJS' | 'TMM' | 'TMT' | 'TND' | 'TOP' | 'TPE' | 'TRL' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UAK' | 'UGS' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYP' | 'UYU' | 'UYW' | 'UZS' | 'VEB' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VNN' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XEU' | 'XFO' | 'XFU' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XRE' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YDD' | 'YER' | 'YUD' | 'YUM' | 'YUN' | 'YUR' | 'ZAL' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZRN' | 'ZRZ' | 'ZWD' | 'ZWL' | 'ZWR': The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. - `neq` 'ADP' | 'AED' | 'AFA' | 'AFN' | 'ALK' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'AOK' | 'AON' | 'AOR' | 'ARA' | 'ARL' | 'ARM' | 'ARP' | 'ARS' | 'ATS' | 'AUD' | 'AWG' | 'AZM' | 'AZN' | 'BAD' | 'BAM' | 'BAN' | 'BBD' | 'BDT' | 'BEC' | 'BEF' | 'BEL' | 'BGL' | 'BGM' | 'BGN' | 'BGO' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOL' | 'BOP' | 'BOV' | 'BRB' | 'BRC' | 'BRE' | 'BRL' | 'BRN' | 'BRR' | 'BRZ' | 'BSD' | 'BTN' | 'BUK' | 'BWP' | 'BYB' | 'BYN' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLE' | 'CLF' | 'CLP' | 'CNH' | 'CNX' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CSD' | 'CSK' | 'CUC' | 'CUP' | 'CVE' | 'CYP' | 'CZK' | 'DDM' | 'DEM' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'ECS' | 'ECV' | 'EEK' | 'EGP' | 'ERN' | 'ESA' | 'ESB' | 'ESP' | 'ETB' | 'EUR' | 'FIM' | 'FJD' | 'FKP' | 'FRF' | 'GBP' | 'GEK' | 'GEL' | 'GHC' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GNS' | 'GQE' | 'GRD' | 'GTQ' | 'GWE' | 'GWP' | 'GYD' | 'HKD' | 'HNL' | 'HRD' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'IEP' | 'ILP' | 'ILR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISJ' | 'ISK' | 'ITL' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRH' | 'KRO' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LTT' | 'LUC' | 'LUF' | 'LUL' | 'LVL' | 'LVR' | 'LYD' | 'MAD' | 'MAF' | 'MCF' | 'MDC' | 'MDL' | 'MGA' | 'MGF' | 'MKD' | 'MKN' | 'MLF' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MRU' | 'MTL' | 'MTP' | 'MUR' | 'MVP' | 'MVR' | 'MWK' | 'MXN' | 'MXP' | 'MXV' | 'MYR' | 'MZE' | 'MZM' | 'MZN' | 'NAD' | 'NGN' | 'NIC' | 'NIO' | 'NLG' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEI' | 'PEN' | 'PES' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PLZ' | 'PTE' | 'PYG' | 'QAR' | 'RHD' | 'ROL' | 'RON' | 'RSD' | 'RUB' | 'RUR' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDD' | 'SDG' | 'SDP' | 'SEK' | 'SGD' | 'SHP' | 'SIT' | 'SKK' | 'SLE' | 'SLL' | 'SOS' | 'SRD' | 'SRG' | 'SSP' | 'STD' | 'STN' | 'SUR' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJR' | 'TJS' | 'TMM' | 'TMT' | 'TND' | 'TOP' | 'TPE' | 'TRL' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UAK' | 'UGS' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYP' | 'UYU' | 'UYW' | 'UZS' | 'VEB' | 'VED' | 'VEF' | 'VES' | 'VND' | 'VNN' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XCG' | 'XDR' | 'XEU' | 'XFO' | 'XFU' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XRE' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YDD' | 'YER' | 'YUD' | 'YUM' | 'YUN' | 'YUR' | 'ZAL' | 'ZAR' | 'ZMK' | 'ZMW' | 'ZRN' | 'ZRZ' | 'ZWD' | 'ZWL' | 'ZWR': The 3 character [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. - `in` Currency[] - `nin` Currency[] - `totalAmount` union - EqualityComparatorDecimalOutput - … - OrderedComparatorDecimalOutput (recursive) - `numInstallments` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `frequency` EqualityComparatorPaymentPlanFrequency - `eq` 'weekly' | 'biweekly' | 'monthly' | 'custom' - `neq` 'weekly' | 'biweekly' | 'monthly' | 'custom' - `in` PaymentPlanFrequency[] - `nin` PaymentPlanFrequency[] - `startDate` union - EqualityComparatorDateOperand - … - OrderedComparatorDateOperand - … - `reminderDaysBefore` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `overdueAlertDays` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `completedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `canceledAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `cancelReason` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `notes` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `remoteId` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerPaymentPlanInstallment` PaymentPlanInstallmentWorkflowFilterOutput: Typed payment-plan installment fields compiled directly to SQLAlchemy. - `and` PaymentPlanInstallmentWorkflowFilterOutput[]: Additional filters that must all match. - `or` PaymentPlanInstallmentWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `paymentPlanId` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `paymentPlanStatus` EqualityComparatorPaymentPlanStatus - `eq` 'draft' | 'active' | 'completed' | 'canceled' - `neq` 'draft' | 'active' | 'completed' | 'canceled' - `in` PaymentPlanStatus[] - `nin` PaymentPlanStatus[] - `sequence` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `dueDate` union - EqualityComparatorDateOperand - … - OrderedComparatorDateOperand - … - `amount` union - EqualityComparatorDecimalOutput - … - OrderedComparatorDecimalOutput (recursive) - `status` EqualityComparatorPaymentPlanInstallmentStatus - `eq` 'scheduled' | 'due' | 'partially_paid' | 'paid' | 'canceled' - `neq` 'scheduled' | 'due' | 'partially_paid' | 'paid' | 'canceled' - `in` PaymentPlanInstallmentStatus[] - `nin` PaymentPlanInstallmentStatus[] - `amountReceived` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `receivedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `isOverdue` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `reminderSentAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `overdueAlertedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `remoteId` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerPaymentPromise` PaymentPromiseWorkflowFilterOutput - `and` PaymentPromiseWorkflowFilterOutput[]: Additional filters that must all match. - `or` PaymentPromiseWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `partnerId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `invoiceId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `promisedToPayDate` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `source` union - EqualityComparatorPaymentPromiseSource - … - NullComparator: Test whether a nullable scalar field is null. - … - `createdByUserId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `extractedInvoiceNumber` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `paymentType` union - EqualityComparatorPaymentType - … - NullComparator: Test whether a nullable scalar field is null. - … - `sentDate` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `amount` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `currency` union - EqualityComparatorCurrency - … - NullComparator: Test whether a nullable scalar field is null. - … - `isCalculated` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `agentConfidenceScore` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `agentErrorCode` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerRemittance` RemittanceWorkflowFilterOutput - `and` RemittanceWorkflowFilterOutput[]: Additional filters that must all match. - `or` RemittanceWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `currency` union - EqualityComparatorCurrency - … - NullComparator: Test whether a nullable scalar field is null. - … - `payerEmail` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `payerName` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `paymentMethod` union - EqualityComparatorPaymentMethodType - … - NullComparator: Test whether a nullable scalar field is null. - … - `remoteId` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `status` EqualityComparatorRemittanceStatus - `eq` 'submitted' | 'processing' | 'invalid' | 'processed' | 'split' - `neq` 'submitted' | 'processing' | 'invalid' | 'processed' | 'split' - `in` RemittanceStatus[] - `nin` RemittanceStatus[] - `transactionAmount` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `amount` union - EqualityComparatorInt - … - OrderedComparatorInt (recursive) - `extractedTotalAmount` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `memo` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `transactionDate` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `transactionNumber` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `bankTransactionId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `agentConfidenceScore` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `agentErrorCode` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerSms` SMSWorkflowFilterOutput - `and` SMSWorkflowFilterOutput[]: Additional filters that must all match. - `or` SMSWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `direction` EqualityComparatorSMSDirection - `eq` 'inbound' | 'outbound' - `neq` 'inbound' | 'outbound' - `in` SMSDirection[] - `nin` SMSDirection[] - `status` EqualityComparatorSMSStatus - `eq` 'draft' | 'pending' | 'sent' | 'delivered' | 'failed' | 'undelivered' - `neq` 'draft' | 'pending' | 'sent' | 'delivered' | 'failed' | 'undelivered' - `in` SMSStatus[] - `nin` SMSStatus[] - `isAutomated` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isConsentRequest` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `sentAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `deliveredAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `partnerId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerTask` TaskWorkflowFilterOutput: Task assignment and classification fields available to workflow conditions. - `and` TaskWorkflowFilterOutput[]: Additional filters that must all match. - `or` TaskWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `assigneeId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `status` EqualityComparatorTaskStatus - `eq` 'open' | 'completed' | 'closed' | 'archived' | 'failed' | 'processing' | 'assigned_to_agent' | 'research' - `neq` 'open' | 'completed' | 'closed' | 'archived' | 'failed' | 'processing' | 'assigned_to_agent' | 'research' - `in` TaskStatus[] - `nin` TaskStatus[] - `type` EqualityComparatorTaskType - `eq` 'auto_response_email' | 'auto_response_sms' | 'call_analysis' | 'disable_contact' | 'recommendation_new_contact' | 'manual_call' | 'broken_promise_follow_up' | 'payment_promise' | 'escalation' | 'pause_state_update' | 'dispute_create' | 'dispute_activate' | 'dispute_update' | 'dispute_resolution' | 'email_send_failure' | 'workflow' | 'payment_plan' | 'ap_portal_rejection' | 'ap_portal_pre_submission' | 'manual_sms' - `neq` 'auto_response_email' | 'auto_response_sms' | 'call_analysis' | 'disable_contact' | 'recommendation_new_contact' | 'manual_call' | 'broken_promise_follow_up' | 'payment_promise' | 'escalation' | 'pause_state_update' | 'dispute_create' | 'dispute_activate' | 'dispute_update' | 'dispute_resolution' | 'email_send_failure' | 'workflow' | 'payment_plan' | 'ap_portal_rejection' | 'ap_portal_pre_submission' | 'manual_sms' - `in` TaskType[] - `nin` TaskType[] - `source` EqualityComparatorTaskSource - `eq` 'email' | 'call' | 'sms' | 'outreach' | 'broken_promise' | 'account' | 'workflow' | 'ap_portal' - `neq` 'email' | 'call' | 'sms' | 'outreach' | 'broken_promise' | 'account' | 'workflow' | 'ap_portal' - `in` TaskSource[] - `nin` TaskSource[] - `priority` EqualityComparatorTaskPriority - `eq` 'low' | 'medium' | 'high' | 'urgent' - `neq` 'low' | 'medium' | 'high' | 'urgent' - `in` TaskPriority[] - `nin` TaskPriority[] - `isGroup` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isInternal` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `partnerId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `invoiceId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `groupId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerUser` UserWorkflowFilterOutput - `and` UserWorkflowFilterOutput[]: Additional filters that must all match. - `or` UserWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `email` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `familyName` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `givenName` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `role` EqualityComparatorUserRoleType - `eq` 'admin' | 'member' | 'manager' - `neq` 'admin' | 'member' | 'manager' - `in` UserRoleType[] - `nin` UserRoleType[] - `object` string, required: String representing the object's type. Objects of the same type share the same value. - `actions` WorkflowAction[], required - `created_at` string, date-time, required - `modified_at` string, date-time, nullable, required - `id` string, required - `position` integer, required: Execution order within the workflow. - `step_key` string, required - `name` string, nullable, required - `action_type` string, required: Action name, such as send_dunning_communication. - `inputs` object, required: Typed JSON action configuration. - `execution_mode` 'automatic' | 'assisted' | 'manual', required - `execution_config` WorkflowActionExecutionConfig, required - `percentage` integer, required - `delay_after_previous` WorkflowActionDelayConfig, required - `weeks` integer, nullable - `days` integer, nullable - `hours` integer, nullable - `is_active` boolean, required: Whether this action can execute. - `clause` WorkflowClauseOutput, required: A recursive FQL clause over concrete workflow context entities. - `and` WorkflowClauseOutput[]: Additional filters that must all match. - `or` WorkflowClauseOutput[]: Alternative filters where at least one must match. - `event` EventWorkflowFilterOutput: Stable fields from the event envelope available to workflow clauses. - `and` EventWorkflowFilterOutput[]: Additional filters that must all match. - `or` EventWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `name` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `entityType` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `entityId` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `occurredAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `triggerAdjustment` AdjustmentWorkflowFilterOutput - `and` AdjustmentWorkflowFilterOutput[]: Additional filters that must all match. - `or` AdjustmentWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `name` StringComparator: One string comparison with an optional case-sensitivity modifier. - `eq` string - `neq` string - `in` string[] - `nin` string[] - `contains` string - `not_contains` string - `starts_with` string - `not_starts_with` string - `ends_with` string - `not_ends_with` string - `case` 'sensitive' | 'insensitive' - `isActive` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `isSystem` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `automated` EqualityComparatorBool - `eq` boolean - `neq` boolean - `in` boolean[] - `nin` boolean[] - `description` union - StringComparator: One string comparison with an optional case-sensitivity modifier. - … - NullComparator: Test whether a nullable scalar field is null. - … - `ledgerAccountId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `triggerBankStatement` BankStatementWorkflowFilterOutput - `and` BankStatementWorkflowFilterOutput[]: Additional filters that must all match. - `or` BankStatementWorkflowFilterOutput[]: Alternative filters where at least one must match. - `id` EqualityComparatorStr - `eq` string - `neq` string - `in` string[] - `nin` string[] - `createdAt` union - EqualityComparatorDateTimeOperand - … - OrderedComparatorDateTimeOperand - … - `modifiedAt` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `periodEnd` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `periodStart` union - union - … - NullComparator: Test whether a nullable scalar field is null. - … - `status` EqualityComparatorStatus - `eq` 'submitted' | 'processing' | 'invalid' | 'pending_approval' | 'approved' | 'split' | 'synced' - `neq` 'submitted' | 'processing' | 'invalid' | 'pending_approval' | 'approved' | 'split' | 'synced' - `in` Status[] - `nin` Status[] - `accountId` union - EqualityComparatorStr - … - NullComparator: Test whether a nullable scalar field is null. - … - `approverId` union - EqualityComparatorStr - … - … truncated; see the full OpenAPI document linked below ## Other responses - `404`: Not Found - `422`: Validation Error --- [API](https://skmtc.dev/stuut/apis/stuut-api.md) - [All operations](https://skmtc.dev/stuut/apis/stuut-api/llms.txt) - [OpenAPI document](https://skmtc.dev/stuut/apis/stuut-api/revisions/3b5ab941f918?raw)