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

# 정산 목록 조회

> 비즈니스의 정산 목록을 최신순(`created` DESC)으로 조회합니다. 연결된 계약(`contract`)과 정산 형태(`type`)가 nested로 포함됩니다.

**filter:** `OpenapiSettlementFilter`로 contract/type/status 필터링 가능.



## OpenAPI

````yaml GET /v1/settlement
openapi: 3.1.0
info:
  title: pluuug openapi
  version: 1.0.0
  description: >-
    플러그에서 제공하는 REST API의 상세 내용을 확인하고 직접 테스트할 수 있는 인터페이스입니다.<br>이 문서를 통해 API의
    엔드포인트, 요청 및 응답 형식 등을 확인할 수 있습니다.
servers:
  - url: https://openapi.pluuug.com
security: []
paths:
  /v1/settlement:
    get:
      tags:
        - settlement
      summary: 정산 목록
      description: >-
        비즈니스의 정산 목록을 최신순(`created` DESC)으로 조회합니다. 연결된 계약(`contract`)과 정산
        형태(`type`)가 nested로 포함됩니다.


        **filter:** `OpenapiSettlementFilter`로 contract/type/status 필터링 가능.
      operationId: settlement_list
      parameters:
        - in: query
          name: contract_id
          schema:
            type: string
        - in: query
          name: created_end
          schema:
            type: string
            format: date
          description: 생성일 종료 (YYYY-MM-DD)
        - in: query
          name: created_start
          schema:
            type: string
            format: date
          description: 생성일 시작 (YYYY-MM-DD)
        - name: cursor
          required: false
          in: query
          description: Pagination을 위한 커서
          schema:
            type: string
        - in: query
          name: due_date_end
          schema:
            type: string
            format: date
          description: 정산 예정일 종료 (YYYY-MM-DD)
        - in: query
          name: due_date_start
          schema:
            type: string
            format: date
          description: 정산 예정일 시작 (YYYY-MM-DD)
        - in: query
          name: is_hidden
          schema:
            type: boolean
          description: '숨김 처리 여부 필터 (true: 숨김 항목만, false: 비숨김 항목만, 미전달: 전체)'
        - name: page_size
          required: false
          in: query
          description: 한번에 조회할 데이터의 개수 (limit)
          schema:
            type: integer
        - in: query
          name: search
          schema:
            type: string
        - in: query
          name: settled_date_end
          schema:
            type: string
            format: date
          description: 정산 완료일 종료 (YYYY-MM-DD)
        - in: query
          name: settled_date_start
          schema:
            type: string
            format: date
          description: 정산 완료일 시작 (YYYY-MM-DD)
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOpenapiSettlementListCreateList'
          description: ''
      security:
        - ApiKeyAuth: []
          Signature: []
components:
  schemas:
    PaginatedOpenapiSettlementListCreateList:
      type: object
      required:
        - results
      properties:
        next:
          type:
            - string
            - 'null'
          format: uri
          example: http://api.example.org/accounts/?cursor=cD00ODY%3D"
        previous:
          type:
            - string
            - 'null'
          format: uri
          example: http://api.example.org/accounts/?cursor=cj0xJnA9NDg3
        results:
          type: array
          items:
            $ref: '#/components/schemas/OpenapiSettlementListCreate'
    OpenapiSettlementListCreate:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        title:
          type: string
          description: 정산 제목
          maxLength: 128
        status:
          enum:
            - C
            - D
            - S
            - P
          type: string
          x-spec-enum-id: 3bf0af9565254de8
          readOnly: true
          description: |-
            정산 상태

            * `C` - 정산 예정
            * `D` - 정산 지연
            * `S` - 정산 완료
            * `P` - 정산 중단
          x-enumNames:
            - 정산 예정
            - 정산 지연
            - 정산 완료
            - 정산 중단
        amount:
          type: integer
          minimum: 0
          description: 정산 금액
        additionalAmount:
          type: integer
          minimum: 0
          description: 추가 금액
        vat:
          type: integer
          minimum: 0
          description: 부가세
        dueDate:
          type:
            - string
            - 'null'
          format: date
          description: 지급 예정일
        settledDate:
          type:
            - string
            - 'null'
          format: date
          description: 지급 완료일
        typeAlias:
          type: string
          readOnly: true
          description: 정산 형태
        created:
          type: string
          format: date-time
          readOnly: true
          description: 생성일시
        contract:
          allOf:
            - $ref: '#/components/schemas/OpenapiNestedSettlementContract'
          description: 계약
      required:
        - additionalAmount
        - amount
        - contract
        - created
        - id
        - status
        - title
        - typeAlias
        - vat
    OpenapiNestedSettlementContract:
      type: object
      description: |-
        nested 아이템이 제공되면 선언된 required 필드를 모두 가져야 함을 강제한다.

        부모 레벨 partial(미전송 필드 생략)은 유지하되, nested 아이템은 object-level
        validate에서 required 필드 존재를 재확인해 누락 시 400을 반환한다.
      properties:
        id:
          type: integer
        title:
          type: string
          readOnly: true
          description: 계약 제목
        amount:
          type: integer
          readOnly: true
          description: 계약 금액
        type:
          enum:
            - I
            - S
            - G
          type: string
          x-spec-enum-id: 4b039ce324ed7b8c
          readOnly: true
          description: |-
            계약 타입

            * `I` - 회차 정산형
            * `S` - 정기 결제형
            * `G` - 단건 정산
          x-enumNames:
            - 회차 정산형
            - 정기 결제형
            - 단건 정산
        status:
          enum:
            - P
            - I
            - C
            - T
          type: string
          x-spec-enum-id: 81c3becab4b92e5c
          readOnly: true
          description: |-
            계약 상태

            * `P` - 계약 준비 중
            * `I` - 정산 진행 중
            * `C` - 계약 종료
            * `T` - 계약 중단
          x-enumNames:
            - 계약 준비 중
            - 정산 진행 중
            - 계약 종료
            - 계약 중단
        startDate:
          type:
            - string
            - 'null'
          format: date
          readOnly: true
          description: 계약 착수일
        endDate:
          type:
            - string
            - 'null'
          format: date
          readOnly: true
          description: 계약 종료일
      required:
        - amount
        - endDate
        - id
        - startDate
        - status
        - title
        - type
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
    Signature:
      type: apiKey
      in: header
      name: X-Signature
      description: |-
        HMAC-SHA256 방식으로 body를 secret key로 해싱하여 생성한 서명을 넣어야 합니다.
        서버는 X-API-Key와 대응되는 secret key로 서명을 검증합니다.

````