> ## 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.

# 고객 생성

> 새 고객(`Client`)을 생성합니다. `status.id` 미지정 시 비즈니스의 기본 클라이언트 상태가 할당될 수 있으니, 원하는 상태가 있다면 명시적으로 전달하세요. 별도 알림 없음.

### 커스텀 필드

* 플러그 Openapi는 고객의 커스텀 필드 값 수정을 지원합니다.

* 커스텀 필드 자체의 수정은 비즈니스 설정 - 필드 설정 탭에서 수정하실 수 있습니다.

<img src="https://mintcdn.com/pluuug-b8acb99c/O5D3FA2FK1c10mz3/images/field_setting.png?fit=max&auto=format&n=O5D3FA2FK1c10mz3&q=85&s=80e7c5525a0288831f00d797cd040177" alt="" width="1164" height="869" data-path="images/field_setting.png" />    &#x9;

* 수정 API의 `field_set` 필드를 활용하여 각 커스텀 필드의 값을 수정하실 수 있습니다.

* 커스텀 필드는 총 8가지의 타입을 지원합니다.

* 데이터 입력 예

<table>
  <thead>
    <tr>
      <th>데이터 타입</th>
      <th>입력 예시</th>
    </tr>
  </thead>

  <tbody>
    <tr>
      <td>텍스트 (String)</td>

      <td>
        <pre>
          <code>
            \{
                "field": \{
                     "id": 1
                },
                "value": "text"
            }
          </code>
        </pre>
      </td>
    </tr>

    <tr>
      <td>
        숫자 (Number)

        * 소수점 입력 가능
      </td>

      <td>
        <pre>
          <code>
            \{
                "field": \{
                     "id": 2
                },
                "value": 12345
            }
          </code>
        </pre>
      </td>
    </tr>

    <tr>
      <td>
        멤버 (Member)

        * 해당 필드의 'member\_set'에서 id 선택
      </td>

      <td>
        <pre>
          <code>
            \{
                "field": \{
                     "id": 3
                },
                "value": \[
                    \{
                        "id": 1
                    },
                    \{
                        "id": 2
                    }
                ]
            }
          </code>
        </pre>
      </td>
    </tr>

    <tr>
      <td>날짜 (Date)</td>

      <td>
        <pre>
          <code>
            \{
                "field": \{
                     "id": 4
                },
                "value": "2025-03-01"
            }
          </code>
        </pre>
      </td>
    </tr>

    <tr>
      <td>시간 (Time)</td>

      <td>
        <pre>
          <code>
            \{
                "field": \{
                     "id": 5
                },
                "value": "10:00:00"
            }
          </code>
        </pre>
      </td>
    </tr>

    <tr>
      <td>토글 (Boolean)</td>

      <td>
        <pre>
          <code>
            \{
                "field": \{
                     "id": 6
                },
                "value": true
            }
          </code>
        </pre>
      </td>
    </tr>

    <tr>
      <td>
        단수선택 리스트 (Single List)

        * 해당 필드의 'option\_set'에서 id 선택
      </td>

      <td>
        <pre>
          <code>
            \{
                "field": \{
                     "id": 7
                },
                "value": \{
                    "id": "FEWKSLVE2"
                }
            }
          </code>
        </pre>
      </td>
    </tr>

    <tr>
      <td>
        복수선택 리스트 (Multi List)

        * 해당 필드의 'option\_set'에서 id 선택
      </td>

      <td>
        <pre>
          <code>
            \{
                "field": \{
                     "id": 8
                },
                "value": \[
                    \{
                        "id": "EFI4VLB2D"
                    },
                    \{
                        "id": "BORE32VKE"
                    }
                ]
            }
          </code>
        </pre>
      </td>
    </tr>
  </tbody>
</table>


## OpenAPI

````yaml POST /v1/client
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/client:
    post:
      tags:
        - client
      summary: 고객 생성
      description: >-
        새 고객(`Client`)을 생성합니다. `status.id` 미지정 시 비즈니스의 기본 클라이언트 상태가 할당될 수 있으니,
        원하는 상태가 있다면 명시적으로 전달하세요. 별도 알림 없음.
      operationId: client_create
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenapiClientListCreateRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OpenapiClientListCreateRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/OpenapiClientListCreateRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenapiClientListCreate'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpenapiClientListCreateValidationError'
          description: ''
      security:
        - ApiKeyAuth: []
          Signature: []
components:
  schemas:
    OpenapiClientListCreateRequest:
      type: object
      properties:
        status:
          description: 고객 상태 (미입력 시 기본 상태)
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/OpenapiNestedClientStatusRequest'
        companyName:
          type: string
          minLength: 1
          description: 회사명
          maxLength: 128
        inCharge:
          type:
            - string
            - 'null'
          minLength: 1
          description: 담당자
          maxLength: 64
        position:
          type:
            - string
            - 'null'
          minLength: 1
          description: 직책
          maxLength: 64
        contact:
          type:
            - string
            - 'null'
          minLength: 1
          description: 연락처
          maxLength: 128
        email:
          type:
            - string
            - 'null'
          format: email
          minLength: 1
          description: 이메일
          maxLength: 128
        content:
          type:
            - string
            - 'null'
          writeOnly: true
          minLength: 1
          description: 메모
        businessRegistrationNumber:
          type:
            - string
            - 'null'
          writeOnly: true
          minLength: 1
          description: 사업자 등록번호
          maxLength: 16
        ceoName:
          type:
            - string
            - 'null'
          writeOnly: true
          minLength: 1
          description: 대표자
          maxLength: 128
        companyAddress:
          type:
            - string
            - 'null'
          writeOnly: true
          minLength: 1
          description: 소재지
          maxLength: 256
        companyDetailAddress:
          type:
            - string
            - 'null'
          writeOnly: true
          minLength: 1
          description: 소재지 상세
          maxLength: 256
        businessType:
          type:
            - string
            - 'null'
          writeOnly: true
          minLength: 1
          description: 업태
          maxLength: 128
        businessClass:
          type:
            - string
            - 'null'
          writeOnly: true
          minLength: 1
          description: 종목
          maxLength: 128
        branchNumber:
          type:
            - string
            - 'null'
          writeOnly: true
          minLength: 1
          description: 종사업장 번호
          maxLength: 4
        taxInvoiceEmail:
          type:
            - string
            - 'null'
          writeOnly: true
          minLength: 1
          description: 세금계산서 전용 이메일
          maxLength: 128
        fieldSet:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/OpenapiClientFieldsRequest'
          writeOnly: true
          description: 커스텀 필드
      required:
        - companyName
    OpenapiClientListCreate:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        status:
          description: 고객 상태 (미입력 시 기본 상태)
          oneOf:
            - type: 'null'
            - $ref: '#/components/schemas/OpenapiNestedClientStatus'
        companyName:
          type: string
          description: 회사명
          maxLength: 128
        inCharge:
          type:
            - string
            - 'null'
          description: 담당자
          maxLength: 64
        position:
          type:
            - string
            - 'null'
          description: 직책
          maxLength: 64
        contact:
          type:
            - string
            - 'null'
          description: 연락처
          maxLength: 128
        email:
          type:
            - string
            - 'null'
          format: email
          description: 이메일
          maxLength: 128
        created:
          type: string
          format: date-time
          readOnly: true
          description: 생성일시
      required:
        - companyName
        - created
        - id
    OpenapiClientListCreateValidationError:
      type: object
      properties:
        nonField:
          type: array
          items:
            type: string
        status:
          $ref: '#/components/schemas/OpenapiNestedClientStatusValidationError'
        companyName:
          type: array
          items:
            type: string
        inCharge:
          type: array
          items:
            type: string
        position:
          type: array
          items:
            type: string
        contact:
          type: array
          items:
            type: string
        email:
          type: array
          items:
            type: string
        content:
          type: array
          items:
            type: string
        businessRegistrationNumber:
          type: array
          items:
            type: string
        ceoName:
          type: array
          items:
            type: string
        companyAddress:
          type: array
          items:
            type: string
        companyDetailAddress:
          type: array
          items:
            type: string
        businessType:
          type: array
          items:
            type: string
        businessClass:
          type: array
          items:
            type: string
        branchNumber:
          type: array
          items:
            type: string
        taxInvoiceEmail:
          type: array
          items:
            type: string
        fieldSet:
          type: array
          items:
            type: string
    OpenapiNestedClientStatusRequest:
      type: object
      description: |-
        nested 아이템이 제공되면 선언된 required 필드를 모두 가져야 함을 강제한다.

        부모 레벨 partial(미전송 필드 생략)은 유지하되, nested 아이템은 object-level
        validate에서 required 필드 존재를 재확인해 누락 시 400을 반환한다.
      properties:
        id:
          type: integer
      required:
        - id
    OpenapiClientFieldsRequest:
      type: object
      properties:
        field:
          allOf:
            - $ref: '#/components/schemas/OpenapiNestedFieldRequest'
          description: 커스텀 필드
        value:
          anyOf:
            - type: string
            - type: number
            - type: boolean
            - type: object
            - type: array
              items:
                type: object
          description: 값
      required:
        - field
        - value
    OpenapiNestedClientStatus:
      type: object
      description: |-
        nested 아이템이 제공되면 선언된 required 필드를 모두 가져야 함을 강제한다.

        부모 레벨 partial(미전송 필드 생략)은 유지하되, nested 아이템은 object-level
        validate에서 required 필드 존재를 재확인해 누락 시 400을 반환한다.
      properties:
        id:
          type: integer
        title:
          type: string
          readOnly: true
          description: 상태 제목
      required:
        - id
        - title
    OpenapiNestedClientStatusValidationError:
      type: object
      properties:
        id:
          type: array
          items:
            type: string
    OpenapiNestedFieldRequest:
      type: object
      properties:
        id:
          type: integer
      required:
        - id
  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로 서명을 검증합니다.

````