Cacheflow

Cacheflow Settings API

The Settings API from Cacheflow — 6 operation(s) for settings.

GitHub OpenAPI

Operations 9

GET /api/latest/ssr/ssr-types List SSR types #
GET /api/latest/settings/all-events List all events #
GET /api/latest/settings/org/defaults/{config_key} Retrieve setting by key #
PUT /api/latest/settings/org/defaults/{config_key} Update setting for key #
POST /api/latest/settings/org/defaults/{config_key} Create setting for key #
DELETE /api/latest/settings/org/defaults/{config_key} Delete setting #
GET /api/latest/settings/org/defaults List org settings #
POST /api/latest/state-tokens Create a token key #
GET /api/latest/state-tokens/{tokenKey} Retrieve a token key #

Documentation

📖
Documentation
https://developer.getcacheflow.com/reference
📖
APIReference
https://developer.getcacheflow.com/reference
📖
GettingStarted
https://developer.getcacheflow.com/reference/create-an-api-token-copy
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/cacheflow/refs/heads/main/authentication/cacheflow-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/cacheflow/refs/heads/main/rate-limits/cacheflow-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cacheflow/refs/heads/main/openapi/cacheflow-settings-api-openapi.yml

Other Resources

🔗
DeveloperPortal
https://developer.getcacheflow.com/
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/cacheflow/refs/heads/main/conventions/cacheflow-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/cacheflow/refs/heads/main/errors/cacheflow-error-codes.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/cacheflow/refs/heads/main/data-model/cacheflow-data-model.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/cacheflow/refs/heads/main/asyncapi/cacheflow-webhooks.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/cacheflow/refs/heads/main/sandbox/cacheflow-sandbox.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/cacheflow/refs/heads/main/llms/cacheflow-llms.txt

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/cacheflow-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cacheflow-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cacheflow Settings API
  version: 0.0.3
servers:
- url: https://api.getcacheflow.com
  description: 'Production. Calls are tenant-routed: send Host: <org-flow-domain>.api.getcacheflow.com (per github.com/getcacheflow/api-examples SETUP.md). Host no longer resolves as of 2026-08-13.'
- url: https://api.sandbox.getcacheflow.com
  description: Sandbox. Tenant-routed as <org-flow-domain>.api.sandbox.getcacheflow.com. Host no longer resolves as of 2026-08-13.
tags:
- name: Settings
paths:
  /api/latest/ssr/ssr-types:
    get:
      tags:
      - Settings
      summary: List SSR types
      operationId: getSsrTypes
      responses:
        '200':
          description: to get SSR types in generated contracts...
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/EmailProps'
                - $ref: '#/components/schemas/CheckoutPdfData'
                - $ref: '#/components/schemas/SsrRenderEmailRequest'
                - $ref: '#/components/schemas/SsrRenderPdfRequest'
                - $ref: '#/components/schemas/SsrHtmlResponse'
  /api/latest/settings/all-events:
    get:
      tags:
      - Settings
      summary: List all events
      operationId: getAllEventTypes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
  /api/latest/settings/org/defaults/{config_key}:
    get:
      tags:
      - Settings
      summary: Retrieve setting by key
      operationId: getOrgConfig
      parameters:
      - name: config_key
        in: path
        required: true
        schema:
          type: string
          enum:
          - assistantConfig
          - avalaraConfig
          - acceptOnSigning
          - approvalExclusionGroup
          - addressVerificationConfig
          - areApprovalsEnabled
          - autoRenewalConfig
          - billingPeriodConfig
          - closeConfig
          - branding
          - defaultBillingPeriod
          - defaultCrmSource
          - defaultPaymentTerm
          - defaultSignature
          - docusignAccountId
          - enableDocusignResponsiveHtml
          - googleTagConfig
          - hubspotConfig
          - invoiceConfig
          - locationCodeMappingConfig
          - locationCodeType
          - paymentErrorContact
          - paymentsGracePeriod
          - profitwellConfig
          - proposalConfig
          - proposalNumberPrefix
          - purchaseOrderConfig
          - quickbooksConfig
          - reportingConfig
          - salesforceConfig
          - staleUsagePeriod
          - stripeConfig
          - taxCountryRulesConfig
          - timezone
          - warmlyConfig
          - zapierConfig
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgConfig'
    put:
      tags:
      - Settings
      summary: Update setting for key
      operationId: upsertOrgConfig
      parameters:
      - name: config_key
        in: path
        required: true
        schema:
          type: string
          enum:
          - assistantConfig
          - avalaraConfig
          - acceptOnSigning
          - approvalExclusionGroup
          - addressVerificationConfig
          - areApprovalsEnabled
          - autoRenewalConfig
          - billingPeriodConfig
          - closeConfig
          - branding
          - defaultBillingPeriod
          - defaultCrmSource
          - defaultPaymentTerm
          - defaultSignature
          - docusignAccountId
          - enableDocusignResponsiveHtml
          - googleTagConfig
          - hubspotConfig
          - invoiceConfig
          - locationCodeMappingConfig
          - locationCodeType
          - paymentErrorContact
          - paymentsGracePeriod
          - profitwellConfig
          - proposalConfig
          - proposalNumberPrefix
          - purchaseOrderConfig
          - quickbooksConfig
          - reportingConfig
          - salesforceConfig
          - staleUsagePeriod
          - stripeConfig
          - taxCountryRulesConfig
          - timezone
          - warmlyConfig
          - zapierConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrgConfig'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgConfig'
    post:
      tags:
      - Settings
      summary: Create setting for key
      operationId: createOrgConfig
      parameters:
      - name: config_key
        in: path
        required: true
        schema:
          type: string
          enum:
          - assistantConfig
          - avalaraConfig
          - acceptOnSigning
          - approvalExclusionGroup
          - addressVerificationConfig
          - areApprovalsEnabled
          - autoRenewalConfig
          - billingPeriodConfig
          - closeConfig
          - branding
          - defaultBillingPeriod
          - defaultCrmSource
          - defaultPaymentTerm
          - defaultSignature
          - docusignAccountId
          - enableDocusignResponsiveHtml
          - googleTagConfig
          - hubspotConfig
          - invoiceConfig
          - locationCodeMappingConfig
          - locationCodeType
          - paymentErrorContact
          - paymentsGracePeriod
          - profitwellConfig
          - proposalConfig
          - proposalNumberPrefix
          - purchaseOrderConfig
          - quickbooksConfig
          - reportingConfig
          - salesforceConfig
          - staleUsagePeriod
          - stripeConfig
          - taxCountryRulesConfig
          - timezone
          - warmlyConfig
          - zapierConfig
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrgConfig'
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgConfig'
    delete:
      tags:
      - Settings
      summary: Delete setting
      operationId: deleteOrgConfig
      parameters:
      - name: config_key
        in: path
        required: true
        schema:
          type: string
          enum:
          - assistantConfig
          - avalaraConfig
          - acceptOnSigning
          - approvalExclusionGroup
          - addressVerificationConfig
          - areApprovalsEnabled
          - autoRenewalConfig
          - billingPeriodConfig
          - closeConfig
          - branding
          - defaultBillingPeriod
          - defaultCrmSource
          - defaultPaymentTerm
          - defaultSignature
          - docusignAccountId
          - enableDocusignResponsiveHtml
          - googleTagConfig
          - hubspotConfig
          - invoiceConfig
          - locationCodeMappingConfig
          - locationCodeType
          - paymentErrorContact
          - paymentsGracePeriod
          - profitwellConfig
          - proposalConfig
          - proposalNumberPrefix
          - purchaseOrderConfig
          - quickbooksConfig
          - reportingConfig
          - salesforceConfig
          - staleUsagePeriod
          - stripeConfig
          - taxCountryRulesConfig
          - timezone
          - warmlyConfig
          - zapierConfig
      responses:
        default:
          description: default response
          content:
            application/json: {}
  /api/latest/settings/org/defaults:
    get:
      tags:
      - Settings
      summary: List org settings
      operationId: listOrgConfigs
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/OrgConfig'
  /api/latest/state-tokens:
    post:
      tags:
      - Settings
      summary: Create a token key
      operationId: createStateToken
      responses:
        '201':
          description: OK
          content:
            '*/*':
              schema:
                type: string
  /api/latest/state-tokens/{tokenKey}:
    get:
      tags:
      - Settings
      summary: Retrieve a token key
      operationId: getStateToken
      parameters:
      - name: tokenKey
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
components:
  schemas:
    ContractEvent:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
          readOnly: true
        createdBy:
          type: string
        user:
          $ref: '#/components/schemas/User'
        contact:
          $ref: '#/components/schemas/_ContactInternal'
        eventType:
          type: string
          enum:
          - created
          - billing_added
          - billing_updated
          - created_change
          - created_renewal
          - accepted_change
          - accepted_renewal
          - renewal_applied
          - renewal_due
          - cancelled
          - archived
          - restored
          - updated
          - ended
        otherId:
          type: string
          format: uuid
        otherType:
          type: string
          enum:
          - account
          - apiwebhook
          - apitoken
          - approvalgroup
          - attachmentconfig
          - authidentity
          - billingschedule
          - companyInfo
          - connectorSyncEvent
          - contact
          - contentTemplate
          - contract
          - contractitem
          - contractitemlevel
          - currency
          - customer
          - docusignaccount
          - document
          - documentversion
          - group
          - invite
          - invoice
          - invoiceConfiguration
          - organization
          - orgconfig
          - orgidentitytoken
          - payment
          - paymentMethod
          - paymentSchedule
          - paymentTerm
          - pricebook
          - pricebookentry
          - product
          - productlevel
          - productusage
          - proposal
          - proposalapprovalrule
          - proposalevent
          - proposalitem
          - proposaliteminterval
          - proposalitemlevel
          - proposaloption
          - refund
          - renewalconfiguration
          - signature
          - signingdocument
          - transfer
          - transferevent
          - unit
          - user
        correlationRef:
          type: string
        instanceRef:
          type: string
    OrganizationSummary:
      type: object
      properties:
        logoUrl:
          type: string
        id:
          type: string
          format: uuid
        name:
          type: string
        internalName:
          type: string
        billingAddress:
          $ref: '#/components/schemas/Address'
        branding:
          type: object
          additionalProperties:
            type: object
    Proposal:
      required:
      - amount
      - amountFormatted
      - archived
      - attachments
      - baseAmount
      - baseAmountFormatted
      - billingPeriods
      - createdAt
      - currency
      - deleted
      - displayStatus
      - effectiveStartDate
      - id
      - legacyCheckout
      - name
      - overrideRanges
      - proposalContacts
      - proposalItems
      - proposalType
      - schedules
      - signed
      - status
      - syncable
      - termLengthMonths
      - termQty
      - termType
      - updatedAt
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
        proposalItems:
          type: array
          items:
            $ref: '#/components/schemas/Item'
        name:
          type: string
        customTerms:
          type: string
        externalLink:
          type: string
        deleted:
          type: boolean
        archived:
          type: boolean
        legacyCheckout:
          type: boolean
        owner:
          $ref: '#/components/schemas/User'
        displayStatus:
          type: string
          enum:
          - draft
          - active
          - approved
          - archived
          - expired
          - cancelled
          - deleted
          - completed
          - pending_approval
          - shared_payment_selection
          - shared_schedule_selection
          - shared_active
          - signed_awaiting_payment
        amount:
          type: integer
          format: int64
        proposalContacts:
          type: array
          items:
            $ref: '#/components/schemas/ProposalContact'
        signingDocument:
          $ref: '#/components/schemas/SigningDocument'
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/ProposalAttachment'
        options:
          type: object
          additionalProperties:
            type: boolean
        schedules:
          type: array
          items:
            $ref: '#/components/schemas/PaymentSchedule'
        acceptedScheduleId:
          type: string
          format: uuid
        proposalType:
          type: string
          enum:
          - initial
          - change
          - renewal
          - template
        contract:
          $ref: '#/components/schemas/ObjectReference'
        effectiveStartDate:
          type: string
          format: date
        termType:
          type: string
          enum:
          - month
          - quarter
          - year
        termQty:
          type: integer
          format: int32
        termLengthMonths:
          type: integer
          format: int32
        freeMonths:
          type: integer
          format: int32
        proposalNumber:
          type: string
        customer:
          $ref: '#/components/schemas/Customer'
        billTo:
          $ref: '#/components/schemas/Customer'
        shipFrom:
          $ref: '#/components/schemas/OrganizationSummary'
        source:
          type: string
          deprecated: true
          enum:
          - manual
          - close
          - plaid
          - stripe
          - hubspot
          - salesforce
          - avalara
          - quickbooks
          - profitwell
          - netsuite
          - google
          - warmly
          - zapier
          - cacheflow_checkout
        externalId:
          type: string
          deprecated: true
        lastEvent:
          $ref: '#/components/schemas/ProposalEvent'
        previous:
          $ref: '#/components/schemas/ObjectReference'
        expiresAt:
          type: string
          format: date
        endDate:
          type: string
          format: date
        startDate:
          type: string
          format: date
        previewCode:
          type: string
        paymentTerm:
          type: string
          enum:
          - net_15
          - net_30
          - net_45
          - net_60
          - net_75
          - net_90
          - upon_receipt
          - end_of_month
          - on_15th
        acceptedAt:
          type: string
          format: date-time
        defaultBillingPeriod:
          type: string
          enum:
          - month
          - quarter
          - halfyear
          - year
        billingPeriods:
          type: array
          items:
            type: string
            enum:
            - month
            - quarter
            - halfyear
            - year
        selectedScheduleId:
          type: string
          format: uuid
        changes:
          $ref: '#/components/schemas/ProposalChanges'
        description:
          type: string
        baseAmount:
          type: integer
          format: int64
        signed:
          type: boolean
        currency:
          type: string
        coverLetter:
          type: string
        sellerEmail:
          type: string
        syncable:
          type: boolean
        pendingRenewalAt:
          type: string
          format: date-time
        billingMethod:
          $ref: '#/components/schemas/BillingMethod'
        renewalConfiguration:
          $ref: '#/components/schemas/RenewalConfiguration'
        invoiceConfiguration:
          $ref: '#/components/schemas/InvoiceConfiguration'
        isSystemGenerated:
          type: boolean
        overrideRanges:
          type: array
          items:
            $ref: '#/components/schemas/OverrideRange'
        acceptedByContact:
          $ref: '#/components/schemas/Contact'
        acceptedByUser:
          $ref: '#/components/schemas/User'
        externalSource:
          $ref: '#/components/schemas/ExternalSource'
        purchaseOrderNumber:
          type: string
        type:
          type: string
          enum:
          - account
          - apiwebhook
          - apitoken
          - approvalgroup
          - attachmentconfig
          - authidentity
          - billingschedule
          - companyInfo
          - connectorSyncEvent
          - contact
          - contentTemplate
          - contract
          - contractitem
          - contractitemlevel
          - currency
          - customer
          - docusignaccount
          - document
          - documentversion
          - group
          - invite
          - invoice
          - invoiceConfiguration
          - organization
          - orgconfig
          - orgidentitytoken
          - payment
          - paymentMethod
          - paymentSchedule
          - paymentTerm
          - pricebook
          - pricebookentry
          - product
          - productlevel
          - productusage
          - proposal
          - proposalapprovalrule
          - proposalevent
          - proposalitem
          - proposaliteminterval
          - proposalitemlevel
          - proposaloption
          - refund
          - renewalconfiguration
          - signature
          - signingdocument
          - transfer
          - transferevent
          - unit
          - user
        baseAmountFormatted:
          type: string
        referenceType:
          type: string
          enum:
          - account
          - apiwebhook
          - apitoken
          - approvalgroup
          - attachmentconfig
          - authidentity
          - billingschedule
          - companyInfo
          - connectorSyncEvent
          - contact
          - contentTemplate
          - contract
          - contractitem
          - contractitemlevel
          - currency
          - customer
          - docusignaccount
          - document
          - documentversion
          - group
          - invite
          - invoice
          - invoiceConfiguration
          - organization
          - orgconfig
          - orgidentitytoken
          - payment
          - paymentMethod
          - paymentSchedule
          - paymentTerm
          - pricebook
          - pricebookentry
          - product
          - productlevel
          - productusage
          - proposal
          - proposalapprovalrule
          - proposalevent
          - proposalitem
          - proposaliteminterval
          - proposalitemlevel
          - proposaloption
          - refund
          - renewalconfiguration
          - signature
          - signingdocument
          - transfer
          - transferevent
          - unit
          - user
        status:
          type: string
          enum:
          - draft
          - pending_approval
          - approved
          - schedule_selection
          - payment_selection
          - active
          - pending_renewal
          - accepted
          - expired
          - cancelled
          - deleted
        amountFormatted:
          type: string
        orderNumber:
          type: string
          deprecated: true
    DomainField:
      required:
      - displayName
      - name
      - type
      type: object
      properties:
        type:
          type: string
          enum:
          - Boolean
          - String
          - Number
          - Integer
          - Date
          - Datetime
        name:
          type: string
        displayName:
          type: string
    SalesforceConfig:
      type: object
      allOf:
      - $ref: '#/components/schemas/Config'
      - type: object
        properties:
          enabled:
            type: boolean
          gatewayType:
            type: string
            enum:
            - cacheflow
            - paragon
          locationCodeType:
            type: string
            enum:
            - NAME
            - ISO
            - ISO2
            - ISO3
            - CUSTOM
          sourceType:
            type: string
            enum:
            - manual
            - close
            - plaid
            - stripe
            - hubspot
            - salesforce
            - avalara
            - quickbooks
            - profitwell
            - netsuite
            - google
            - warmly
            - zapier
            - cacheflow_checkout
          stageMappings:
            type: array
            items:
              $ref: '#/components/schemas/StageMapping'
          proposalFieldMappings:
            type: array
            items:
              $ref: '#/components/schemas/ExternalFieldMapping'
          lineItemFieldMappings:
            type: array
            items:
              $ref: '#/components/schemas/ExternalFieldMapping'
          syncSignedDocument:
            type: boolean
          syncSourceToCacheflow:
            type: boolean
          syncLineItems:
            type: boolean
          lineItemSyncConfig:
            $ref: '#/components/schemas/LineItemSyncConfig'
          renewalDealCreation:
            type: boolean
          renewalDealCreationForAutoRenewals:
            type: boolean
          renewalDealDaysBeforeEndDate:
            type: integer
            format: int32
          renewalDealStage:
            type: string
          renewalDealCloseDays:
            type: integer
            format: int32
          syncSubscriptions:
            type: boolean
          syncAmount:
            type: boolean
          connectedUserId:
            type: string
            format: uuid
          multiCurrency:
            type: boolean
          priceBook2Id:
            type: string
          createProduct2:
            type: boolean
          useRelatedContacts:
            type: boolean
          signedProposalLocation:
            type: string
            enum:
            - FILES
            - ATTACHMENTS
    RenewalConfiguration:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
          readOnly: true
        createdBy:
          type: string
        updatedAt:
          type: string
          format: date-time
          readOnly: true
        updatedBy:
          type: string
          readOnly: true
        termLengthMonths:
          type: integer
          format: int32
        cancellationDeadlineDays:
          type: integer
          format: int32
        renewalClause:
          type: string
        priceIncrease:
          minimum: 0
          type: number
        renewalClauseDescription:
          type: string
    _ContactInternal:
      required:
      - email
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
          readOnly: true
        createdBy:
          type: string
        updatedAt:
          type: string
          format: date-time
          readOnly: true
        updatedBy:
          type: string
          readOnly: true
        firstName:
          type: string
        lastName:
          type: string
        email:
          type: string
        role:
          type: string
        deleted:
          type: boolean
        customerReference:
          $ref: '#/components/schemas/ObjectReference'
        gdprDeleted:
          type: boolean
    Config:
      title: Config
      type: object
      properties:
        configType:
          type: string
          enum:
          - avalaraConfig
          - addressVerificationConfig
          - assistantConfig
          - autoRenewalConfig
          - billingPeriodConfig
          - proposalConfig
          - closeConfig
          - googleTagConfig
          - hubspotConfig
          - invoiceConfig
          - paymentsGracePeriod
          - locationCodeMappingConfig
          - quickbooksConfig
          - profitwellConfig
          - purchaseOrderConfig
          - reportingConfig
          - salesforceConfig
          - stripeConfig
          - taxCountryRulesConfig
          - warmlyConfig
          - zapierConfig
      discriminator:
        propertyName: configType
        mapping:
          addressVerificationConfig: '#/components/schemas/AddressVerificationConfig'
          assistantConfig: '#/components/schemas/AssistantConfig'
          autoRenewalConfig: '#/components/schemas/AutoRenewalConfig'
          avalaraConfig: '#/components/schemas/AvalaraConfig'
          billingPeriodConfig: '#/components/schemas/BillingPeriodConfig'
          closeConfig: '#/components/schemas/CloseConfig'
          googleTagConfig: '#/components/schemas/GoogleTagConfig'
          hubspotConfig: '#/components/schemas/HubspotConfig'
          invoiceConfig: '#/components/schemas/InvoiceConfig'
          locationCodeMappingConfig: '#/components/schemas/LocationCodeMappingConfig'
          paymentsGracePeriod: '#/components/schemas/PaymentGracePeriodConfig'
          profitwellConfig: '#/components/schemas/ProfitwellConfig'
          proposalConfig: '#/components/schemas/ProposalConfig'
          purchaseOrderConfig: '#/components/schemas/PurchaseOrderConfig'
          quickbooksConfig: '#/components/schemas/QuickbooksConfig'
          reportingConfig: '#/components/schemas/ReportingConfig'
          salesforceConfig: '#/components/schemas/SalesforceConfig'
          stripeConfig: '#/components/schemas/StripeConfig'
          taxCountryRulesConfig: '#/components/schemas/TaxCountryRulesConfig'
          warmlyConfig: '#/components/schemas/WarmlyConfig'
          zapierConfig: '#/components/schemas/ZapierConfig'
    CheckoutPdfData:
      required:
      - checkoutUrl
      - companyInfo
      - paymentMethods
      - proposal
      - subdomain
      - timezone
      type: object
      properties:
        subdomain:
          type: string
        checkoutUrl:
          type: string
        timezone:
          type: string
        proposal:
          $ref: '#/components/schemas/Proposal'
        companyInfo:
          $ref: '#/components/schemas/CompanyInfo'
        paymentMethods:
          type: array
          items:
            $ref: '#/components/schemas/CheckoutPaymentMethod'
        companyLogo:
          type: string
        contract:
          $ref: '#/components/schemas/Contract'
        signature:
          $ref: '#/components/schemas/Signature'
        itemDeltaSpans:
          type: array
          items:
            $ref: '#/components/schemas/ItemDeltaSpansResponse'
    InvoiceConfiguration:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
          readOnly: true
        createdBy:
          type: string
        updatedAt:
          type: string
          format: date-time
          readOnly: true
        updatedBy:
          type: string
          readOnly: true
        invoiceInAdvance:
          type: boolean
        invoiceInAdvanceDays:
          type: integer
          format: int32
        invoiceInAdvanceDate:
          type: string
          enum:
          - advance_date
          - billing_period_start_date
    BillingItem:
      required:
      - amountDue
      - amountDueFormatted
      - amountWithoutTax
      - amountWithoutTaxFormatted
      - createdAt
      - currency
      - id
      - itemId
      - product
      - serviceEndDate
      - serviceStartDate
      - updatedAt
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
        createdBy:
          type: string
        updatedAt:
          type: string
          format: date-time
        updatedBy:
          type: string
        serviceStartDate:
          type: string
          format: date
        serviceEndDate:
          type: string
          format: date
        currency:
          type: string
        amountDue:
          type: integer
          format: int64
        amountDueFormatted:
          type: string
        amountWithoutTax:
          type: integer
          format: int64
        amountWithoutTaxFormatted:
          type: string
        taxAmount:
          type: integer
          format: int64
        taxAmountFormatted:
          type: string
        product:
          $ref: '#/components/schemas/ObjectReference'
        itemId:
          type: string
          format: uuid
        name:
          type: string
        description:
          type: string
        descriptionText:
          type: string
        bundle:
          $ref: '#/components/schemas/ObjectReference'
        bundleName:
          type: string
        bundleDescription:
          type: string
        bundleDescriptionText:
          type: string
        bundleQuantity:
          type: number
        quantity:
          type: number
        proration:
          type: integer
          format: int32
        latestProductUsage:
          $ref: '#/components/schemas/ProductUsage'
        displayQuantityOnInvoicePdf:
          type: boolean
    PaymentGracePeriodConfig:
      type: object
      allOf:
      - $ref: '#/components/schemas/Config'
      - type: object
        properties:
          enabled:
            type: boolean
          defaultGracePeriodInDays:
            type: integer
            format: int32
    ExternalSource:
      required:
      - sourceId
      - sourceType
      type: object
      properties:
        sourceType:
          type: string
          enum:
          - manual
          - close
          - plaid
          - stripe
          - hubspot
          - salesforce
          - avalara
          - quickbooks
          - profitwell
          - netsuite
          - google
          - warmly
          - zapier
          - cacheflow_checkout
        sourceId:
          type: string
        sourceLink:
          type: string
    User:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-time
          readOnly: true
        createdBy:
          type: string
        updatedAt:
          type: string
          format: date-time
          readOnly: true
        updatedBy:
          type: string
          readOnly: true
        username:
          type: string
        status:
          type: string
          enum:
          - pending
          - active
          - inactive
        source:
          type: string
        firstName:
          type: string
        lastName:
          type: string
        lastActiveAt:
          type: string
          format: date-time
        manager:
          $ref: '#/components/schemas/User'
    NotificationEventConfiguration:
      type: object
      properties:
        beforeDays:
          type: integer
          format: int32
        notificationType:
          type: string
          enum:
          - email
        targetGroups:
          type: array
          items:
            type: string
            enum:
            - billing_contact
            - accepting_contact
        eventType:
          type: string
          enum:
          - auto_renewal_reminder
    PaymentMethod:
      type: object
      properties:
        id:
          type: string
          format: uuid
        createdAt:
          type: string
          format: date-tim

# --- truncated at 32 KB (123 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cacheflow/refs/heads/main/openapi/cacheflow-settings-api-openapi.yml