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

# Retrieves the payment received state.



## OpenAPI

````yaml api-reference/openapi.json get /api/payments-received/state
openapi: 3.0.0
info:
  title: Bigcapital
  description: Financial accounting software
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /api/payments-received/state:
    get:
      tags:
        - Payments Received
      summary: Retrieves the payment received state.
      operationId: PaymentReceivesController_getPaymentReceivedState
      parameters:
        - name: Authorization
          in: header
          description: >-
            Value must be 'Bearer <token>' where <token> is an API key prefixed
            with 'bc_' or a JWT token.
          required: true
          schema:
            type: string
            example: Bearer bc_1234567890abcdef
        - name: organization-id
          in: header
          description: >-
            Required if Authorization is a JWT token. The organization ID to
            operate within.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The payment received state has been successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentReceivedStateResponseDto'
components:
  schemas:
    PaymentReceivedStateResponseDto:
      type: object
      properties:
        defaultTemplateId:
          type: number
          description: The ID of the default PDF template for payment received
          example: 1
          nullable: true
      required:
        - defaultTemplateId

````