xdata-kr

xdata-kr Billing Invoices API

The Billing Invoices API from xdata-kr — 2 operation(s) for billing invoices.

GitHub OpenAPI

Operations 2

GET /v1/invoices List Invoices #
GET /v1/invoices/{invoice_id} Get Invoice #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/xdata-kr/openapi/xdata-kr-billing-invoices-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/xdata-kr:xdata-kr-billing-invoices-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

xdata-kr-billing-invoices-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: XBOSS Billing Invoices API
  description: '통합 REST API 서버 (홈택스 등). Human API guide: https://developer.xdata.kr · OpenAPI Reference: /docs'
  version: 2.0.0
security:
- basicClientCredential: []
- mcpOAuth2: []
tags:
- name: Billing Invoices
paths:
  /v1/invoices:
    get:
      tags:
      - Billing Invoices
      summary: List Invoices
      description: 인보이스 목록 조회.
      operationId: list_invoices_v1_invoices_get
      parameters:
      - name: query
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/InvoiceListQuery'
      - name: env_scope
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
          enum:
          - production
          - real_test
          - sandbox
          title: Env Scope
        description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Env-Scope
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
          enum:
          - production
          - real_test
          - sandbox
          title: X-Env-Scope
        description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageEnvelope_InvoiceResponse_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/invoices/{invoice_id}:
    get:
      tags:
      - Billing Invoices
      summary: Get Invoice
      description: 인보이스 단건 조회.
      operationId: get_invoice_v1_invoices__invoice_id__get
      parameters:
      - name: invoice_id
        in: path
        required: true
        schema:
          type: integer
          title: Invoice Id
      - name: env_scope
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
          enum:
          - production
          - real_test
          - sandbox
          title: Env Scope
        description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
      - name: Authorization
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Authorization
      - name: X-Env-Scope
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
          enum:
          - production
          - real_test
          - sandbox
          title: X-Env-Scope
        description: 환경을 고릅니다. 값은 production · real_test · sandbox 중 하나입니다. 경로 접두(/v1/sandbox/... · /v1/test/... · /v1/production/...) · X-Env-Scope 헤더 · env_scope 쿼리 가운데 한 통로로 반드시 보내야 합니다. 빼면 자동으로 채우지 않고 거절하며, 두 통로에 서로 다른 값을 담아도 거절합니다. 거절은 HTTP 422 이고 오류 코드는 VALIDATION_ENV_SCOPE_MISMATCH 입니다.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvoiceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    InvoiceItemResponse:
      properties:
        invoice_item_id:
          type: integer
          minimum: 1.0
          title: Invoice Item Id
          description: invoice_items.id.
        description:
          type: string
          maxLength: 200
          minLength: 1
          title: Description
          description: 청구 항목 설명.
        quantity:
          type: integer
          minimum: 0.0
          title: Quantity
          description: 수량. 0 이상이어야 한다.
        unit_amount_minor:
          type: integer
          minimum: 0.0
          title: Unit Amount Minor
          description: 단가 (minor unit 정수). 음수 금지.
        amount_minor:
          type: integer
          minimum: 0.0
          title: Amount Minor
          description: 항목 합계 (minor unit 정수). 수량 x 단가와 같아야 한다. (= quantity * unit_amount_minor) 강제. 서비스 계층 검증 책임.
        currency:
          type: string
          const: KRW
          title: Currency
          description: 통화 코드. v1=KRW.
        item_kind:
          type: string
          enum:
          - SUBSCRIPTION
          - USAGE
          - ONE_TIME
          - DISCOUNT
          - TAX_ADJUSTMENT
          title: Item Kind
          description: 항목 종류 (5값 enum).
        period_start:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Period Start
          description: 항목 적용 기간 시작 (구독성 항목만 채워짐).
        period_end:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Period End
          description: 항목 적용 기간 종료.
      additionalProperties: false
      type: object
      required:
      - invoice_item_id
      - description
      - quantity
      - unit_amount_minor
      - amount_minor
      - currency
      - item_kind
      title: InvoiceItemResponse
      description: '인보이스 항목 단일 객체 응답.


        자세한 SCHEMA 매핑과 제약은 이 클래스 위 주석에 있다.'
    InvoiceResponse:
      properties:
        invoice_id:
          type: integer
          minimum: 1.0
          title: Invoice Id
          description: invoices.id.
        organization_id:
          type: integer
          minimum: 1.0
          title: Organization Id
          description: 소유 조직 PK.
        subscription_id:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Subscription Id
          description: 연결된 구독 ID. 일회성 청구 시 NULL.
        env_scope:
          type: string
          enum:
          - sandbox
          - real_test
          - production
          title: Env Scope
          description: 환경 스코프.
        invoice_number:
          type: string
          maxLength: 40
          minLength: 1
          title: Invoice Number
          description: 인보이스 비즈 번호 'INV-YYYYMM-XXXXXX' 형식.
        status:
          type: string
          enum:
          - DRAFT
          - OPEN
          - PAID
          - VOID
          - UNCOLLECTIBLE
          - REFUNDED
          - PARTIALLY_REFUNDED
          title: Status
          description: 인보이스 상태 (7값 enum).
        subtotal_amount_minor:
          type: integer
          minimum: 0.0
          title: Subtotal Amount Minor
          description: 공급가액 합계 (minor unit). 음수는 받지 않는다.
        tax_amount_minor:
          type: integer
          minimum: 0.0
          title: Tax Amount Minor
          description: 부가세 합계 (minor unit). 0 허용 (영세율 등).
        total_amount_minor:
          type: integer
          minimum: 0.0
          title: Total Amount Minor
          description: 총액 (minor unit). 공급가액 + 세액과 같아야 한다. (= subtotal + tax) 강제. 서비스 계층 검증 책임.
        currency:
          type: string
          const: KRW
          title: Currency
          description: 통화 코드. v1=KRW.
        period_start:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Period Start
          description: 청구 적용 기간 시작.
        period_end:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Period End
          description: 청구 적용 기간 종료.
        issued_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Issued At
          description: OPEN 전이 시각 (DRAFT는 NULL).
        due_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Due At
          description: 지급 만기 시각.
        paid_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Paid At
          description: PAID 전이 시각 (미결제 시 NULL).
        voided_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Voided At
          description: VOID 전이 시각 (정상 시 NULL).
        items:
          items:
            $ref: '#/components/schemas/InvoiceItemResponse'
          type: array
          title: Items
          description: 청구 항목 배열. 빈 배열 허용(DRAFT 단계).
        created_at:
          type: string
          format: date-time
          title: Created At
          description: 인보이스 생성 시각 (aware datetime, naive 입력 시 422).
      additionalProperties: false
      type: object
      required:
      - invoice_id
      - organization_id
      - env_scope
      - invoice_number
      - status
      - subtotal_amount_minor
      - tax_amount_minor
      - total_amount_minor
      - currency
      - created_at
      title: InvoiceResponse
      description: '인보이스 단일 객체 응답.


        자세한 SCHEMA 매핑과 제약은 이 클래스 위 주석에 있다.'
    InvoiceListQuery:
      properties:
        organization_id:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Organization Id
          description: 조직 PK. 본인 조직 미지정 가능(라우트 주입).
        subscription_id:
          anyOf:
          - type: integer
            minimum: 1.0
          - type: 'null'
          title: Subscription Id
          description: 구독 ID 필터.
        status:
          anyOf:
          - items:
              type: string
              enum:
              - DRAFT
              - OPEN
              - PAID
              - VOID
              - UNCOLLECTIBLE
              - REFUNDED
              - PARTIALLY_REFUNDED
            type: array
          - type: 'null'
          title: Status
          description: 상태 필터(다중). 미지정 시 전체.
        limit:
          type: integer
          maximum: 100.0
          minimum: 1.0
          title: Limit
          description: 페이지 크기.
          default: 20
        cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Cursor
          description: 이전 응답의 next_cursor.
      type: object
      title: InvoiceListQuery
      description: '인보이스 목록 조회 쿼리.


        자동 필터(라우트 강제):

        - `organization_id`: 본인 조직(ADMIN은 명시 가능)

        - `env_scope = X-Env-Scope`


        명세에 쿼리 표가 없어 이 DTO 가 그 표의 자리를 대신한다.'
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PageEnvelope_InvoiceResponse_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/InvoiceResponse'
          type: array
          title: Items
          description: Page result items. Empty list allowed.
        next_cursor:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Cursor
          description: Opaque cursor for next page, or null on last page.
        has_more:
          type: boolean
          title: Has More
          description: Whether another page exists. False when next_cursor is null.
          default: false
      additionalProperties: false
      type: object
      title: PageEnvelope[InvoiceResponse]
  securitySchemes:
    basicClientCredential:
      type: http
      scheme: basic
      description: 'Console-issued client credential. Send `Authorization: Basic base64(client_id:client_secret)`.'
    mcpOAuth2:
      type: oauth2
      description: For MCP clients. OAuth 2.0 authorization code flow with PKCE (S256) for public clients. The client_id is the HTTPS URL of an OAuth Client ID Metadata Document that XBOSS has allow-listed; dynamic client registration is not supported.
      flows:
        authorizationCode:
          authorizationUrl: https://api.xdata.kr/oauth/authorize
          tokenUrl: https://api.xdata.kr/oauth/token
          scopes: {}