creditnote

type Allocation struct {
	InvoiceId       string             `json:"invoice_id"`
	AllocatedAmount int64              `json:"allocated_amount"`
	AllocatedAt     int64              `json:"allocated_at"`
	InvoiceDate     int64              `json:"invoice_date"`
	InvoiceStatus   invoiceEnum.Status `json:"invoice_status"`
	Object          string             `json:"object"`
}

type BillingAddress struct {
	FirstName        string                `json:"first_name"`
	LastName         string                `json:"last_name"`
	Email            string                `json:"email"`
	Company          string                `json:"company"`
	Phone            string                `json:"phone"`
	Line1            string                `json:"line1"`
	Line2            string                `json:"line2"`
	Line3            string                `json:"line3"`
	City             string                `json:"city"`
	StateCode        string                `json:"state_code"`
	State            string                `json:"state"`
	Country          string                `json:"country"`
	Zip              string                `json:"zip"`
	ValidationStatus enum.ValidationStatus `json:"validation_status"`
	Object           string                `json:"object"`
}

type CreateLineItemParams struct {
	ReferenceLineItemId string `json:"reference_line_item_id"`
	UnitAmount          *int64 `json:"unit_amount,omitempty"`
	UnitAmountInDecimal string `json:"unit_amount_in_decimal,omitempty"`
	Quantity            *int32 `json:"quantity,omitempty"`
	QuantityInDecimal   string `json:"quantity_in_decimal,omitempty"`
	Amount              *int64 `json:"amount,omitempty"`
	DateFrom            *int64 `json:"date_from,omitempty"`
	DateTo              *int64 `json:"date_to,omitempty"`
	Description         string `json:"description,omitempty"`
}

type CreateRequestParams struct {
	ReferenceInvoiceId string                    `json:"reference_invoice_id"`
	Total              *int64                    `json:"total,omitempty"`
	Type               creditNoteEnum.Type       `json:"type"`
	ReasonCode         creditNoteEnum.ReasonCode `json:"reason_code,omitempty"`
	CreateReasonCode   string                    `json:"create_reason_code,omitempty"`
	Date               *int64                    `json:"date,omitempty"`
	CustomerNotes      string                    `json:"customer_notes,omitempty"`
	LineItems          []*CreateLineItemParams   `json:"line_items,omitempty"`
	Comment            string                    `json:"comment,omitempty"`
}

type CreditNote struct {
	Id                        string                    `json:"id"`
	CustomerId                string                    `json:"customer_id"`
	SubscriptionId            string                    `json:"subscription_id"`
	ReferenceInvoiceId        string                    `json:"reference_invoice_id"`
	Type                      creditNoteEnum.Type       `json:"type"`
	ReasonCode                creditNoteEnum.ReasonCode `json:"reason_code"`
	Status                    creditNoteEnum.Status     `json:"status"`
	VatNumber                 string                    `json:"vat_number"`
	Date                      int64                     `json:"date"`
	PriceType                 enum.PriceType            `json:"price_type"`
	CurrencyCode              string                    `json:"currency_code"`
	Total                     int64                     `json:"total"`
	AmountAllocated           int64                     `json:"amount_allocated"`
	AmountRefunded            int64                     `json:"amount_refunded"`
	AmountAvailable           int64                     `json:"amount_available"`
	RefundedAt                int64                     `json:"refunded_at"`
	VoidedAt                  int64                     `json:"voided_at"`
	GeneratedAt               int64                     `json:"generated_at"`
	ResourceVersion           int64                     `json:"resource_version"`
	UpdatedAt                 int64                     `json:"updated_at"`
	Channel                   enum.Channel              `json:"channel"`
	Einvoice                  *Einvoice                 `json:"einvoice"`
	SubTotal                  int64                     `json:"sub_total"`
	SubTotalInLocalCurrency   int64                     `json:"sub_total_in_local_currency"`
	TotalInLocalCurrency      int64                     `json:"total_in_local_currency"`
	LocalCurrencyCode         string                    `json:"local_currency_code"`
	RoundOffAmount            int64                     `json:"round_off_amount"`
	FractionalCorrection      int64                     `json:"fractional_correction"`
	LineItems                 []*LineItem               `json:"line_items"`
	Discounts                 []*Discount               `json:"discounts"`
	LineItemDiscounts         []*LineItemDiscount       `json:"line_item_discounts"`
	LineItemTiers             []*LineItemTier           `json:"line_item_tiers"`
	Taxes                     []*Tax                    `json:"taxes"`
	LineItemTaxes             []*LineItemTax            `json:"line_item_taxes"`
	LinkedRefunds             []*LinkedRefund           `json:"linked_refunds"`
	Allocations               []*Allocation             `json:"allocations"`
	Deleted                   bool                      `json:"deleted"`
	LocalCurrencyExchangeRate float64                   `json:"local_currency_exchange_rate"`
	CreateReasonCode          string                    `json:"create_reason_code"`
	VatNumberPrefix           string                    `json:"vat_number_prefix"`
	BusinessEntityId          string                    `json:"business_entity_id"`
	ShippingAddress           *ShippingAddress          `json:"shipping_address"`
	BillingAddress            *BillingAddress           `json:"billing_address"`
	Object                    string                    `json:"object"`
}

type CreditNotesForCustomerRequestParams struct {
	Limit  *int32 `json:"limit,omitempty"`
	Offset string `json:"offset,omitempty"`
}

type DeleteRequestParams struct {
	Comment string `json:"comment,omitempty"`
}

type Discount struct {
	Amount        int64                             `json:"amount"`
	Description   string                            `json:"description"`
	EntityType    creditNoteEnum.DiscountEntityType `json:"entity_type"`
	EntityId      string                            `json:"entity_id"`
	CouponSetCode string                            `json:"coupon_set_code"`
	Object        string                            `json:"object"`
}

type Einvoice struct {
	Id              string                        `json:"id"`
	ReferenceNumber string                        `json:"reference_number"`
	Status          creditNoteEnum.EinvoiceStatus `json:"status"`
	Message         string                        `json:"message"`
	Object          string                        `json:"object"`
}

type ImportCreditNoteAllocationParams struct {
	InvoiceId       string `json:"invoice_id"`
	AllocatedAmount *int64 `json:"allocated_amount"`
	AllocatedAt     *int64 `json:"allocated_at"`
}

type ImportCreditNoteDiscountParams struct {
	LineItemId  string                         `json:"line_item_id,omitempty"`
	EntityType  invoiceEnum.DiscountEntityType `json:"entity_type"`
	EntityId    string                         `json:"entity_id,omitempty"`
	Description string                         `json:"description,omitempty"`
	Amount      *int64                         `json:"amount"`
}

type ImportCreditNoteLineItemParams struct {
	ReferenceLineItemId        string                            `json:"reference_line_item_id,omitempty"`
	Id                         string                            `json:"id,omitempty"`
	DateFrom                   *int64                            `json:"date_from,omitempty"`
	DateTo                     *int64                            `json:"date_to,omitempty"`
	SubscriptionId             string                            `json:"subscription_id,omitempty"`
	Description                string                            `json:"description"`
	UnitAmount                 *int64                            `json:"unit_amount,omitempty"`
	Quantity                   *int32                            `json:"quantity,omitempty"`
	Amount                     *int64                            `json:"amount,omitempty"`
	UnitAmountInDecimal        string                            `json:"unit_amount_in_decimal,omitempty"`
	QuantityInDecimal          string                            `json:"quantity_in_decimal,omitempty"`
	AmountInDecimal            string                            `json:"amount_in_decimal,omitempty"`
	EntityType                 creditNoteEnum.LineItemEntityType `json:"entity_type,omitempty"`
	EntityId                   string                            `json:"entity_id,omitempty"`
	ItemLevelDiscount1EntityId string                            `json:"item_level_discount1_entity_id,omitempty"`
	ItemLevelDiscount1Amount   *int64                            `json:"item_level_discount1_amount,omitempty"`
	ItemLevelDiscount2EntityId string                            `json:"item_level_discount2_entity_id,omitempty"`
	ItemLevelDiscount2Amount   *int64                            `json:"item_level_discount2_amount,omitempty"`
	Tax1Name                   string                            `json:"tax1_name,omitempty"`
	Tax1Amount                 *int64                            `json:"tax1_amount,omitempty"`
	Tax2Name                   string                            `json:"tax2_name,omitempty"`
	Tax2Amount                 *int64                            `json:"tax2_amount,omitempty"`
	Tax3Name                   string                            `json:"tax3_name,omitempty"`
	Tax3Amount                 *int64                            `json:"tax3_amount,omitempty"`
	Tax4Name                   string                            `json:"tax4_name,omitempty"`
	Tax4Amount                 *int64                            `json:"tax4_amount,omitempty"`
	Tax5Name                   string                            `json:"tax5_name,omitempty"`
	Tax5Amount                 *int64                            `json:"tax5_amount,omitempty"`
	Tax6Name                   string                            `json:"tax6_name,omitempty"`
	Tax6Amount                 *int64                            `json:"tax6_amount,omitempty"`
	Tax7Name                   string                            `json:"tax7_name,omitempty"`
	Tax7Amount                 *int64                            `json:"tax7_amount,omitempty"`
	Tax8Name                   string                            `json:"tax8_name,omitempty"`
	Tax8Amount                 *int64                            `json:"tax8_amount,omitempty"`
	Tax9Name                   string                            `json:"tax9_name,omitempty"`
	Tax9Amount                 *int64                            `json:"tax9_amount,omitempty"`
	Tax10Name                  string                            `json:"tax10_name,omitempty"`
	Tax10Amount                *int64                            `json:"tax10_amount,omitempty"`
}

type ImportCreditNoteLineItemTierParams struct {
	LineItemId            string `json:"line_item_id"`
	StartingUnit          *int32 `json:"starting_unit,omitempty"`
	EndingUnit            *int32 `json:"ending_unit,omitempty"`
	QuantityUsed          *int32 `json:"quantity_used,omitempty"`
	UnitAmount            *int64 `json:"unit_amount,omitempty"`
	StartingUnitInDecimal string `json:"starting_unit_in_decimal,omitempty"`
	EndingUnitInDecimal   string `json:"ending_unit_in_decimal,omitempty"`
	QuantityUsedInDecimal string `json:"quantity_used_in_decimal,omitempty"`
	UnitAmountInDecimal   string `json:"unit_amount_in_decimal,omitempty"`
}

type ImportCreditNoteLinkedRefundParams struct {
	Amount          *int64             `json:"amount"`
	PaymentMethod   enum.PaymentMethod `json:"payment_method"`
	Date            *int64             `json:"date"`
	ReferenceNumber string             `json:"reference_number,omitempty"`
}

type ImportCreditNoteRequestParams struct {
	Id                   string                                `json:"id"`
	CustomerId           string                                `json:"customer_id,omitempty"`
	SubscriptionId       string                                `json:"subscription_id,omitempty"`
	ReferenceInvoiceId   string                                `json:"reference_invoice_id"`
	Type                 creditNoteEnum.Type                   `json:"type"`
	CurrencyCode         string                                `json:"currency_code,omitempty"`
	CreateReasonCode     string                                `json:"create_reason_code"`
	Date                 *int64                                `json:"date"`
	Status               creditNoteEnum.Status                 `json:"status,omitempty"`
	Total                *int64                                `json:"total,omitempty"`
	RefundedAt           *int64                                `json:"refunded_at,omitempty"`
	VoidedAt             *int64                                `json:"voided_at,omitempty"`
	SubTotal             *int64                                `json:"sub_total,omitempty"`
	RoundOffAmount       *int64                                `json:"round_off_amount,omitempty"`
	FractionalCorrection *int64                                `json:"fractional_correction,omitempty"`
	VatNumberPrefix      string                                `json:"vat_number_prefix,omitempty"`
	LineItems            []*ImportCreditNoteLineItemParams     `json:"line_items,omitempty"`
	LineItemTiers        []*ImportCreditNoteLineItemTierParams `json:"line_item_tiers,omitempty"`
	Discounts            []*ImportCreditNoteDiscountParams     `json:"discounts,omitempty"`
	Taxes                []*ImportCreditNoteTaxParams          `json:"taxes,omitempty"`
	Allocations          []*ImportCreditNoteAllocationParams   `json:"allocations,omitempty"`
	LinkedRefunds        []*ImportCreditNoteLinkedRefundParams `json:"linked_refunds,omitempty"`
}

type ImportCreditNoteTaxParams struct {
	Name        string            `json:"name"`
	Rate        *float64          `json:"rate"`
	Amount      *int64            `json:"amount,omitempty"`
	Description string            `json:"description,omitempty"`
	JurisType   enum.TaxJurisType `json:"juris_type,omitempty"`
	JurisName   string            `json:"juris_name,omitempty"`
	JurisCode   string            `json:"juris_code,omitempty"`
}

type LineItem struct {
	Id                      string                            `json:"id"`
	SubscriptionId          string                            `json:"subscription_id"`
	DateFrom                int64                             `json:"date_from"`
	DateTo                  int64                             `json:"date_to"`
	UnitAmount              int64                             `json:"unit_amount"`
	Quantity                int32                             `json:"quantity"`
	Amount                  int64                             `json:"amount"`
	PricingModel            enum.PricingModel                 `json:"pricing_model"`
	IsTaxed                 bool                              `json:"is_taxed"`
	TaxAmount               int64                             `json:"tax_amount"`
	TaxRate                 float64                           `json:"tax_rate"`
	UnitAmountInDecimal     string                            `json:"unit_amount_in_decimal"`
	QuantityInDecimal       string                            `json:"quantity_in_decimal"`
	AmountInDecimal         string                            `json:"amount_in_decimal"`
	DiscountAmount          int64                             `json:"discount_amount"`
	ItemLevelDiscountAmount int64                             `json:"item_level_discount_amount"`
	ReferenceLineItemId     string                            `json:"reference_line_item_id"`
	Description             string                            `json:"description"`
	EntityDescription       string                            `json:"entity_description"`
	EntityType              creditNoteEnum.LineItemEntityType `json:"entity_type"`
	TaxExemptReason         enum.TaxExemptReason              `json:"tax_exempt_reason"`
	EntityId                string                            `json:"entity_id"`
	CustomerId              string                            `json:"customer_id"`
	Object                  string                            `json:"object"`
}

type LineItemDiscount struct {
	LineItemId     string                                      `json:"line_item_id"`
	DiscountType   creditNoteEnum.LineItemDiscountDiscountType `json:"discount_type"`
	CouponId       string                                      `json:"coupon_id"`
	EntityId       string                                      `json:"entity_id"`
	DiscountAmount int64                                       `json:"discount_amount"`
	Object         string                                      `json:"object"`
}

type LineItemTax struct {
	LineItemId               string            `json:"line_item_id"`
	TaxName                  string            `json:"tax_name"`
	TaxRate                  float64           `json:"tax_rate"`
	IsPartialTaxApplied      bool              `json:"is_partial_tax_applied"`
	IsNonComplianceTax       bool              `json:"is_non_compliance_tax"`
	TaxableAmount            int64             `json:"taxable_amount"`
	TaxAmount                int64             `json:"tax_amount"`
	TaxJurisType             enum.TaxJurisType `json:"tax_juris_type"`
	TaxJurisName             string            `json:"tax_juris_name"`
	TaxJurisCode             string            `json:"tax_juris_code"`
	TaxAmountInLocalCurrency int64             `json:"tax_amount_in_local_currency"`
	LocalCurrencyCode        string            `json:"local_currency_code"`
	Object                   string            `json:"object"`
}

type LineItemTier struct {
	LineItemId            string `json:"line_item_id"`
	StartingUnit          int32  `json:"starting_unit"`
	EndingUnit            int32  `json:"ending_unit"`
	QuantityUsed          int32  `json:"quantity_used"`
	UnitAmount            int64  `json:"unit_amount"`
	StartingUnitInDecimal string `json:"starting_unit_in_decimal"`
	EndingUnitInDecimal   string `json:"ending_unit_in_decimal"`
	QuantityUsedInDecimal string `json:"quantity_used_in_decimal"`
	UnitAmountInDecimal   string `json:"unit_amount_in_decimal"`
	Object                string `json:"object"`
}

type LinkedRefund struct {
	TxnId            string                 `json:"txn_id"`
	AppliedAmount    int64                  `json:"applied_amount"`
	AppliedAt        int64                  `json:"applied_at"`
	TxnStatus        transactionEnum.Status `json:"txn_status"`
	TxnDate          int64                  `json:"txn_date"`
	TxnAmount        int64                  `json:"txn_amount"`
	RefundReasonCode string                 `json:"refund_reason_code"`
	Object           string                 `json:"object"`
}

type ListEinvoiceParams struct {
	Status *filter.EnumFilter `json:"status,omitempty"`
}

type ListRequestParams struct {
	Limit              *int32                  `json:"limit,omitempty"`
	Offset             string                  `json:"offset,omitempty"`
	IncludeDeleted     *bool                   `json:"include_deleted,omitempty"`
	Id                 *filter.StringFilter    `json:"id,omitempty"`
	CustomerId         *filter.StringFilter    `json:"customer_id,omitempty"`
	SubscriptionId     *filter.StringFilter    `json:"subscription_id,omitempty"`
	ReferenceInvoiceId *filter.StringFilter    `json:"reference_invoice_id,omitempty"`
	Type               *filter.EnumFilter      `json:"type,omitempty"`
	ReasonCode         *filter.EnumFilter      `json:"reason_code,omitempty"`
	CreateReasonCode   *filter.StringFilter    `json:"create_reason_code,omitempty"`
	Status             *filter.EnumFilter      `json:"status,omitempty"`
	Date               *filter.TimestampFilter `json:"date,omitempty"`
	Total              *filter.NumberFilter    `json:"total,omitempty"`
	PriceType          *filter.EnumFilter      `json:"price_type,omitempty"`
	AmountAllocated    *filter.NumberFilter    `json:"amount_allocated,omitempty"`
	AmountRefunded     *filter.NumberFilter    `json:"amount_refunded,omitempty"`
	AmountAvailable    *filter.NumberFilter    `json:"amount_available,omitempty"`
	VoidedAt           *filter.TimestampFilter `json:"voided_at,omitempty"`
	UpdatedAt          *filter.TimestampFilter `json:"updated_at,omitempty"`
	SortBy             *filter.SortFilter      `json:"sort_by,omitempty"`
	Channel            *filter.EnumFilter      `json:"channel,omitempty"`
	Einvoice           *ListEinvoiceParams     `json:"einvoice,omitempty"`
}

type PdfRequestParams struct {
	DispositionType enum.DispositionType `json:"disposition_type,omitempty"`
}

type RecordRefundRequestParams struct {
	Transaction      *RecordRefundTransactionParams `json:"transaction,omitempty"`
	RefundReasonCode string                         `json:"refund_reason_code,omitempty"`
	Comment          string                         `json:"comment,omitempty"`
}

type RecordRefundTransactionParams struct {
	Amount          *int64             `json:"amount,omitempty"`
	PaymentMethod   enum.PaymentMethod `json:"payment_method"`
	ReferenceNumber string             `json:"reference_number,omitempty"`
	Date            *int64             `json:"date"`
}

type RefundRequestParams struct {
	RefundAmount     *int64 `json:"refund_amount,omitempty"`
	CustomerNotes    string `json:"customer_notes,omitempty"`
	RefundReasonCode string `json:"refund_reason_code,omitempty"`
}

type RemoveTaxWithheldRefundRequestParams struct {
	TaxWithheld *RemoveTaxWithheldRefundTaxWithheldParams `json:"tax_withheld,omitempty"`
}

type RemoveTaxWithheldRefundTaxWithheldParams struct {
	Id string `json:"id"`
}

type ShippingAddress struct {
	FirstName        string                `json:"first_name"`
	LastName         string                `json:"last_name"`
	Email            string                `json:"email"`
	Company          string                `json:"company"`
	Phone            string                `json:"phone"`
	Line1            string                `json:"line1"`
	Line2            string                `json:"line2"`
	Line3            string                `json:"line3"`
	City             string                `json:"city"`
	StateCode        string                `json:"state_code"`
	State            string                `json:"state"`
	Country          string                `json:"country"`
	Zip              string                `json:"zip"`
	ValidationStatus enum.ValidationStatus `json:"validation_status"`
	Index            int32                 `json:"index"`
	Object           string                `json:"object"`
}

type Tax struct {
	Name        string `json:"name"`
	Amount      int64  `json:"amount"`
	Description string `json:"description"`
	Object      string `json:"object"`
}

type VoidCreditNoteRequestParams struct {
	Comment string `json:"comment,omitempty"`
}