billing

type API struct {
	// contains filtered or unexported fields
}

type DownloadInvoiceRequest struct {
	// InvoiceID: invoice ID.
	InvoiceID string `json:"-"`
	// FileType: wanted file type.
	// Default value: pdf
	FileType DownloadInvoiceRequestFileType `json:"-"`
}

type DownloadInvoiceRequestFileType string

type GetConsumptionRequest struct {
	// OrganizationID: filter by organization ID.
	OrganizationID string `json:"-"`
}

type GetConsumptionResponse struct {
	// Consumptions: detailed consumption list.
	Consumptions []*GetConsumptionResponseConsumption `json:"consumptions"`
	// UpdatedAt: last consumption update date.
	UpdatedAt *time.Time `json:"updated_at"`
}

type GetConsumptionResponseConsumption struct {
	// Value: monetary value of the consumption.
	Value *scw.Money `json:"value"`
	// Description: description of the consumption.
	Description string `json:"description"`
	// ProjectID: project ID of the consumption.
	ProjectID string `json:"project_id"`
	// Category: category of the consumption.
	Category string `json:"category"`
	// OperationPath: unique identifier of the product.
	OperationPath string `json:"operation_path"`
}

type Invoice struct {
	// ID: invoice ID.
	ID string `json:"id"`
	// StartDate: start date of the billing period.
	StartDate *time.Time `json:"start_date"`
	// IssuedDate: date when the invoice was sent to the customer.
	IssuedDate *time.Time `json:"issued_date"`
	// DueDate: payment time limit, set according to the Organization's payment conditions.
	DueDate *time.Time `json:"due_date"`
	// TotalUntaxed: total amount, untaxed.
	TotalUntaxed *scw.Money `json:"total_untaxed"`
	// TotalTaxed: total amount, taxed.
	TotalTaxed *scw.Money `json:"total_taxed"`
	// InvoiceType: type of invoice.
	// Default value: unknown_type
	InvoiceType InvoiceType `json:"invoice_type"`
	// Number: invoice number.
	Number int32 `json:"number"`
}

type InvoiceType string

type ListInvoicesRequest struct {
	// OrganizationID: organization ID to filter for, only invoices from this Organization will be returned.
	OrganizationID *string `json:"-"`
	// StartedAfter: invoice's `start_date` is greater or equal to `started_after`.
	StartedAfter *time.Time `json:"-"`
	// StartedBefore: invoice's `start_date` precedes `started_before`.
	StartedBefore *time.Time `json:"-"`
	// InvoiceType: invoice type. It can either be `periodic` or `purchase`.
	// Default value: unknown_type
	InvoiceType InvoiceType `json:"-"`
	// Page: positive integer to choose the page to return.
	Page *int32 `json:"-"`
	// PageSize: positive integer lower or equal to 100 to select the number of items to return.
	// Default value: 20
	PageSize *uint32 `json:"-"`
	// OrderBy: how invoices are ordered in the response.
	// Default value: invoice_number_desc
	OrderBy ListInvoicesRequestOrderBy `json:"-"`
}

type ListInvoicesRequestOrderBy string

type ListInvoicesResponse struct {
	// TotalCount: total number of invoices.
	TotalCount uint32 `json:"total_count"`
	// Invoices: paginated returned invoices.
	Invoices []*Invoice `json:"invoices"`
}