getDemandCostList

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

Classic/VPC環境で利用できます。

設定期間に基づいて月請求費用リストを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET、POST	/cost/getDemandCostList

リクエストヘッダ

Cost And Usage APIで共通して使用されるヘッダの詳細は、Cost And Usageの共通ヘッダをご参照ください。

リクエストクエリパラメータ

パラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`pageNo`	Integer	Optional	ページ番号
`pageSize`	Integer	Optional	ページサイズ 1,000以下(デフォルト: 1,000)
`isOrganization`	Boolean	Optional	Organizationサービスアカウントの統合照会かどうかマスターのみ使用可能 `isOrganization`、`isPartner`のいずれも`true`の場合、エラーを返す
`isPartner`	Boolean	Optional	パートナーアカウントの照会かどうかパートナー代表のみ使用可能 `isOrganization`、`isPartner`のいずれも`true`の場合、エラーを返す
`memberNoList`	List<String>	Optional	会員番号リストマスターまたはパートナー代表のみ使用可能
`startMonth`	String	Required	照会開始月(yyyyMM) 最大3か月照会可能 <例> 202401
`endMonth`	String	Required	照会最終月(yyyyMM) 最大3か月照会可能 <例> 202403
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://billingapi.apigw.ntruss.com/billing/v1/cost/getDemandCostList?startMonth=202401&endMonth=202401&responseFormatType=json' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Sub Account Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの詳細は、DemandCostListをご参照ください。

レスポンスステータスコード

NAVERクラウドプラットフォームでで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "getDemandCostListResponse": {
        "totalRows": 1,
        "demandCostList": [
            {
                "memberNo": "2760000",
                "demandMonth": "202401",
                "demandNo": "9540000",
                "integrationDemandNo": "",
                "demandAttribute": {
                    "code": "GEN",
                    "codeName": "General"
                },
                "useAmount": 36290,
                "promiseDiscountAmount": 0,
                "promotionDiscountAmount": 0,
                "etcDiscountAmount": 0,
                "customerDiscountAmount": 0,
                "productDiscountAmount": 0,
                "creditDiscountAmount": 0,
                "rounddownDiscountAmount": 90,
                "currencyDiscountAmount": 0,
                "coinUseAmount": 0,
                "defaultAmount": 0,
                "thisMonthDemandAmount": 36200,
                "thisMonthVatRatio": 0.1,
                "thisMonthVatAmount": 3620,
                "thisMonthAmountIncludingVat": 39820,
                "totalDemandAmount": 39820,
                "isPaidUp": true,
                "paidUpDate": "2024-02-01T07:08:30+0900",
                "overduePlusAmount": 0,
                "overdueRatio": 0.0,
                "thisMonthOverdueAmount": 39820,
                "beforeMonthDemandNo": "9180000",
                "totalOverdueAmount": 39820,
                "writeDate": "2024-02-01T06:44:51+0900",
                "memberPriceDiscountAmount": 0,
                "memberPromiseDiscountAddAmount": 0,
                "payCurrency": {
                    "code": "KRW",
                    "codeName": "South Korea Won"
                },
                "thisMonthAppliedExchangeRate": 1
            }
        ],
        "requestId": "0000001d-b737-47ef-9875-0d28ce000000",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

この記事は役に立ちましたか?

What's Next

getRegionList

リクエスト
レスポンス

タグ

Cost And Usage