> ## 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.

# List CashSale records (v1)

> Retrieve a paginated list of CashSale records with filtering and ordering options.



## OpenAPI

````yaml /developers/openapi/resources-v1.json get /public/v1/cash-sales/
openapi: 3.1.0
info:
  title: DualEntry Public API
  version: 1.0.0
  description: ''
servers:
  - url: https://api.dualentry.com
    description: Production environment
  - url: https://api-dev.dualentry.com
    description: Development environment (for testing)
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.
  - 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.
  - name: Budgets
    description: >-
      Manage financial budgets. Create and track income statement and balance
      sheet budgets with monthly cell values, actuals comparison, and
      classification filtering.
  - name: Companies
    description: >-
      Access and manage company information. Retrieve details about your
      organization including legal name, tax identifiers, addresses, and
      accounting preferences.
  - 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.
  - name: Contracts
    description: >-
      Manage revenue recognition contracts. Create and retrieve contracts with
      performance obligations, and manage obligation usage for usage-based
      obligations.
  - 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.
  - 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.
  - name: Journal Entries
    description: >-
      Create and manage manual journal entries. Record direct debits and credits
      to accounts for adjustments, accruals, reclassifications, and other
      accounting transactions.
  - 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.
  - 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.
  - 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.
  - 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.
  - name: Customer Prepayment Applications
    description: >-
      Apply customer prepayments and credits to invoices. Record applications of
      prepayments or credit memos to reduce invoice balances.
  - 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.
  - name: Customer Refunds
    description: >-
      Process and track customer refunds. Record refunds issued to customers for
      overpayments, returns, or cancelled transactions.
  - 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.
  - 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.
  - 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.
  - 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).
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - name: Vendor Payments
    description: >-
      Record and manage vendor payments. Track payments made to vendors and
      apply them to outstanding bills and credits, including partial payments
      and overpayments.
  - 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.
  - name: Vendor Prepayment Applications
    description: >-
      Apply vendor prepayments to bills. Record applications of prepayments to
      reduce bill balances and track amounts owed.
  - 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.
  - name: Vendor Refunds
    description: >-
      Process and track vendor refunds. Record refunds received from vendors for
      overpayments, returns, or cancelled transactions.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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: 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.
  - 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.
paths:
  /public/v1/cash-sales/:
    get:
      tags:
        - Cash Sales
      summary: List CashSale records
      description: >-
        Retrieve a paginated list of CashSale records with filtering and
        ordering options.
      operationId: list_CashSale_records
      parameters:
        - in: query
          name: search
          schema:
            title: Search
            type:
              - string
              - 'null'
          required: false
        - in: query
          name: company_id
          schema:
            q: company_id__in
            title: Company Id
            items:
              type: integer
            type:
              - array
              - 'null'
          required: false
        - in: query
          name: number
          schema:
            q: number__in
            title: Number
            items:
              type: integer
            type:
              - array
              - 'null'
          required: false
        - in: query
          name: customer_id
          schema:
            q: customer_id__in
            title: Customer Id
            items:
              type: integer
            type:
              - array
              - 'null'
          required: false
        - in: query
          name: start_date
          schema:
            q: transaction__date__gte
            title: Start Date
            format: date
            type:
              - string
              - 'null'
          required: false
        - in: query
          name: end_date
          schema:
            q: transaction__date__lte
            title: End Date
            format: date
            type:
              - string
              - 'null'
          required: false
        - in: query
          name: transaction_currency
          schema:
            anyOf:
              - $ref: '#/components/schemas/SystemCurrencies'
              - type: 'null'
            q: transaction__currency_iso_4217_code
          required: false
        - in: query
          name: record_status
          schema:
            q: transaction__record_status__in
            title: Record Status
            items:
              $ref: '#/components/schemas/RecordStatus'
            type:
              - array
              - 'null'
          required: false
        - in: query
          name: updated_after
          schema:
            q: updated_at__gte
            title: Updated After
            format: date-time
            type:
              - string
              - 'null'
          required: false
        - in: query
          name: updated_before
          schema:
            q: updated_at__lte
            title: Updated Before
            format: date-time
            type:
              - string
              - 'null'
          required: false
        - in: query
          name: ordering
          schema:
            default: id
            title: Ordering
            type:
              - string
              - 'null'
          required: false
        - in: query
          name: limit
          schema:
            default: 100
            description: Number of records to return per page (capped at 100)
            minimum: 1
            title: Limit
            type: integer
          required: false
          description: Number of records to return per page (capped at 100)
        - in: query
          name: offset
          schema:
            default: 0
            description: Number of records to skip before starting to return results
            minimum: 0
            title: Offset
            type: integer
          required: false
          description: Number of records to skip before starting to return results
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PagedPublicCashSaleSchemaOut'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
components:
  schemas:
    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
    RecordStatus:
      enum:
        - draft
        - posted
        - archived
      title: RecordStatus
      type: string
    PagedPublicCashSaleSchemaOut:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PublicCashSaleSchemaOut'
          title: Items
          type: array
        count:
          title: Count
          type: integer
      required:
        - items
        - count
      title: PagedPublicCashSaleSchemaOut
      type: object
    ErrorSchema:
      properties:
        success:
          const: false
          default: false
          title: Success
          type: boolean
        errors:
          additionalProperties:
            items:
              type: string
            type: array
          title: Errors
          type: object
      required:
        - errors
      title: ErrorSchema
      type: object
    PublicCashSaleSchemaOut:
      properties:
        bill_to_address:
          deprecated: true
          description: >-
            Deprecated: send the structured billing_address / shipping_address
            instead.
          title: Bill To Address
          type: string
        ship_to_address:
          deprecated: true
          description: >-
            Deprecated: send the structured billing_address / shipping_address
            instead.
          title: Ship To Address
          type: string
        billing_address:
          anyOf:
            - $ref: '#/components/schemas/AddressSchemaOut'
            - type: 'null'
        shipping_address:
          anyOf:
            - $ref: '#/components/schemas/AddressSchemaOut'
            - type: 'null'
        custom_fields:
          default: []
          items:
            $ref: '#/components/schemas/CustomFieldValuePairOutputSchema'
          title: Custom Fields
          type: array
        attachments:
          default: []
          items:
            $ref: '#/components/schemas/PublicAttachmentSchemaOut'
          title: Attachments
          type: array
        classifications:
          default: []
          items:
            $ref: '#/components/schemas/PublicRecordClassificationsSchemaOut'
          title: Classifications
          type: array
        transaction_ids:
          items:
            type: integer
          title: Transaction Ids
          type: array
        created_by:
          anyOf:
            - $ref: '#/components/schemas/AuditActorSchemaOut'
            - type: 'null'
        updated_by:
          anyOf:
            - $ref: '#/components/schemas/AuditActorSchemaOut'
            - type: 'null'
        internal_id:
          title: Internal Id
          type: integer
        number:
          title: Number
          type: integer
        items:
          items:
            $ref: '#/components/schemas/PublicCashSaleItemOut'
          title: Items
          type: array
        company_id:
          title: Company Id
          type: integer
        company_name:
          title: Company Name
          type: string
        company_currency:
          title: Company Currency
          type: string
        customer_id:
          title: Customer Id
          type: integer
        customer_name:
          title: Customer Name
          type: string
        account_number:
          title: Account Number
          type:
            - integer
            - 'null'
        amount:
          description: Total transaction amount
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Amount
          type: string
        memo:
          title: Memo
          type: string
        check_number:
          title: Check Number
          type: string
        date:
          description: >-
            Posting date (GL date) - the date when the transaction is recorded
            in the general ledger
          format: date
          title: Date
          type: string
        transaction_date:
          description: >-
            Transaction date (inception date) - the date when the transaction
            actually occurred
          format: date
          title: Transaction Date
          type: string
        currency_iso_4217_code:
          $ref: '#/components/schemas/SystemCurrencies'
        exchange_rate:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,16}0*$
          title: Exchange Rate
          type: string
        undeposited_funds_currency:
          anyOf:
            - $ref: '#/components/schemas/SystemCurrencies'
            - type: 'null'
        bank_or_undeposited_account_amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Bank Or Undeposited Account Amount
          type: string
        payment_method_id:
          title: Payment Method Id
          type:
            - integer
            - 'null'
        record_status:
          $ref: '#/components/schemas/RecordStatus'
        created_at:
          description: Date and time the record was created
          format: date-time
          title: Created At
          type: string
        updated_at:
          description: Date and time the record was last updated
          format: date-time
          title: Updated At
          type: string
      required:
        - bill_to_address
        - ship_to_address
        - transaction_ids
        - internal_id
        - number
        - items
        - company_id
        - company_name
        - company_currency
        - customer_id
        - customer_name
        - account_number
        - amount
        - memo
        - check_number
        - date
        - transaction_date
        - currency_iso_4217_code
        - exchange_rate
        - undeposited_funds_currency
        - bank_or_undeposited_account_amount
        - record_status
        - created_at
        - updated_at
      title: PublicCashSaleSchemaOut
      type: object
    AddressSchemaOut:
      properties:
        name:
          title: Name
          type:
            - string
            - 'null'
        street:
          title: Street
          type: string
        second_line:
          title: Second Line
          type: string
        city:
          title: City
          type: string
        state:
          title: State
          type: string
        postal_code:
          title: Postal Code
          type: string
        country:
          title: Country
          type: string
      required:
        - street
        - second_line
        - city
        - state
        - postal_code
        - country
      title: AddressSchemaOut
      type: object
    CustomFieldValuePairOutputSchema:
      properties:
        field:
          $ref: '#/components/schemas/CustomFieldSchemaOut'
        value:
          anyOf:
            - $ref: '#/components/schemas/CustomFieldValueSchemaOut'
            - type: 'null'
      required:
        - field
      title: CustomFieldValuePairOutputSchema
      type: object
    PublicAttachmentSchemaOut:
      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'
      required:
        - id
        - file_name
        - file_size
      title: PublicAttachmentSchemaOut
      type: object
    PublicRecordClassificationsSchemaOut:
      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: PublicRecordClassificationsSchemaOut
      type: object
    AuditActorSchemaOut:
      description: Schema for audit actor information.
      properties:
        actor_type:
          title: Actor Type
          type:
            - string
            - 'null'
        email:
          title: Email
          type:
            - string
            - 'null'
        first_name:
          title: First Name
          type:
            - string
            - 'null'
        last_name:
          title: Last Name
          type:
            - string
            - 'null'
        timestamp:
          title: Timestamp
          format: date-time
          type:
            - string
            - 'null'
      title: AuditActorSchemaOut
      type: object
    PublicCashSaleItemOut:
      properties:
        classifications:
          default: []
          items:
            $ref: '#/components/schemas/PublicRecordClassificationsSchemaOut'
          title: Classifications
          type: array
        item_type:
          title: Item Type
          type:
            - string
            - 'null'
        hsn_sac_code:
          title: Hsn Sac Code
          type:
            - string
            - 'null'
        tax:
          anyOf:
            - $ref: '#/components/schemas/ItemTaxDataOut'
            - type: 'null'
        id:
          title: Id
          type: integer
        item_id:
          title: Item Id
          type: integer
        quantity:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
          title: Quantity
          type: string
        rate:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
          title: Rate
          type: string
        position:
          title: Position
          type: integer
        memo:
          title: Memo
          type: string
        bank_or_undeposited_account_amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Bank Or Undeposited Account Amount
          type: string
        net_amount:
          description: Net amount before tax
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          readOnly: true
          title: Net Amount
          type: string
        tax_amount:
          description: Calculated tax amount
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          readOnly: true
          title: Tax Amount
          type: string
        gross_amount:
          description: Calculated total amount including tax
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          readOnly: true
          title: Gross Amount
          type: string
        amount:
          description: >-
            Calculated total amount including tax named amount for backward
            compatibility
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          readOnly: true
          title: Amount
          type: string
      required:
        - id
        - item_id
        - quantity
        - rate
        - position
        - memo
        - bank_or_undeposited_account_amount
        - net_amount
        - tax_amount
        - gross_amount
        - amount
      title: PublicCashSaleItemOut
      type: object
    CustomFieldSchemaOut:
      properties:
        id:
          title: Id
          type: integer
        company_id:
          title: Company Id
          type:
            - integer
            - 'null'
        company_ids:
          title: Company Ids
          items:
            type: integer
          type:
            - array
            - 'null'
        name:
          title: Name
          type: string
        description:
          title: Description
          type:
            - string
            - 'null'
        helper_text:
          title: Helper Text
          type:
            - string
            - 'null'
        field_type:
          $ref: '#/components/schemas/FieldType'
        applies_to:
          items:
            $ref: '#/components/schemas/AppliesToItemSchema'
          title: Applies To
          type: array
        default_value:
          anyOf:
            - type: string
            - items:
                type: string
              type: array
            - type: 'null'
          title: Default Value
        options:
          title: Options
          items:
            type: string
          type:
            - array
            - 'null'
        is_active:
          title: Is Active
          type:
            - boolean
            - 'null'
      required:
        - id
        - name
        - description
        - helper_text
        - field_type
        - applies_to
        - options
        - is_active
      title: CustomFieldSchemaOut
      type: object
    CustomFieldValueSchemaOut:
      properties:
        id:
          title: Id
          type: integer
        custom_field_id:
          title: Custom Field Id
          type: integer
        custom_field_name:
          title: Custom Field Name
          type: string
        custom_field_type:
          title: Custom Field Type
          type: string
        custom_field_value_id:
          title: Custom Field Value Id
          type: integer
        value:
          title: Value
        created_at:
          title: Created At
          type: string
        updated_at:
          title: Updated At
          type: string
      required:
        - id
        - custom_field_id
        - custom_field_name
        - custom_field_type
        - custom_field_value_id
        - value
        - created_at
        - updated_at
      title: CustomFieldValueSchemaOut
      type: object
    ItemTaxDataOut:
      properties:
        code:
          title: Code
          type: string
        rate:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
          title: Rate
          type: string
        amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Amount
          type: string
        is_taxable:
          title: Is Taxable
          type:
            - boolean
            - 'null'
        tax_exempt_amount:
          title: Tax Exempt Amount
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          type:
            - string
            - 'null'
        vat_rate_id:
          title: Vat Rate Id
          type:
            - integer
            - 'null'
        gst_tax_rate_id:
          title: Gst Tax Rate Id
          type:
            - integer
            - 'null'
        tax_components:
          title: Tax Components
          items:
            $ref: '#/components/schemas/TaxComponentSchema'
          type:
            - array
            - 'null'
        amount_with_tax:
          title: Amount With Tax
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          type:
            - string
            - 'null'
        rate_name:
          title: Rate Name
          type:
            - string
            - 'null'
        rate_type:
          title: Rate Type
          type:
            - string
            - 'null'
        tax_treatment:
          title: Tax Treatment
          type:
            - string
            - 'null'
      required:
        - code
        - rate
        - amount
      title: ItemTaxDataOut
      type: object
    FieldType:
      enum:
        - text
        - number
        - currency
        - date
        - boolean
        - single_select
        - multi_select
        - link
        - paragraph
      title: FieldType
      type: string
    AppliesToItemSchema:
      description: >-
        An entry in `applies_to` — binds a custom field to a record type with
        activation/required flags.
      properties:
        type:
          $ref: '#/components/schemas/AppliesToTypes'
        is_active:
          default: true
          title: Is Active
          type: boolean
        is_required:
          default: false
          title: Is Required
          type: boolean
      required:
        - type
      title: AppliesToItemSchema
      type: object
    TaxComponentSchema:
      description: >-
        Per-component tax breakdown stored on line items (denormalized from
        GstTaxRateComponent).
      properties:
        component_type:
          $ref: '#/components/schemas/GstComponentType'
        rate:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,6}0*$
          title: Rate
          type: string
        amount:
          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
          title: Amount
          type: string
        region:
          title: Region
          type:
            - string
            - 'null'
        position:
          title: Position
          type: integer
      required:
        - component_type
        - rate
        - amount
        - position
      title: TaxComponentSchema
      type: object
    AppliesToTypes:
      enum:
        - invoice
        - bill
        - direct_expense
        - journal_entry
        - vendor_prepayment
        - vendor_credit
        - vendor_payment
        - vendor_refund
        - customer_payment
        - customer_prepayment
        - customer_refund
        - customer_deposit
        - currency_revaluation
        - contract
        - fixed_asset
        - customer
        - vendor
        - company
        - sales_order
        - cash_sale
        - customer_credit
      title: AppliesToTypes
      type: string
    GstComponentType:
      enum:
        - CGST
        - SGST
        - IGST
        - CESS
        - GST
        - PST
        - HST
        - QST
      title: GstComponentType
      type: string

````