Billing Accounts - Validate Payment Terms

Referenz

Dienst:: Billing

API-Version:: 2024-04-01

Überprüft die Zahlungsbedingungen für ein Abrechnungskonto mit dem Vertragstyp "Microsoft-Kundenvertrag" und dem Kontotyp "Enterprise".

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
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})?)$	Die ID, die ein Abrechnungskonto eindeutig identifiziert.
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2024-04-01.

Anforderungstext

Name	Typ	Beschreibung
parameters	PaymentTerm[]	Die Eigenschaften der Zahlungslaufzeit.

Antworten

Name	Typ	Beschreibung
200 OK	PaymentTermsEligibilityResult	Ergebnis der Zahlungsbedingungen.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

PaymentTermInvalid

PaymentTermValid

PaymentTermInvalid

Beispielanforderung

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

[
  {
    "term": "net10",
    "startDate": "2023-02-05T22:39:34.2606750Z",
    "endDate": "2023-01-25T22:39:34.2606750Z"
  }
]


import com.azure.resourcemanager.billing.models.PaymentTerm;
import java.time.OffsetDateTime;
import java.util.Arrays;

/**
 * Samples for BillingAccounts ValidatePaymentTerms.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermInvalid.json
     */
    /**
     * Sample code: PaymentTermInvalid.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void paymentTermInvalid(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingAccounts().validatePaymentTermsWithResponse(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
            Arrays.asList(
                new PaymentTerm().withTerm("net10").withStartDate(OffsetDateTime.parse("2023-02-05T22:39:34.2606750Z"))
                    .withEndDate(OffsetDateTime.parse("2023-01-25T22:39:34.2606750Z"))),
            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 payment_term_invalid.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.billing_accounts.validate_payment_terms(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        parameters=[
            {"endDate": "2023-01-25T22:39:34.2606750Z", "startDate": "2023-02-05T22:39:34.2606750Z", "term": "net10"}
        ],
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermInvalid.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"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/paymentTermInvalid.json
func ExampleAccountsClient_ValidatePaymentTerms_paymentTermInvalid() {
	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.NewAccountsClient().ValidatePaymentTerms(ctx, "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", []*armbilling.PaymentTerm{
		{
			EndDate:   to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-25T22:39:34.260Z"); return t }()),
			StartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-02-05T22:39:34.260Z"); return t }()),
			Term:      to.Ptr("net10"),
		}}, 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.PaymentTermsEligibilityResult = armbilling.PaymentTermsEligibilityResult{
	// 	EligibilityDetails: []*armbilling.PaymentTermsEligibilityDetail{
	// 		{
	// 			Code: to.Ptr(armbilling.PaymentTermsEligibilityCodeInvalidDateRange),
	// 			Message: to.Ptr("The date range is invalid. The start date must be before the end date."),
	// 	}},
	// 	EligibilityStatus: to.Ptr(armbilling.PaymentTermsEligibilityStatusInvalid),
	// }
}

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 Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.
 *
 * @summary Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermInvalid.json
 */
async function paymentTermInvalid() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const parameters = [
    {
      endDate: new Date("2023-01-25T22:39:34.2606750Z"),
      startDate: new Date("2023-02-05T22:39:34.2606750Z"),
      term: "net10",
    },
  ];
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.billingAccounts.validatePaymentTerms(billingAccountName, parameters);
  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/paymentTermInvalid.json
// this example is just showing the usage of "BillingAccounts_ValidatePaymentTerms" 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
IEnumerable<BillingPaymentTerm> arrayOfPaymentTerm = new BillingPaymentTerm[]
{
new BillingPaymentTerm
{
Term = "net10",
StartOn = DateTimeOffset.Parse("2023-02-05T22:39:34.2606750Z"),
EndOn = DateTimeOffset.Parse("2023-01-25T22:39:34.2606750Z"),
}
};
PaymentTermsEligibilityResult result = await billingAccount.ValidatePaymentTermsAsync(arrayOfPaymentTerm);

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "eligibilityStatus": "Invalid",
  "eligibilityDetails": [
    {
      "code": "InvalidDateRange",
      "message": "The date range is invalid. The start date must be before the end date."
    }
  ]
}

PaymentTermValid

Beispielanforderung

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

[
  {
    "term": "net10",
    "startDate": "2023-01-05T22:39:34.2606750Z",
    "endDate": "2023-01-25T22:39:34.2606750Z"
  }
]


import com.azure.resourcemanager.billing.models.PaymentTerm;
import java.time.OffsetDateTime;
import java.util.Arrays;

/**
 * Samples for BillingAccounts ValidatePaymentTerms.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermValid.json
     */
    /**
     * Sample code: PaymentTermValid.
     * 
     * @param manager Entry point to BillingManager.
     */
    public static void paymentTermValid(com.azure.resourcemanager.billing.BillingManager manager) {
        manager.billingAccounts().validatePaymentTermsWithResponse(
            "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
            Arrays.asList(
                new PaymentTerm().withTerm("net10").withStartDate(OffsetDateTime.parse("2023-01-05T22:39:34.2606750Z"))
                    .withEndDate(OffsetDateTime.parse("2023-01-25T22:39:34.2606750Z"))),
            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 payment_term_valid.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.billing_accounts.validate_payment_terms(
        billing_account_name="00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31",
        parameters=[
            {"endDate": "2023-01-25T22:39:34.2606750Z", "startDate": "2023-01-05T22:39:34.2606750Z", "term": "net10"}
        ],
    )
    print(response)


# x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermValid.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"

	"time"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"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/paymentTermValid.json
func ExampleAccountsClient_ValidatePaymentTerms_paymentTermValid() {
	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.NewAccountsClient().ValidatePaymentTerms(ctx, "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31", []*armbilling.PaymentTerm{
		{
			EndDate:   to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-25T22:39:34.260Z"); return t }()),
			StartDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-01-05T22:39:34.260Z"); return t }()),
			Term:      to.Ptr("net10"),
		}}, 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.PaymentTermsEligibilityResult = armbilling.PaymentTermsEligibilityResult{
	// 	EligibilityStatus: to.Ptr(armbilling.PaymentTermsEligibilityStatusValid),
	// }
}

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 Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.
 *
 * @summary Validates payment terms on a billing account with agreement type 'Microsoft Customer Agreement' and account type 'Enterprise'.
 * x-ms-original-file: specification/billing/resource-manager/Microsoft.Billing/stable/2024-04-01/examples/paymentTermValid.json
 */
async function paymentTermValid() {
  const billingAccountName =
    "00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000_2019-05-31";
  const parameters = [
    {
      endDate: new Date("2023-01-25T22:39:34.2606750Z"),
      startDate: new Date("2023-01-05T22:39:34.2606750Z"),
      term: "net10",
    },
  ];
  const credential = new DefaultAzureCredential();
  const client = new BillingManagementClient(credential);
  const result = await client.billingAccounts.validatePaymentTerms(billingAccountName, parameters);
  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/paymentTermValid.json
// this example is just showing the usage of "BillingAccounts_ValidatePaymentTerms" 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
IEnumerable<BillingPaymentTerm> arrayOfPaymentTerm = new BillingPaymentTerm[]
{
new BillingPaymentTerm
{
Term = "net10",
StartOn = DateTimeOffset.Parse("2023-01-05T22:39:34.2606750Z"),
EndOn = DateTimeOffset.Parse("2023-01-25T22:39:34.2606750Z"),
}
};
PaymentTermsEligibilityResult result = await billingAccount.ValidatePaymentTermsAsync(arrayOfPaymentTerm);

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "eligibilityStatus": "Valid"
}

Definitionen

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
PaymentTerm	Die Eigenschaften der Zahlungslaufzeit.
PaymentTermsEligibilityCode	Gibt den Grund für die Unzulässigkeit der Zahlungsbedingungen an.
PaymentTermsEligibilityDetail	Details zu den Zahlungsbedingungen.
PaymentTermsEligibilityResult	Ergebnis der Zahlungsbedingungen.
PaymentTermsEligibilityStatus	Gibt den Berechtigungsstatus der Zahlungsbedingungen an.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

PaymentTerm

Objekt

Die Eigenschaften der Zahlungslaufzeit.

Name	Typ	Beschreibung
endDate	string (date-time)	Das Datum, an dem der definierte "Zahlungstermin" endet und immer in UTC liegt.
isDefault	boolean	Gibt an, dass der Zahlungstermin der Standardzahlungstermin ist.
startDate	string (date-time)	Das Datum, an dem der definierte "Zahlungstermin" abläuft und immer in UTC liegt.
term	string	Stellt die Dauer im netXX-Format dar. Immer in Tagen.

PaymentTermsEligibilityCode

Enumeration

Gibt den Grund für die Unzulässigkeit der Zahlungsbedingungen an.

Wert	Beschreibung
BillingAccountNotFound
InactiveBillingAccount
IneligibleBillingAccountStatus
InvalidBillingAccountType
InvalidDateFormat
InvalidDateRange
InvalidTerms
NullOrEmptyPaymentTerms
Other
OverlappingPaymentTerms

PaymentTermsEligibilityDetail

Objekt

Details zu den Zahlungsbedingungen.

Name	Typ	Beschreibung
code	PaymentTermsEligibilityCode	Gibt den Grund für die Unzulässigkeit der Zahlungsbedingungen an.
message	string	Gibt die Meldung für die Unzulässigkeit der Zahlungsbedingungen an.

PaymentTermsEligibilityResult

Objekt

Ergebnis der Zahlungsbedingungen.

Name	Typ	Beschreibung
eligibilityDetails	PaymentTermsEligibilityDetail[]	Details zu den Zahlungsbedingungen.
eligibilityStatus	PaymentTermsEligibilityStatus	Gibt den Berechtigungsstatus der Zahlungsbedingungen an.

PaymentTermsEligibilityStatus

Enumeration

Gibt den Berechtigungsstatus der Zahlungsbedingungen an.

Wert	Beschreibung
Invalid
Other
Valid

Freigeben über

Billing Accounts - Validate Payment Terms

URI-Parameter

Anforderungstext

Antworten

Beispiele

PaymentTermInvalid

Beispielanforderung

Beispiel für eine Antwort

PaymentTermValid

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

PaymentTerm

PaymentTermsEligibilityCode

PaymentTermsEligibilityDetail

PaymentTermsEligibilityResult

PaymentTermsEligibilityStatus