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

# Ledger Items

> Read the ledger entries for one or more payments.

<Note>
  **Beta** — This endpoint is currently available for **Gusto** only. Endpoint paths and field names may change before general availability.
</Note>


## OpenAPI

````yaml post /employer/ledger-items
openapi: 3.1.0
info:
  title: API Reference
  version: '2020-09-17'
  contact: {}
  description: >-
    The Finch HRIS API provides a unified way to connect to a multitide of HRIS
    systems. The API requires an access token issued by Finch.


    By default, Organization and Payroll requests use Finch's [Data
    Syncs](/developer-resources/Data-Syncs). If a request is made before the
    initial sync has completed, Finch will request data live from the provider.
    The latency on live requests may range from seconds to minutes depending on
    the provider and batch size.

    For automated integrations, Deductions requests (both read and write) are
    always made live to the provider. Latencies may range from seconds to
    minutes depending on the provider and batch size.



    Employer products are specified by the product parameter, a space-separated
    list of products that your application requests from an employer
    authenticating through Finch Connect. Valid product names are—

    - `company`: Read basic company data


    - `directory`: Read company directory and organization structure


    - `individual`: Read individual data, excluding income and employment data


    - `employment`: Read individual employment and income data


    - `payment`: Read payroll and contractor related payments by the company


    - `pay_statement`: Read detailed pay statements for each individual


    - `benefits`: Create and manage deductions and contributions and enrollment
    for an employer


    [![Open in
    Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/21027137-08db0929-883d-4094-a9ce-dbf5a9bee4a4?action=collection%2Ffork&collection-url=entityId%3D21027137-08db0929-883d-4094-a9ce-dbf5a9bee4a4%26entityType%3Dcollection%26workspaceId%3D1edf19bc-e0a8-41e9-ac55-481a4b50790b)
servers:
  - url: https://api.tryfinch.com
    description: ''
security: []
tags:
  - name: Organization
  - name: Payroll
  - name: Deductions
  - name: Benefits
  - name: Management
  - name: Sandbox
paths:
  /employer/ledger-items:
    post:
      tags:
        - Payroll
      summary: Ledger Items
      description: Read the ledger entries for one or more payments.
      operationId: get-ledger-items
      parameters:
        - name: entity_ids
          in: query
          required: false
          description: >-
            The entity IDs to specify which entities' data to access. Provide
            exactly one entity ID per request; a maximum of one is accepted.
          schema:
            type: array
            items:
              type: string
              format: uuid
            minItems: 1
            maxItems: 1
            example:
              - 550e8400-e29b-41d4-a716-446655440000
          style: form
          explode: true
        - $ref: '#/components/parameters/API-Version'
        - $ref: '#/components/parameters/Content-Type'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                requests:
                  type: array
                  description: One entry per payment you want the ledger for.
                  items:
                    type: object
                    properties:
                      payment_id:
                        type: string
                        description: A stable Finch `id` (UUID v4) for a payment.
                        pattern: '[0-9a-f]{8}[-]?(?:[0-9a-f]{4}[-]?){3}[0-9a-f]{12}'
                        format: uuid
                      offset:
                        type: integer
                        minimum: 0
                        description: The number of `ledger_items` to skip for this payment.
                      limit:
                        type: integer
                        minimum: 1
                        description: >-
                          The maximum number of `ledger_items` to return for
                          this payment.
                    required:
                      - payment_id
              required:
                - requests
            examples:
              example1:
                value:
                  requests:
                    - payment_id: string
      responses:
        '200':
          description: The ledger for each requested payment.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLedgerItemsResponse'
              examples:
                Success:
                  value:
                    responses:
                      - payment_id: fc8b024e-d373-4c9c-80fc-f1625383d142
                        code: 200
                        body:
                          source: direct
                          provider_description: null
                          pay_date: '2022-05-20'
                          totals:
                            debit:
                              amount: 5463791
                              currency: usd
                            credit:
                              amount: 5463791
                              currency: usd
                            balanced: true
                          paging:
                            count: 2
                            offset: 0
                          ledger_items:
                            - type: regular_wages
                              account_type: RegularWages
                              account_description: Regular Wages
                              debit:
                                amount: 5463791
                                currency: usd
                              credit:
                                amount: 0
                                currency: usd
                            - type: cash_debit_net_pay
                              account_type: DebitNetPay
                              account_description: Employee Payment
                              debit:
                                amount: 0
                                currency: usd
                              credit:
                                amount: 5463791
                                currency: usd
        '202':
          description: >-
            The request has been accepted for processing, but data is not yet
            available
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AcceptedResponse'
              examples:
                DataSyncInProgress:
                  value:
                    code: 202
                    name: sync_in_progress
                    finch_code: data_sync_in_progress
                    message: >-
                      The data being requested is being fetched. Please check
                      back later.
                AuthorizationPending:
                  value:
                    code: 202
                    name: authorization_pending
                    finch_code: pending
                    message: Authorization to this company's data is pending
      security:
        - bearerAuth: []
components:
  parameters:
    API-Version:
      name: Finch-API-Version
      in: header
      required: true
      schema:
        type: string
        default: '2020-09-17'
        format: date
        pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))
      description: >-
        Header used to specify the version for a given API request. Current
        version is 2020-09-17.
    Content-Type:
      name: Content-Type
      in: header
      required: true
      schema:
        type: string
        default: application/json
      description: 'Used to indicate the original media type of the resource '
  schemas:
    GetLedgerItemsResponse:
      type: object
      properties:
        responses:
          type: array
          items:
            $ref: '#/components/schemas/LedgerBatchItem'
      required:
        - responses
    AcceptedResponse:
      type: object
      properties:
        code:
          type: number
          default: 202
        name:
          type: string
        finch_code:
          type: string
        message:
          type: string
      required:
        - name
        - finch_code
        - message
    LedgerBatchItem:
      type: object
      properties:
        payment_id:
          type: string
        code:
          type: integer
        body:
          anyOf:
            - $ref: '#/components/schemas/LedgerItemsData'
            - $ref: '#/components/schemas/BatchError'
      required:
        - payment_id
        - code
        - body
      title: Ledger Batch Item
    LedgerItemsData:
      type: object
      properties:
        source:
          type: string
          enum:
            - direct
            - synthesized
          description: >-
            `direct` when the provider supplies the ledger; `synthesized` when
            Finch computes it from pay statements.
        provider_description:
          type: string
          nullable: true
          description: >-
            The provider's own description for this ledger, returned unmodified.
            `null` when the provider gives none.
        pay_date:
          type: string
          description: The payroll check date for this ledger, in `YYYY-MM-DD`.
        totals:
          $ref: '#/components/schemas/LedgerTotals'
        paging:
          type: object
          properties:
            count:
              type: integer
              description: >-
                The total number of elements for the entire query (not just the
                given page)
            offset:
              type: integer
              description: The current start index of the returned list of elements
          required:
            - offset
          title: Paging
          x-tags:
            - Models
        ledger_items:
          type: array
          items:
            $ref: '#/components/schemas/LedgerEntry'
      required:
        - source
        - provider_description
        - pay_date
        - totals
        - paging
        - ledger_items
      title: Ledger Items Data
    BatchError:
      type: object
      properties:
        code:
          type: number
        finch_code:
          type: string
        message:
          type: string
        name:
          type: string
      required:
        - code
        - message
        - name
    LedgerTotals:
      type: object
      properties:
        debit:
          $ref: '#/components/schemas/LedgerMoney'
        credit:
          $ref: '#/components/schemas/LedgerMoney'
        balanced:
          type: boolean
          description: '`true` when total debit equals total credit.'
      required:
        - debit
        - credit
        - balanced
      title: Ledger Totals
    LedgerEntry:
      type: object
      properties:
        type:
          type: string
          enum:
            - regular_wages
            - overtime_wages
            - bonus_wages
            - paid_leave_wages
            - severance_wages
            - equity_compensation
            - other_earnings
            - expense_reimbursement
            - contractor_payment
            - employer_donation
            - employer_tax_fica
            - employer_tax_unemployment
            - employer_tax_other
            - employee_tax_income
            - employee_tax_fica
            - employee_tax_other
            - employer_contribution_retirement
            - employer_contribution_health
            - employer_contribution_other
            - pretax_deduction
            - posttax_deduction
            - garnishment
            - benefit_liability
            - tax_liability_accrual
            - tax_receivable
            - tax_credit_accrual
            - cash_debit_net_pay
            - cash_debit_tax_remittance
            - cash_debit_other
            - adjustment
            - other
          description: >-
            The normalized Finch classification for this entry, consistent
            across providers. See `account_type` for the provider's own label.
        account_type:
          type: string
          nullable: true
          description: The provider's own account-type label, returned unmodified.
        account_description:
          type: string
          nullable: true
          description: The provider's own account description, returned unmodified.
        debit:
          $ref: '#/components/schemas/LedgerMoney'
        credit:
          $ref: '#/components/schemas/LedgerMoney'
      required:
        - type
        - account_type
        - account_description
        - debit
        - credit
      title: Ledger Entry
    LedgerMoney:
      type: object
      properties:
        amount:
          type: integer
          description: The amount in cents.
        currency:
          type: string
          nullable: true
          description: The ISO 4217 currency code.
      required:
        - amount
        - currency
      title: Ledger Money
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Please use your Access Token

````