invoice

package
v0.20241209.1115630 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 9, 2024 License: MPL-2.0 Imports: 15 Imported by: 1

README

github.com/hashicorp/go-azure-sdk/resource-manager/billing/2024-04-01/invoice Documentation

The invoice SDK allows for interaction with Azure Resource Manager billing (API Version 2024-04-01).

This readme covers example usages, but further information on using this SDK can be found in the project root.

Import Path

import "github.com/hashicorp/go-azure-sdk/resource-manager/billing/2024-04-01/invoice"

Client Initialization

client := invoice.NewInvoiceClientWithBaseURI("https://management.azure.com")
client.Client.Authorizer = authorizer

Example Usage: InvoiceClient.Amend

ctx := context.TODO()
id := invoice.NewBillingAccountInvoiceID("billingAccountName", "invoiceName")

if err := client.AmendThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: InvoiceClient.DownloadByBillingAccount

ctx := context.TODO()
id := invoice.NewBillingAccountInvoiceID("billingAccountName", "invoiceName")

if err := client.DownloadByBillingAccountThenPoll(ctx, id, invoice.DefaultDownloadByBillingAccountOperationOptions()); err != nil {
	// handle the error
}

Example Usage: InvoiceClient.DownloadByBillingSubscription

ctx := context.TODO()
id := invoice.NewBillingSubscriptionInvoiceID("subscriptionId", "invoiceName")

if err := client.DownloadByBillingSubscriptionThenPoll(ctx, id, invoice.DefaultDownloadByBillingSubscriptionOperationOptions()); err != nil {
	// handle the error
}

Example Usage: InvoiceClient.DownloadDocumentsByBillingAccount

ctx := context.TODO()
id := invoice.NewBillingAccountID("billingAccountName")
var payload []DocumentDownloadRequest

if err := client.DownloadDocumentsByBillingAccountThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: InvoiceClient.DownloadDocumentsByBillingSubscription

ctx := context.TODO()
id := invoice.NewBillingSubscriptionID("subscriptionId")
var payload []DocumentDownloadRequest

if err := client.DownloadDocumentsByBillingSubscriptionThenPoll(ctx, id, payload); err != nil {
	// handle the error
}

Example Usage: InvoiceClient.DownloadSummaryByBillingAccount

ctx := context.TODO()
id := invoice.NewBillingAccountInvoiceID("billingAccountName", "invoiceName")

if err := client.DownloadSummaryByBillingAccountThenPoll(ctx, id); err != nil {
	// handle the error
}

Example Usage: InvoiceClient.Get

ctx := context.TODO()
id := invoice.NewInvoiceID("invoiceName")

read, err := client.Get(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: InvoiceClient.GetByBillingAccount

ctx := context.TODO()
id := invoice.NewBillingAccountInvoiceID("billingAccountName", "invoiceName")

read, err := client.GetByBillingAccount(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: InvoiceClient.GetByBillingSubscription

ctx := context.TODO()
id := invoice.NewBillingSubscriptionInvoiceID("subscriptionId", "invoiceName")

read, err := client.GetByBillingSubscription(ctx, id)
if err != nil {
	// handle the error
}
if model := read.Model; model != nil {
	// do something with the model/response object
}

Example Usage: InvoiceClient.ListByBillingAccount

ctx := context.TODO()
id := invoice.NewBillingAccountID("billingAccountName")

// alternatively `client.ListByBillingAccount(ctx, id, invoice.DefaultListByBillingAccountOperationOptions())` can be used to do batched pagination
items, err := client.ListByBillingAccountComplete(ctx, id, invoice.DefaultListByBillingAccountOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: InvoiceClient.ListByBillingProfile

ctx := context.TODO()
id := invoice.NewBillingProfileID("billingAccountName", "billingProfileName")

// alternatively `client.ListByBillingProfile(ctx, id, invoice.DefaultListByBillingProfileOperationOptions())` can be used to do batched pagination
items, err := client.ListByBillingProfileComplete(ctx, id, invoice.DefaultListByBillingProfileOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Example Usage: InvoiceClient.ListByBillingSubscription

ctx := context.TODO()
id := invoice.NewBillingSubscriptionID("subscriptionId")

// alternatively `client.ListByBillingSubscription(ctx, id, invoice.DefaultListByBillingSubscriptionOperationOptions())` can be used to do batched pagination
items, err := client.ListByBillingSubscriptionComplete(ctx, id, invoice.DefaultListByBillingSubscriptionOperationOptions())
if err != nil {
	// handle the error
}
for _, item := range items {
	// do something
}

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PossibleValuesForDocumentSource 

func PossibleValuesForDocumentSource() []string

func PossibleValuesForFailedPaymentReason 

func PossibleValuesForFailedPaymentReason() []string

func PossibleValuesForInvoiceDocumentType 

func PossibleValuesForInvoiceDocumentType() []string

func PossibleValuesForInvoiceStatus 

func PossibleValuesForInvoiceStatus() []string

func PossibleValuesForInvoiceType 

func PossibleValuesForInvoiceType() []string

func PossibleValuesForPaymentMethodFamily 

func PossibleValuesForPaymentMethodFamily() []string

func PossibleValuesForRefundReasonCode 

func PossibleValuesForRefundReasonCode() []string

func PossibleValuesForRefundStatus 

func PossibleValuesForRefundStatus() []string

func PossibleValuesForSpecialTaxationType 

func PossibleValuesForSpecialTaxationType() []string

func ValidateBillingAccountID 

func ValidateBillingAccountID(input interface{}, key string) (warnings []string, errors []error)

ValidateBillingAccountID checks that 'input' can be parsed as a Billing Account ID

func ValidateBillingAccountInvoiceID 

func ValidateBillingAccountInvoiceID(input interface{}, key string) (warnings []string, errors []error)

ValidateBillingAccountInvoiceID checks that 'input' can be parsed as a Billing Account Invoice ID

func ValidateBillingProfileID 

func ValidateBillingProfileID(input interface{}, key string) (warnings []string, errors []error)

ValidateBillingProfileID checks that 'input' can be parsed as a Billing Profile ID

func ValidateBillingSubscriptionID 

func ValidateBillingSubscriptionID(input interface{}, key string) (warnings []string, errors []error)

ValidateBillingSubscriptionID checks that 'input' can be parsed as a Billing Subscription ID

func ValidateBillingSubscriptionInvoiceID 

func ValidateBillingSubscriptionInvoiceID(input interface{}, key string) (warnings []string, errors []error)

ValidateBillingSubscriptionInvoiceID checks that 'input' can be parsed as a Billing Subscription Invoice ID

func ValidateInvoiceID 

func ValidateInvoiceID(input interface{}, key string) (warnings []string, errors []error)

ValidateInvoiceID checks that 'input' can be parsed as a Invoice ID

Types

type AmendOperationResponse 

type AmendOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
}

type Amount 

type Amount struct {
	Currency *string  `json:"currency,omitempty"`
	Value    *float64 `json:"value,omitempty"`
}

type BillingAccountId 

type BillingAccountId struct {
	BillingAccountName string
}

BillingAccountId is a struct representing the Resource ID for a Billing Account

func NewBillingAccountID 

func NewBillingAccountID(billingAccountName string) BillingAccountId

NewBillingAccountID returns a new BillingAccountId struct

func ParseBillingAccountID 

func ParseBillingAccountID(input string) (*BillingAccountId, error)

ParseBillingAccountID parses 'input' into a BillingAccountId

func ParseBillingAccountIDInsensitively 

func ParseBillingAccountIDInsensitively(input string) (*BillingAccountId, error)

ParseBillingAccountIDInsensitively parses 'input' case-insensitively into a BillingAccountId note: this method should only be used for API response data and not user input

func (*BillingAccountId) FromParseResult 

func (id *BillingAccountId) FromParseResult(input resourceids.ParseResult) error

func (BillingAccountId) ID 

func (id BillingAccountId) ID() string

ID returns the formatted Billing Account ID

func (BillingAccountId) Segments 

func (id BillingAccountId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Billing Account ID

func (BillingAccountId) String 

func (id BillingAccountId) String() string

String returns a human-readable description of this Billing Account ID

type BillingAccountInvoiceId 

type BillingAccountInvoiceId struct {
	BillingAccountName string
	InvoiceName        string
}

BillingAccountInvoiceId is a struct representing the Resource ID for a Billing Account Invoice

func NewBillingAccountInvoiceID 

func NewBillingAccountInvoiceID(billingAccountName string, invoiceName string) BillingAccountInvoiceId

NewBillingAccountInvoiceID returns a new BillingAccountInvoiceId struct

func ParseBillingAccountInvoiceID 

func ParseBillingAccountInvoiceID(input string) (*BillingAccountInvoiceId, error)

ParseBillingAccountInvoiceID parses 'input' into a BillingAccountInvoiceId

func ParseBillingAccountInvoiceIDInsensitively 

func ParseBillingAccountInvoiceIDInsensitively(input string) (*BillingAccountInvoiceId, error)

ParseBillingAccountInvoiceIDInsensitively parses 'input' case-insensitively into a BillingAccountInvoiceId note: this method should only be used for API response data and not user input

func (*BillingAccountInvoiceId) FromParseResult 

func (id *BillingAccountInvoiceId) FromParseResult(input resourceids.ParseResult) error

func (BillingAccountInvoiceId) ID 

func (id BillingAccountInvoiceId) ID() string

ID returns the formatted Billing Account Invoice ID

func (BillingAccountInvoiceId) Segments 

func (id BillingAccountInvoiceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Billing Account Invoice ID

func (BillingAccountInvoiceId) String 

func (id BillingAccountInvoiceId) String() string

String returns a human-readable description of this Billing Account Invoice ID

type BillingProfileId 

type BillingProfileId struct {
	BillingAccountName string
	BillingProfileName string
}

BillingProfileId is a struct representing the Resource ID for a Billing Profile

func NewBillingProfileID 

func NewBillingProfileID(billingAccountName string, billingProfileName string) BillingProfileId

NewBillingProfileID returns a new BillingProfileId struct

func ParseBillingProfileID 

func ParseBillingProfileID(input string) (*BillingProfileId, error)

ParseBillingProfileID parses 'input' into a BillingProfileId

func ParseBillingProfileIDInsensitively 

func ParseBillingProfileIDInsensitively(input string) (*BillingProfileId, error)

ParseBillingProfileIDInsensitively parses 'input' case-insensitively into a BillingProfileId note: this method should only be used for API response data and not user input

func (*BillingProfileId) FromParseResult 

func (id *BillingProfileId) FromParseResult(input resourceids.ParseResult) error

func (BillingProfileId) ID 

func (id BillingProfileId) ID() string

ID returns the formatted Billing Profile ID

func (BillingProfileId) Segments 

func (id BillingProfileId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Billing Profile ID

func (BillingProfileId) String 

func (id BillingProfileId) String() string

String returns a human-readable description of this Billing Profile ID

type BillingSubscriptionId 

type BillingSubscriptionId struct {
	SubscriptionId string
}

BillingSubscriptionId is a struct representing the Resource ID for a Billing Subscription

func NewBillingSubscriptionID 

func NewBillingSubscriptionID(subscriptionId string) BillingSubscriptionId

NewBillingSubscriptionID returns a new BillingSubscriptionId struct

func ParseBillingSubscriptionID 

func ParseBillingSubscriptionID(input string) (*BillingSubscriptionId, error)

ParseBillingSubscriptionID parses 'input' into a BillingSubscriptionId

func ParseBillingSubscriptionIDInsensitively 

func ParseBillingSubscriptionIDInsensitively(input string) (*BillingSubscriptionId, error)

ParseBillingSubscriptionIDInsensitively parses 'input' case-insensitively into a BillingSubscriptionId note: this method should only be used for API response data and not user input

func (*BillingSubscriptionId) FromParseResult 

func (id *BillingSubscriptionId) FromParseResult(input resourceids.ParseResult) error

func (BillingSubscriptionId) ID 

func (id BillingSubscriptionId) ID() string

ID returns the formatted Billing Subscription ID

func (BillingSubscriptionId) Segments 

func (id BillingSubscriptionId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Billing Subscription ID

func (BillingSubscriptionId) String 

func (id BillingSubscriptionId) String() string

String returns a human-readable description of this Billing Subscription ID

type BillingSubscriptionInvoiceId 

type BillingSubscriptionInvoiceId struct {
	SubscriptionId string
	InvoiceName    string
}

BillingSubscriptionInvoiceId is a struct representing the Resource ID for a Billing Subscription Invoice

func NewBillingSubscriptionInvoiceID 

func NewBillingSubscriptionInvoiceID(subscriptionId string, invoiceName string) BillingSubscriptionInvoiceId

NewBillingSubscriptionInvoiceID returns a new BillingSubscriptionInvoiceId struct

func ParseBillingSubscriptionInvoiceID 

func ParseBillingSubscriptionInvoiceID(input string) (*BillingSubscriptionInvoiceId, error)

ParseBillingSubscriptionInvoiceID parses 'input' into a BillingSubscriptionInvoiceId

func ParseBillingSubscriptionInvoiceIDInsensitively 

func ParseBillingSubscriptionInvoiceIDInsensitively(input string) (*BillingSubscriptionInvoiceId, error)

ParseBillingSubscriptionInvoiceIDInsensitively parses 'input' case-insensitively into a BillingSubscriptionInvoiceId note: this method should only be used for API response data and not user input

func (*BillingSubscriptionInvoiceId) FromParseResult 

func (id *BillingSubscriptionInvoiceId) FromParseResult(input resourceids.ParseResult) error

func (BillingSubscriptionInvoiceId) ID 

func (id BillingSubscriptionInvoiceId) ID() string

ID returns the formatted Billing Subscription Invoice ID

func (BillingSubscriptionInvoiceId) Segments 

func (id BillingSubscriptionInvoiceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Billing Subscription Invoice ID

func (BillingSubscriptionInvoiceId) String 

func (id BillingSubscriptionInvoiceId) String() string

String returns a human-readable description of this Billing Subscription Invoice ID

type DocumentDownloadRequest 

type DocumentDownloadRequest struct {
	DocumentName *string `json:"documentName,omitempty"`
	InvoiceName  *string `json:"invoiceName,omitempty"`
}

type DocumentDownloadResult 

type DocumentDownloadResult struct {
	ExpiryTime *string `json:"expiryTime,omitempty"`
	Url        *string `json:"url,omitempty"`
}

type DocumentSource 

type DocumentSource string
const (
	DocumentSourceDRS   DocumentSource = "DRS"
	DocumentSourceENF   DocumentSource = "ENF"
	DocumentSourceOther DocumentSource = "Other"
)

func (*DocumentSource) UnmarshalJSON 

func (s *DocumentSource) UnmarshalJSON(bytes []byte) error

type DownloadByBillingAccountOperationOptions 

type DownloadByBillingAccountOperationOptions struct {
	DocumentName *string
}

func DefaultDownloadByBillingAccountOperationOptions 

func DefaultDownloadByBillingAccountOperationOptions() DownloadByBillingAccountOperationOptions

func (DownloadByBillingAccountOperationOptions) ToHeaders 

func (o DownloadByBillingAccountOperationOptions) ToHeaders() *client.Headers

func (DownloadByBillingAccountOperationOptions) ToOData 

func (o DownloadByBillingAccountOperationOptions) ToOData() *odata.Query

func (DownloadByBillingAccountOperationOptions) ToQuery 

func (o DownloadByBillingAccountOperationOptions) ToQuery() *client.QueryParams

type DownloadByBillingAccountOperationResponse 

type DownloadByBillingAccountOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DocumentDownloadResult
}

type DownloadByBillingSubscriptionOperationOptions 

type DownloadByBillingSubscriptionOperationOptions struct {
	DocumentName *string
}

func DefaultDownloadByBillingSubscriptionOperationOptions 

func DefaultDownloadByBillingSubscriptionOperationOptions() DownloadByBillingSubscriptionOperationOptions

func (DownloadByBillingSubscriptionOperationOptions) ToHeaders 

func (o DownloadByBillingSubscriptionOperationOptions) ToHeaders() *client.Headers

func (DownloadByBillingSubscriptionOperationOptions) ToOData 

func (o DownloadByBillingSubscriptionOperationOptions) ToOData() *odata.Query

func (DownloadByBillingSubscriptionOperationOptions) ToQuery 

func (o DownloadByBillingSubscriptionOperationOptions) ToQuery() *client.QueryParams

type DownloadByBillingSubscriptionOperationResponse 

type DownloadByBillingSubscriptionOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DocumentDownloadResult
}

type DownloadDocumentsByBillingAccountOperationResponse 

type DownloadDocumentsByBillingAccountOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DocumentDownloadResult
}

type DownloadDocumentsByBillingSubscriptionOperationResponse 

type DownloadDocumentsByBillingSubscriptionOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DocumentDownloadResult
}

type DownloadSummaryByBillingAccountOperationResponse 

type DownloadSummaryByBillingAccountOperationResponse struct {
	Poller       pollers.Poller
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *DocumentDownloadResult
}

type FailedPayment 

type FailedPayment struct {
	Date                *string              `json:"date,omitempty"`
	FailedPaymentReason *FailedPaymentReason `json:"failedPaymentReason,omitempty"`
}

func (*FailedPayment) GetDateAsTime 

func (o *FailedPayment) GetDateAsTime() (*time.Time, error)

func (*FailedPayment) SetDateAsTime 

func (o *FailedPayment) SetDateAsTime(input time.Time)

type FailedPaymentReason 

type FailedPaymentReason string
const (
	FailedPaymentReasonBankDeclined         FailedPaymentReason = "BankDeclined"
	FailedPaymentReasonCardExpired          FailedPaymentReason = "CardExpired"
	FailedPaymentReasonIncorrectCardDetails FailedPaymentReason = "IncorrectCardDetails"
	FailedPaymentReasonOther                FailedPaymentReason = "Other"
)

func (*FailedPaymentReason) UnmarshalJSON 

func (s *FailedPaymentReason) UnmarshalJSON(bytes []byte) error

type GetByBillingAccountOperationResponse 

type GetByBillingAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Invoice
}

type GetByBillingSubscriptionOperationResponse 

type GetByBillingSubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Invoice
}

type GetOperationResponse 

type GetOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *Invoice
}

type Invoice 

type Invoice struct {
	Id         *string                `json:"id,omitempty"`
	Name       *string                `json:"name,omitempty"`
	Properties *InvoiceProperties     `json:"properties,omitempty"`
	SystemData *systemdata.SystemData `json:"systemData,omitempty"`
	Tags       *map[string]string     `json:"tags,omitempty"`
	Type       *string                `json:"type,omitempty"`
}

type InvoiceClient 

type InvoiceClient struct {
	Client *resourcemanager.Client
}

func NewInvoiceClientWithBaseURI 

func NewInvoiceClientWithBaseURI(sdkApi sdkEnv.Api) (*InvoiceClient, error)

func (InvoiceClient) Amend 

func (c InvoiceClient) Amend(ctx context.Context, id BillingAccountInvoiceId) (result AmendOperationResponse, err error)

Amend ...

func (InvoiceClient) AmendThenPoll 

func (c InvoiceClient) AmendThenPoll(ctx context.Context, id BillingAccountInvoiceId) error

AmendThenPoll performs Amend then polls until it's completed

func (InvoiceClient) DownloadByBillingAccount 

func (c InvoiceClient) DownloadByBillingAccount(ctx context.Context, id BillingAccountInvoiceId, options DownloadByBillingAccountOperationOptions) (result DownloadByBillingAccountOperationResponse, err error)

DownloadByBillingAccount ...

func (InvoiceClient) DownloadByBillingAccountThenPoll 

func (c InvoiceClient) DownloadByBillingAccountThenPoll(ctx context.Context, id BillingAccountInvoiceId, options DownloadByBillingAccountOperationOptions) error

DownloadByBillingAccountThenPoll performs DownloadByBillingAccount then polls until it's completed

func (InvoiceClient) DownloadByBillingSubscription 

func (c InvoiceClient) DownloadByBillingSubscription(ctx context.Context, id BillingSubscriptionInvoiceId, options DownloadByBillingSubscriptionOperationOptions) (result DownloadByBillingSubscriptionOperationResponse, err error)

DownloadByBillingSubscription ...

func (InvoiceClient) DownloadByBillingSubscriptionThenPoll 

func (c InvoiceClient) DownloadByBillingSubscriptionThenPoll(ctx context.Context, id BillingSubscriptionInvoiceId, options DownloadByBillingSubscriptionOperationOptions) error

DownloadByBillingSubscriptionThenPoll performs DownloadByBillingSubscription then polls until it's completed

func (InvoiceClient) DownloadDocumentsByBillingAccount 

func (c InvoiceClient) DownloadDocumentsByBillingAccount(ctx context.Context, id BillingAccountId, input []DocumentDownloadRequest) (result DownloadDocumentsByBillingAccountOperationResponse, err error)

DownloadDocumentsByBillingAccount ...

func (InvoiceClient) DownloadDocumentsByBillingAccountThenPoll 

func (c InvoiceClient) DownloadDocumentsByBillingAccountThenPoll(ctx context.Context, id BillingAccountId, input []DocumentDownloadRequest) error

DownloadDocumentsByBillingAccountThenPoll performs DownloadDocumentsByBillingAccount then polls until it's completed

func (InvoiceClient) DownloadDocumentsByBillingSubscription 

func (c InvoiceClient) DownloadDocumentsByBillingSubscription(ctx context.Context, id BillingSubscriptionId, input []DocumentDownloadRequest) (result DownloadDocumentsByBillingSubscriptionOperationResponse, err error)

DownloadDocumentsByBillingSubscription ...

func (InvoiceClient) DownloadDocumentsByBillingSubscriptionThenPoll 

func (c InvoiceClient) DownloadDocumentsByBillingSubscriptionThenPoll(ctx context.Context, id BillingSubscriptionId, input []DocumentDownloadRequest) error

DownloadDocumentsByBillingSubscriptionThenPoll performs DownloadDocumentsByBillingSubscription then polls until it's completed

func (InvoiceClient) DownloadSummaryByBillingAccount 

func (c InvoiceClient) DownloadSummaryByBillingAccount(ctx context.Context, id BillingAccountInvoiceId) (result DownloadSummaryByBillingAccountOperationResponse, err error)

DownloadSummaryByBillingAccount ...

func (InvoiceClient) DownloadSummaryByBillingAccountThenPoll 

func (c InvoiceClient) DownloadSummaryByBillingAccountThenPoll(ctx context.Context, id BillingAccountInvoiceId) error

DownloadSummaryByBillingAccountThenPoll performs DownloadSummaryByBillingAccount then polls until it's completed

func (InvoiceClient) Get 

func (c InvoiceClient) Get(ctx context.Context, id InvoiceId) (result GetOperationResponse, err error)

Get ...

func (InvoiceClient) GetByBillingAccount 

func (c InvoiceClient) GetByBillingAccount(ctx context.Context, id BillingAccountInvoiceId) (result GetByBillingAccountOperationResponse, err error)

GetByBillingAccount ...

func (InvoiceClient) GetByBillingSubscription 

func (c InvoiceClient) GetByBillingSubscription(ctx context.Context, id BillingSubscriptionInvoiceId) (result GetByBillingSubscriptionOperationResponse, err error)

GetByBillingSubscription ...

func (InvoiceClient) ListByBillingAccount 

func (c InvoiceClient) ListByBillingAccount(ctx context.Context, id BillingAccountId, options ListByBillingAccountOperationOptions) (result ListByBillingAccountOperationResponse, err error)

ListByBillingAccount ...

func (InvoiceClient) ListByBillingAccountComplete 

func (c InvoiceClient) ListByBillingAccountComplete(ctx context.Context, id BillingAccountId, options ListByBillingAccountOperationOptions) (ListByBillingAccountCompleteResult, error)

ListByBillingAccountComplete retrieves all the results into a single object

func (InvoiceClient) ListByBillingAccountCompleteMatchingPredicate 

func (c InvoiceClient) ListByBillingAccountCompleteMatchingPredicate(ctx context.Context, id BillingAccountId, options ListByBillingAccountOperationOptions, predicate InvoiceOperationPredicate) (result ListByBillingAccountCompleteResult, err error)

ListByBillingAccountCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (InvoiceClient) ListByBillingProfile 

func (c InvoiceClient) ListByBillingProfile(ctx context.Context, id BillingProfileId, options ListByBillingProfileOperationOptions) (result ListByBillingProfileOperationResponse, err error)

ListByBillingProfile ...

func (InvoiceClient) ListByBillingProfileComplete 

func (c InvoiceClient) ListByBillingProfileComplete(ctx context.Context, id BillingProfileId, options ListByBillingProfileOperationOptions) (ListByBillingProfileCompleteResult, error)

ListByBillingProfileComplete retrieves all the results into a single object

func (InvoiceClient) ListByBillingProfileCompleteMatchingPredicate 

func (c InvoiceClient) ListByBillingProfileCompleteMatchingPredicate(ctx context.Context, id BillingProfileId, options ListByBillingProfileOperationOptions, predicate InvoiceOperationPredicate) (result ListByBillingProfileCompleteResult, err error)

ListByBillingProfileCompleteMatchingPredicate retrieves all the results and then applies the predicate

func (InvoiceClient) ListByBillingSubscription 

func (c InvoiceClient) ListByBillingSubscription(ctx context.Context, id BillingSubscriptionId, options ListByBillingSubscriptionOperationOptions) (result ListByBillingSubscriptionOperationResponse, err error)

ListByBillingSubscription ...

func (InvoiceClient) ListByBillingSubscriptionComplete 

func (c InvoiceClient) ListByBillingSubscriptionComplete(ctx context.Context, id BillingSubscriptionId, options ListByBillingSubscriptionOperationOptions) (ListByBillingSubscriptionCompleteResult, error)

ListByBillingSubscriptionComplete retrieves all the results into a single object

func (InvoiceClient) ListByBillingSubscriptionCompleteMatchingPredicate 

func (c InvoiceClient) ListByBillingSubscriptionCompleteMatchingPredicate(ctx context.Context, id BillingSubscriptionId, options ListByBillingSubscriptionOperationOptions, predicate InvoiceOperationPredicate) (result ListByBillingSubscriptionCompleteResult, err error)

ListByBillingSubscriptionCompleteMatchingPredicate retrieves all the results and then applies the predicate

type InvoiceDocument 

type InvoiceDocument struct {
	DocumentNumbers *[]string            `json:"documentNumbers,omitempty"`
	ExternalURL     *string              `json:"externalUrl,omitempty"`
	Kind            *InvoiceDocumentType `json:"kind,omitempty"`
	Name            *string              `json:"name,omitempty"`
	Source          *DocumentSource      `json:"source,omitempty"`
	Url             *string              `json:"url,omitempty"`
}

type InvoiceDocumentType 

type InvoiceDocumentType string
const (
	InvoiceDocumentTypeCreditNote   InvoiceDocumentType = "CreditNote"
	InvoiceDocumentTypeInvoice      InvoiceDocumentType = "Invoice"
	InvoiceDocumentTypeOther        InvoiceDocumentType = "Other"
	InvoiceDocumentTypeSummary      InvoiceDocumentType = "Summary"
	InvoiceDocumentTypeTaxReceipt   InvoiceDocumentType = "TaxReceipt"
	InvoiceDocumentTypeTransactions InvoiceDocumentType = "Transactions"
	InvoiceDocumentTypeVoidNote     InvoiceDocumentType = "VoidNote"
)

func (*InvoiceDocumentType) UnmarshalJSON 

func (s *InvoiceDocumentType) UnmarshalJSON(bytes []byte) error

type InvoiceId 

type InvoiceId struct {
	InvoiceName string
}

InvoiceId is a struct representing the Resource ID for a Invoice

func NewInvoiceID 

func NewInvoiceID(invoiceName string) InvoiceId

NewInvoiceID returns a new InvoiceId struct

func ParseInvoiceID 

func ParseInvoiceID(input string) (*InvoiceId, error)

ParseInvoiceID parses 'input' into a InvoiceId

func ParseInvoiceIDInsensitively 

func ParseInvoiceIDInsensitively(input string) (*InvoiceId, error)

ParseInvoiceIDInsensitively parses 'input' case-insensitively into a InvoiceId note: this method should only be used for API response data and not user input

func (*InvoiceId) FromParseResult 

func (id *InvoiceId) FromParseResult(input resourceids.ParseResult) error

func (InvoiceId) ID 

func (id InvoiceId) ID() string

ID returns the formatted Invoice ID

func (InvoiceId) Segments 

func (id InvoiceId) Segments() []resourceids.Segment

Segments returns a slice of Resource ID Segments which comprise this Invoice ID

func (InvoiceId) String 

func (id InvoiceId) String() string

String returns a human-readable description of this Invoice ID

type InvoiceOperationPredicate 

type InvoiceOperationPredicate struct {
	Id   *string
	Name *string
	Type *string
}

func (InvoiceOperationPredicate) Matches 

func (p InvoiceOperationPredicate) Matches(input Invoice) bool

type InvoiceProperties 

type InvoiceProperties struct {
	AmountDue                 *Amount               `json:"amountDue,omitempty"`
	AzurePrepaymentApplied    *Amount               `json:"azurePrepaymentApplied,omitempty"`
	BilledAmount              *Amount               `json:"billedAmount,omitempty"`
	BilledDocumentId          *string               `json:"billedDocumentId,omitempty"`
	BillingProfileDisplayName *string               `json:"billingProfileDisplayName,omitempty"`
	BillingProfileId          *string               `json:"billingProfileId,omitempty"`
	CreditAmount              *Amount               `json:"creditAmount,omitempty"`
	CreditForDocumentId       *string               `json:"creditForDocumentId,omitempty"`
	DocumentType              *InvoiceDocumentType  `json:"documentType,omitempty"`
	Documents                 *[]InvoiceDocument    `json:"documents,omitempty"`
	DueDate                   *string               `json:"dueDate,omitempty"`
	FailedPayments            *[]FailedPayment      `json:"failedPayments,omitempty"`
	FreeAzureCreditApplied    *Amount               `json:"freeAzureCreditApplied,omitempty"`
	InvoiceDate               *string               `json:"invoiceDate,omitempty"`
	InvoicePeriodEndDate      *string               `json:"invoicePeriodEndDate,omitempty"`
	InvoicePeriodStartDate    *string               `json:"invoicePeriodStartDate,omitempty"`
	InvoiceType               *InvoiceType          `json:"invoiceType,omitempty"`
	IsMonthlyInvoice          *bool                 `json:"isMonthlyInvoice,omitempty"`
	Payments                  *[]Payment            `json:"payments,omitempty"`
	PurchaseOrderNumber       *string               `json:"purchaseOrderNumber,omitempty"`
	RebillDetails             *RebillDetails        `json:"rebillDetails,omitempty"`
	RefundDetails             *RefundDetailsSummary `json:"refundDetails,omitempty"`
	SpecialTaxationType       *SpecialTaxationType  `json:"specialTaxationType,omitempty"`
	Status                    *InvoiceStatus        `json:"status,omitempty"`
	SubTotal                  *Amount               `json:"subTotal,omitempty"`
	SubscriptionDisplayName   *string               `json:"subscriptionDisplayName,omitempty"`
	SubscriptionId            *string               `json:"subscriptionId,omitempty"`
	TaxAmount                 *Amount               `json:"taxAmount,omitempty"`
	TotalAmount               *Amount               `json:"totalAmount,omitempty"`
}

func (*InvoiceProperties) GetDueDateAsTime 

func (o *InvoiceProperties) GetDueDateAsTime() (*time.Time, error)

func (*InvoiceProperties) GetInvoiceDateAsTime 

func (o *InvoiceProperties) GetInvoiceDateAsTime() (*time.Time, error)

func (*InvoiceProperties) GetInvoicePeriodEndDateAsTime 

func (o *InvoiceProperties) GetInvoicePeriodEndDateAsTime() (*time.Time, error)

func (*InvoiceProperties) GetInvoicePeriodStartDateAsTime 

func (o *InvoiceProperties) GetInvoicePeriodStartDateAsTime() (*time.Time, error)

func (*InvoiceProperties) SetDueDateAsTime 

func (o *InvoiceProperties) SetDueDateAsTime(input time.Time)

func (*InvoiceProperties) SetInvoiceDateAsTime 

func (o *InvoiceProperties) SetInvoiceDateAsTime(input time.Time)

func (*InvoiceProperties) SetInvoicePeriodEndDateAsTime 

func (o *InvoiceProperties) SetInvoicePeriodEndDateAsTime(input time.Time)

func (*InvoiceProperties) SetInvoicePeriodStartDateAsTime 

func (o *InvoiceProperties) SetInvoicePeriodStartDateAsTime(input time.Time)

type InvoiceStatus 

type InvoiceStatus string
const (
	InvoiceStatusDue     InvoiceStatus = "Due"
	InvoiceStatusLocked  InvoiceStatus = "Locked"
	InvoiceStatusOther   InvoiceStatus = "Other"
	InvoiceStatusOverDue InvoiceStatus = "OverDue"
	InvoiceStatusPaid    InvoiceStatus = "Paid"
	InvoiceStatusVoid    InvoiceStatus = "Void"
)

func (*InvoiceStatus) UnmarshalJSON 

func (s *InvoiceStatus) UnmarshalJSON(bytes []byte) error

type InvoiceType 

type InvoiceType string
const (
	InvoiceTypeAzureMarketplace InvoiceType = "AzureMarketplace"
	InvoiceTypeAzureServices    InvoiceType = "AzureServices"
	InvoiceTypeAzureSupport     InvoiceType = "AzureSupport"
	InvoiceTypeOther            InvoiceType = "Other"
)

func (*InvoiceType) UnmarshalJSON 

func (s *InvoiceType) UnmarshalJSON(bytes []byte) error

type ListByBillingAccountCompleteResult 

type ListByBillingAccountCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Invoice
}

type ListByBillingAccountCustomPager added in v0.20240628.1153531 

type ListByBillingAccountCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByBillingAccountCustomPager) NextPageLink() *odata.Link

type ListByBillingAccountOperationOptions 

type ListByBillingAccountOperationOptions struct {
	Count           *bool
	Filter          *string
	OrderBy         *string
	PeriodEndDate   *string
	PeriodStartDate *string
	Search          *string
	Skip            *int64
	Top             *int64
}

func DefaultListByBillingAccountOperationOptions 

func DefaultListByBillingAccountOperationOptions() ListByBillingAccountOperationOptions

func (ListByBillingAccountOperationOptions) ToHeaders 

func (o ListByBillingAccountOperationOptions) ToHeaders() *client.Headers

func (ListByBillingAccountOperationOptions) ToOData 

func (o ListByBillingAccountOperationOptions) ToOData() *odata.Query

func (ListByBillingAccountOperationOptions) ToQuery 

func (o ListByBillingAccountOperationOptions) ToQuery() *client.QueryParams

type ListByBillingAccountOperationResponse 

type ListByBillingAccountOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Invoice
}

type ListByBillingProfileCompleteResult 

type ListByBillingProfileCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Invoice
}

type ListByBillingProfileCustomPager added in v0.20240628.1153531 

type ListByBillingProfileCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByBillingProfileCustomPager) NextPageLink() *odata.Link

type ListByBillingProfileOperationOptions 

type ListByBillingProfileOperationOptions struct {
	Count           *bool
	Filter          *string
	OrderBy         *string
	PeriodEndDate   *string
	PeriodStartDate *string
	Search          *string
	Skip            *int64
	Top             *int64
}

func DefaultListByBillingProfileOperationOptions 

func DefaultListByBillingProfileOperationOptions() ListByBillingProfileOperationOptions

func (ListByBillingProfileOperationOptions) ToHeaders 

func (o ListByBillingProfileOperationOptions) ToHeaders() *client.Headers

func (ListByBillingProfileOperationOptions) ToOData 

func (o ListByBillingProfileOperationOptions) ToOData() *odata.Query

func (ListByBillingProfileOperationOptions) ToQuery 

func (o ListByBillingProfileOperationOptions) ToQuery() *client.QueryParams

type ListByBillingProfileOperationResponse 

type ListByBillingProfileOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Invoice
}

type ListByBillingSubscriptionCompleteResult 

type ListByBillingSubscriptionCompleteResult struct {
	LatestHttpResponse *http.Response
	Items              []Invoice
}

type ListByBillingSubscriptionCustomPager added in v0.20240628.1153531 

type ListByBillingSubscriptionCustomPager struct {
	NextLink *odata.Link `json:"nextLink"`
}
func (p *ListByBillingSubscriptionCustomPager) NextPageLink() *odata.Link

type ListByBillingSubscriptionOperationOptions 

type ListByBillingSubscriptionOperationOptions struct {
	Count           *bool
	Filter          *string
	OrderBy         *string
	PeriodEndDate   *string
	PeriodStartDate *string
	Search          *string
	Skip            *int64
	Top             *int64
}

func DefaultListByBillingSubscriptionOperationOptions 

func DefaultListByBillingSubscriptionOperationOptions() ListByBillingSubscriptionOperationOptions

func (ListByBillingSubscriptionOperationOptions) ToHeaders 

func (o ListByBillingSubscriptionOperationOptions) ToHeaders() *client.Headers

func (ListByBillingSubscriptionOperationOptions) ToOData 

func (o ListByBillingSubscriptionOperationOptions) ToOData() *odata.Query

func (ListByBillingSubscriptionOperationOptions) ToQuery 

func (o ListByBillingSubscriptionOperationOptions) ToQuery() *client.QueryParams

type ListByBillingSubscriptionOperationResponse 

type ListByBillingSubscriptionOperationResponse struct {
	HttpResponse *http.Response
	OData        *odata.OData
	Model        *[]Invoice
}

type Payment 

type Payment struct {
	Amount              *Amount              `json:"amount,omitempty"`
	Date                *string              `json:"date,omitempty"`
	PaymentMethodFamily *PaymentMethodFamily `json:"paymentMethodFamily,omitempty"`
	PaymentMethodId     *string              `json:"paymentMethodId,omitempty"`
	PaymentMethodType   *string              `json:"paymentMethodType,omitempty"`
	PaymentType         *string              `json:"paymentType,omitempty"`
}

func (*Payment) GetDateAsTime 

func (o *Payment) GetDateAsTime() (*time.Time, error)

func (*Payment) SetDateAsTime 

func (o *Payment) SetDateAsTime(input time.Time)

type PaymentMethodFamily 

type PaymentMethodFamily string
const (
	PaymentMethodFamilyCheckWire   PaymentMethodFamily = "CheckWire"
	PaymentMethodFamilyCreditCard  PaymentMethodFamily = "CreditCard"
	PaymentMethodFamilyCredits     PaymentMethodFamily = "Credits"
	PaymentMethodFamilyDirectDebit PaymentMethodFamily = "DirectDebit"
	PaymentMethodFamilyEWallet     PaymentMethodFamily = "EWallet"
	PaymentMethodFamilyNone        PaymentMethodFamily = "None"
	PaymentMethodFamilyOther       PaymentMethodFamily = "Other"
	PaymentMethodFamilyTaskOrder   PaymentMethodFamily = "TaskOrder"
)

func (*PaymentMethodFamily) UnmarshalJSON 

func (s *PaymentMethodFamily) UnmarshalJSON(bytes []byte) error

type RebillDetails 

type RebillDetails struct {
	CreditNoteDocumentId *string        `json:"creditNoteDocumentId,omitempty"`
	InvoiceDocumentId    *string        `json:"invoiceDocumentId,omitempty"`
	RebillDetails        *RebillDetails `json:"rebillDetails,omitempty"`
}

type RefundDetailsSummary 

type RefundDetailsSummary struct {
	AmountRefunded    *Amount           `json:"amountRefunded,omitempty"`
	AmountRequested   *Amount           `json:"amountRequested,omitempty"`
	ApprovedOn        *string           `json:"approvedOn,omitempty"`
	CompletedOn       *string           `json:"completedOn,omitempty"`
	RebillInvoiceId   *string           `json:"rebillInvoiceId,omitempty"`
	RefundOperationId *string           `json:"refundOperationId,omitempty"`
	RefundReason      *RefundReasonCode `json:"refundReason,omitempty"`
	RefundStatus      *RefundStatus     `json:"refundStatus,omitempty"`
	RequestedOn       *string           `json:"requestedOn,omitempty"`
	TransactionCount  *int64            `json:"transactionCount,omitempty"`
}

func (*RefundDetailsSummary) GetApprovedOnAsTime 

func (o *RefundDetailsSummary) GetApprovedOnAsTime() (*time.Time, error)

func (*RefundDetailsSummary) GetCompletedOnAsTime 

func (o *RefundDetailsSummary) GetCompletedOnAsTime() (*time.Time, error)

func (*RefundDetailsSummary) GetRequestedOnAsTime 

func (o *RefundDetailsSummary) GetRequestedOnAsTime() (*time.Time, error)

func (*RefundDetailsSummary) SetApprovedOnAsTime 

func (o *RefundDetailsSummary) SetApprovedOnAsTime(input time.Time)

func (*RefundDetailsSummary) SetCompletedOnAsTime 

func (o *RefundDetailsSummary) SetCompletedOnAsTime(input time.Time)

func (*RefundDetailsSummary) SetRequestedOnAsTime 

func (o *RefundDetailsSummary) SetRequestedOnAsTime(input time.Time)

type RefundReasonCode 

type RefundReasonCode string
const (
	RefundReasonCodeAccidentalConversion RefundReasonCode = "AccidentalConversion"
	RefundReasonCodeAccidentalPurchase   RefundReasonCode = "AccidentalPurchase"
	RefundReasonCodeForgotToCancel       RefundReasonCode = "ForgotToCancel"
	RefundReasonCodeOther                RefundReasonCode = "Other"
	RefundReasonCodeUnclearDocumentation RefundReasonCode = "UnclearDocumentation"
	RefundReasonCodeUnclearPricing       RefundReasonCode = "UnclearPricing"
)

func (*RefundReasonCode) UnmarshalJSON 

func (s *RefundReasonCode) UnmarshalJSON(bytes []byte) error

type RefundStatus 

type RefundStatus string
const (
	RefundStatusApproved  RefundStatus = "Approved"
	RefundStatusCancelled RefundStatus = "Cancelled"
	RefundStatusCompleted RefundStatus = "Completed"
	RefundStatusDeclined  RefundStatus = "Declined"
	RefundStatusExpired   RefundStatus = "Expired"
	RefundStatusOther     RefundStatus = "Other"
	RefundStatusPending   RefundStatus = "Pending"
)

func (*RefundStatus) UnmarshalJSON 

func (s *RefundStatus) UnmarshalJSON(bytes []byte) error

type SpecialTaxationType 

type SpecialTaxationType string
const (
	SpecialTaxationTypeInvoiceLevel  SpecialTaxationType = "InvoiceLevel"
	SpecialTaxationTypeSubtotalLevel SpecialTaxationType = "SubtotalLevel"
)

func (*SpecialTaxationType) UnmarshalJSON 

func (s *SpecialTaxationType) UnmarshalJSON(bytes []byte) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.