Available Balances - Get By Billing Account

Referensi

Layanan:: Billing

Versi API:: 2024-04-01

Kredit atau Pembayaran yang Tersedia pada Saldo Akun untuk akun penagihan. Saldo kredit dapat digunakan untuk menyelesaikan faktur jatuh tempo atau lewat jatuh tempo dan didukung untuk akun penagihan dengan jenis perjanjian Perjanjian Pelanggan Microsoft. Pembayaran saldo akun didukung untuk akun penagihan dengan jenis perjanjian Perjanjian Pelanggan Microsoft atau Program Layanan Online Microsoft.

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/availableBalance/default?api-version=2024-04-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
billingAccountName	path	True	string pattern: ^([0-9]+\|([Pp][Cc][Nn]\.[A-Za-z0-9]+)\|[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}(:[0-9A-Fa-f]{8}-([0-9A-Fa-f]{4}-){3}[0-9A-Fa-f]{12}_[0-9]{4}(-[0-9]{2}){2})?)$	ID yang secara unik mengidentifikasi akun penagihan.
api-version	query	True	string	Versi API yang akan digunakan dengan permintaan klien. Versi saat ini adalah 2024-04-01.

Respons

Nama	Jenis	Deskripsi
200 OK	AvailableBalance	Kredit atau Pembayaran yang Tersedia pada Saldo Akun. Saldo kredit dapat digunakan untuk menyelesaikan faktur jatuh tempo atau lewat jatuh tempo.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

AvailableBalanceGetByBillingAccount

Permintaan sampel

GET https://management.azure.com/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/availableBalance/default?api-version=2024-04-01


/**
 * Samples for AvailableBalances GetByBillingAccount.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/
     * availableBalanceGetByBillingAccount.json
     */
    /**
     * Sample code: AvailableBalanceGetByBillingAccount.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void availableBalanceGetByBillingAccount(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.availableBalances().getByBillingAccountWithResponse(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.billing import BillingManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-billing
# USAGE
    python available_balance_get_by_billing_account.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = BillingManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="SUBSCRIPTION_ID",
    )

    response = client.available_balances.get_by_billing_account(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingAccount.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armbilling_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/billing/armbilling"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c08ac9813477921ad8295b98ced8f82d11b8f913/specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingAccount.json
func ExampleAvailableBalancesClient_GetByBillingAccount() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armbilling.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAvailableBalancesClient().GetByBillingAccount(ctx, "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.AvailableBalance = armbilling.AvailableBalance{
	// 	Name: to.Ptr("default"),
	// 	Type: to.Ptr("Microsoft.Billing/billingAccounts/availableBalance"),
	// 	ID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/availableBalance/default"),
	// 	Properties: &armbilling.AvailableBalanceProperties{
	// 		Amount: &armbilling.AvailableBalancePropertiesAmount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](500),
	// 		},
	// 		PaymentsOnAccount: []*armbilling.PaymentOnAccount{
	// 			{
	// 				Amount: &armbilling.PaymentOnAccountAmount{
	// 					Currency: to.Ptr("USD"),
	// 					Value: to.Ptr[float32](50),
	// 				},
	// 				BillingProfileDisplayName: to.Ptr("Contoso Finance"),
	// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx"),
	// 				Date: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2024-04-01T00:00:00.000Z"); return t}()),
	// 				InvoiceID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789"),
	// 				InvoiceName: to.Ptr("G123456789"),
	// 				PaymentMethodType: to.Ptr(armbilling.PaymentMethodFamilyCheckWire),
	// 			},
	// 			{
	// 				Amount: &armbilling.PaymentOnAccountAmount{
	// 					Currency: to.Ptr("USD"),
	// 					Value: to.Ptr[float32](150),
	// 				},
	// 				BillingProfileDisplayName: to.Ptr("Contoso Engineering"),
	// 				BillingProfileID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/yyyy-yyyy-yyy-yyy"),
	// 				Date: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-01T00:00:00.000Z"); return t}()),
	// 				InvoiceID: to.Ptr("/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321"),
	// 				InvoiceName: to.Ptr("G987654321"),
	// 				PaymentMethodType: to.Ptr(armbilling.PaymentMethodFamilyCheckWire),
	// 		}},
	// 		TotalPaymentsOnAccount: &armbilling.AvailableBalancePropertiesTotalPaymentsOnAccount{
	// 			Currency: to.Ptr("USD"),
	// 			Value: to.Ptr[float32](200),
	// 		},
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { BillingManagementClient } = require("@azure/arm-billing");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to The Available Credit or Payment on Account Balance for a billing account. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Online Services Program.
 *
 * @summary The Available Credit or Payment on Account Balance for a billing account. The credit balance can be used to settle due or past due invoices and is supported for billing accounts with agreement type Microsoft Customer Agreement. The payment on account balance is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Online Services Program.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingAccount.json
 */
async function availableBalanceGetByBillingAccount() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.availableBalances.getByBillingAccount(billingAccountName);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Billing.Models;
using Azure.ResourceManager.Billing;

// Generated from example definition: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/availableBalanceGetByBillingAccount.json
// this example is just showing the usage of "AvailableBalances_GetByBillingAccount" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this BillingAccountResource created on azure
// for more information of creating BillingAccountResource, please refer to the document of BillingAccountResource
string billingAccountName = "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
ResourceIdentifier billingAccountResourceId = BillingAccountResource.CreateResourceIdentifier(billingAccountName);
BillingAccountResource billingAccount = client.GetBillingAccountResource(billingAccountResourceId);

// invoke the operation
BillingAvailableBalanceData result = await billingAccount.GetBillingAccountAvailableBalanceAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respon sampel

Kode status:: 200

{
  "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/availableBalance/default",
  "name": "default",
  "properties": {
    "amount": {
      "currency": "USD",
      "value": 500
    },
    "paymentsOnAccount": [
      {
        "amount": {
          "currency": "USD",
          "value": 50
        },
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/xxxx-xxxx-xxx-xxx",
        "billingProfileDisplayName": "Contoso Finance",
        "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G123456789",
        "invoiceName": "G123456789",
        "date": "2024-04-01T00:00:00.0000000Z",
        "paymentMethodType": "CheckWire"
      },
      {
        "amount": {
          "currency": "USD",
          "value": 150
        },
        "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/billingProfiles/yyyy-yyyy-yyy-yyy",
        "billingProfileDisplayName": "Contoso Engineering",
        "invoiceId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31/invoices/G987654321",
        "invoiceName": "G987654321",
        "date": "2023-01-01T00:00:00.0000000Z",
        "paymentMethodType": "CheckWire"
      }
    ],
    "totalPaymentsOnAccount": {
      "currency": "USD",
      "value": 200
    }
  },
  "type": "Microsoft.Billing/billingAccounts/availableBalance"
}

Definisi

Nama	Deskripsi
Amount	Jumlahnya.
AvailableBalance	Kredit atau Pembayaran yang Tersedia pada Saldo Akun. Saldo kredit dapat digunakan untuk menyelesaikan faktur jatuh tempo atau lewat jatuh tempo.
AvailableBalanceProperties	Kredit atau Pembayaran yang Tersedia pada Saldo Akun. Saldo kredit dapat digunakan untuk menyelesaikan faktur jatuh tempo atau lewat jatuh tempo.
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
PaymentMethodFamily	Pembayaran pada jenis Akun.
PaymentOnAccount	Pembayaran di Akun.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.
TotalPaymentsOnAccount	Jumlah total pembayaran pada akun.

Amount

Objek

Jumlahnya.

Nama	Jenis	Deskripsi
currency	string	Mata uang untuk nilai jumlah.
value	number	Nilai jumlah. Misalnya, jika mata uang adalah USD, maka nilai 600 adalah $600,00.

AvailableBalance

Objek

Kredit atau Pembayaran yang Tersedia pada Saldo Akun. Saldo kredit dapat digunakan untuk menyelesaikan faktur jatuh tempo atau lewat jatuh tempo.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya
properties	AvailableBalanceProperties	Kredit atau Pembayaran yang Tersedia pada Saldo Akun. Saldo kredit dapat digunakan untuk menyelesaikan faktur jatuh tempo atau lewat jatuh tempo.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
tags	object	Kamus metadata yang terkait dengan sumber daya. Ini mungkin tidak diisi untuk semua jenis sumber daya. Panjang kunci/nilai maksimum yang didukung 256 karakter. Kunci/nilai tidak boleh kosong nilai atau null. Kunci tidak dapat berisi <> % & \ ? /
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

AvailableBalanceProperties

Objek

Kredit atau Pembayaran yang Tersedia pada Saldo Akun. Saldo kredit dapat digunakan untuk menyelesaikan faktur jatuh tempo atau lewat jatuh tempo.

Nama	Jenis	Deskripsi
amount	Amount	Jumlah kredit untuk pembayaran segera.
paymentsOnAccount	PaymentOnAccount[]	Daftar pembayaran pada akun.
totalPaymentsOnAccount	TotalPaymentsOnAccount	Jumlah total pembayaran pada akun.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

PaymentMethodFamily

Enumeration

Pembayaran pada jenis Akun.

Nilai	Deskripsi
CheckWire
CreditCard
Credits
DirectDebit
EWallet
None
Other
TaskOrder

PaymentOnAccount

Objek

Pembayaran di Akun.

Nama	Jenis	Deskripsi
amount	Amount	Pembayaran pada jumlah Rekening.
billingProfileDisplayName	string	Nama profil penagihan untuk pembayaran di akun.
billingProfileId	string	ID profil penagihan untuk pembayaran di akun.
date	string (date-time)	Tanggal pembayaran pada akun.
invoiceId	string	ID faktur tempat pembayaran pada akun dibuat.
invoiceName	string	Nama faktur untuk pembayaran di akun.
paymentMethodType	PaymentMethodFamily	Pembayaran pada jenis Akun.

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.

TotalPaymentsOnAccount

Objek

Jumlah total pembayaran pada akun.

Nama	Jenis	Deskripsi
currency	string	Mata uang untuk nilai jumlah.
value	number	Nilai jumlah. Misalnya, jika mata uang adalah USD, maka nilai 600 adalah $600,00.