---
updatedAt: 2026-05-11T10:32:40.000Z
agentTools:
  projectIndex: https://guides.sterasmartone.com/llms.txt
---

# Retrieve EasyQR code

EasyQRコードオブジェクトを取得する

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "version": "1.3.0",
    "title": "elepay API リファレンス",
    "description": "elepay APIはRESTをベースに構成された決済APIです。支払い処理、返金処理など、決済に関わる運用における様々なことができます。",
    "contact": {
      "name": "ELESTYLE, INC",
      "url": "https://elepay.io",
      "email": "support@elestyle.jp"
    }
  },
  "servers": [
    {
      "url": "https://api.elepay.io"
    }
  ],
  "tags": [
    {
      "name": "Code"
    }
  ],
  "security": [
    {
      "bearerAuth": []
    },
    {
      "basicAuth": []
    }
  ],
  "paths": {
    "/codes/{codeId}": {
      "get": {
        "tags": [
          "Code"
        ],
        "summary": "Retrieve EasyQR code",
        "description": "EasyQRコードオブジェクトを取得する",
        "operationId": "retrieveCode",
        "parameters": [
          {
            "name": "codeId",
            "description": "EasyQRコード",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json;charset=utf-8": {
                "schema": {
                  "$ref": "#/components/schemas/CodeDto"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "basicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "API呼出すの認証は、秘密鍵をユーザーネームとして扱い、パスワードは省略して、Basic 認証経由で行われます。\n秘密鍵は、全ての API リクエスト操作が可能となる重要なキーなので、取扱いにご注意ください。\n"
      },
      "bearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "description": "API呼出すの認証は、秘密鍵を認証トークンとして扱い、Bearer 認証経由で行われます。\n秘密鍵は、全ての API リクエスト操作が可能となる重要なキーなので、取扱いにご注意ください。\n"
      }
    },
    "schemas": {
      "PaymentMethodType": {
        "description": "決済方法\n- auto 自動識別(CPM決済のみ利用可能)\n- alipay アリペイ\n- alipayhk アリペイHK\n- alipayplus Alipay+\n- amazonpay Amazon Pay\n- applepay Apple Pay\n- applepay_cn Apple Pay(中国)\n- atokara アトカラ\n- atone atone(コンビニで翌月払い)\n- aupay au Pay\n- clicktopay Click To Pay\n- banktransfer 銀行振込\n- creditcard クレジットカード\n- dana DANA\n- docomopay d払い\n- ezlink EZ-Link\n- felica 電子マネー\n- felica_id iD\n- felica_quickpay QUICPay\n- felica_transport_ic 交通系ICカード\n- gcash GCash\n- ginkopay 銀行Pay\n- googlepay Google Pay\n- jcoinpay J-Coin Pay\n- jkopay JKOPAY\n- kakaopay Kakao Pay\n- konbini コンビニ決済\n- linepay LINE Pay\n- merpay メルペイ\n- origamipay Origami Pay\n- paidy Paidy 翌月払い\n- paypal PayPal\n- paypay PayPay\n- pxpayplus 全支付\n- rakutenpay 楽天ペイ\n- smartcode スマートコード\n- tng Touch 'n Go eWallet\n- truemoney TrueMoney\n- unionpay 雲閃付\n- wechatpay Wechat Pay\n- aeonpay AEON Pay\n- rabbitlinepay Rabbit LINE Pay\n- bpi BPI\n- boost Boost\n- hellomoney HelloMoney by AUB\n- tosspay Toss Pay\n- naverpay Naver Pay\n- wellwa WellWa Points\n- grabpay Grab Pay\n- momopay Momo Pay\n- promptpay Prompt Pay\n- wovenpay Woven City Pay\n- ezopay EZO Pay\n",
        "type": "string",
        "enum": [
          "alipay",
          "alipayhk",
          "alipayplus",
          "amazonpay",
          "applepay",
          "applepay_cn",
          "atokara",
          "atone",
          "aupay",
          "clicktopay",
          "banktransfer",
          "creditcard",
          "dana",
          "docomopay",
          "ezlink",
          "felica",
          "felica_id",
          "felica_quickpay",
          "felica_transport_ic",
          "gcash",
          "ginkopay",
          "googlepay",
          "jcoinpay",
          "jkopay",
          "kakaopay",
          "konbini",
          "linepay",
          "merpay",
          "origamipay",
          "paidy",
          "paypal",
          "paypay",
          "pxpayplus",
          "rakutenpay",
          "smartcode",
          "tng",
          "truemoney",
          "unionpay",
          "wechatpay",
          "aeonpay",
          "rabbitlinepay",
          "bpi",
          "boost",
          "hellomoney",
          "tosspay",
          "naverpay",
          "wellwa",
          "grabpay",
          "momopay",
          "promptpay",
          "wovenpay",
          "ezopay",
          "auto"
        ]
      },
      "ResourceType": {
        "description": "決済リソース\n- web WEBブラウザ\n- ios iOS Nativeアプリ\n- android Android Nativeアプリ\n- liff Line LIFFアプリ\n- mini WeChatミニプログラム\n- cpm CPM決済、利用者提示型QRコード\n- mpm MPM決済、店舗側提示型QRコード\n- reader カードリーダー決済(リーダー設備が必要)\n- posapp POSアプリ決済(POSアプリが連携必要)\n",
        "type": "string",
        "enum": [
          "web",
          "ios",
          "android",
          "liff",
          "mini",
          "cpm",
          "mpm",
          "reader",
          "posapp"
        ]
      },
      "CardBrandType": {
        "description": "- unknown\n- visa\n- mastercard\n- amex\n- jcb\n- diners\n- unionpay\n- discover\n- felica\n- seven_eleven\n- lawson\n- familymart\n- ministop\n- seicomart\n",
        "type": "string"
      },
      "ChargeStatusType": {
        "description": "支払い状態\n- pending 未支払\n- waiting 支払い待ち(情報入力済)\n- notified 支払い準備中(通知済)\n- uncaptured 承認済み(未確定)\n- captured 支払済み\n- partially_refunded 一部返金\n- refunded 返金済み\n- amount_mismatch 金額相違\n- revoked キャンセル済み\n- failed 支払い失敗\n",
        "type": "string",
        "enum": [
          "pending",
          "waiting",
          "notified",
          "uncaptured",
          "captured",
          "partially_refunded",
          "refunded",
          "amount_mismatch",
          "revoked",
          "failed"
        ]
      },
      "RefundStatusType": {
        "description": "返金状態\n- pending 未返金\n- refunded 返金済み\n",
        "type": "string",
        "enum": [
          "pending",
          "refunded"
        ]
      },
      "CodeStatusType": {
        "description": "EasyQrコード状態\n- pending 未支払\n- completed 支払い情報の準備が完了\n- captured 支払済み\n- closed 有効期限切れ・削除された\n",
        "type": "string",
        "enum": [
          "pending",
          "completed",
          "captured",
          "closed"
        ]
      },
      "ChargeDto": {
        "type": "object",
        "description": "支払いオブジェクト",
        "properties": {
          "id": {
            "description": "Charge ID",
            "type": "string",
            "maxLength": 32
          },
          "appId": {
            "description": "App ID",
            "type": "string",
            "maxLength": 32
          },
          "object": {
            "description": "対象種類の表記",
            "type": "string",
            "default": "charge"
          },
          "liveMode": {
            "description": "本番モードかどうか\n- false テストモード\n- true 本番モード\n",
            "type": "boolean"
          },
          "amount": {
            "description": "支払い金額",
            "type": "integer"
          },
          "authorizeAmount": {
            "description": "事前承認金額",
            "type": "integer"
          },
          "currency": {
            "description": "通貨コード (ISO_4217)",
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "default": "JPY"
          },
          "authorize": {
            "description": "事前承認フラグ",
            "type": "boolean"
          },
          "paymentMethod": {
            "$ref": "#/components/schemas/PaymentMethodType"
          },
          "resource": {
            "$ref": "#/components/schemas/ResourceType"
          },
          "orderNo": {
            "description": "お客様システム側のオーダーNo、例えば注文番号、決済IDなど",
            "type": "string",
            "maxLength": 50
          },
          "description": {
            "description": "支払い説明文",
            "type": "string",
            "maxLength": 1024
          },
          "location": {
            "$ref": "#/components/schemas/ChargeLocationDto"
          },
          "extra": {
            "description": "支払いエキストラデータ",
            "type": "object",
            "maxProperties": 20,
            "propertyNames": {
              "type": "string",
              "maxLength": 20
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "metadata": {
            "description": "支払いメタデータ",
            "type": "object",
            "maxProperties": 20,
            "propertyNames": {
              "type": "string",
              "maxLength": 20
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "cardInfo": {
            "$ref": "#/components/schemas/CardInfo"
          },
          "voucherNo": {
            "description": "プロバイダー決済伝票番号",
            "type": "string",
            "maxLength": 32
          },
          "clientIp": {
            "description": "Client IP アドレス",
            "type": "string",
            "maxLength": 45
          },
          "paid": {
            "description": "支払い済みフラグ",
            "type": "boolean"
          },
          "refunded": {
            "description": "返金済みフラグ",
            "type": "boolean"
          },
          "disputed": {
            "description": "不審請求フラグ",
            "type": "boolean"
          },
          "refunds": {
            "$ref": "#/components/schemas/RefundsDto"
          },
          "status": {
            "$ref": "#/components/schemas/ChargeStatusType"
          },
          "codeContent": {
            "description": "店舗側提示型QRコード(リソースはmpm場合のみ)",
            "type": "string"
          },
          "credential": {
            "description": "Client SDKの認証情報",
            "type": "string"
          },
          "paidTime": {
            "description": "支払い時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          },
          "refundTime": {
            "description": "返金時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          },
          "expiryTime": {
            "description": "支払い請求有効時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          },
          "settleTime": {
            "description": "支払い締め時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          },
          "createTime": {
            "description": "支払い新規時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "RefundDto": {
        "description": "返金オブジェクト",
        "type": "object",
        "properties": {
          "id": {
            "description": "Refund ID",
            "type": "string",
            "maxLength": 32
          },
          "object": {
            "description": "対象種類の表記",
            "type": "string",
            "default": "refund"
          },
          "chargeId": {
            "description": "Charge ID",
            "type": "string",
            "maxLength": 32
          },
          "liveMode": {
            "description": "本番モードかどうか\n- false テストモード\n- true 本番モード\n",
            "type": "boolean"
          },
          "amount": {
            "description": "返金金額。全額返金、及び amount を指定することで金額の部分返金を行うことができます。",
            "type": "integer"
          },
          "currency": {
            "description": "通貨コード (ISO_4217)",
            "type": "string",
            "minLength": 3,
            "maxLength": 3
          },
          "metadata": {
            "description": "返金メタデータ",
            "type": "object",
            "maxProperties": 20,
            "propertyNames": {
              "type": "string",
              "maxLength": 20
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "reason": {
            "description": "返金理由",
            "type": "string",
            "maxLength": 255
          },
          "status": {
            "$ref": "#/components/schemas/RefundStatusType"
          },
          "refundedTime": {
            "description": "返金を行う時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          },
          "createTime": {
            "description": "返金新規時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "RefundsDto": {
        "description": "返金のサマリー。複数回返金された場合、返金内容をサマリーして返します。",
        "type": "object",
        "properties": {
          "amount": {
            "description": "返金総額",
            "type": "integer"
          },
          "totalCount": {
            "description": "返金回数",
            "type": "integer"
          },
          "data": {
            "description": "返金詳細情報",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/RefundDto"
            }
          }
        }
      },
      "CustomerStatusType": {
        "description": "状態\n",
        "type": "string",
        "enum": [
          "active",
          "deleted"
        ]
      },
      "CustomerDto": {
        "description": "カスタマオブジェクト",
        "properties": {
          "id": {
            "description": "Customer ID",
            "type": "string",
            "maxLength": 32
          },
          "object": {
            "description": "対象種類の表記",
            "type": "string",
            "default": "customer"
          },
          "liveMode": {
            "description": "本番モードかどうか\n- false テストモード\n- true 本番モード\n",
            "type": "boolean"
          },
          "defaultSource": {
            "description": "デフォルトカスタマソースID",
            "type": "string",
            "maxLength": 32
          },
          "name": {
            "description": "名前",
            "type": "string",
            "maxLength": 255
          },
          "description": {
            "description": "カスタマに関する説明",
            "type": "string",
            "maxLength": 255
          },
          "email": {
            "description": "メールアドレス",
            "type": "string",
            "maxLength": 255
          },
          "phone": {
            "description": "電話番号",
            "type": "string",
            "maxLength": 255
          },
          "remark": {
            "description": "備考",
            "type": "string"
          },
          "operator": {
            "description": "操作者",
            "type": "string",
            "maxLength": 255
          },
          "status": {
            "$ref": "#/components/schemas/CustomerStatusType"
          },
          "metadata": {
            "description": "メタデータ",
            "type": "object",
            "maxProperties": 20,
            "propertyNames": {
              "type": "string",
              "maxLength": 20
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "updateTime": {
            "description": "update time",
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "SourceStatusType": {
        "description": "カスタマソースステータス\n- pending 未承認\n- active 承認済み\n- failed 承認失敗\n- inactive 承認済みだが、現在は利用不可\n- deleted 削除済みあるいは失効\n",
        "type": "string",
        "enum": [
          "pending",
          "active",
          "failed",
          "inactive",
          "deleted"
        ]
      },
      "SourceDto": {
        "description": "カスタマソースオブジェクト",
        "properties": {
          "id": {
            "description": "Source ID",
            "type": "string",
            "maxLength": 32
          },
          "object": {
            "description": "対象種類の表記",
            "type": "string",
            "default": "source"
          },
          "liveMode": {
            "description": "本番モードかどうか\n- false テストモード\n- true 本番モード\n",
            "type": "boolean"
          },
          "paymentMethod": {
            "$ref": "#/components/schemas/PaymentMethodType"
          },
          "resource": {
            "$ref": "#/components/schemas/ResourceType"
          },
          "description": {
            "description": "カスタマソースに関する説明",
            "type": "string",
            "maxLength": 255
          },
          "extra": {
            "description": "カスタマソースエキストラデータ",
            "type": "object",
            "maxProperties": 20,
            "propertyNames": {
              "type": "string",
              "maxLength": 20
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "info": {
            "description": "カスタマソース情報",
            "type": "object",
            "additionalProperties": {
              "type": "object"
            }
          },
          "cardInfo": {
            "$ref": "#/components/schemas/CardInfo"
          },
          "metadata": {
            "description": "メタデータ",
            "type": "object",
            "maxProperties": 20,
            "propertyNames": {
              "type": "string",
              "maxLength": 20
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "credential": {
            "description": "Client SDK の認証情報",
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/SourceStatusType"
          }
        }
      },
      "CodeDto": {
        "type": "object",
        "description": "EasyQRコードオブジェクト",
        "properties": {
          "id": {
            "description": "EasyQRコードID",
            "type": "string",
            "maxLength": 32
          },
          "object": {
            "description": "対象種類の表記",
            "type": "string",
            "default": "code"
          },
          "liveMode": {
            "description": "本番モードかどうか\n- false テストモード\n- true 本番モード\n",
            "type": "boolean"
          },
          "codeUrl": {
            "description": "EasyQRコードURL",
            "type": "string",
            "maxLength": 255
          },
          "amount": {
            "description": "支払い金額",
            "type": "integer"
          },
          "currency": {
            "description": "通貨コード (ISO_4217)",
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "default": "JPY"
          },
          "orderNo": {
            "description": "お客様システム側のオーダーNo、例えば注文番号、決済IDなど",
            "type": "string",
            "maxLength": 50
          },
          "description": {
            "description": "支払いオブジェクトの「決済に関する説明」",
            "type": "string",
            "maxLength": 255
          },
          "extra": {
            "description": "支払いエキストラデータ",
            "type": "object",
            "maxProperties": 20,
            "propertyNames": {
              "type": "string",
              "maxLength": 20
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "metadata": {
            "description": "支払いオブジェクトの「メタデータ」",
            "type": "object",
            "maxProperties": 20,
            "propertyNames": {
              "type": "string",
              "maxLength": 20
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "status": {
            "$ref": "#/components/schemas/CodeStatusType"
          },
          "charge": {
            "$ref": "#/components/schemas/ChargeDto"
          },
          "customer": {
            "$ref": "#/components/schemas/CustomerDto"
          },
          "source": {
            "$ref": "#/components/schemas/SourceDto"
          },
          "frontUrl": {
            "type": "string"
          },
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CodeItem"
            }
          },
          "locationId": {
            "description": "ロケーションID",
            "type": "string",
            "maxLength": 32
          },
          "expired": {
            "description": "EasyQRコード有効有無",
            "type": "boolean"
          },
          "expiryTime": {
            "description": "EasyQRコード有効期限（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          },
          "expiryPeriod": {
            "description": "EasyQRコード有効期限までの残りミリ秒数",
            "type": "integer",
            "format": "int64"
          },
          "createTime": {
            "description": "コード新規時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          },
          "shouldCreateSource": {
            "description": "このコードで新しいカスタマソースを作成する必要があるかどうか。\n",
            "type": "boolean"
          },
          "activeSources": {
            "description": "有効なカスタマソースリスト",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SourceDto"
            }
          },
          "invoice": {
            "$ref": "#/components/schemas/InvoiceDto"
          }
        }
      },
      "CardInfo": {
        "type": "object",
        "description": "カード情報やウォレット情報",
        "properties": {
          "brand": {
            "$ref": "#/components/schemas/CardBrandType"
          },
          "last4": {
            "description": "カード番号の下四桁",
            "type": "string"
          },
          "expMonth": {
            "description": "有効期限月",
            "type": "integer"
          },
          "expYear": {
            "description": "有効期限年",
            "type": "integer"
          },
          "name": {
            "description": "カード保有者名",
            "type": "string"
          },
          "issuerCode": {
            "description": "カード発行会社コード（GMO決済のみ）\nGMO-PG「仕向先カード会社コード」に準拠\n",
            "type": "string"
          },
          "issuerName": {
            "description": "カード発行会社名（GMO決済のみ）\nGMO-PG「仕向先カード会社コード」に対応する会社名\n",
            "type": "string"
          },
          "wallet": {
            "description": "ウォレット情報",
            "type": "string"
          },
          "walletApp": {
            "description": "ウォレットアプリ情報(paymentMethodはalipayplusやsmartcodeの場合は、実際利用しているアプリ名)",
            "type": "string"
          },
          "repaymentType": {
            "description": "リペイメントタイプ\n- 1 一括払い\n- revolving リボ払い\n- bonus_one_time ボーナス一括払い\n- 2 分割2回払い\n- 3 分割3回払い\n",
            "type": "string"
          },
          "approvalCode": {
            "description": "承認コード",
            "type": "string"
          },
          "threeDSecure": {
            "description": "3Dセキュア有無",
            "type": "boolean"
          },
          "threeDSecureVersion": {
            "description": "3Dセキュアバージョン",
            "type": "string"
          },
          "threeDSecureDetail": {
            "description": "3Dセキュア詳細情報",
            "type": "string"
          },
          "businessType": {
            "description": "ビジネスタイプ",
            "type": "string"
          },
          "konbiniScanTime": {
            "description": "コンビニがラストスキャンする日時",
            "type": "integer",
            "format": "int64"
          },
          "konbiniType": {
            "description": "実際支払い時のコンビニタイプ\n- unknown\n- seven_eleven\n- lawson\n- familymart\n- ministop\n- seicomart\n",
            "type": "string"
          },
          "receivedAmount": {
            "description": "コンビニ、または銀行から実際入金の金額",
            "type": "integer"
          },
          "receivedTime": {
            "description": "コンビニ、または銀行に実際入金の日時、この数値が年月日のみ（零時）の可能性もある",
            "type": "integer",
            "format": "int64"
          },
          "bankUserCode": {
            "description": "銀行、振り込んだユーザーのコード",
            "type": "string"
          },
          "bankUserName": {
            "description": "銀行、振り込んだユーザーの名義",
            "type": "string"
          },
          "bankName": {
            "description": "振り込められた銀行名",
            "type": "string"
          },
          "bankBranchName": {
            "description": "振り込められた銀行支店名",
            "type": "string"
          },
          "bankAccountNo": {
            "description": "振り込められた銀行番号",
            "type": "string"
          },
          "billingNo": {
            "description": "請求番号（決済ステーション用）",
            "type": "string"
          }
        }
      },
      "CodeItem": {
        "type": "object",
        "description": "商品情報",
        "required": [
          "name",
          "price",
          "count"
        ],
        "properties": {
          "name": {
            "description": "商品の名前",
            "type": "string"
          },
          "image": {
            "description": "商品の画像URL",
            "type": "string",
            "pattern": "https?://[-A-Za-z0-9+&@#/%?=~_|!:,.;]+[-A-Za-z0-9+&@#/%=~_|]"
          },
          "price": {
            "description": "各商品の決済金額",
            "type": "integer"
          },
          "count": {
            "description": "商品数",
            "type": "integer"
          }
        }
      },
      "TaxRateType": {
        "description": "税率区分\n- standard 税率10%\n- reduced 税率8%\n- free 税率0%\n",
        "type": "string",
        "enum": [
          "standard",
          "reduced",
          "free"
        ]
      },
      "InvoiceStatusType": {
        "description": "インボイス状態\n- draft 下書き\n- submit 確定済み\n- sent 送信済み\n- paid 支払い済み\n- expired 期限切れ\n- canceled キャンセル済み\n",
        "type": "string",
        "enum": [
          "draft",
          "submit",
          "sent",
          "paid",
          "expired",
          "canceled"
        ]
      },
      "InvoiceDto": {
        "description": "インボイスオブジェクト",
        "properties": {
          "id": {
            "description": "Invoice ID",
            "type": "string",
            "maxLength": 32
          },
          "object": {
            "description": "対象種類の表記",
            "type": "string",
            "default": "invoice"
          },
          "liveMode": {
            "description": "本番モードかどうか\n- false テストモード\n- true 本番モード\n",
            "type": "boolean"
          },
          "customer": {
            "$ref": "#/components/schemas/CustomerDto"
          },
          "invoiceNo": {
            "description": "Invoice Number",
            "type": "string",
            "maxLength": 255
          },
          "name": {
            "description": "インボイス件名",
            "type": "string",
            "maxLength": 255
          },
          "memo": {
            "description": "インボイスメモ",
            "type": "string",
            "maxLength": 255
          },
          "amount": {
            "description": "支払い金額",
            "type": "integer"
          },
          "currency": {
            "description": "通貨コード (ISO_4217)",
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "default": "JPY"
          },
          "status": {
            "$ref": "#/components/schemas/InvoiceStatusType"
          },
          "operator": {
            "description": "操作者",
            "type": "string",
            "maxLength": 255
          },
          "invoiceTime": {
            "description": "請求日（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          },
          "sendTime": {
            "description": "送信時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          },
          "paidTime": {
            "description": "支払い時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          },
          "expiryTime": {
            "description": "支払い請求有効時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          },
          "createTime": {
            "description": "作成時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          },
          "fields": {
            "description": "インボイスフィールドリスト",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "items": {
            "description": "インボイスアイテムリスト",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/InvoiceItem"
            }
          },
          "remark": {
            "description": "追加説明",
            "type": "string"
          },
          "metadata": {
            "description": "メタデータ",
            "type": "object",
            "maxProperties": 20,
            "propertyNames": {
              "type": "string",
              "maxLength": 20
            },
            "additionalProperties": {
              "type": "string"
            }
          },
          "enableAutoCharge": {
            "description": "自動支払いを有効にするかどうか。\ntrue 有効、false 無効\n",
            "type": "boolean"
          }
        }
      },
      "InvoiceItem": {
        "description": "インボイスアイテムオブジェクト",
        "properties": {
          "id": {
            "description": "Invoice Item ID",
            "type": "string",
            "maxLength": 32
          },
          "object": {
            "description": "対象種類の表記",
            "type": "string",
            "default": "invoiceItem"
          },
          "name": {
            "description": "商品名",
            "type": "string",
            "maxLength": 255
          },
          "unitPrice": {
            "description": "単価",
            "type": "integer"
          },
          "currency": {
            "description": "通貨コード (ISO_4217)",
            "type": "string",
            "minLength": 3,
            "maxLength": 3,
            "default": "JPY"
          },
          "quantity": {
            "description": "件数",
            "type": "integer"
          },
          "unit": {
            "description": "単位",
            "type": "string"
          },
          "taxRateType": {
            "$ref": "#/components/schemas/TaxRateType"
          },
          "transactionTime": {
            "description": "取引時間（エポックミリ秒）",
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "ChargeLocationStatusType": {
        "description": "ロケーションステータス\n- active 有効\n- submitted 提出済み\n",
        "type": "string",
        "enum": [
          "active",
          "submitted"
        ]
      },
      "ChargeLocationDto": {
        "description": "ロケーションオブジェクト",
        "type": "object",
        "properties": {
          "id": {
            "description": "Location ID",
            "type": "string",
            "maxLength": 32
          },
          "name": {
            "$ref": "#/components/schemas/StringTransliterationDto"
          },
          "tel": {
            "description": "電話番号",
            "type": "string",
            "maxLength": 20
          },
          "zip": {
            "description": "郵便番号",
            "type": "string",
            "maxLength": 8
          },
          "address": {
            "$ref": "#/components/schemas/AddressTransliterationDto"
          },
          "latitude": {
            "description": "緯度",
            "type": "number",
            "format": "double"
          },
          "longitude": {
            "description": "経度",
            "type": "number",
            "format": "double"
          },
          "note": {
            "description": "備考",
            "type": "string"
          },
          "status": {
            "$ref": "#/components/schemas/ChargeLocationStatusType"
          }
        }
      },
      "AddressTransliterationDto": {
        "description": "住所内容オブジェクト",
        "type": "object",
        "properties": {
          "kanji": {
            "$ref": "#/components/schemas/AddressDto"
          },
          "kana": {
            "$ref": "#/components/schemas/AddressDto"
          },
          "romaji": {
            "$ref": "#/components/schemas/AddressDto"
          }
        }
      },
      "StringTransliterationDto": {
        "description": "名前内容オブジェクト",
        "type": "object",
        "properties": {
          "kanji": {
            "description": "漢字",
            "type": "string"
          },
          "kana": {
            "description": "カナ",
            "type": "string"
          },
          "romaji": {
            "description": "ローマ字",
            "type": "string"
          }
        }
      },
      "AddressDto": {
        "description": "住所オブジェクト",
        "type": "object",
        "properties": {
          "pref": {
            "description": "都道府県",
            "type": "string"
          },
          "city": {
            "description": "市区町村",
            "type": "string"
          },
          "town": {
            "description": "町域",
            "type": "string"
          },
          "address1": {
            "description": "住所1",
            "type": "string"
          },
          "address2": {
            "description": "住所2",
            "type": "string"
          }
        }
      }
    }
  }
}
```