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

# List accounting release templates

> Returns a list of accounting release templates



## OpenAPI

````yaml /openapi-public.json get /v1/accounting-release-templates
openapi: 3.0.1
info:
  title: Light API
  version: 1.0.0
servers: []
security:
  - apiKeyAuth: []
  - bearerAuth: []
paths:
  /v1/accounting-release-templates:
    get:
      tags:
        - v1 - Accounting Release Templates
      summary: List accounting release templates
      description: Returns a list of accounting release templates
      operationId: listAccountingReleaseTemplates
      parameters:
        - name: sort
          in: query
          schema:
            type: string
            description: >-
              Sort string in the format `field:direction`. To provide multiple
              sort fields, separate them with commas.


              Available directions: `asc`, `desc`. 


              Available fields: `name`, `method`, `type`, `deferralAccountId`,
              `createdAt`.
            example: amount:desc,createdAt:asc
        - name: filter
          in: query
          schema:
            type: string
            description: >-
              Filter string in the format `field:operator:value`. To provide
              multiple filters, separate them with commas.


              Available operators: `eq`, `ne`, `in`, `not_in`, `gt`, `gte`,
              `lt`, `lte`.
               - For `in` and `not_in` operators, provide multiple values separated by the pipe character (`|`). 

              Available fields: `id`, `companyId`, `name`, `method`, `type`,
              `deferralAccountId`, `initialAmountPercentage`,
              `residualAmountPercentage`, `status`.
            example: state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500,vendorId:ne:null
        - name: limit
          in: query
          description: Maximum number of items to return. Default is 50, maximum is 200.
          schema:
            maximum: 200
            type: integer
            format: int32
        - name: offset
          in: query
          description: >-
            Number of items to skip before starting to collect the result set.
            Deprecated, use 'cursor' instead.
          deprecated: true
          schema:
            type: integer
            format: int64
        - name: cursor
          in: query
          description: >-
            The cursor position to start returning results from.

            To opt-in into cursor-based pagination, provide `0` for the initial
            request.

            For subsequent requests, use `nextCursor` and `prevCursor` from the
            previous response to navigate.

            Cursor values are opaque and should not be constructed manually.
          schema:
            type: string
      responses:
        default:
          description: default response
          content:
            application/json;charset=UTF-8:
              schema:
                $ref: >-
                  #/components/schemas/ExternalPaginatedResponseV1ModelExternalAccountingReleaseTemplateV1Model
components:
  schemas:
    ExternalPaginatedResponseV1ModelExternalAccountingReleaseTemplateV1Model:
      type: object
      properties:
        records:
          type: array
          description: List of records for the current page
          items:
            $ref: '#/components/schemas/ExternalAccountingReleaseTemplateV1Model'
        hasMore:
          type: boolean
          description: Boolean flag indicating if there are more records available
        total:
          type: integer
          description: >-
            Total number of records (only for offset pagination). This field is
            not guaranteed to be returned and only available for offset
            pagination, please do not rely on it and migrate to cursor
            pagination.
          format: int64
          nullable: true
          deprecated: true
        nextCursor:
          type: string
          description: Cursor for fetching the next page (only for cursor pagination)
          nullable: true
        prevCursor:
          type: string
          description: Cursor for fetching the previous page (only for cursor pagination)
          nullable: true
    ExternalAccountingReleaseTemplateV1Model:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the object
          format: uuid
        companyId:
          type: string
          description: ID of the company
          format: uuid
        createdBy:
          type: string
          description: ID of the user who created the template
          format: uuid
        name:
          type: string
          description: Name of the template
        method:
          type: string
          description: >-
            How the amount is spread across the release schedule


            - `STRAIGHT_LINE_WITH_PARTIAL_ADJUSTMENT` - An equal amount each
            period, with the first and last periods adjusted for partial months

            - `REDUCING_BALANCE` - A fixed fraction of the remaining balance
            each period, so the amount declines over time


            ⚠️ This enum is not exhaustive; new values may be added in the
            future.
          nullable: false
          deprecated: false
          enum:
            - STRAIGHT_LINE_WITH_PARTIAL_ADJUSTMENT
            - REDUCING_BALANCE
        type:
          type: string
          description: >-
            The kind of document or asset this template applies to. Fixed at
            creation


            - `AR` - Accounts receivable. Releases deferred revenue on invoice
            receivables

            - `AP` - Accounts payable. Releases prepaid expenses on invoice
            payables, credit notes and card transactions

            - `JE` - Journal entries

            - `CONTRACT` - Contracts. Releases deferred revenue over the
            contract term

            - `FIXED_ASSET` - Fixed assets. Depreciates a capitalised asset over
            its useful life


            ⚠️ This enum is not exhaustive; new values may be added in the
            future.
          nullable: false
          deprecated: false
          enum:
            - AR
            - AP
            - JE
            - CONTRACT
            - FIXED_ASSET
        deferralAccountId:
          type: string
          description: >-
            ID of the ledger account holding the not-yet-released balance. Fixed
            at creation
          format: uuid
        contractAccountId:
          type: string
          description: >-
            ID of the ledger account used when the template is applied to a
            contract. Fixed at creation
          format: uuid
          nullable: true
        additionsAccountId:
          type: string
          description: >-
            ID of the ledger account credited or debited by each generated
            release. Falls back to the deferral account when not set. Fixed at
            creation
          format: uuid
          nullable: true
        disposalAccountId:
          type: string
          description: >-
            ID of the ledger account used when a fixed asset is disposed of.
            Fixed at creation
          format: uuid
          nullable: true
        profitAccountId:
          type: string
          description: ID of the ledger account for a gain on disposal. Fixed at creation
          format: uuid
          nullable: true
        lossAccountId:
          type: string
          description: ID of the ledger account for a loss on disposal. Fixed at creation
          format: uuid
          nullable: true
        initialAmountPercentage:
          type: number
          description: >-
            Fraction of the amount released in the first period, as a decimal
            between 0 and 1
          nullable: true
        residualAmountPercentage:
          type: number
          description: >-
            Fraction of the amount left unreleased at the end of the schedule,
            as a decimal between 0 and 1
          nullable: true
        residualAmount:
          type: integer
          description: >-
            Absolute amount in cents left unreleased at the end of the schedule.
            Only for the `REDUCING_BALANCE` method, and mutually exclusive with
            `reducingRate`
          format: int64
          nullable: true
        reducingRate:
          type: number
          description: >-
            Fraction of the remaining balance released each period, as a decimal
            between 0 and 1. Only for the `REDUCING_BALANCE` method, and
            mutually exclusive with `residualAmount`
          nullable: true
        accumulatePastReleasesEnabled:
          type: boolean
          description: >-
            Whether releases for periods that have already passed are posted as
            a single catch-up amount in the current period
        defaultDuration:
          type: integer
          description: >-
            Default number of months the release schedule runs for. Can be
            overridden per document
          format: int32
          nullable: true
        context:
          type: string
          description: Free-text notes on the template
          nullable: true
        status:
          type: string
          description: >-
            Template status


            - `ACTIVE` - The template can be assigned to new documents and
            contracts

            - `ARCHIVED` - The template is archived and can no longer be
            assigned. Existing releases are unaffected


            ⚠️ This enum is not exhaustive; new values may be added in the
            future.
          nullable: false
          deprecated: false
          enum:
            - ACTIVE
            - ARCHIVED
        createdAt:
          type: string
          description: Timestamp when the template was created
          format: date-time
        updatedAt:
          type: string
          description: Timestamp when the template was last updated
          format: date-time
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      description: >-
        Basic authentication header of the form **Basic** **<api_key>**, where
        **<api_key>** is your api key.
      name: Authorization
      in: header
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````