InvoiceProperties Class

Package:: com.azure.resourcemanager.billing.models

Maven Artifact:: com.azure.resourcemanager:azure-resourcemanager-billing:1.0.0

java.lang.Object
- com.azure.resourcemanager.billing.models.InvoiceProperties

Implements

public final class InvoiceProperties
implements JsonSerializable<InvoiceProperties>

An invoice.

Constructor Summary

Constructor	Description
InvoiceProperties()	Creates an instance of InvoiceProperties class.

Method Summary

Modifier and Type	Method and Description
InvoicePropertiesAmountDue	amountDue() Get the amountDue property: The amount due as of now.
InvoicePropertiesAzurePrepaymentApplied	azurePrepaymentApplied() Get the azurePrepaymentApplied property: The amount of Azure prepayment applied to the charges.
InvoicePropertiesBilledAmount	billedAmount() Get the billedAmount property: The total charges for the invoice billing period.
String	billedDocumentId() Get the billedDocumentId property: The Id of the active invoice which is originally billed after this invoice was voided.
String	billingProfileDisplayName() Get the billingProfileDisplayName property: The name of the billing profile for which the invoice is generated.
String	billingProfileId() Get the billingProfileId property: The ID of the billing profile for which the invoice is generated.
InvoicePropertiesCreditAmount	creditAmount() Get the creditAmount property: The total refund for returns and cancellations during the invoice billing period.
String	creditForDocumentId() Get the creditForDocumentId property: The Id of the invoice which got voided and this credit note was issued as a result.
List<InvoiceDocument>	documents() Get the documents property: List of documents available to download and view such as invoice, credit note, or tax receipt.
InvoiceDocumentType	documentType() Get the documentType property: The type of the document.
OffsetDateTime	dueDate() Get the dueDate property: The due date for the invoice.
List<FailedPayment>	failedPayments() Get the failedPayments property: List of failed payments.
InvoicePropertiesFreeAzureCreditApplied	freeAzureCreditApplied() Get the freeAzureCreditApplied property: The amount of free Azure credits applied to the charges.
static InvoiceProperties	fromJson(JsonReader jsonReader) Reads an instance of InvoiceProperties from the JsonReader.
OffsetDateTime	invoiceDate() Get the invoiceDate property: The date when the invoice was generated.
OffsetDateTime	invoicePeriodEndDate() Get the invoicePeriodEndDate property: The end date of the billing period for which the invoice is generated.
OffsetDateTime	invoicePeriodStartDate() Get the invoicePeriodStartDate property: The start date of the billing period for which the invoice is generated.
InvoiceType	invoiceType() Get the invoiceType property: Invoice type.
Boolean	isMonthlyInvoice() Get the isMonthlyInvoice property: Specifies if the invoice is generated as part of monthly invoicing cycle or not.
List<Payment>	payments() Get the payments property: List of payments.
String	purchaseOrderNumber() Get the purchaseOrderNumber property: An optional purchase order number for the invoice.
InvoicePropertiesRebillDetails	rebillDetails() Get the rebillDetails property: Rebill details for an invoice.
InvoicePropertiesRefundDetails	refundDetails() Get the refundDetails property: The details of a refund request.
SpecialTaxationType	specialTaxationType() Get the specialTaxationType property: Identifies the type of tax calculation used for the invoice.
InvoiceStatus	status() Get the status property: The current status of the invoice.
String	subscriptionDisplayName() Get the subscriptionDisplayName property: The name of the billing subscription for which the invoice is generated.
String	subscriptionId() Get the subscriptionId property: The ID of the subscription for which the invoice is generated.
InvoicePropertiesSubTotal	subTotal() Get the subTotal property: The pre-tax amount due.
InvoicePropertiesTaxAmount	taxAmount() Get the taxAmount property: The amount of tax charged for the billing period.
JsonWriter	toJson(JsonWriter jsonWriter)
InvoicePropertiesTotalAmount	totalAmount() Get the totalAmount property: The amount due when the invoice was generated.
void	validate() Validates the instance.
InvoiceProperties	withAmountDue(InvoicePropertiesAmountDue amountDue) Set the amountDue property: The amount due as of now.
InvoiceProperties	withAzurePrepaymentApplied(InvoicePropertiesAzurePrepaymentApplied azurePrepaymentApplied) Set the azurePrepaymentApplied property: The amount of Azure prepayment applied to the charges.
InvoiceProperties	withBilledAmount(InvoicePropertiesBilledAmount billedAmount) Set the billedAmount property: The total charges for the invoice billing period.
InvoiceProperties	withCreditAmount(InvoicePropertiesCreditAmount creditAmount) Set the creditAmount property: The total refund for returns and cancellations during the invoice billing period.
InvoiceProperties	withFreeAzureCreditApplied(InvoicePropertiesFreeAzureCreditApplied freeAzureCreditApplied) Set the freeAzureCreditApplied property: The amount of free Azure credits applied to the charges.
InvoiceProperties	withRebillDetails(InvoicePropertiesRebillDetails rebillDetails) Set the rebillDetails property: Rebill details for an invoice.
InvoiceProperties	withRefundDetails(InvoicePropertiesRefundDetails refundDetails) Set the refundDetails property: The details of a refund request.
InvoiceProperties	withSubTotal(InvoicePropertiesSubTotal subTotal) Set the subTotal property: The pre-tax amount due.
InvoiceProperties	withTaxAmount(InvoicePropertiesTaxAmount taxAmount) Set the taxAmount property: The amount of tax charged for the billing period.
InvoiceProperties	withTotalAmount(InvoicePropertiesTotalAmount totalAmount) Set the totalAmount property: The amount due when the invoice was generated.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

InvoiceProperties

public InvoiceProperties()

Creates an instance of InvoiceProperties class.

Method Details

amountDue

public InvoicePropertiesAmountDue amountDue()

Get the amountDue property: The amount due as of now.

Returns:

the amountDue value.

azurePrepaymentApplied

public InvoicePropertiesAzurePrepaymentApplied azurePrepaymentApplied()

Get the azurePrepaymentApplied property: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Returns:

the azurePrepaymentApplied value.

billedAmount

public InvoicePropertiesBilledAmount billedAmount()

Get the billedAmount property: The total charges for the invoice billing period.

Returns:

the billedAmount value.

billedDocumentId

public String billedDocumentId()

Get the billedDocumentId property: The Id of the active invoice which is originally billed after this invoice was voided. This field is applicable to the void invoices only.

Returns:

the billedDocumentId value.

billingProfileDisplayName

public String billingProfileDisplayName()

Get the billingProfileDisplayName property: The name of the billing profile for which the invoice is generated.

Returns:

the billingProfileDisplayName value.

billingProfileId

public String billingProfileId()

Get the billingProfileId property: The ID of the billing profile for which the invoice is generated.

Returns:

the billingProfileId value.

creditAmount

public InvoicePropertiesCreditAmount creditAmount()

Get the creditAmount property: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Returns:

the creditAmount value.

creditForDocumentId

public String creditForDocumentId()

Get the creditForDocumentId property: The Id of the invoice which got voided and this credit note was issued as a result. This field is applicable to the credit notes only.

Returns:

the creditForDocumentId value.

documents

public List<InvoiceDocument> documents()

Get the documents property: List of documents available to download and view such as invoice, credit note, or tax receipt.

Returns:

the documents value.

documentType

public InvoiceDocumentType documentType()

Get the documentType property: The type of the document.

Returns:

the documentType value.

dueDate

public OffsetDateTime dueDate()

Get the dueDate property: The due date for the invoice.

Returns:

the dueDate value.

failedPayments

public List<FailedPayment> failedPayments()

Get the failedPayments property: List of failed payments.

Returns:

the failedPayments value.

freeAzureCreditApplied

public InvoicePropertiesFreeAzureCreditApplied freeAzureCreditApplied()

Get the freeAzureCreditApplied property: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Returns:

the freeAzureCreditApplied value.

fromJson

public static InvoiceProperties fromJson(JsonReader jsonReader)

Reads an instance of InvoiceProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of InvoiceProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the InvoiceProperties.

invoiceDate

public OffsetDateTime invoiceDate()

Get the invoiceDate property: The date when the invoice was generated.

Returns:

the invoiceDate value.

invoicePeriodEndDate

public OffsetDateTime invoicePeriodEndDate()

Get the invoicePeriodEndDate property: The end date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.

Returns:

the invoicePeriodEndDate value.

invoicePeriodStartDate

public OffsetDateTime invoicePeriodStartDate()

Get the invoicePeriodStartDate property: The start date of the billing period for which the invoice is generated. The date is in MM-DD-YYYY format.

Returns:

the invoicePeriodStartDate value.

invoiceType

public InvoiceType invoiceType()

Get the invoiceType property: Invoice type.

Returns:

the invoiceType value.

isMonthlyInvoice

public Boolean isMonthlyInvoice()

Get the isMonthlyInvoice property: Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Returns:

the isMonthlyInvoice value.

payments

public List<Payment> payments()

Get the payments property: List of payments.

Returns:

the payments value.

purchaseOrderNumber

public String purchaseOrderNumber()

Get the purchaseOrderNumber property: An optional purchase order number for the invoice.

Returns:

the purchaseOrderNumber value.

rebillDetails

public InvoicePropertiesRebillDetails rebillDetails()

Get the rebillDetails property: Rebill details for an invoice.

Returns:

the rebillDetails value.

refundDetails

public InvoicePropertiesRefundDetails refundDetails()

Get the refundDetails property: The details of a refund request.

Returns:

the refundDetails value.

specialTaxationType

public SpecialTaxationType specialTaxationType()

Get the specialTaxationType property: Identifies the type of tax calculation used for the invoice. The field is applicable only to invoices with special tax calculation logic.

Returns:

the specialTaxationType value.

status

public InvoiceStatus status()

Get the status property: The current status of the invoice.

Returns:

the status value.

subscriptionDisplayName

public String subscriptionDisplayName()

Get the subscriptionDisplayName property: The name of the billing subscription for which the invoice is generated.

Returns:

the subscriptionDisplayName value.

subscriptionId

public String subscriptionId()

Get the subscriptionId property: The ID of the subscription for which the invoice is generated.

Returns:

the subscriptionId value.

subTotal

public InvoicePropertiesSubTotal subTotal()

Get the subTotal property: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Returns:

the subTotal value.

taxAmount

public InvoicePropertiesTaxAmount taxAmount()

Get the taxAmount property: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Returns:

the taxAmount value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

totalAmount

public InvoicePropertiesTotalAmount totalAmount()

Get the totalAmount property: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Returns:

the totalAmount value.

validate

public void validate()

Validates the instance.

withAmountDue

public InvoiceProperties withAmountDue(InvoicePropertiesAmountDue amountDue)

Set the amountDue property: The amount due as of now.

Parameters:

amountDue - the amountDue value to set.

Returns:

the InvoiceProperties object itself.

withAzurePrepaymentApplied

public InvoiceProperties withAzurePrepaymentApplied(InvoicePropertiesAzurePrepaymentApplied azurePrepaymentApplied)

Set the azurePrepaymentApplied property: The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

azurePrepaymentApplied - the azurePrepaymentApplied value to set.

Returns:

the InvoiceProperties object itself.

withBilledAmount

public InvoiceProperties withBilledAmount(InvoicePropertiesBilledAmount billedAmount)

Set the billedAmount property: The total charges for the invoice billing period.

Parameters:

billedAmount - the billedAmount value to set.

Returns:

the InvoiceProperties object itself.

withCreditAmount

public InvoiceProperties withCreditAmount(InvoicePropertiesCreditAmount creditAmount)

Set the creditAmount property: The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

creditAmount - the creditAmount value to set.

Returns:

the InvoiceProperties object itself.

withFreeAzureCreditApplied

public InvoiceProperties withFreeAzureCreditApplied(InvoicePropertiesFreeAzureCreditApplied freeAzureCreditApplied)

Set the freeAzureCreditApplied property: The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

freeAzureCreditApplied - the freeAzureCreditApplied value to set.

Returns:

the InvoiceProperties object itself.

withRebillDetails

public InvoiceProperties withRebillDetails(InvoicePropertiesRebillDetails rebillDetails)

Set the rebillDetails property: Rebill details for an invoice.

Parameters:

rebillDetails - the rebillDetails value to set.

Returns:

the InvoiceProperties object itself.

withRefundDetails

public InvoiceProperties withRefundDetails(InvoicePropertiesRefundDetails refundDetails)

Set the refundDetails property: The details of a refund request.

Parameters:

refundDetails - the refundDetails value to set.

Returns:

the InvoiceProperties object itself.

withSubTotal

public InvoiceProperties withSubTotal(InvoicePropertiesSubTotal subTotal)

Set the subTotal property: The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

subTotal - the subTotal value to set.

Returns:

the InvoiceProperties object itself.

withTaxAmount

public InvoiceProperties withTaxAmount(InvoicePropertiesTaxAmount taxAmount)

Set the taxAmount property: The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

taxAmount - the taxAmount value to set.

Returns:

the InvoiceProperties object itself.

withTotalAmount

public InvoiceProperties withTotalAmount(InvoicePropertiesTotalAmount totalAmount)

Set the totalAmount property: The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.

Parameters:

totalAmount - the totalAmount value to set.

Returns:

the InvoiceProperties object itself.

Applies to

Feedback

Was this page helpful?