invoices_pkg

Documentation

Index

• type INVOICES
• type INVOICES_IMPL
  • func NewINVOICES(config configuration_pkg.CONFIGURATION) *INVOICES_IMPL
  • func (me *INVOICES_IMPL) CancelInvoice(invoiceId string, idempotencyKey *string) (*models_pkg.GetInvoiceResponse, error)
  • func (me *INVOICES_IMPL) CreateInvoice(subscriptionId string, cycleId string, idempotencyKey *string, ...) (*models_pkg.GetInvoiceResponse, error)
  • func (me *INVOICES_IMPL) GetInvoice(invoiceId string) (*models_pkg.GetInvoiceResponse, error)
  • func (me *INVOICES_IMPL) GetInvoices(page *int64, size *int64, code *string, customerId *string, ...) (*models_pkg.ListInvoicesResponse, error)
  • func (me *INVOICES_IMPL) GetPartialInvoice(subscriptionId string) (*models_pkg.GetInvoiceResponse, error)
  • func (me *INVOICES_IMPL) UpdateInvoiceMetadata(invoiceId string, body *models_pkg.UpdateMetadataRequest, ...) (*models_pkg.GetInvoiceResponse, error)
  • func (me *INVOICES_IMPL) UpdateInvoiceStatus(invoiceId string, body *models_pkg.UpdateInvoiceStatusRequest, ...) (*models_pkg.GetInvoiceResponse, error)

Types

type INVOICES

type INVOICES interface {
	CancelInvoice(string, *string) (*models_pkg.GetInvoiceResponse, error)

	GetInvoice(string) (*models_pkg.GetInvoiceResponse, error)

	CreateInvoice(string, string, *string, *models_pkg.CreateInvoiceRequest) (*models_pkg.GetInvoiceResponse, error)

	UpdateInvoiceMetadata(string, *models_pkg.UpdateMetadataRequest, *string) (*models_pkg.GetInvoiceResponse, error)

	GetInvoices(*int64, *int64, *string, *string, *string, *time.Time, *time.Time, *string, *time.Time, *time.Time, *string) (*models_pkg.ListInvoicesResponse, error)

	GetPartialInvoice(string) (*models_pkg.GetInvoiceResponse, error)

	UpdateInvoiceStatus(string, *models_pkg.UpdateInvoiceStatusRequest, *string) (*models_pkg.GetInvoiceResponse, error)
}

* Interface for the INVOICES_IMPL

type INVOICES_IMPL

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

* Client structure as interface implementation

func NewINVOICES

func NewINVOICES(config configuration_pkg.CONFIGURATION) *INVOICES_IMPL

* Factory for the INVOICES interaface returning INVOICES_IMPL

func (*INVOICES_IMPL) CancelInvoice

func (me *INVOICES_IMPL) CancelInvoice(
	invoiceId string,
	idempotencyKey *string) (*models_pkg.GetInvoiceResponse, error)

*

• Cancels an invoice
• @param string invoiceId parameter: Required
• @param *string idempotencyKey parameter: Optional
• @return Returns the *models_pkg.GetInvoiceResponse response from the API call

func (*INVOICES_IMPL) CreateInvoice

func (me *INVOICES_IMPL) CreateInvoice(
	subscriptionId string,
	cycleId string,
	idempotencyKey *string,
	body *models_pkg.CreateInvoiceRequest) (*models_pkg.GetInvoiceResponse, error)

*

• Create an Invoice
• @param string subscriptionId parameter: Required
• @param string cycleId parameter: Required
• @param *string idempotencyKey parameter: Optional
• @param *models_pkg.CreateInvoiceRequest body parameter: Optional
• @return Returns the *models_pkg.GetInvoiceResponse response from the API call

func (*INVOICES_IMPL) GetInvoice

func (me *INVOICES_IMPL) GetInvoice(
	invoiceId string) (*models_pkg.GetInvoiceResponse, error)

*

• Gets an invoice
• @param string invoiceId parameter: Required
• @return Returns the *models_pkg.GetInvoiceResponse response from the API call

func (*INVOICES_IMPL) GetInvoices

func (me *INVOICES_IMPL) GetInvoices(
	page *int64,
	size *int64,
	code *string,
	customerId *string,
	subscriptionId *string,
	createdSince *time.Time,
	createdUntil *time.Time,
	status *string,
	dueSince *time.Time,
	dueUntil *time.Time,
	customerDocument *string) (*models_pkg.ListInvoicesResponse, error)

*

• Gets all invoices
• @param *int64 page parameter: Optional
• @param *int64 size parameter: Optional
• @param *string code parameter: Optional
• @param *string customerId parameter: Optional
• @param *string subscriptionId parameter: Optional
• @param *time.Time createdSince parameter: Optional
• @param *time.Time createdUntil parameter: Optional
• @param *string status parameter: Optional
• @param *time.Time dueSince parameter: Optional
• @param *time.Time dueUntil parameter: Optional
• @param *string customerDocument parameter: Optional
• @return Returns the *models_pkg.ListInvoicesResponse response from the API call

func (*INVOICES_IMPL) GetPartialInvoice

func (me *INVOICES_IMPL) GetPartialInvoice(
	subscriptionId string) (*models_pkg.GetInvoiceResponse, error)

*

• GetPartialInvoice
• @param string subscriptionId parameter: Required
• @return Returns the *models_pkg.GetInvoiceResponse response from the API call

func (*INVOICES_IMPL) UpdateInvoiceMetadata

func (me *INVOICES_IMPL) UpdateInvoiceMetadata(
	invoiceId string,
	body *models_pkg.UpdateMetadataRequest,
	idempotencyKey *string) (*models_pkg.GetInvoiceResponse, error)

*

• Updates the metadata from an invoice
• @param string invoiceId parameter: Required
• @param *models_pkg.UpdateMetadataRequest body parameter: Required
• @param *string idempotencyKey parameter: Optional
• @return Returns the *models_pkg.GetInvoiceResponse response from the API call

func (*INVOICES_IMPL) UpdateInvoiceStatus

func (me *INVOICES_IMPL) UpdateInvoiceStatus(
	invoiceId string,
	body *models_pkg.UpdateInvoiceStatusRequest,
	idempotencyKey *string) (*models_pkg.GetInvoiceResponse, error)

*

• Updates the status from an invoice
• @param string invoiceId parameter: Required
• @param *models_pkg.UpdateInvoiceStatusRequest body parameter: Required
• @param *string idempotencyKey parameter: Optional
• @return Returns the *models_pkg.GetInvoiceResponse response from the API call