swag-payments/spec/paths/analytics@shops@{shopID}@invoices.yaml

get:
  description: Поиск инвойсов
  tags:
    - Search
  operationId: searchInvoices
  parameters:
    - $ref: '#/parameters/requestID'
    - $ref: '#/parameters/deadline'
    - $ref: '#/parameters/shopID'
    - $ref: '#/parameters/fromTime'
    - $ref: '#/parameters/toTime'
    - $ref: '#/parameters/limit'
    - name: invoiceStatus
      in: query
      description: Статус инвойса для поиска
      required: false
      type: string
      enum:
        - unpaid
        - cancelled
        - paid
        - fulfilled
    - name: paymentStatus
      in: query
      description: Статус платежа для поиска
      required: false
      type: string
      enum:
        - pending
        - processed
        - captured
        - cancelled
        - refunded
        - failed
    - name: paymentFlow
      in: query
      description: Flow платежа
      required: false
      type: string
      enum:
        - instant
        - hold
    - name: paymentMethod
      in: query
      description: Метод оплаты
      required: false
      type: string
      enum:
        - bankCard
        - paymentTerminal
    - name: paymentTerminalProvider
      in: query
      description: Провайдер платежного терминала
      required: false
      type: string
      enum:
        - euroset
    - name: invoiceID
      in: query
      description: Идентификатор инвойса
      required: false
      type: string
      maxLength: 40
      minLength: 1
    - name: paymentID
      in: query
      description: Идентификатор платежа
      required: false
      type: string
      maxLength: 40
      minLength: 1
    - name: payerEmail
      in: query
      description: 'Email, указанный при оплате'
      required: false
      type: string
      format: email
      maxLength: 100
    - name: payerIP
      in: query
      description: IP-адрес плательщика
      required: false
      type: string
      format: ip-address
      maxLength: 45
    - name: payerFingerprint
      in: query
      description: Уникальный отпечаток user agent'а плательщика
      required: false
      type: string
      maxLength: 1000
    - name: customerID
      in: query
      description: Идентификатор плательщика
      required: false
      type: string
      maxLength: 40
      minLength: 1
    - x-rebillyMerge:
      - name: bankCardTokenProvider
        in: query
        required: false
      - $ref: '#/definitions/BankCardTokenProvider'
    - x-rebillyMerge:
      - name: bankCardPaymentSystem
        in: query
        required: false
      - $ref: '#/definitions/BankCardPaymentSystem'
    - name: bin
      in: query
      description: BIN банка-эмитента карты
      required: false
      type: string
      pattern: '^\d{6,8}$'
    - name: lastDigits
      in: query
      description: Последние цифры номера карты
      required: false
      type: string
      pattern: '^\d{2,4}$'
    - name: paymentAmount
      in: query
      description: Сумма платежа
      required: false
      type: integer
      format: int64
      minimum: 1
    - name: invoiceAmount
      in: query
      description: Сумма инвойса
      required: false
      type: integer
      format: int64
      minimum: 1
    - x-rebillyMerge:
      - name: continuationToken
        in: query
        required: false
      - $ref: '#/definitions/ContinuationToken'
  responses:
    '200':
      description: Найденные инвойсы
      schema:
        type: object
        properties:
          continuationToken:
            x-rebillyMerge:
              - $ref: '#/definitions/ContinuationToken'
          result:
            type: array
            items:
              $ref: '#/definitions/Invoice'
    '404':
      $ref: '#/responses/NotFound'
    '400':
      description: Неверные данные для поиска
      schema:
        type: object
        required:
          - code
          - message
        properties:
          code:
            description: |
              [Код ошибки](#tag/Error-Codes)              
            type: string
            enum:
              - invalidRequest
          message:
            description: Человекочитаемое описание ошибки
            type: string