getContractDemandCostList

印刷する
共有
PDF

記事の要約

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

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

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

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

リクエスト

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

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

リクエストヘッダ

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	会員番号リストマスターまたはパートナー代表のみ使用可能
`contractNo`	String	Optional	契約番号
`startMonth`	String	Required	照会開始月(yyyyMM) 最大3か月照会可能 <例> 202401
`endMonth`	String	Required	照会最終月(yyyyMM) 最大3か月照会可能 <例> 202403
`demandTypeCode`	String	Optional	請求タイプコード
`demandTypeDetailCode`	String	Optional	請求タイプ詳細コード
`regionCode`	String	Optional	リージョンコード getRegionListアクションを通じて確認
`responseFormatType`	String	Optional	レスポンス結果の形式 `xml`(デフォルト) \| `json`

リクエスト例

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

curl --location --request GET 'https://billingapi.apigw.ntruss.com/billing/v1/cost/getContractDemandCostList?startMonth=202403&endMonth=202403&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}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

{
    "getContractDemandCostListResponse": {
        "totalRows": 5,
        "contractDemandCostList": [
            {
                "memberNo": "2760000",
                "regionCode": "KR",
                "demandType": {
                    "code": "SW",
                    "codeName": "Software License"
                },
                "demandTypeDetail": {
                    "code": "SWST",
                    "codeName": "Software OS License Stop Usage "
                },
                "contract": {
                    "memberNo": "2760000",
                    "contractNo": "15430000",
                    "conjunctionContractNo": "15430000",
                    "contractType": {
                        "code": "SW",
                        "codeName": "Software"
                    },
                    "contractStatus": {
                        "code": "NLEND",
                        "codeName": "Normal termination"
                    },
                    "contractStartDate": "2024-01-09T11:40:50+0900",
                    "contractEndDate": "2024-01-24T11:35:45+0900",
                    "instanceName": "mysql(5.6)-ubuntu-14.04-64-server",
                    "regionCode": "KR",
                    "platformType": {},
                    "contractProductList": [
                        {
                            "contractProductSequence": "1",
                            "beforeContractProductSequence": "",
                            "productCode": "SPSW0LINUX000051",
                            "priceNo": "310",
                            "promiseNo": "",
                            "instanceNo": "22010000",
                            "productItemKind": {
                                "code": "SW",
                                "codeName": "Software"
                            },
                            "productRatingType": {
                                "code": "SW",
                                "codeName": "Software OS License"
                            },
                            "serviceStatus": {
                                "code": "END",
                                "codeName": "Termination"
                            },
                            "serviceStartDate": "2024-01-09T11:40:50+0900",
                            "serviceEndDate": "2024-01-24T11:35:45+0900",
                            "productSize": 0,
                            "productCount": 0,
                            "usageList": []
                        }
                    ]
                },
                "demandMonth": "202401",
                "unitUsageQuantity": 0,
                "packageUnitUsageQuantity": 0,
                "totalUnitUsageQuantity": 0,
                "usageUnit": {
                    "code": "USAGE_DAY",
                    "codeName": "Usage time (per day)"
                },
                "productPrice": 0,
                "useAmount": 0,
                "promotionDiscountAmount": 0,
                "etcDiscountAmount": 0,
                "promiseDiscountAmount": 0,
                "demandAmount": 0,
                "writeDate": "2024-02-01T04:49:20+0900",
                "memberPriceDiscountAmount": 0,
                "memberPromiseDiscountAddAmount": 0,
                "payCurrency": {
                    "code": "KRW",
                    "codeName": "South Korea Won"
                },
                "sectionPriceList": [],
                "thisMonthAppliedExchangeRate": 1
            },
// (省略)
        ],
        "requestId": "0000002a-2448-4e2c-8b14-eeacc1000000",
        "returnCode": "0",
        "returnMessage": "success"
    }
}

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

What's Next

getProductDemandCostList

リクエスト
レスポンス

タグ

Cost And Usage