> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dualentry.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Preview Contract Schedule

> Preview contract billing and revenue recognition schedules without saving data.



## OpenAPI

````yaml /developers/openapi/resources-v3-alpha.json post /public/v3-alpha/contracts/actions/preview_schedule/
openapi: 3.1.0
info:
  title: DualEntry Public API
  version: 3.0.0-alpha
  description: ''
servers:
  - url: https://api.dualentry.com
    description: Production environment
security: []
tags:
  - name: Health
    description: >-
      Monitor API availability and service status. Use these endpoints to verify
      connectivity and check if the API is operational.
  - name: Webhooks
    description: >-
      Register webhook endpoints to receive real-time event notifications when
      records change in your organization. Manage subscriptions, view available
      topics, and inspect delivery history.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Accounts
    description: >-
      Manage your chart of accounts. Create and maintain the accounts used to
      categorize financial transactions, including assets, liabilities, equity,
      revenue, and expenses.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Reporting
    description: >-
      Reporting facts and balances: account balances as of a date; paginated
      general-ledger lines; dense trial-balance facts (account x company x
      month); chart-of-accounts facts; and consolidated rates. Row shapes match
      the `general_ledger`, `trial_balance`, `chart_of_accounts`, and
      `consolidated_rates` tables in your data export.
  - name: Budgets
    description: >-
      Read income statement and balance sheet budget settings. Monthly cell
      values, actuals comparisons, and accounts are available through separate
      budget routes.
  - name: Companies
    description: >-
      Access and manage company information. Retrieve details about your
      organization including legal name, tax identifiers, addresses, and
      accounting preferences.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Period Locks
    description: >-
      Period locks for bills, invoices, other ledger activity, non-ledger
      records, and tax schedules.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Payment Methods
    description: >-
      List payment methods. Filter by id to resolve payment_method_id on a
      payment record. V2 API only.
  - name: Terms
    description: >-
      List payment terms. Use a term `id` as `term_id` on a record that has a
      due date.
  - name: Books
    description: >-
      List accounting books. Use book ids in `book_ids` on a journal entry.
      Depreciation books are a separate resource.
  - name: Projects
    description: >-
      List projects. Use a project `id` as `billable_project_id` on a billable
      line.
  - name: Contract Templates
    description: >-
      List contract templates. Use a template `id` as `contract_template_id` on
      a contract.
  - name: Accrual Templates
    description: >-
      List accrual templates. Use a template `id` as `accrual_template_id` on a
      journal entry.
  - name: Paper Check Templates
    description: >-
      List paper check templates. Use a template `id` as `template_id` when you
      print a check.
  - name: Customers
    description: >-
      Manage customer records. Create, update, and track customers who purchase
      goods or services from your organization, including contact information,
      billing addresses, and payment terms.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Contracts
    description: >-
      Manage revenue recognition contracts. Create, retrieve, and update
      contracts with performance obligations, manage obligation usage, and
      create change orders (v2).


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Items
    description: >-
      Manage products and services. Define items that appear on invoices and
      bills, including pricing, descriptions, and associated accounts for
      revenue or expense tracking.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Vendors
    description: >-
      Manage vendor and supplier records. Track businesses and individuals from
      whom you purchase goods or services, including contact details, payment
      terms, and tax information.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Journal Entries
    description: >-
      Create and manage manual journal entries. Create and update post a general
      ledger transaction.


      A reversal date posts a reversing transaction. Book ids assign accounting
      books. An aging reason on an accounts receivable or accounts payable line
      excludes that line from aging. The save can link a related journal entry
      and an accrual template.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Invoices
    description: >-
      Manage sales invoices. Create and track invoices sent to customers for
      goods or services rendered, including line items, taxes, discounts, and
      payment status.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Quotes
    description: >-
      Create, submit, and send CPQ quotes, with line billing frequencies,
      multi-year ramps, recipients and signing order, and totals by billing
      frequency. Requires the CPQ subscription.


      Save a quote with `record_status` `posted` to submit it for approval.
      Approvers approve or reject it in DualEntry.


      Send your own quote PDF. This API does not render one.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Sales Orders
    description: >-
      Create and manage sales orders. Track customer orders for goods or
      services before invoicing, including line items, quantities, fulfillment
      status, and invoicing progress.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Bills
    description: >-
      Manage vendor bills and payables. Record and track bills received from
      vendors for goods or services purchased, including line items, due dates,
      and payment tracking.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Customer Prepayments
    description: >-
      Track advance payments from customers. Access prepayments received before
      goods or services are delivered, which can be applied to future invoices.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Customer Prepayment Applications
    description: >-
      Apply customer prepayments and credits to invoices. Record applications of
      prepayments or credit memos to reduce invoice balances.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Customer Deposits
    description: >-
      Manage customer deposit transactions. Record and track deposits received
      from customers as security or partial payment, held in liability accounts
      until earned or refunded.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Customer Refunds
    description: >-
      Process and track customer refunds. Record refunds issued to customers for
      overpayments, returns, or cancelled transactions.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Customer Credits
    description: >-
      Manage credit memos for customers. Issue credits for returned goods,
      billing adjustments, or discounts that reduce customer balances or can be
      applied to future invoices.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Cash Sales
    description: >-
      Record immediate cash sales transactions. Track sales where payment is
      received at the time of sale, including point-of-sale transactions and
      cash receipts.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Customer Payments
    description: >-
      Record and manage customer payments. Track payments received from
      customers and apply them to outstanding invoices, including partial
      payments and overpayments.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Recurring Invoices
    description: >-
      Automate recurring billing. Set up and manage templates for invoices that
      are automatically generated on a regular schedule (e.g., monthly
      subscriptions).


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Recurring Bills
    description: >-
      Automate recurring expenses. Configure templates for bills that repeat on
      a regular basis (e.g., monthly rent, subscriptions) to streamline expense
      tracking.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Recurring Journal Entries
    description: >-
      Automate recurring journal entries. Create templates for journal entries
      that occur regularly (e.g., monthly depreciation, amortization) to ensure
      consistent accounting treatment.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Classifications
    description: >-
      Manage custom classification dimensions. Create and maintain
      classification categories (e.g., departments, locations, projects) used to
      tag and analyze transactions across multiple dimensions.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Classifications Lines
    description: >-
      Manage classification values. Define the specific values within each
      classification category that can be assigned to transaction line items for
      detailed reporting and analysis.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Custom Fields
    description: >-
      Manage custom field definitions. Extend records with organization-specific
      attributes: name, type (text, number, boolean, date, single_select,
      multi_select, currency, link, paragraph), default value, options, and
      which record types (invoice, bill, customer, vendor, etc.) and companies
      the field applies to. Values are set via the `custom_fields` attribute on
      each record's create/update endpoint.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Purchase Orders
    description: >-
      Create and track purchase orders. Manage formal requests to vendors for
      goods or services, including approval workflows, receiving tracking, and
      bill matching.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Vendor Payments
    description: >-
      Record vendor payments and apply them to bills, vendor credits, and
      journal entry lines.


      Create and update post a general ledger transaction. The save also
      computes realized, rounding, and matching gain or loss.


      Send attachments to replace the file list. `PATCH` changes only the sent
      fields. `POST /{number}/attachments/` adds files and keeps existing files.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Vendor Prepayments
    description: >-
      Track advance payments to vendors. Record prepayments made before goods or
      services are received, which can be applied to future bills.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Vendor Prepayment Applications
    description: >-
      Apply vendor prepayments to bills. Record applications of prepayments to
      reduce bill balances and track amounts owed.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Vendor Credits
    description: >-
      Manage vendor credit memos. Record credits from vendors for returned
      goods, billing adjustments, or discounts that reduce amounts owed or can
      be applied to future bills.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Vendor Refunds
    description: >-
      Process and track vendor refunds. Record refunds received from vendors for
      overpayments, returns, or cancelled transactions.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Paper Checks
    description: >-
      Manage paper check printing. Create, queue, and batch print paper checks
      for vendor payments, direct expenses, vendor prepayments, and customer
      refunds.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Direct Expenses
    description: >-
      Record direct expense transactions. Track payments made directly from a
      bank or credit card account for expenses, without going through the
      accounts payable process.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Bank Transfers
    description: >-
      Manage bank-to-bank transfers. Record and track transfers between bank and
      credit card accounts, including multi-currency transfers with exchange
      rate handling.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Bank Match
    description: >-
      Reconcile bank-feed rows against accounting transactions. List bank rows,
      trigger the matching pipeline, read AI suggestions, and confirm or undo
      matches. V2 API only.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Bank Connections
    description: >-
      Register and list customer-built inbound bank connection feeds. Create
      connections and accounts with `customer_api` as `source_type`, then push
      transactions separately. V2 API only.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Fixed Assets
    description: >-
      Manage fixed assets and capital equipment. Create, update, and track
      long-lived tangible assets including depreciation schedules, account
      assignments, and asset lifecycle management.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Fixed Asset Classes
    description: >-
      Create, update, and list fixed asset classes. Each class includes its
      asset account, accumulated depreciation account, expense account, and book
      defaults. Use the class id as `fixed_asset_class_id` on an asset.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Intercompany Journal Entries
    description: >-
      Create and manage intercompany journal entries. Record GL activity that
      spans two or more companies within the same organization, with per-line
      company assignment and automatic intercompany elimination.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Depreciation Books
    description: >-
      Discover available depreciation books for multi-book depreciation. Each
      organization has a posting book (BOOK) and may have additional tax books
      (FEDERAL, AMT, STATE_*). V2 API only.
  - name: VAT Rates
    description: >-
      Look up available VAT (Value Added Tax) rates for your organization. Use
      these IDs as `vat_rate_id` on transaction line items. Rates are scoped by
      country and include standard, reduced, zero-rated, exempt, and reverse
      charge types. V2 API only.
  - name: GST Tax Rates
    description: >-
      Look up available GST (Goods and Services Tax) rates for your
      organization. Use these IDs as `gst_tax_rate_id` on transaction line
      items. Covers AU, NZ, SG, IN, CA GST regimes and MY SST, with
      per-component breakdowns (e.g. CGST+SGST for India). V2 API only.
  - name: Withholding Tax Rates
    description: >-
      Look up the withholding tax rates of your organization. Use these IDs as
      `withholding_tax_rate_id` on bill and direct expense lines, and as
      `default_withholding_tax_rate_id` on vendors. Not available on V1.
  - name: Withholding Tax Remittances
    description: >-
      Record a payment to a tax agency for the withheld amounts of posted bills,
      direct expenses, and vendor credits. List the open withheld amounts, then
      create a remittance with their `withheld_entry_id` values. A posted
      remittance moves the amount from the withholding tax payable account to
      the bank account. Not available on V1.
  - name: Product Tax Codes
    description: >-
      Manage organization product tax codes and discover global product tax
      codes. Use these IDs as `product_tax_code_id` on item payloads. V2 API
      only.
  - name: Approval Policies
    description: >-
      Manage approval workflows and policies. Define approval rules, steps,
      conditions, and approvers for different record types. Monitor workflow
      execution states and view approval history.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Inbox
    description: >-
      View pending approvals and approval status. Access transactions and
      records awaiting approval across the organization, including full approval
      workflow details, approvers, and action history.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: Statistical Journals
    description: >-
      Record non-monetary quantity values, such as headcount or square footage.
      Statistical journals never post to the general ledger.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
  - name: E-invoicing
    description: >-
      Read the e-invoicing settings of the organization, the registrations of
      its companies, and the e-invoice filing of an invoice or a customer credit
      with its events and legal files. Retry a failed filing, refresh a started
      one, check a customer before a post, and set the e-invoicing identifiers
      of a customer. The settings, the registrations and the company identifiers
      are read-only: change them in the DualEntry app.


      **Subscription.** Every route except the status route needs the
      e-invoicing subscription. Without it, the route answers `402` before it
      checks the permission. The filing, its legal files and the send rules of a
      record that DualEntry filed still answer after the subscription ends. An
      organization without the subscription posts, sends and archives invoices
      as before.


      **Permissions.** The settings, the registrations and the event list need
      `e_invoicing:view`.


      The filing of a record follows the permission of its record:
      `invoice:view` or `customer_credit:view` to read it, `invoice:edit` or
      `customer_credit:edit` to retry it.


      The identifiers need `e_invoicing:view` with `customer:view` or
      `vendor:view` to read, and `e_invoicing:edit` with `customer:edit` to
      write, as in the app. A key that the CLI sign-in made reaches only the
      companies of its user.


      **Error codes.** A refused e-invoicing request carries a stable
      `error_code`:


      - `e_invoicing_send_held`: the authority must clear the invoice before the
      customer gets it.

      - `e_invoicing_legal_pdf_missing`: the authority PDF is not stored yet.

      - `e_invoicing_validation`: the authority refuses the document data.

      - `e_invoicing_setup`: the setup of the country is broken.

      - `e_invoicing_engine`: the e-invoicing engine did not answer or refused
      the request.

      - `e_invoicing_not_retryable`: the filing is not failed or rejected.

      - `e_invoicing_error`: any other refusal.


      A record save that e-invoicing refuses, such as a change of a cleared
      invoice, answers `422` with the reason under the `e_invoicing` key. Not in
      v1.
  - name: Data Exports
    description: >-
      Request off-cycle refreshes of your organization's data export to its
      configured destination (for example a Snowflake warehouse) and poll their
      status. Exports also run automatically on a schedule; these requests are
      an on-demand supplement. Requests are accepted and orchestrated by
      DualEntry; there is no SLA on when a run starts.


      If your organization connects an integration that syncs this resource with
      a third-party system, a change you make here can also be applied in that
      system, immediately or on a later sync. See the documentation for each
      integration for details.
paths:
  /public/v3-alpha/contracts/actions/preview_schedule/:
    post:
      tags:
        - Contracts
      summary: Preview Contract Schedule
      description: >-
        Preview contract billing and revenue recognition schedules without
        saving data.
      operationId: core_api_public_contracts_preview_public_contract_schedule
      parameters:
        - in: query
          name: include_tax
          schema:
            default: false
            title: Include Tax
            type: boolean
          required: false
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            type: string
            maxLength: 255
          description: >-
            Optional. A unique value (a UUID works well) identifying this
            operation. If the request is repeated with the same key, the
            original response is replayed instead of the operation running
            again, so a retry cannot create a duplicate record. Results are
            replayable for 48 hours. Reusing a key with a different request body
            returns `422`.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContractPublicSchemaCreateIn'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContractSchedulePreviewOut'
        '422':
          description: Unprocessable Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
components:
  schemas:
    ContractPublicSchemaCreateIn:
      properties:
        custom_fields:
          title: Custom Fields
          items:
            additionalProperties: true
            type: object
          type:
            - array
            - 'null'
        memo:
          default: ''
          maxLength: 512
          title: Memo
          type: string
        date:
          format: date
          title: Date
          type: string
        start_date:
          format: date
          title: Start Date
          type: string
        end_date:
          title: End Date
          format: date
          type:
            - string
            - 'null'
        company_id:
          title: Company Id
          type:
            - integer
            - 'null'
        customer_id:
          title: Customer Id
          type:
            - integer
            - 'null'
        name:
          default: ''
          maxLength: 128
          title: Name
          type: string
        currency_iso_4217_code:
          allOf:
            - $ref: '#/components/schemas/SystemCurrencies'
          default: USD
        bill_to_address:
          default: ''
          title: Bill To Address
          type: string
        billing_address:
          anyOf:
            - $ref: '#/components/schemas/AddressSchemaIn'
            - type: 'null'
        ship_to_address:
          default: ''
          title: Ship To Address
          type: string
        shipping_address:
          anyOf:
            - $ref: '#/components/schemas/AddressSchemaIn'
            - type: 'null'
        obligations:
          default: []
          items:
            $ref: '#/components/schemas/PerformanceObligationIn'
          title: Obligations
          type: array
        term_id:
          title: Term Id
          type:
            - integer
            - 'null'
        default_ar_account_id:
          title: Default Ar Account Id
          type:
            - integer
            - 'null'
        unbilled_receivable_account_id:
          title: Unbilled Receivable Account Id
          type:
            - integer
            - 'null'
        contract_template_id:
          title: Contract Template Id
          type:
            - integer
            - 'null'
        billing_start_date:
          title: Billing Start Date
          format: date
          type:
            - string
            - 'null'
        billing_frequency:
          allOf:
            - $ref: '#/components/schemas/BillingCadence'
          default: monthly
        billing_interval:
          default: 1
          minimum: 1
          title: Billing Interval
          type: integer
        billing_anchor_weekday:
          description: Optional weekday anchor for weekly billing (0=Monday)
          title: Billing Anchor Weekday
          maximum: 6
          minimum: 0
          type:
            - integer
            - 'null'
        recognition_start_date:
          title: Recognition Start Date
          format: date
          type:
            - string
            - 'null'
        recognition_frequency:
          allOf:
            - $ref: '#/components/schemas/RecognitionCadence'
          default: monthly
        recognition_interval:
          default: 1
          minimum: 1
          title: Recognition Interval
          type: integer
        recognition_anchor_weekday:
          description: Optional weekday anchor for weekly recognition (0=Monday)
          title: Recognition Anchor Weekday
          maximum: 6
          minimum: 0
          type:
            - integer
            - 'null'
        status:
          $ref: '#/components/schemas/ContractStatus'
        recognition_mode:
          allOf:
            - $ref: '#/components/schemas/RecognitionMode'
          default: individual
        contract_attachments:
          default: []
          items:
            $ref: '#/components/schemas/AttachmentSchemaOut'
          title: Contract Attachments
          type: array
        change_orders_attachments:
          default: []
          items:
            $ref: '#/components/schemas/AttachmentSchemaOut'
          title: Change Orders Attachments
          type: array
        payment:
          anyOf:
            - $ref: '#/components/schemas/PaymentSchemaIn'
            - type: 'null'
        prepared_invoices:
          default: []
          items:
            $ref: '#/components/schemas/InvoiceSchemaCreateIn'
          title: Prepared Invoices
          type: array
        revenue_recognitions:
          default: []
          items:
            $ref: '#/components/schemas/RevenueRecognitionSchemaCreateIn'
          title: Revenue Recognitions
          type: array
        cutover_date:
          title: Cutover Date
          format: date
          type:
            - string
            - 'null'
        prior_recognized_amount:
          anyOf:
            - minimum: 0
              type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
              type: string
            - type: 'null'
          title: Prior Recognized Amount
        default_early_termination_fee:
          anyOf:
            - minimum: 0
              type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
              type: string
            - type: 'null'
          title: Default Early Termination Fee
        discount_type:
          anyOf:
            - $ref: '#/components/schemas/DiscountType'
            - type: 'null'
          description: >-
            Type of discount applied to the full contract. Send PERCENTAGE.
            Fixed contract discounts are not supported.
        discount_value:
          anyOf:
            - exclusiveMinimum: 0
              maximum: 100
              type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
              type: string
            - type: 'null'
          description: >-
            Discount percentage for the full contract. For example, send 10 for
            10 percent.
          title: Discount Value
      required:
        - status
      title: ContractPublicSchemaCreateIn
      type: object
    ContractSchedulePreviewOut:
      properties:
        allocations:
          items:
            $ref: '#/components/schemas/ObligationAllocationOut'
          title: Allocations
          type: array
        billing_schedules:
          items:
            $ref: '#/components/schemas/ObligationBillingScheduleOut'
          title: Billing Schedules
          type: array
        recognition_schedules:
          items:
            $ref: '#/components/schemas/ObligationRecognitionScheduleOut'
          title: Recognition Schedules
          type: array
        summary:
          items:
            $ref: '#/components/schemas/RevRecSummaryRowOut'
          title: Summary
          type: array
        metrics:
          $ref: '#/components/schemas/ContractMetricsSchemaOut'
        renewed_end_date:
          title: Renewed End Date
          format: date
          type:
            - string
            - 'null'
        next_renewal_date:
          title: Next Renewal Date
          format: date
          type:
            - string
            - 'null'
        cutover_date:
          title: Cutover Date
          format: date
          type:
            - string
            - 'null'
        prior_recognized_amount:
          title: Prior Recognized Amount
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          type:
            - string
            - 'null'
      required:
        - allocations
        - billing_schedules
        - recognition_schedules
        - summary
        - metrics
      title: ContractSchedulePreviewOut
      type: object
    ErrorSchema:
      properties:
        success:
          const: false
          default: false
          title: Success
          type: boolean
        errors:
          additionalProperties:
            items:
              type: string
            type: array
          title: Errors
          type: object
        error_code:
          description: >-
            A stable code that identifies the control that refused the request.
            Branch on this code, not on the message text. When a control refuses
            the request, `error_code` is one of these values:

            - `period_locked`: The request changes data in a locked accounting
            period.

            - `approved_record_immutable`: The record is approved, and the
            organization does not allow changes to approved records.

            - `posted_record_immutable`: The record is posted, and the
            organization does not allow changes to posted records.

            - `adjusting_entry_permission_required`: You do not have the
            permission to post adjusting entries.

            - `adjusting_entries_disabled`: Adjusting entries are not enabled
            for the company.

            - `adjusting_entry_bank_account`: An adjusting entry cannot use a
            bank or credit card account.

            - `recurring_adjusting_entry`: A recurring journal entry cannot be
            an adjusting entry.

            - `segregation_of_duties_no_substitute_approver`: The approval
            policy needs an approver other than the creator, and the
            organization has no other admin.

            - `posting_date_after_limit`: The organization limits how far in the
            future a record can be posted.

            - `independent_transaction_dates_disabled`: The organization does
            not allow transaction_date to differ from date. Enable Separate
            posting and transaction dates in organization settings.

            - `tax_not_calculated`: The organization uses manual tax mode with
            the tax reminder on. A posted record needs calculated tax.

            - `recurring_template_archived_party`: A recurring template cannot
            use an archived customer or vendor.

            - `master_data_unavailable`: The request sets a reference that the
            app does not offer for this record. It is inactive, archived, a
            draft, not available to the record's company, in another currency,
            or the party for the record's own company.
          title: Error Code
          type:
            - string
            - 'null'
        error_reason:
          title: Error Reason
          type:
            - string
            - 'null'
      required:
        - errors
      title: ErrorSchema
      type: object
    SystemCurrencies:
      enum:
        - AED
        - AFN
        - ALL
        - AMD
        - ANG
        - AOA
        - ARS
        - AUD
        - AWG
        - AZN
        - BAM
        - BBD
        - BDT
        - BGN
        - BHD
        - BIF
        - BMD
        - BND
        - BOB
        - BRL
        - BSD
        - BTN
        - BWP
        - BYN
        - BZD
        - CAD
        - CDF
        - CHF
        - CLF
        - CLP
        - CNY
        - COP
        - CRC
        - CUP
        - CVE
        - CZK
        - DJF
        - DKK
        - DOP
        - DZD
        - EGP
        - ERN
        - ETB
        - EUR
        - FJD
        - FKP
        - GBP
        - GEL
        - GHS
        - GIP
        - GMD
        - GNF
        - GTQ
        - GYD
        - HKD
        - HNL
        - HTG
        - HUF
        - IDR
        - ILS
        - INR
        - IQD
        - IRR
        - ISK
        - JMD
        - JOD
        - JPY
        - KES
        - KGS
        - KHR
        - KMF
        - KPW
        - KRW
        - KWD
        - KYD
        - KZT
        - LAK
        - LBP
        - LKR
        - LRD
        - LSL
        - LYD
        - MAD
        - MDL
        - MGA
        - MKD
        - MMK
        - MNT
        - MOP
        - MRU
        - MUR
        - MVR
        - MWK
        - MXN
        - MYR
        - MZN
        - NAD
        - NGN
        - NIO
        - NOK
        - NPR
        - NZD
        - OMR
        - PAB
        - PEN
        - PGK
        - PHP
        - PKR
        - PLN
        - PYG
        - QAR
        - RON
        - RSD
        - RUB
        - RWF
        - SAR
        - SBD
        - SCR
        - SDG
        - SEK
        - SGD
        - SHP
        - SLL
        - SOS
        - SRD
        - STN
        - SVC
        - SYP
        - SZL
        - THB
        - TJS
        - TMT
        - TND
        - TOP
        - TRY
        - TTD
        - TWD
        - TZS
        - UAH
        - UGX
        - USD
        - UYU
        - UZS
        - VES
        - VND
        - VUV
        - WST
        - XAF
        - XAG
        - XAU
        - XCD
        - XDR
        - XOF
        - XPD
        - XPF
        - XPT
        - YER
        - ZAR
        - ZMW
        - ZWL
      title: SystemCurrencies
      type: string
    AddressSchemaIn:
      properties:
        street:
          title: Street
          type: string
        city:
          title: City
          type: string
        state:
          default: ''
          title: State
          type: string
        postal_code:
          title: Postal Code
          type: string
        country:
          anyOf:
            - const: ''
              type: string
            - $ref: '#/components/schemas/SystemCountries'
          default: ''
          title: Country
        second_line:
          default: ''
          title: Second Line
          type: string
        name:
          title: Name
          type:
            - string
            - 'null'
      required:
        - street
        - city
        - postal_code
      title: AddressSchemaIn
      type: object
    PerformanceObligationIn:
      properties:
        id:
          title: Id
          type:
            - integer
            - 'null'
        item_id:
          title: Item Id
          minimum: 1
          type:
            - integer
            - 'null'
        quantity:
          anyOf:
            - exclusiveMinimum: 0
              type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
              type: string
            - type: 'null'
          description: >-
            On released v1 and v2, quantity is for the whole term: quantity 10
            at a unit price of $100 gives a total contract value of $1,000. On
            v3, and on v1 or v2 with breaking changes enabled, quantity is for
            each billing period: the same values over 12 monthly periods give
            $12,000. You can omit this field when the obligation is incomplete.
            A value must be greater than `0`. You can use up to 6 decimal
            places.
          title: Quantity
        rate:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,10}0*$
              type: string
            - type: 'null'
          description: >-
            On released v1 and v2, this unit price applies to the quantity for
            the whole term: quantity 10 at a unit price of $100 gives a total
            contract value of $1,000. On v3, and on v1 or v2 with breaking
            changes enabled, this unit price applies to each billing period: the
            same values over 12 monthly periods give $12,000. You can use up to
            10 decimal places.
          title: Rate
        position:
          default: 0
          title: Position
          type: integer
        memo:
          default: ''
          maxLength: 512
          title: Memo
          type: string
        standalone_selling_price:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,10}0*$
              type: string
            - type: 'null'
          title: Standalone Selling Price
        term_id:
          title: Term Id
          type:
            - integer
            - 'null'
        billing_group:
          default: 1
          minimum: 1
          title: Billing Group
          type: integer
        recognition_strategy:
          allOf:
            - $ref: '#/components/schemas/RecognitionStrategy'
          default: straight_line
        obligation_conditions:
          additionalProperties: true
          title: Obligation Conditions
          type: object
        classifications:
          default: []
          items:
            $ref: '#/components/schemas/RecordClassificationsSchemaOut'
          title: Classifications
          type: array
        billing_start_date:
          title: Billing Start Date
          format: date
          type:
            - string
            - 'null'
        billing_end_date:
          title: Billing End Date
          format: date
          type:
            - string
            - 'null'
        billing_frequency:
          anyOf:
            - $ref: '#/components/schemas/BillingCadence'
            - type: 'null'
        billing_interval:
          title: Billing Interval
          type:
            - integer
            - 'null'
        billing_mode:
          anyOf:
            - $ref: '#/components/schemas/BillingMode'
            - type: 'null'
        sync_billing_with_recognition:
          default: false
          title: Sync Billing With Recognition
          type: boolean
        skip_invoice_generation:
          default: false
          title: Skip Invoice Generation
          type: boolean
        recognition_start_date:
          title: Recognition Start Date
          format: date
          type:
            - string
            - 'null'
        recognition_end_date:
          title: Recognition End Date
          format: date
          type:
            - string
            - 'null'
        recognition_frequency:
          anyOf:
            - $ref: '#/components/schemas/RecognitionCadence'
            - type: 'null'
        recognition_interval:
          title: Recognition Interval
          type:
            - integer
            - 'null'
        discount_type:
          anyOf:
            - $ref: '#/components/schemas/DiscountType'
            - type: 'null'
        discount_value:
          anyOf:
            - exclusiveMinimum: 0
              type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
              type: string
            - type: 'null'
          title: Discount Value
        selected_vat_rate_id:
          title: Selected Vat Rate Id
          type:
            - integer
            - 'null'
        selected_gst_tax_rate_id:
          title: Selected Gst Tax Rate Id
          type:
            - integer
            - 'null'
        is_auto_renewable:
          default: false
          title: Is Auto Renewable
          type: boolean
        ramp_group_id:
          title: Ramp Group Id
          format: uuid
          type:
            - string
            - 'null'
      title: PerformanceObligationIn
      type: object
    BillingCadence:
      enum:
        - one_time
        - daily
        - weekly
        - monthly
        - quarterly
        - semi_annually
        - annually
      title: BillingCadence
      type: string
    RecognitionCadence:
      enum:
        - daily
        - weekly
        - monthly
        - quarterly
        - semi_annually
        - annually
      title: RecognitionCadence
      type: string
    ContractStatus:
      enum:
        - draft
        - active
        - completed
        - terminated
        - archived
      title: ContractStatus
      type: string
    RecognitionMode:
      enum:
        - individual
        - subledger
      title: RecognitionMode
      type: string
    AttachmentSchemaOut:
      properties:
        id:
          title: Id
          type: integer
        file_name:
          title: File Name
          type: string
        file_size:
          title: File Size
          type: integer
        download_url:
          title: Download Url
          type:
            - string
            - 'null'
        upload_url:
          title: Upload Url
          type:
            - string
            - 'null'
        category:
          default: default
          title: Category
          type: string
      required:
        - id
        - file_name
        - file_size
      title: AttachmentSchemaOut
      type: object
    PaymentSchemaIn:
      description: >-
        Schema for payment collection configuration input (matches frontend
        structure).
      properties:
        type:
          title: Type
          type:
            - string
            - 'null'
        id:
          title: Id
          type:
            - integer
            - 'null'
        body:
          title: Body
          type:
            - string
            - 'null'
        link:
          title: Link
          type:
            - string
            - 'null'
      title: PaymentSchemaIn
      type: object
    InvoiceSchemaCreateIn:
      properties:
        supply_date:
          description: >-
            Tax point date for VAT and GST.


            When the saved record uses a VAT or GST tax regime and you omit this
            field, DualEntry sets it to `transaction_date`, or to `date` when
            there is no `transaction_date`.


            Recurring templates store the value you send. Each generated record
            that uses VAT or GST and has no supply date gets that default on
            save.


            On PATCH, an omitted field keeps the stored value. Send
            `supply_date` again when you change `date` or `transaction_date`.
          title: Supply Date
          format: date
          type:
            - string
            - 'null'
        place_of_supply:
          title: Place Of Supply
          maxLength: 2
          type:
            - string
            - 'null'
        tax_registration_numbers:
          anyOf:
            - $ref: '#/components/schemas/TaxRegistrationNumbersSnapshot'
            - type: 'null'
        tax_metadata:
          anyOf:
            - $ref: '#/components/schemas/RecordTaxMetadata'
            - type: 'null'
        bill_to_address:
          default: ''
          deprecated: true
          description: >-
            Deprecated: send the structured `billing_address` /
            `shipping_address` instead.
          title: Bill To Address
          type:
            - string
            - 'null'
        ship_to_address:
          default: ''
          deprecated: true
          description: >-
            Deprecated: send the structured `billing_address` /
            `shipping_address` instead.
          title: Ship To Address
          type:
            - string
            - 'null'
        billing_address:
          anyOf:
            - $ref: '#/components/schemas/AddressSchemaIn'
            - type: 'null'
        shipping_address:
          anyOf:
            - $ref: '#/components/schemas/AddressSchemaIn'
            - type: 'null'
        custom_fields:
          title: Custom Fields
          items:
            additionalProperties: true
            type: object
          type:
            - array
            - 'null'
        date:
          format: date
          title: Date
          type: string
        transaction_date:
          title: Transaction Date
          format: date
          type:
            - string
            - 'null'
        origin:
          allOf:
            - $ref: '#/components/schemas/Origin'
          default: manual
        discount_type:
          anyOf:
            - $ref: '#/components/schemas/DiscountType'
            - type: 'null'
        discount_value:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
              type: string
            - type: 'null'
          title: Discount Value
        book_ids:
          description: >-
            Select accounting Book IDs. Omit this field on update to preserve
            assignments. Use null or an empty list to select all active Books.
            For records controlled by the organization setting, disabled
            selection makes creates use all active Books and rejects changed
            non-empty updates. Journal Entries are exempt.
          title: Book Ids
          items:
            type: integer
          type:
            - array
            - 'null'
        memo:
          title: Memo
          type:
            - string
            - 'null'
        due_date:
          title: Due Date
          format: date
          type:
            - string
            - 'null'
        company_id:
          title: Company Id
          type:
            - integer
            - 'null'
        customer_id:
          title: Customer Id
          type:
            - integer
            - 'null'
        currency_iso_4217_code:
          anyOf:
            - $ref: '#/components/schemas/SystemCurrencies'
            - type: 'null'
        exchange_rate:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,16}0*$
              type: string
            - type: 'null'
          title: Exchange Rate
        items:
          title: Items
          items:
            $ref: '#/components/schemas/InvoiceItemIn'
          type:
            - array
            - 'null'
        sales_order_id:
          title: Sales Order Id
          type:
            - integer
            - 'null'
        attachments:
          default: []
          items:
            $ref: '#/components/schemas/AttachmentSchemaOut'
          title: Attachments
          type: array
        record_status:
          allOf:
            - $ref: '#/components/schemas/RecordStatus'
          default: posted
        contracted:
          default: false
          title: Contracted
          type: boolean
        contract_id:
          title: Contract Id
          type:
            - integer
            - 'null'
        term_id:
          title: Term Id
          type:
            - integer
            - 'null'
        installments:
          description: >-
            Optional applied installment rows for this record. When you send a
            non-empty list, DualEntry stores these rows instead of copying the
            term schedule. Amounts must add up to the record total. Paid and
            partially paid rows must stay with the same position, due date, and
            amount. An empty list stores no rows, and that is valid when the
            term is not an installment term. Omit `installments` to copy the
            term schedule.
          title: Installments
          items:
            $ref: '#/components/schemas/RecordInstallmentSchemaIn'
          type:
            - array
            - 'null'
        reference_number:
          default: ''
          title: Reference Number
          type: string
        ar_account_id:
          title: Ar Account Id
          type:
            - integer
            - 'null'
        payment:
          anyOf:
            - $ref: '#/components/schemas/PaymentSchemaIn'
            - type: 'null'
        include_payment_link:
          default: false
          title: Include Payment Link
          type: boolean
      required:
        - date
      title: InvoiceSchemaCreateIn
      type: object
    RevenueRecognitionSchemaCreateIn:
      properties:
        date:
          format: date
          title: Date
          type: string
        transaction_date:
          title: Transaction Date
          format: date
          type:
            - string
            - 'null'
        amount:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
              type: string
          title: Amount
        record_status:
          allOf:
            - $ref: '#/components/schemas/RecordStatus'
          default: posted
        performance_obligation_id:
          title: Performance Obligation Id
          type:
            - integer
            - 'null'
        income_account_id:
          title: Income Account Id
          type:
            - integer
            - 'null'
        deferral_account_id:
          title: Deferral Account Id
          type:
            - integer
            - 'null'
        gross_amount:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
              type: string
            - type: 'null'
          title: Gross Amount
        discount_amount:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
              type: string
            - type: 'null'
          title: Discount Amount
      required:
        - date
        - amount
      title: RevenueRecognitionSchemaCreateIn
      type: object
    DiscountType:
      enum:
        - PERCENTAGE
        - FIXED
      title: DiscountType
      type: string
    ObligationAllocationOut:
      properties:
        position:
          title: Position
          type: integer
        item_id:
          title: Item Id
          type: integer
        quantity:
          description: >-
            Quantity for each billing period on this performance obligation.
            Quantity 10 and a unit price of $100 for 12 monthly periods give a
            total contract value of $12,000. Quantity is greater than or equal
            to `0`.
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
          title: Quantity
          type: string
        rate:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,10}0*$
          title: Rate
          type: string
        line_amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Line Amount
          type: string
        standalone_selling_price:
          title: Standalone Selling Price
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,10}0*$
          type:
            - string
            - 'null'
        allocation_ratio:
          title: Allocation Ratio
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
          type:
            - string
            - 'null'
        allocated_amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Allocated Amount
          type: string
        recognition_strategy:
          $ref: '#/components/schemas/RecognitionStrategy'
      required:
        - position
        - item_id
        - quantity
        - rate
        - line_amount
        - standalone_selling_price
        - allocation_ratio
        - allocated_amount
        - recognition_strategy
      title: ObligationAllocationOut
      type: object
    ObligationBillingScheduleOut:
      properties:
        position:
          title: Position
          type: integer
        item_id:
          title: Item Id
          type: integer
        total_amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Total Amount
          type: string
        total_tax_amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Total Tax Amount
          type: string
        schedule:
          items:
            $ref: '#/components/schemas/BillingScheduleRowOut'
          title: Schedule
          type: array
      required:
        - position
        - item_id
        - total_amount
        - total_tax_amount
        - schedule
      title: ObligationBillingScheduleOut
      type: object
    ObligationRecognitionScheduleOut:
      properties:
        position:
          title: Position
          type: integer
        item_id:
          title: Item Id
          type: integer
        allocated_amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Allocated Amount
          type: string
        recognition_strategy:
          $ref: '#/components/schemas/RecognitionStrategy'
        schedule:
          items:
            $ref: '#/components/schemas/ObligationRecognitionScheduleRowOut'
          title: Schedule
          type: array
        usage_schedule:
          title: Usage Schedule
          items:
            $ref: '#/components/schemas/UsageRecognitionScheduleRowOut'
          type:
            - array
            - 'null'
      required:
        - position
        - item_id
        - allocated_amount
        - recognition_strategy
        - schedule
      title: ObligationRecognitionScheduleOut
      type: object
    RevRecSummaryRowOut:
      properties:
        date:
          format: date
          title: Date
          type: string
        invoiced_revenue:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Invoiced Revenue
          type: string
        recognized_revenue:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Recognized Revenue
          type: string
        deferred_revenue:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Deferred Revenue
          type: string
        status:
          $ref: '#/components/schemas/ContractScheduleStatus'
      required:
        - date
        - invoiced_revenue
        - recognized_revenue
        - deferred_revenue
        - status
      title: RevRecSummaryRowOut
      type: object
    ContractMetricsSchemaOut:
      properties:
        total_contract_value:
          title: Total Contract Value
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          type:
            - string
            - 'null'
        mrr:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Mrr
          type: string
        arr:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Arr
          type: string
        amount_invoiced:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Amount Invoiced
          type: string
        amount_invoiced_percentage:
          title: Amount Invoiced Percentage
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          type:
            - string
            - 'null'
        invoices_paid:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Invoices Paid
          type: string
        invoices_paid_percentage:
          title: Invoices Paid Percentage
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          type:
            - string
            - 'null'
        revenue_recognized:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Revenue Recognized
          type: string
        revenue_recognized_percentage:
          title: Revenue Recognized Percentage
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          type:
            - string
            - 'null'
        unbilled_revenue:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Unbilled Revenue
          type: string
        unrecognized_revenue:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Unrecognized Revenue
          type: string
        deferred_revenue:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Deferred Revenue
          type: string
        next_invoice_date:
          title: Next Invoice Date
          format: date
          type:
            - string
            - 'null'
        total_discount_amount:
          default: '0'
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Total Discount Amount
          type: string
        total_tax_amount:
          default: '0'
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Total Tax Amount
          type: string
      required:
        - mrr
        - arr
        - amount_invoiced
        - invoices_paid
        - revenue_recognized
        - unbilled_revenue
        - unrecognized_revenue
        - deferred_revenue
      title: ContractMetricsSchemaOut
      type: object
    SystemCountries:
      enum:
        - AA
        - AB
        - AC
        - AD
        - AE
        - AF
        - AG
        - AH
        - AI
        - AJ
        - AK
        - AL
        - AM
        - AN
        - AO
        - AP
        - AQ
        - AR
        - AS
        - AT
        - AU
        - AV
        - AW
        - AX
        - AY
        - AZ
        - BA
        - BB
        - BC
        - BD
        - BE
        - BF
        - BG
        - BH
        - BI
        - BJ
        - BK
        - BL
        - BM
        - BN
        - BO
        - BP
        - BQ
        - BR
        - BS
        - BT
        - BU
        - BV
        - BW
        - BX
        - BY
        - BZ
        - CA
        - CB
        - CC
        - CD
        - CE
        - CF
        - CG
        - CH
        - CI
        - CJ
        - CK
        - CL
        - CM
        - CN
        - CO
        - CP
        - CQ
        - CR
        - CS
        - CT
        - CU
        - CV
        - CW
        - CX
        - CY
        - CZ
        - DA
        - DB
        - DC
        - DD
        - DE
        - DF
        - DG
        - DH
        - DI
        - DJ
        - DK
        - DL
        - DM
        - DN
        - DO
        - DP
        - DQ
        - DR
        - DS
        - DT
        - DU
        - DV
        - DW
        - DX
        - DY
        - DZ
        - EA
        - EB
        - EC
        - ED
        - EE
        - EF
        - EG
        - EH
        - EI
        - EJ
        - EK
        - EL
        - EM
        - EN
        - EO
        - EP
        - EQ
        - ER
        - ES
        - ET
        - EU
        - EV
        - EW
        - EX
        - EY
        - EZ
        - FA
        - FB
        - FC
        - FD
        - FE
        - FF
        - FG
        - FH
        - FI
        - FJ
        - FK
        - FL
        - FM
        - FN
        - FO
        - FP
        - FQ
        - FR
        - FS
        - FT
        - FU
        - FV
        - FW
        - FX
        - FY
        - FZ
        - GA
        - GB
        - GC
        - GD
        - GE
        - GF
        - GG
        - GH
        - GI
        - GJ
        - GK
        - GL
        - GM
        - GN
        - GO
        - GP
        - GQ
        - GR
        - GS
        - GT
        - GU
        - GV
        - GW
        - GX
        - GY
        - GZ
        - HA
        - HB
        - HC
        - HD
        - HE
        - HF
        - HG
        - HH
        - HI
        - HJ
        - HK
        - HL
        - HM
        - HN
        - HO
        - HP
        - HQ
        - HR
        - HS
        - HT
        - HU
        - HV
        - HW
        - HX
        - HY
        - HZ
        - IA
        - IB
        - IC
        - ID
        - IE
        - IF
        - IG
        - IH
        - II
        - IJ
        - IK
        - IL
        - IM
        - IN
        - IO
        - IP
        - IQ
        - IR
        - IS
        - IT
        - IU
        - IV
        - IW
        - IX
        - IY
        - IZ
        - JA
        - JB
        - JC
        - JD
        - JE
        - JF
        - JG
        - JH
        - JI
        - JJ
        - JK
        - JL
        - JM
        - JN
        - JO
        - JP
        - JQ
        - JR
        - JS
        - JT
        - JU
        - JV
        - JW
        - JX
        - JY
        - JZ
        - KA
        - KB
        - KC
        - KD
        - KE
        - KF
        - KG
        - KH
        - KI
        - KJ
        - KK
        - KL
        - KM
        - KN
        - KO
        - KP
        - KQ
        - KR
        - KS
        - KT
        - KU
        - KV
        - KW
        - KX
        - KY
        - KZ
        - LA
        - LB
        - LC
        - LD
        - LE
        - LF
        - LG
        - LH
        - LI
        - LJ
        - LK
        - LL
        - LM
        - LN
        - LO
        - LP
        - LQ
        - LR
        - LS
        - LT
        - LU
        - LV
        - LW
        - LX
        - LY
        - LZ
        - MA
        - MB
        - MC
        - MD
        - ME
        - MF
        - MG
        - MH
        - MI
        - MJ
        - MK
        - ML
        - MM
        - MN
        - MO
        - MP
        - MQ
        - MR
        - MS
        - MT
        - MU
        - MV
        - MW
        - MX
        - MY
        - MZ
        - NA
        - NB
        - NC
        - ND
        - NE
        - NF
        - NG
        - NH
        - NI
        - NJ
        - NK
        - NL
        - NM
        - NN
        - 'NO'
        - NP
        - NQ
        - NR
        - NS
        - NT
        - NU
        - NV
        - NW
        - NX
        - NY
        - NZ
        - OA
        - OB
        - OC
        - OD
        - OE
        - OF
        - OG
        - OH
        - OI
        - OJ
        - OK
        - OL
        - OM
        - 'ON'
        - OO
        - OP
        - OQ
        - OR
        - OS
        - OT
        - OU
        - OV
        - OW
        - OX
        - OY
        - OZ
        - PA
        - PB
        - PC
        - PD
        - PE
        - PF
        - PG
        - PH
        - PI
        - PJ
        - PK
        - PL
        - PM
        - PN
        - PO
        - PP
        - PQ
        - PR
        - PS
        - PT
        - PU
        - PV
        - PW
        - PX
        - PY
        - PZ
        - QA
        - QB
        - QC
        - QD
        - QE
        - QF
        - QG
        - QH
        - QI
        - QJ
        - QK
        - QL
        - QM
        - QN
        - QO
        - QP
        - QQ
        - QR
        - QS
        - QT
        - QU
        - QV
        - QW
        - QX
        - QY
        - QZ
        - RA
        - RB
        - RC
        - RD
        - RE
        - RF
        - RG
        - RH
        - RI
        - RJ
        - RK
        - RL
        - RM
        - RN
        - RO
        - RP
        - RQ
        - RR
        - RS
        - RT
        - RU
        - RV
        - RW
        - RX
        - RY
        - RZ
        - SA
        - SB
        - SC
        - SD
        - SE
        - SF
        - SG
        - SH
        - SI
        - SJ
        - SK
        - SL
        - SM
        - SN
        - SO
        - SP
        - SQ
        - SR
        - SS
        - ST
        - SU
        - SV
        - SW
        - SX
        - SY
        - SZ
        - TA
        - TB
        - TC
        - TD
        - TE
        - TF
        - TG
        - TH
        - TI
        - TJ
        - TK
        - TL
        - TM
        - TN
        - TO
        - TP
        - TQ
        - TR
        - TS
        - TT
        - TU
        - TV
        - TW
        - TX
        - TY
        - TZ
        - UA
        - UB
        - UC
        - UD
        - UE
        - UF
        - UG
        - UH
        - UI
        - UJ
        - UK
        - UL
        - UM
        - UN
        - UO
        - UP
        - UQ
        - UR
        - US
        - UT
        - UU
        - UV
        - UW
        - UX
        - UY
        - UZ
        - VA
        - VB
        - VC
        - VD
        - VE
        - VF
        - VG
        - VH
        - VI
        - VJ
        - VK
        - VL
        - VM
        - VN
        - VO
        - VP
        - VQ
        - VR
        - VS
        - VT
        - VU
        - VV
        - VW
        - VX
        - VY
        - VZ
        - WA
        - WB
        - WC
        - WD
        - WE
        - WF
        - WG
        - WH
        - WI
        - WJ
        - WK
        - WL
        - WM
        - WN
        - WO
        - WP
        - WQ
        - WR
        - WS
        - WT
        - WU
        - WV
        - WW
        - WX
        - WY
        - WZ
        - XA
        - XB
        - XC
        - XD
        - XE
        - XF
        - XG
        - XH
        - XI
        - XJ
        - XK
        - XL
        - XM
        - XN
        - XO
        - XP
        - XQ
        - XR
        - XS
        - XT
        - XU
        - XV
        - XW
        - XX
        - XY
        - XZ
        - YA
        - YB
        - YC
        - YD
        - YE
        - YF
        - YG
        - YH
        - YI
        - YJ
        - YK
        - YL
        - YM
        - YN
        - YO
        - YP
        - YQ
        - YR
        - YS
        - YT
        - YU
        - YV
        - YW
        - YX
        - YY
        - YZ
        - ZA
        - ZB
        - ZC
        - ZD
        - ZE
        - ZF
        - ZG
        - ZH
        - ZI
        - ZJ
        - ZK
        - ZL
        - ZM
        - ZN
        - ZO
        - ZP
        - ZQ
        - ZR
        - ZS
        - ZT
        - ZU
        - ZV
        - ZW
        - ZX
        - ZY
        - ZZ
      title: SystemCountries
      type: string
    RecognitionStrategy:
      enum:
        - straight_line
        - straight_line_start_end_even
        - daily_prorata
        - milestone
        - usage_tiered
        - usage
        - immediate
        - deposit_release
      title: RecognitionStrategy
      type: string
    RecordClassificationsSchemaOut:
      properties:
        id:
          title: Id
          type: integer
        name:
          title: Name
          type: string
        line_id:
          title: Line Id
          type: integer
        line_name:
          title: Line Name
          type: string
        parent_classification_id:
          title: Parent Classification Id
          type:
            - integer
            - 'null'
        parent_classification_line_id:
          title: Parent Classification Line Id
          type:
            - integer
            - 'null'
      required:
        - id
        - name
        - line_id
        - line_name
      title: RecordClassificationsSchemaOut
      type: object
    BillingMode:
      enum:
        - period
        - synced
        - drawdown
      title: BillingMode
      type: string
    TaxRegistrationNumbersSnapshot:
      properties:
        company:
          items:
            $ref: '#/components/schemas/TaxRegistrationNumberEntry'
          title: Company
          type: array
        counterparty:
          items:
            $ref: '#/components/schemas/TaxRegistrationNumberEntry'
          title: Counterparty
          type: array
      title: TaxRegistrationNumbersSnapshot
      type: object
    RecordTaxMetadata:
      additionalProperties:
        additionalProperties: true
        type: object
      type: object
    Origin:
      enum:
        - manual
        - integration
        - initial_sync
        - banking
        - payments
      title: Origin
      type: string
    InvoiceItemIn:
      properties:
        discount_type:
          anyOf:
            - $ref: '#/components/schemas/DiscountType'
            - type: 'null'
        discount_value:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
              type: string
            - type: 'null'
          title: Discount Value
        discount_account_id:
          title: Discount Account Id
          type:
            - integer
            - 'null'
        record_level_discount_amount:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
              type: string
            - type: 'null'
          title: Record Level Discount Amount
        tax:
          anyOf:
            - $ref: '#/components/schemas/ItemTaxData'
            - type: 'null'
        custom_fields:
          title: Custom Fields
          items:
            additionalProperties: true
            type: object
          type:
            - array
            - 'null'
        id:
          title: Id
          type:
            - integer
            - 'null'
        item_id:
          title: Item Id
          type: integer
        quantity:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
              type: string
          description: >-
            Quantity billed on this line. Quantity must be greater than or equal
            to `0`. You can use up to 6 decimal places.
          title: Quantity
        rate:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,10}0*$
              type: string
          title: Rate
        position:
          title: Position
          type: integer
        memo:
          title: Memo
          type: string
        classifications:
          default: []
          items:
            $ref: '#/components/schemas/RecordClassificationsSchemaOut'
          title: Classifications
          type: array
        company_id:
          title: Company Id
          type:
            - integer
            - 'null'
      required:
        - id
        - item_id
        - quantity
        - rate
        - position
        - memo
      title: InvoiceItemIn
      type: object
    RecordStatus:
      enum:
        - draft
        - posted
        - archived
      title: RecordStatus
      type: string
    RecordInstallmentSchemaIn:
      properties:
        position:
          minimum: 1
          title: Position
          type: integer
        due_date:
          format: date
          title: Due Date
          type: string
        amount:
          anyOf:
            - minimum: 0
              type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
              type: string
          title: Amount
      required:
        - position
        - due_date
        - amount
      title: RecordInstallmentSchemaIn
      type: object
    BillingScheduleRowOut:
      properties:
        date:
          format: date
          title: Date
          type: string
        amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Amount
          type: string
        tax_amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Tax Amount
          type: string
        status:
          $ref: '#/components/schemas/ContractScheduleStatus'
      required:
        - date
        - amount
        - tax_amount
        - status
      title: BillingScheduleRowOut
      type: object
    ObligationRecognitionScheduleRowOut:
      properties:
        date:
          format: date
          title: Date
          type: string
        quantity_to_deliver:
          description: Quantity this recognition period delivers.
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
          title: Quantity to deliver
          type: string
        amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Amount
          type: string
        percentage:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Percentage
          type: string
        cumulative_percentage:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Cumulative Percentage
          type: string
        status:
          $ref: '#/components/schemas/ContractScheduleStatus'
      required:
        - date
        - quantity_to_deliver
        - amount
        - percentage
        - cumulative_percentage
        - status
      title: ObligationRecognitionScheduleRowOut
      type: object
    UsageRecognitionScheduleRowOut:
      description: >-
        Schedule row for USAGE recognition strategy where qty/rate/amount are
        per-period estimates.
      properties:
        date:
          format: date
          title: Date
          type: string
        estimated_qty_per_delivery:
          description: Estimated quantity for this usage period.
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
          title: Est. quantity per delivery
          type: string
        actual_qty_delivered:
          description: >-
            Quantity delivered in this usage period. A schedule preview leaves
            this value empty and does not read recorded usage.
          title: Actual quantity delivered
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
          type:
            - string
            - 'null'
        estimated_amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Estimated Amount
          type: string
        status:
          $ref: '#/components/schemas/ContractScheduleStatus'
      required:
        - date
        - estimated_qty_per_delivery
        - actual_qty_delivered
        - estimated_amount
        - status
      title: UsageRecognitionScheduleRowOut
      type: object
    ContractScheduleStatus:
      enum:
        - scheduled
        - completed
      title: ContractScheduleStatus
      type: string
    TaxRegistrationNumberEntry:
      properties:
        type:
          description: >-
            Registration type (e.g. SST_SALES, SST_SERVICE, GST, GSTIN, PST,
            QST).
          title: Type
          type: string
        number:
          description: Frozen-at-snapshot registration number.
          title: Number
          type: string
        region:
          description: >-
            2-letter region code for region-scoped registrations (e.g. Canadian
            PST/QST provinces); null for country-wide registrations.
          title: Region
          type:
            - string
            - 'null'
      required:
        - type
        - number
      title: TaxRegistrationNumberEntry
      type: object
    ItemTaxData:
      properties:
        code:
          title: Code
          type: string
        rate:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
              type: string
          title: Rate
        amount:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
              type: string
          title: Amount
        is_taxable:
          title: Is Taxable
          type:
            - boolean
            - 'null'
        tax_exempt_amount:
          anyOf:
            - type: number
            - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
              type: string
            - type: 'null'
          title: Tax Exempt Amount
        vat_rate_id:
          title: Vat Rate Id
          type:
            - integer
            - 'null'
        gst_tax_rate_id:
          title: Gst Tax Rate Id
          type:
            - integer
            - 'null'
        tax_metadata:
          title: Tax Metadata
          additionalProperties: true
          type:
            - object
            - 'null'
      required:
        - code
        - rate
        - amount
      title: ItemTaxData
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.