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

# Preview Cost Allocation Split

> Fan-out lines the posting path would produce for an amount, period, and entity. Writes nothing.



## OpenAPI

````yaml https://api.meetcampfire.com/api/schema?format=json get /coa/api/cost-allocations/{id}/preview
openapi: 3.0.3
info:
  title: Campfire Developer APIs
  version: 1.0.0
  description: >
    ## Introduction

    Campfire's developer APIs offer granular access to Campfire's core
    accounting,

    revenue recognition, and financial data features.


    These APIs are designed to be used by developers to build custom
    integrations,

    automate workflows, and perform any other programmatic operations.


    ## Rate limits

    API users can make up to **5 requests per second**. This limit is shared
    across

    all endpoints for the same API user. Requests that exceed the limit receive
    a

    `429 Too Many Requests` response. Wait for the number of seconds specified
    in

    the `Retry-After` response header before retrying.
servers:
  - url: https://api.meetcampfire.com
    description: Production server
security: []
tags:
  - name: Cash Management
    description: Operations related to accounts, transactions, and other bank-related data.
  - name: Core Accounting
    description: >-
      Operations related to core accounting data, such as the chart of accounts,
      entity management, and the general ledger.
  - name: Revenue Recognition
    description: >-
      Operations related to revenue recognition, contract management, and
      contract data aggregation.
  - name: Accounts Receivable
    description: Operations related to invoicing and the AR subledger
  - name: Accounts Payable
    description: Operations related to billing and the AP subledger.
  - name: Financial Statements
    description: Operations related to financial statement generation and data aggregation.
  - name: Settings
    description: Operations related to system and accounting settings configuration.
paths:
  /coa/api/cost-allocations/{id}/preview:
    get:
      tags:
        - Company Objects
      summary: Preview Cost Allocation Split
      description: >-
        Fan-out lines the posting path would produce for an amount, period, and
        entity. Writes nothing.
      operationId: coa_api_cost_allocations_preview_retrieve
      parameters:
        - in: query
          name: amount
          schema:
            type: number
            format: double
            maximum: 1000000000000000000
            minimum: -1000000000000000000
            exclusiveMaximum: true
            exclusiveMinimum: true
          required: true
        - in: query
          name: entity
          schema:
            type: integer
            nullable: true
        - in: path
          name: id
          schema:
            type: integer
          required: true
        - in: query
          name: period
          schema:
            type: string
            pattern: ^\d{4}-(0[1-9]|1[0-2])$
            minLength: 1
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CostAllocationPreviewQuery'
          description: ''
components:
  schemas:
    CostAllocationPreviewQuery:
      type: object
      properties:
        amount:
          type: number
          format: double
          maximum: 1000000000000000000
          minimum: -1000000000000000000
          exclusiveMaximum: true
          exclusiveMinimum: true
        period:
          type: string
          pattern: ^\d{4}-(0[1-9]|1[0-2])$
        entity:
          type: integer
          nullable: true
      required:
        - amount
        - period

````