請求書の概要を取得する
適用対象: パートナー センター | 21Vianet が運営するパートナー センター | Microsoft Cloud for US Government のパートナー センター
InvoiceSummaries を使用して、定期的な料金と 1 回限りの両方の料金の残高と合計料金を示す請求書の概要を取得できます。 InvoiceSummaries リソースには、通貨の種類ごとに請求書の概要が含まれています。
前提条件
パートナー センターの認証に関するページで説明している資格情報。 このシナリオでは、アプリとユーザーの資格情報を使用した認証のみがサポートされます。
有効な請求書識別子。
C#
通貨の種類ごとに InvoiceSummary を含む InvoiceSummaries コレクションを取得するには:
IAggregatePartner.Invoices コレクションを使用して、Overviews プロパティを呼び出します。
Get() メソッドを呼び出します。
個々の InvoiceSummary の残高を取得するには、コレクションのそのメンバーの BalanceAmount プロパティにアクセスします。
// IAggregatePartner scopedPartnerOperations;
// Get the invoice summaries collection.
var invoiceSummaries = scopedPartnerOperations.Invoices.Summaries.Get();
// Display the balance on the first invoice summary in the collection.
Console.Out.WriteLine("Current Account Balance: {0:C}", invoiceSummaries[0].BalanceAmount);
詳細については、次のコード例を参照してください。
- サンプル: コンソール テスト アプリ
- プロジェクト: PartnerSDK.FeatureSample
- クラス: GetInvoiceSummaries.cs
REST 要求
要求の構文
認証方法 | 要求 URI |
---|---|
GET | {baseURL}/v1/invoices/overviews HTTP/1.1 |
URI パラメーター
なし。
要求ヘッダー
詳細については、「パートナー センター REST ヘッダー」を参照してください。
[要求本文]
なし。
要求の例
GET https://api.partnercenter.microsoft.com/v1/invoices/summaries HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
MS-RequestId: a45e6643-1caf-4429-8f90-07c03d85bc2b
MS-CorrelationId: 57eb2ca7-755f-450f-9187-eae1e75a0114
Connection: Keep-Alive
REST 応答
成功した場合、このメソッドは応答本文で InvoiceSummaries リソースを返します。
応答の成功とエラーのコード
各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。 このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。 完全な一覧については、エラー コードに関するページを参照してください。
応答の例
HTTP/1.1 200 OK
Content-Length: 256
Content-Type: application/json; charset=utf-8
MS-CorrelationId: 57eb2ca7-755f-450f-9187-eae1e75a0114
MS-RequestId: a45e6643-1caf-4429-8f90-07c03d85bc2b
Date: Thu, 24 Mar 2016 05:21:01 GMT
{
"totalCount": 3,
"items": [
{
"balanceAmount": 751094.39,
"currencyCode": "GBP",
"currencySymbol": "£",
"accountingDate": "2018-03-16T00:00:00",
"firstInvoiceCreationDate": "2017-01-21T00:00:00Z",
"lastPaymentDate": "2017-01-01T12:00:00Z",
"lastPaymentAmount": 1000,
"latestInvoiceDate": "2018-03-16T00:00:00",
"details": [
{
"invoiceType": "Recurring",
"summary": {
"balanceAmount": 202955.87,
"currencyCode": "GBP",
"currencySymbol": "£",
"accountingDate": "2017-02-27T00:00:00Z",
"firstInvoiceCreationDate": "2017-01-21T00:00:00Z",
"lastPaymentDate": "2017-01-01T12:00:00Z",
"lastPaymentAmount": 1000,
"latestInvoiceDate": "0001-01-01T00:00:00",
"attributes": {
"objectType": "InvoiceSummary"
}
}
},
{
"invoiceType": "OneTime",
"summary": {
"balanceAmount": 548138.52,
"currencyCode": "GBP",
"currencySymbol": "£",
"accountingDate": "2018-03-16T00:00:00",
"firstInvoiceCreationDate": "2018-03-16T00:00:00",
"lastPaymentDate": "0001-01-01T00:00:00",
"lastPaymentAmount": 0,
"latestInvoiceDate": "2018-03-16T00:00:00",
"attributes": {
"objectType": "InvoiceSummary"
}
}
}
],
"links": {
"self": {
"uri": "/invoices/summary",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "InvoiceSummary"
}
},
{
"balanceAmount": 1230.33,
"currencyCode": "CHF",
"currencySymbol": "CHF",
"accountingDate": "2018-03-16T00:00:00",
"firstInvoiceCreationDate": "2018-03-16T00:00:00",
"lastPaymentDate": "0001-01-01T00:00:00",
"lastPaymentAmount": 0,
"latestInvoiceDate": "2018-03-16T00:00:00",
"details": [
{
"invoiceType": "OneTime",
"summary": {
"balanceAmount": 1230.33,
"currencyCode": "CHF",
"currencySymbol": "CHF",
"accountingDate": "2018-03-16T00:00:00",
"firstInvoiceCreationDate": "2018-03-16T00:00:00",
"lastPaymentDate": "0001-01-01T00:00:00",
"lastPaymentAmount": 0,
"latestInvoiceDate": "2018-03-16T00:00:00",
"attributes": {
"objectType": "InvoiceSummary"
}
}
}
],
"links": {
"self": {
"uri": "/invoices/summary",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "InvoiceSummary"
}
},
{
"balanceAmount": 1001.12,
"currencyCode": "EUR",
"currencySymbol": "€",
"accountingDate": "2018-03-16T00:00:00",
"firstInvoiceCreationDate": "2018-03-16T00:00:00",
"lastPaymentDate": "0001-01-01T00:00:00",
"lastPaymentAmount": 0,
"latestInvoiceDate": "2018-03-16T00:00:00",
"details": [
{
"invoiceType": "OneTime",
"summary": {
"balanceAmount": 1001.12,
"currencyCode": "EUR",
"currencySymbol": "€",
"accountingDate": "2018-03-16T00:00:00",
"firstInvoiceCreationDate": "2018-03-16T00:00:00",
"lastPaymentDate": "0001-01-01T00:00:00",
"lastPaymentAmount": 0,
"latestInvoiceDate": "2018-03-16T00:00:00",
"attributes": {
"objectType": "InvoiceSummary"
}
}
}
],
"links": {
"self": {
"uri": "/invoices/summary",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "InvoiceSummary"
}
}
],
"links": {
"self": {
"uri": "/invoices/summaries",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Collection"
}
}