# Fetch Bulk Bill Details

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/utilityPayment/search:
    post:
      summary: Fetch Bulk Bill Details
      deprecated: false
      description: >-

        :::highlight purple 📌

        Use this API to retrieve bill details in bulk, with a maximum of 5,000
        records returned per request.

        To improve performance and manage response sizes efficiently, it is
        recommended to use the limit and offset parameters. For optimal results,
        set the limit to less than 100.

        :::


        :::info[]

        **Important:**

        The API parameters work using an AND condition, meaning the response
        will include only data that matches all specified filter values.

        :::
      tags:
        - Bharat Connect (BBPS)/APIs - BBPS/Bill Payment/Fetch Bill
      parameters:
        - name: Authorization
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                utilityEnkashIds:
                  type: array
                  items:
                    type: string
                amountRangeStart:
                  type: integer
                amountRangeEnd:
                  type: integer
                consumerNumber:
                  type: string
                consumerNumbers:
                  type: array
                  items:
                    type: string
                billerType:
                  type: string
                billerName:
                  type: string
                paymentStatus:
                  type: string
                paymentStartDate:
                  type: string
                paymentEndDate:
                  type: string
                createdDateFrom:
                  type: string
                createdDateTo:
                  type: string
                billDueDateFrom:
                  type: string
                billDueDateTo:
                  type: string
                billpayStatus:
                  type: string
                offset:
                  type: integer
                limit:
                  type: integer
                statuses:
                  type: array
                  items:
                    type: string
                    enum:
                      - PROCESS
                      - SUCCESS
                      - FAILED
                      - PENDING
                      - CANCELLED
                      - EXPIRED
                      - PARTIAL_REFUNDED
                      - REFUNDED
                      - IN_PROCESS
                      - REFUND_REQUESTED
                      - PENDING_WITH_BANK
                  description: Payment Status filter
                billpayDateFrom:
                  type: string
                billpayDateTo:
                  type: string
                refundDateFrom:
                  type: string
                refundDateTo:
                  type: string
                billPayStatuses:
                  type: array
                  items:
                    type: string
                billReferenceId:
                  type: string
              required:
                - utilityEnkashIds
                - amountRangeStart
                - amountRangeEnd
                - consumerNumber
                - consumerNumbers
                - billerType
                - billerName
                - paymentStatus
                - paymentStartDate
                - paymentEndDate
                - createdDateFrom
                - createdDateTo
                - billDueDateFrom
                - billDueDateTo
                - billpayStatus
                - offset
                - limit
                - statuses
                - billpayDateFrom
                - billpayDateTo
                - refundDateFrom
                - refundDateTo
                - billPayStatuses
                - billReferenceId
              x-apidog-orders:
                - utilityEnkashIds
                - amountRangeStart
                - amountRangeEnd
                - consumerNumber
                - consumerNumbers
                - billerType
                - billerName
                - paymentStatus
                - paymentStartDate
                - paymentEndDate
                - createdDateFrom
                - createdDateTo
                - billDueDateFrom
                - billDueDateTo
                - billpayStatus
                - offset
                - limit
                - statuses
                - billpayDateFrom
                - billpayDateTo
                - refundDateFrom
                - refundDateTo
                - billPayStatuses
                - billReferenceId
                - 01JF9DXDFMNM14PR0FAAMC7VKS
              x-apidog-ignore-properties: []
            example:
              companyName: string
              companyId: string
              utilityEnkashId: string
              utilityEnkashIds:
                - string
              amountRangeStart: 0
              amountRangeEnd: 0
              makerUser: string
              checkerUser: string
              consumerNumber: string
              consumerNumbers:
                - string
              companyBillerIds:
                - string
              billerType: ELECTRICITY
              billerName: string
              billNumber: string
              approvalStatus: MAKER_APPROVAL_PENDING
              paymentStatus: INIT
              serviceProvider: MK
              paymentStartDate: '2024-12-17'
              paymentEndDate: '2024-12-17'
              createdDateFrom: '2024-12-17'
              createdDateTo: '2024-12-17'
              billDueDateFrom: '2024-12-17'
              billDueDateTo: '2024-12-17'
              payoutStartDate: '2024-12-17'
              payoutEndDate: '2024-12-17'
              payoutStatus: SUCCESS
              billpayStatus: SUCCESS
              utr: string
              offset: 0
              limit: 5000
              pgTransactionId: string
              pgCode: KOTAK_D2I
              pgIds:
                - 0
              companyBranchCodeIds:
                - 0
              statuses:
                - INIT
              cpCompanyId: 0
              billpayDateFrom: '2024-12-17'
              billpayDateTo: '2024-12-17'
              refundDateFrom: '2024-12-17'
              refundDateTo: '2024-12-17'
              pendingForMe: true
              approvedByMe: true
              rejectedByMe: true
              approvedByUser: string
              groupIds:
                - string
              branchCodes:
                - string
              branchNames:
                - string
              costCentres:
                - string
              branchCities:
                - string
              branchStates:
                - string
              companyIdLong: 0
              billpayDataModifiedOnFrom: '2024-12-17T04:27:27.585Z'
              billpayDataModifiedOnTo: '2024-12-17T04:27:27.585Z'
              billPayStatuses:
                - SUCCESS
              approvalStatuses:
                - MAKER_APPROVAL_PENDING
              userGroupIds:
                - string
              billReferenceId: string
              paymentStatusesNot:
                - INIT
              attachment: true
              billCopyStatus: FAILED
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ApplicationResponseGenericPaginationResponseUtilityPaymentV2Response
              example:
                response_code: 0
                response_message: string
                payload:
                  recordsCount: 0
                  data:
                    - companyName: string
                      utilityEnkashId: string
                      amount: 0
                      consumerNumber: string
                      consumerName: string
                      billDate: '2025-06-02'
                      billDueDate: '2025-06-02'
                      createdDate: '2025-06-02T14:29:53.262Z'
                      billNumber: string
                      billerBillNumber: string
                      numberOfUnits: 0
                      approvalStatus: MAKER_APPROVAL_PENDING
                      approvalRemarks: string
                      paymentStatus: INIT
                      billpayStatus: SUCCESS
                      failureReason: string
                      failureCode: UTEX001
                      paymentDate: '2025-06-02T14:29:53.262Z'
                      billpayDate: '2025-06-02T14:29:53.262Z'
                      paymentMode: CREDIT_CARD
                      approvedDate: '2025-06-02T14:29:53.262Z'
                      billReferenceId: string
                      billStartDate: '2025-06-02'
                      billEndDate: '2025-06-02'
                      remarks: string
                      companyBiller:
                        companyBillerId: string
                        companyName: string
                        companyId: string
                        biller:
                          billerId: 0
                          name: string
                          billerType: string
                          inputParams:
                            - paramKey: string
                              paramName: string
                              paramType: NUMBER
                              paramRegex: string
                              invalidParamError: string
                              mandatory: true
                              paramValues:
                                - key: string
                                  value: string
                          circleParams:
                            - key: string
                              value: AP
                          paymentAmountExactness: string
                          state: ANDAMAN_AND_NICOBAR_ISLANDS
                          circleStateMapping:
                            additionalProp1: ANDAMAN_AND_NICOBAR_ISLANDS
                            additionalProp2: ANDAMAN_AND_NICOBAR_ISLANDS
                            additionalProp3: ANDAMAN_AND_NICOBAR_ISLANDS
                          viewBillSupported: true
                        circleEnum: AP
                        billInputParams: string
                        billerParams:
                          - key: string
                            name: string
                            value: string
                            paramType: NUMBER
                        consumerNumber: string
                        consumerName: string
                        createdDate: '2025-06-02T14:29:53.262Z'
                        lastDueDate: '2025-06-02'
                        billFetchFailureMessage: string
                      billAmount: 0
                      earlyPaymentDate: '2025-06-02'
                      earlyPaymentAmount: 0
                      latePaymentAmount: 0
                      actualDueDate: '2025-06-02'
                      companyId: string
                      bankTransactionId: string
                      referenceId: string
                      refund:
                        refundDate: '2025-06-02T14:29:53.262Z'
                        refundAmount: 0
                        refundMode: CREDIT_CARD
                        instrument: string
                        refundTransactionId: string
                        refundStatus: string
                        refundReason: string
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: Bharat Connect (BBPS)/APIs - BBPS/Bill Payment/Fetch Bill
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/616243/apis/api-10664799-run
components:
  schemas:
    ApplicationResponseGenericPaginationResponseUtilityPaymentV2Response:
      type: object
      properties:
        response_code:
          type: integer
          format: int32
        response_message:
          type: string
        payload:
          $ref: >-
            #/components/schemas/GenericPaginationResponseUtilityPaymentV2Response
      x-apidog-orders:
        - response_code
        - response_message
        - payload
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    GenericPaginationResponseUtilityPaymentV2Response:
      type: object
      properties:
        recordsCount:
          type: integer
          format: int64
        data:
          type: array
          items:
            $ref: '#/components/schemas/UtilityPaymentV2Response'
      x-apidog-orders:
        - recordsCount
        - data
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    UtilityPaymentV2Response:
      type: object
      properties:
        companyName:
          type: string
        utilityEnkashId:
          type: string
        amount:
          type: integer
        consumerNumber:
          type: string
        consumerName:
          type: string
        billDate:
          type: string
        billDueDate:
          type: string
        createdDate:
          type: string
        billNumber:
          type: string
        billerBillNumber:
          type: string
        numberOfUnits:
          type: integer
        approvalStatus:
          type: string
        approvalRemarks:
          type: string
        paymentStatus:
          type: string
        billpayStatus:
          type: string
        failureReason:
          type: string
        failureCode:
          type: string
        paymentDate:
          type: string
        billpayDate:
          type: string
        paymentMode:
          type: string
        approvedDate:
          type: string
        billReferenceId:
          type: string
        billStartDate:
          type: string
        billEndDate:
          type: string
        remarks:
          type: string
        companyBiller:
          type: object
          properties:
            companyBillerId:
              type: string
            companyName:
              type: string
            companyId:
              type: string
            biller:
              type: object
              properties:
                billerId:
                  type: integer
                name:
                  type: string
                billerType:
                  type: string
                inputParams:
                  type: array
                  items:
                    type: object
                    properties:
                      paramKey:
                        type: string
                      paramName:
                        type: string
                      paramType:
                        type: string
                      paramRegex:
                        type: string
                      invalidParamError:
                        type: string
                      mandatory:
                        type: boolean
                      paramValues:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            value:
                              type: string
                          x-apidog-orders:
                            - key
                            - value
                          x-apidog-ignore-properties: []
                    x-apidog-orders:
                      - paramKey
                      - paramName
                      - paramType
                      - paramRegex
                      - invalidParamError
                      - mandatory
                      - paramValues
                    x-apidog-ignore-properties: []
                circleParams:
                  type: array
                  items:
                    type: object
                    properties:
                      key:
                        type: string
                      value:
                        type: string
                    x-apidog-orders:
                      - key
                      - value
                    x-apidog-ignore-properties: []
                paymentAmountExactness:
                  type: string
                state:
                  type: string
                circleStateMapping:
                  type: object
                  properties:
                    additionalProp1:
                      type: string
                    additionalProp2:
                      type: string
                    additionalProp3:
                      type: string
                  required:
                    - additionalProp1
                    - additionalProp2
                    - additionalProp3
                  x-apidog-orders:
                    - additionalProp1
                    - additionalProp2
                    - additionalProp3
                  x-apidog-ignore-properties: []
                viewBillSupported:
                  type: boolean
              required:
                - billerId
                - name
                - billerType
                - inputParams
                - circleParams
                - paymentAmountExactness
                - state
                - circleStateMapping
                - viewBillSupported
              x-apidog-orders:
                - billerId
                - name
                - billerType
                - inputParams
                - circleParams
                - paymentAmountExactness
                - state
                - circleStateMapping
                - viewBillSupported
              x-apidog-ignore-properties: []
            circleEnum:
              type: string
            billInputParams:
              type: string
            billerParams:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                  name:
                    type: string
                  value:
                    type: string
                  paramType:
                    type: string
                x-apidog-orders:
                  - key
                  - name
                  - value
                  - paramType
                x-apidog-ignore-properties: []
            consumerNumber:
              type: string
            consumerName:
              type: string
            createdDate:
              type: string
            lastDueDate:
              type: string
            billFetchFailureMessage:
              type: string
          required:
            - companyBillerId
            - companyName
            - companyId
            - biller
            - circleEnum
            - billInputParams
            - billerParams
            - consumerNumber
            - consumerName
            - createdDate
            - lastDueDate
            - billFetchFailureMessage
          x-apidog-orders:
            - companyBillerId
            - companyName
            - companyId
            - biller
            - circleEnum
            - billInputParams
            - billerParams
            - consumerNumber
            - consumerName
            - createdDate
            - lastDueDate
            - billFetchFailureMessage
          x-apidog-ignore-properties: []
        billAmount:
          type: integer
        earlyPaymentDate:
          type: string
        earlyPaymentAmount:
          type: integer
        latePaymentAmount:
          type: integer
        actualDueDate:
          type: string
        companyId:
          type: string
        bankTransactionId:
          type: string
        referenceId:
          type: string
        refund:
          type: object
          properties:
            refundDate:
              type: string
            refundAmount:
              type: integer
            refundMode:
              type: string
            instrument:
              type: string
            refundTransactionId:
              type: string
            refundStatus:
              type: string
            refundReason:
              type: string
          required:
            - refundDate
            - refundAmount
            - refundMode
            - instrument
            - refundTransactionId
            - refundStatus
            - refundReason
          x-apidog-orders:
            - refundDate
            - refundAmount
            - refundMode
            - instrument
            - refundTransactionId
            - refundStatus
            - refundReason
          x-apidog-ignore-properties: []
      required:
        - companyName
        - utilityEnkashId
        - amount
        - consumerNumber
        - consumerName
        - billDate
        - billDueDate
        - createdDate
        - billNumber
        - billerBillNumber
        - numberOfUnits
        - approvalStatus
        - approvalRemarks
        - paymentStatus
        - billpayStatus
        - failureReason
        - failureCode
        - paymentDate
        - billpayDate
        - paymentMode
        - approvedDate
        - billReferenceId
        - billStartDate
        - billEndDate
        - remarks
        - companyBiller
        - billAmount
        - earlyPaymentDate
        - earlyPaymentAmount
        - latePaymentAmount
        - actualDueDate
        - companyId
        - bankTransactionId
        - referenceId
        - refund
      x-apidog-orders:
        - companyName
        - utilityEnkashId
        - amount
        - consumerNumber
        - consumerName
        - billDate
        - billDueDate
        - createdDate
        - billNumber
        - billerBillNumber
        - numberOfUnits
        - approvalStatus
        - approvalRemarks
        - paymentStatus
        - billpayStatus
        - failureReason
        - failureCode
        - paymentDate
        - billpayDate
        - paymentMode
        - approvedDate
        - billReferenceId
        - billStartDate
        - billEndDate
        - remarks
        - companyBiller
        - billAmount
        - earlyPaymentDate
        - earlyPaymentAmount
        - latePaymentAmount
        - actualDueDate
        - companyId
        - bankTransactionId
        - referenceId
        - refund
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes: {}
servers:
  - url: https://ekpayout-uat.enkash.in
    description: Testing Env
security: []

```