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

# Get Payroll Report

> Get the income report for a specific payroll link.

Returns the Truv IncomeCheck report for the given link with sensitive fields
(pdf_report, access_token, bank_accounts, derived_fields) removed.
Validates that the link belongs to the authenticated user.



## OpenAPI

````yaml GET /v1/links/{link_id}/report
openapi: 3.1.0
info:
  title: Truv Public API
  description: >
    Read-only API for personal access token (PAT) users.


    ## Authentication


    Authenticate with `Authorization: Bearer <token>`. Tokens have a `pat_`
    prefix

    and are generated in the Truv web app under Settings → API keys.


    ## Available Endpoints


    This API exposes a subset of read-only endpoints for retrieving financial
    data,

    account links, and user profile information.
  version: 1.0.0
servers:
  - url: https://api.mytruv.com
    description: Production
security:
  - BearerAuth: []
tags:
  - name: users
    description: User profile — read-only access to the authenticated user's profile.
  - name: financial-data
    description: >-
      Financial data — balances, transactions, income, spending, liabilities,
      and balance history.
  - name: links
    description: >-
      Account links — list connected financial institutions and payroll
      providers.
paths:
  /v1/links/{link_id}/report:
    get:
      tags:
        - financial-data
      summary: Get Link Report
      description: >-
        Get the income report for a specific payroll link.


        Returns the Truv IncomeCheck report for the given link with sensitive
        fields

        (pdf_report, access_token, bank_accounts, derived_fields) removed.

        Validates that the link belongs to the authenticated user.
      operationId: getLinkIncomeReport
      parameters:
        - name: link_id
          in: path
          required: true
          schema:
            type: string
            title: Link Id
      responses:
        '200':
          description: Payroll income report for a specific link.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkIncomeReportResponse'
        '404':
          description: Resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDetail'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    LinkIncomeReportResponse:
      properties: {}
      additionalProperties: true
      type: object
      title: LinkIncomeReportResponse
      description: >-
        Filtered income report for a single payroll link.


        Contains the full IncomeCheck structure from Truv with sensitive fields

        (pdf_report, access_token, bank_accounts, derived_fields, etc.) removed.

        Uses ``extra='allow'`` because the upstream schema has many optional
        fields.
    ErrorDetail:
      properties:
        detail:
          type: string
          title: Detail
          description: Human-readable error message.
          examples:
            - Link not found
      type: object
      required:
        - detail
      title: ErrorDetail
      description: Standard error response returned by the API for 4xx and 5xx errors.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: PAT
      description: >-
        Bearer authentication with a personal access token (prefix `pat_`).
        Generate tokens in the Truv web app under Settings → API keys.

````