Documentation
¶
Index ¶
- type AddAddonChargeLineItemParams
- type AddAddonChargeRequestParams
- type AddChargeItemItemPriceParams
- type AddChargeItemItemTierParams
- type AddChargeItemRequestParams
- type AddChargeLineItemParams
- type AddChargeRequestParams
- type AdjustmentCreditNote
- type AppliedCredit
- type ApplyCreditsCreditNoteParams
- type ApplyCreditsRequestParams
- type ApplyPaymentsRequestParams
- type ApplyPaymentsTransactionParams
- type BillingAddress
- type ChargeAddonRequestParams
- type ChargeRequestParams
- type CloseNotesToRemoveParams
- type CloseRequestParams
- type CollectPaymentRequestParams
- type CreateAddonParams
- type CreateBankAccountParams
- type CreateCardParams
- type CreateChargeParams
- type CreateForChargeItemItemPriceParams
- type CreateForChargeItemItemTierParams
- type CreateForChargeItemRequestParams
- type CreateForChargeItemsAndChargesBankAccountParams
- type CreateForChargeItemsAndChargesCardParams
- type CreateForChargeItemsAndChargesChargeParams
- type CreateForChargeItemsAndChargesDiscountParams
- type CreateForChargeItemsAndChargesItemPriceParams
- type CreateForChargeItemsAndChargesItemTierParams
- type CreateForChargeItemsAndChargesNotesToRemoveParams
- type CreateForChargeItemsAndChargesPaymentIntentParams
- type CreateForChargeItemsAndChargesPaymentMethodParams
- type CreateForChargeItemsAndChargesRequestParams
- type CreateForChargeItemsAndChargesShippingAddressParams
- type CreateNotesToRemoveParams
- type CreatePaymentIntentParams
- type CreatePaymentMethodParams
- type CreateRequestParams
- type CreateShippingAddressParams
- type DeleteLineItemsLineItemParams
- type DeleteLineItemsRequestParams
- type DeleteRequestParams
- type Discount
- type DunningAttempt
- type Einvoice
- type ImportInvoiceBillingAddressParams
- type ImportInvoiceCreditNoteParams
- type ImportInvoiceDiscountParams
- type ImportInvoiceLineItemParams
- type ImportInvoiceLineItemTierParams
- type ImportInvoiceNoteParams
- type ImportInvoicePaymentParams
- type ImportInvoiceRequestParams
- type ImportInvoiceShippingAddressParams
- type ImportInvoiceTaxParams
- type Invoice
- type InvoicesForCustomerRequestParams
- type InvoicesForSubscriptionRequestParams
- type IssuedCreditNote
- type LineItem
- type LineItemDiscount
- type LineItemTax
- type LineItemTier
- type LinkedOrder
- type LinkedPayment
- type ListEinvoiceParams
- type ListRequestParams
- type Note
- type PdfRequestParams
- type RecordPaymentRequestParams
- type RecordPaymentTransactionParams
- type RecordRefundCreditNoteParams
- type RecordRefundRequestParams
- type RecordRefundTransactionParams
- type RecordTaxWithheldRequestParams
- type RecordTaxWithheldTaxWithheldParams
- type RefundCreditNoteParams
- type RefundRequestParams
- type RemoveCreditNoteCreditNoteParams
- type RemoveCreditNoteRequestParams
- type RemovePaymentRequestParams
- type RemovePaymentTransactionParams
- type RemoveTaxWithheldRequestParams
- type RemoveTaxWithheldTaxWithheldParams
- type ShippingAddress
- type StopDunningRequestParams
- type Tax
- type UpdateDetailsBillingAddressParams
- type UpdateDetailsRequestParams
- type UpdateDetailsShippingAddressParams
- type VoidInvoiceRequestParams
- type WriteOffRequestParams
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddAddonChargeRequestParams ¶
type AddAddonChargeRequestParams struct {
AddonId string `json:"addon_id"`
AddonQuantity *int32 `json:"addon_quantity,omitempty"`
AddonUnitPrice *int64 `json:"addon_unit_price,omitempty"`
AddonQuantityInDecimal string `json:"addon_quantity_in_decimal,omitempty"`
AddonUnitPriceInDecimal string `json:"addon_unit_price_in_decimal,omitempty"`
LineItem *AddAddonChargeLineItemParams `json:"line_item,omitempty"`
Comment string `json:"comment,omitempty"`
SubscriptionId string `json:"subscription_id,omitempty"`
}
type AddChargeItemItemPriceParams ¶
type AddChargeItemItemPriceParams struct {
ItemPriceId string `json:"item_price_id"`
Quantity *int32 `json:"quantity,omitempty"`
QuantityInDecimal string `json:"quantity_in_decimal,omitempty"`
UnitPrice *int64 `json:"unit_price,omitempty"`
UnitPriceInDecimal string `json:"unit_price_in_decimal,omitempty"`
DateFrom *int64 `json:"date_from,omitempty"`
DateTo *int64 `json:"date_to,omitempty"`
}
type AddChargeItemItemTierParams ¶
type AddChargeItemItemTierParams struct {
StartingUnit *int32 `json:"starting_unit,omitempty"`
EndingUnit *int32 `json:"ending_unit,omitempty"`
Price *int64 `json:"price,omitempty"`
StartingUnitInDecimal string `json:"starting_unit_in_decimal,omitempty"`
EndingUnitInDecimal string `json:"ending_unit_in_decimal,omitempty"`
PriceInDecimal string `json:"price_in_decimal,omitempty"`
}
type AddChargeItemRequestParams ¶
type AddChargeItemRequestParams struct {
ItemPrice *AddChargeItemItemPriceParams `json:"item_price,omitempty"`
ItemTiers []*AddChargeItemItemTierParams `json:"item_tiers,omitempty"`
Comment string `json:"comment,omitempty"`
SubscriptionId string `json:"subscription_id,omitempty"`
}
type AddChargeLineItemParams ¶
type AddChargeRequestParams ¶
type AddChargeRequestParams struct {
Amount *int64 `json:"amount"`
Description string `json:"description"`
AvalaraSaleType enum.AvalaraSaleType `json:"avalara_sale_type,omitempty"`
AvalaraTransactionType *int32 `json:"avalara_transaction_type,omitempty"`
AvalaraServiceType *int32 `json:"avalara_service_type,omitempty"`
LineItem *AddChargeLineItemParams `json:"line_item,omitempty"`
Comment string `json:"comment,omitempty"`
SubscriptionId string `json:"subscription_id,omitempty"`
}
type AdjustmentCreditNote ¶
type AdjustmentCreditNote struct {
CnId string `json:"cn_id"`
CnReasonCode creditNoteEnum.ReasonCode `json:"cn_reason_code"`
CnCreateReasonCode string `json:"cn_create_reason_code"`
CnDate int64 `json:"cn_date"`
CnTotal int64 `json:"cn_total"`
CnStatus creditNoteEnum.Status `json:"cn_status"`
Object string `json:"object"`
}
type AppliedCredit ¶
type AppliedCredit struct {
CnId string `json:"cn_id"`
AppliedAmount int64 `json:"applied_amount"`
AppliedAt int64 `json:"applied_at"`
CnReasonCode creditNoteEnum.ReasonCode `json:"cn_reason_code"`
CnCreateReasonCode string `json:"cn_create_reason_code"`
CnDate int64 `json:"cn_date"`
CnStatus creditNoteEnum.Status `json:"cn_status"`
Object string `json:"object"`
}
type ApplyCreditsCreditNoteParams ¶
type ApplyCreditsCreditNoteParams struct {
Id string `json:"id,omitempty"`
}
type ApplyCreditsRequestParams ¶
type ApplyCreditsRequestParams struct {
CreditNotes []*ApplyCreditsCreditNoteParams `json:"credit_notes,omitempty"`
Comment string `json:"comment,omitempty"`
}
type ApplyPaymentsRequestParams ¶
type ApplyPaymentsRequestParams struct {
Transactions []*ApplyPaymentsTransactionParams `json:"transactions,omitempty"`
Comment string `json:"comment,omitempty"`
}
type ApplyPaymentsTransactionParams ¶
type ApplyPaymentsTransactionParams struct {
Id string `json:"id,omitempty"`
}
type BillingAddress ¶
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 ChargeAddonRequestParams ¶
type ChargeAddonRequestParams struct {
CustomerId string `json:"customer_id,omitempty"`
SubscriptionId string `json:"subscription_id,omitempty"`
AddonId string `json:"addon_id"`
AddonQuantity *int32 `json:"addon_quantity,omitempty"`
AddonUnitPrice *int64 `json:"addon_unit_price,omitempty"`
AddonQuantityInDecimal string `json:"addon_quantity_in_decimal,omitempty"`
AddonUnitPriceInDecimal string `json:"addon_unit_price_in_decimal,omitempty"`
DateFrom *int64 `json:"date_from,omitempty"`
DateTo *int64 `json:"date_to,omitempty"`
CouponIds []string `json:"coupon_ids,omitempty"`
Coupon string `json:"coupon,omitempty"`
PoNumber string `json:"po_number,omitempty"`
InvoiceDate *int64 `json:"invoice_date,omitempty"`
PaymentSourceId string `json:"payment_source_id,omitempty"`
}
type ChargeRequestParams ¶
type ChargeRequestParams struct {
CustomerId string `json:"customer_id,omitempty"`
SubscriptionId string `json:"subscription_id,omitempty"`
CurrencyCode string `json:"currency_code,omitempty"`
Amount *int64 `json:"amount,omitempty"`
AmountInDecimal string `json:"amount_in_decimal,omitempty"`
Description string `json:"description"`
DateFrom *int64 `json:"date_from,omitempty"`
DateTo *int64 `json:"date_to,omitempty"`
CouponIds []string `json:"coupon_ids,omitempty"`
Coupon string `json:"coupon,omitempty"`
AvalaraSaleType enum.AvalaraSaleType `json:"avalara_sale_type,omitempty"`
AvalaraTransactionType *int32 `json:"avalara_transaction_type,omitempty"`
AvalaraServiceType *int32 `json:"avalara_service_type,omitempty"`
PoNumber string `json:"po_number,omitempty"`
InvoiceDate *int64 `json:"invoice_date,omitempty"`
PaymentSourceId string `json:"payment_source_id,omitempty"`
}
type CloseNotesToRemoveParams ¶
type CloseNotesToRemoveParams struct {
EntityType enum.EntityType `json:"entity_type,omitempty"`
EntityId string `json:"entity_id,omitempty"`
}
type CloseRequestParams ¶
type CloseRequestParams struct {
Comment string `json:"comment,omitempty"`
InvoiceNote string `json:"invoice_note,omitempty"`
RemoveGeneralNote *bool `json:"remove_general_note,omitempty"`
NotesToRemove []*CloseNotesToRemoveParams `json:"notes_to_remove,omitempty"`
InvoiceDate *int64 `json:"invoice_date,omitempty"`
}
type CreateAddonParams ¶
type CreateAddonParams struct {
Id string `json:"id,omitempty"`
Quantity *int32 `json:"quantity,omitempty"`
UnitPrice *int64 `json:"unit_price,omitempty"`
QuantityInDecimal string `json:"quantity_in_decimal,omitempty"`
UnitPriceInDecimal string `json:"unit_price_in_decimal,omitempty"`
DateFrom *int64 `json:"date_from,omitempty"`
DateTo *int64 `json:"date_to,omitempty"`
}
type CreateBankAccountParams ¶
type CreateBankAccountParams struct {
GatewayAccountId string `json:"gateway_account_id,omitempty"`
Iban string `json:"iban,omitempty"`
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
Company string `json:"company,omitempty"`
Email string `json:"email,omitempty"`
Phone string `json:"phone,omitempty"`
BankName string `json:"bank_name,omitempty"`
AccountNumber string `json:"account_number,omitempty"`
RoutingNumber string `json:"routing_number,omitempty"`
BankCode string `json:"bank_code,omitempty"`
AccountType enum.AccountType `json:"account_type,omitempty"`
AccountHolderType enum.AccountHolderType `json:"account_holder_type,omitempty"`
EcheckType enum.EcheckType `json:"echeck_type,omitempty"`
IssuingCountry string `json:"issuing_country,omitempty"`
SwedishIdentityNumber string `json:"swedish_identity_number,omitempty"`
BillingAddress map[string]interface{} `json:"billing_address,omitempty"`
}
type CreateCardParams ¶
type CreateCardParams struct {
Gateway enum.Gateway `json:"gateway,omitempty"`
GatewayAccountId string `json:"gateway_account_id,omitempty"`
TmpToken string `json:"tmp_token,omitempty"`
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
Number string `json:"number,omitempty"`
ExpiryMonth *int32 `json:"expiry_month,omitempty"`
ExpiryYear *int32 `json:"expiry_year,omitempty"`
Cvv string `json:"cvv,omitempty"`
BillingAddr1 string `json:"billing_addr1,omitempty"`
BillingAddr2 string `json:"billing_addr2,omitempty"`
BillingCity string `json:"billing_city,omitempty"`
BillingStateCode string `json:"billing_state_code,omitempty"`
BillingState string `json:"billing_state,omitempty"`
BillingZip string `json:"billing_zip,omitempty"`
BillingCountry string `json:"billing_country,omitempty"`
IpAddress string `json:"ip_address,omitempty"`
AdditionalInformation map[string]interface{} `json:"additional_information,omitempty"`
}
type CreateChargeParams ¶
type CreateChargeParams struct {
Amount *int64 `json:"amount,omitempty"`
AmountInDecimal string `json:"amount_in_decimal,omitempty"`
Description string `json:"description,omitempty"`
Taxable *bool `json:"taxable,omitempty"`
TaxProfileId string `json:"tax_profile_id,omitempty"`
AvalaraTaxCode string `json:"avalara_tax_code,omitempty"`
HsnCode string `json:"hsn_code,omitempty"`
TaxjarProductCode string `json:"taxjar_product_code,omitempty"`
AvalaraSaleType enum.AvalaraSaleType `json:"avalara_sale_type,omitempty"`
AvalaraTransactionType *int32 `json:"avalara_transaction_type,omitempty"`
AvalaraServiceType *int32 `json:"avalara_service_type,omitempty"`
DateFrom *int64 `json:"date_from,omitempty"`
DateTo *int64 `json:"date_to,omitempty"`
}
type CreateForChargeItemItemPriceParams ¶
type CreateForChargeItemItemPriceParams struct {
ItemPriceId string `json:"item_price_id"`
Quantity *int32 `json:"quantity,omitempty"`
QuantityInDecimal string `json:"quantity_in_decimal,omitempty"`
UnitPrice *int64 `json:"unit_price,omitempty"`
UnitPriceInDecimal string `json:"unit_price_in_decimal,omitempty"`
DateFrom *int64 `json:"date_from,omitempty"`
DateTo *int64 `json:"date_to,omitempty"`
}
type CreateForChargeItemItemTierParams ¶
type CreateForChargeItemItemTierParams struct {
StartingUnit *int32 `json:"starting_unit,omitempty"`
EndingUnit *int32 `json:"ending_unit,omitempty"`
Price *int64 `json:"price,omitempty"`
StartingUnitInDecimal string `json:"starting_unit_in_decimal,omitempty"`
EndingUnitInDecimal string `json:"ending_unit_in_decimal,omitempty"`
PriceInDecimal string `json:"price_in_decimal,omitempty"`
}
type CreateForChargeItemRequestParams ¶
type CreateForChargeItemRequestParams struct {
CustomerId string `json:"customer_id,omitempty"`
SubscriptionId string `json:"subscription_id,omitempty"`
ItemPrice *CreateForChargeItemItemPriceParams `json:"item_price,omitempty"`
ItemTiers []*CreateForChargeItemItemTierParams `json:"item_tiers,omitempty"`
PoNumber string `json:"po_number,omitempty"`
Coupon string `json:"coupon,omitempty"`
PaymentSourceId string `json:"payment_source_id,omitempty"`
InvoiceDate *int64 `json:"invoice_date,omitempty"`
}
type CreateForChargeItemsAndChargesBankAccountParams ¶
type CreateForChargeItemsAndChargesBankAccountParams struct {
GatewayAccountId string `json:"gateway_account_id,omitempty"`
Iban string `json:"iban,omitempty"`
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
Company string `json:"company,omitempty"`
Email string `json:"email,omitempty"`
Phone string `json:"phone,omitempty"`
BankName string `json:"bank_name,omitempty"`
AccountNumber string `json:"account_number,omitempty"`
RoutingNumber string `json:"routing_number,omitempty"`
BankCode string `json:"bank_code,omitempty"`
AccountType enum.AccountType `json:"account_type,omitempty"`
AccountHolderType enum.AccountHolderType `json:"account_holder_type,omitempty"`
EcheckType enum.EcheckType `json:"echeck_type,omitempty"`
IssuingCountry string `json:"issuing_country,omitempty"`
SwedishIdentityNumber string `json:"swedish_identity_number,omitempty"`
BillingAddress map[string]interface{} `json:"billing_address,omitempty"`
}
type CreateForChargeItemsAndChargesCardParams ¶
type CreateForChargeItemsAndChargesCardParams struct {
Gateway enum.Gateway `json:"gateway,omitempty"`
GatewayAccountId string `json:"gateway_account_id,omitempty"`
TmpToken string `json:"tmp_token,omitempty"`
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
Number string `json:"number,omitempty"`
ExpiryMonth *int32 `json:"expiry_month,omitempty"`
ExpiryYear *int32 `json:"expiry_year,omitempty"`
Cvv string `json:"cvv,omitempty"`
BillingAddr1 string `json:"billing_addr1,omitempty"`
BillingAddr2 string `json:"billing_addr2,omitempty"`
BillingCity string `json:"billing_city,omitempty"`
BillingStateCode string `json:"billing_state_code,omitempty"`
BillingState string `json:"billing_state,omitempty"`
BillingZip string `json:"billing_zip,omitempty"`
BillingCountry string `json:"billing_country,omitempty"`
IpAddress string `json:"ip_address,omitempty"`
AdditionalInformation map[string]interface{} `json:"additional_information,omitempty"`
}
type CreateForChargeItemsAndChargesChargeParams ¶
type CreateForChargeItemsAndChargesChargeParams struct {
Amount *int64 `json:"amount,omitempty"`
AmountInDecimal string `json:"amount_in_decimal,omitempty"`
Description string `json:"description,omitempty"`
Taxable *bool `json:"taxable,omitempty"`
TaxProfileId string `json:"tax_profile_id,omitempty"`
AvalaraTaxCode string `json:"avalara_tax_code,omitempty"`
HsnCode string `json:"hsn_code,omitempty"`
TaxjarProductCode string `json:"taxjar_product_code,omitempty"`
AvalaraSaleType enum.AvalaraSaleType `json:"avalara_sale_type,omitempty"`
AvalaraTransactionType *int32 `json:"avalara_transaction_type,omitempty"`
AvalaraServiceType *int32 `json:"avalara_service_type,omitempty"`
DateFrom *int64 `json:"date_from,omitempty"`
DateTo *int64 `json:"date_to,omitempty"`
}
type CreateForChargeItemsAndChargesItemPriceParams ¶
type CreateForChargeItemsAndChargesItemPriceParams struct {
ItemPriceId string `json:"item_price_id,omitempty"`
Quantity *int32 `json:"quantity,omitempty"`
QuantityInDecimal string `json:"quantity_in_decimal,omitempty"`
UnitPrice *int64 `json:"unit_price,omitempty"`
UnitPriceInDecimal string `json:"unit_price_in_decimal,omitempty"`
DateFrom *int64 `json:"date_from,omitempty"`
DateTo *int64 `json:"date_to,omitempty"`
}
type CreateForChargeItemsAndChargesItemTierParams ¶
type CreateForChargeItemsAndChargesItemTierParams struct {
ItemPriceId string `json:"item_price_id,omitempty"`
StartingUnit *int32 `json:"starting_unit,omitempty"`
EndingUnit *int32 `json:"ending_unit,omitempty"`
Price *int64 `json:"price,omitempty"`
StartingUnitInDecimal string `json:"starting_unit_in_decimal,omitempty"`
EndingUnitInDecimal string `json:"ending_unit_in_decimal,omitempty"`
PriceInDecimal string `json:"price_in_decimal,omitempty"`
}
type CreateForChargeItemsAndChargesNotesToRemoveParams ¶
type CreateForChargeItemsAndChargesNotesToRemoveParams struct {
EntityType enum.EntityType `json:"entity_type,omitempty"`
EntityId string `json:"entity_id,omitempty"`
}
type CreateForChargeItemsAndChargesPaymentIntentParams ¶
type CreateForChargeItemsAndChargesPaymentIntentParams struct {
Id string `json:"id,omitempty"`
GatewayAccountId string `json:"gateway_account_id,omitempty"`
GwToken string `json:"gw_token,omitempty"`
PaymentMethodType paymentIntentEnum.PaymentMethodType `json:"payment_method_type,omitempty"`
ReferenceId string `json:"reference_id,omitempty"`
GwPaymentMethodId string `json:"gw_payment_method_id,omitempty"`
AdditionalInformation map[string]interface{} `json:"additional_information,omitempty"`
}
type CreateForChargeItemsAndChargesPaymentMethodParams ¶
type CreateForChargeItemsAndChargesPaymentMethodParams struct {
Type enum.Type `json:"type,omitempty"`
Gateway enum.Gateway `json:"gateway,omitempty"`
GatewayAccountId string `json:"gateway_account_id,omitempty"`
ReferenceId string `json:"reference_id,omitempty"`
TmpToken string `json:"tmp_token,omitempty"`
IssuingCountry string `json:"issuing_country,omitempty"`
AdditionalInformation map[string]interface{} `json:"additional_information,omitempty"`
}
type CreateForChargeItemsAndChargesRequestParams ¶
type CreateForChargeItemsAndChargesRequestParams struct {
CustomerId string `json:"customer_id,omitempty"`
SubscriptionId string `json:"subscription_id,omitempty"`
CurrencyCode string `json:"currency_code,omitempty"`
ItemPrices []*CreateForChargeItemsAndChargesItemPriceParams `json:"item_prices,omitempty"`
ItemTiers []*CreateForChargeItemsAndChargesItemTierParams `json:"item_tiers,omitempty"`
Charges []*CreateForChargeItemsAndChargesChargeParams `json:"charges,omitempty"`
InvoiceNote string `json:"invoice_note,omitempty"`
RemoveGeneralNote *bool `json:"remove_general_note,omitempty"`
NotesToRemove []*CreateForChargeItemsAndChargesNotesToRemoveParams `json:"notes_to_remove,omitempty"`
PoNumber string `json:"po_number,omitempty"`
Coupon string `json:"coupon,omitempty"`
CouponIds []string `json:"coupon_ids,omitempty"`
AuthorizationTransactionId string `json:"authorization_transaction_id,omitempty"`
PaymentSourceId string `json:"payment_source_id,omitempty"`
AutoCollection enum.AutoCollection `json:"auto_collection,omitempty"`
Discounts []*CreateForChargeItemsAndChargesDiscountParams `json:"discounts,omitempty"`
InvoiceDate *int64 `json:"invoice_date,omitempty"`
ShippingAddress *CreateForChargeItemsAndChargesShippingAddressParams `json:"shipping_address,omitempty"`
Card *CreateForChargeItemsAndChargesCardParams `json:"card,omitempty"`
BankAccount *CreateForChargeItemsAndChargesBankAccountParams `json:"bank_account,omitempty"`
TokenId string `json:"token_id,omitempty"`
PaymentMethod *CreateForChargeItemsAndChargesPaymentMethodParams `json:"payment_method,omitempty"`
PaymentIntent *CreateForChargeItemsAndChargesPaymentIntentParams `json:"payment_intent,omitempty"`
ReplacePrimaryPaymentSource *bool `json:"replace_primary_payment_source,omitempty"`
RetainPaymentSource *bool `json:"retain_payment_source,omitempty"`
}
type CreateForChargeItemsAndChargesShippingAddressParams ¶
type CreateForChargeItemsAndChargesShippingAddressParams struct {
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
Email string `json:"email,omitempty"`
Company string `json:"company,omitempty"`
Phone string `json:"phone,omitempty"`
Line1 string `json:"line1,omitempty"`
Line2 string `json:"line2,omitempty"`
Line3 string `json:"line3,omitempty"`
City string `json:"city,omitempty"`
StateCode string `json:"state_code,omitempty"`
State string `json:"state,omitempty"`
Zip string `json:"zip,omitempty"`
Country string `json:"country,omitempty"`
ValidationStatus enum.ValidationStatus `json:"validation_status,omitempty"`
}
type CreateNotesToRemoveParams ¶
type CreateNotesToRemoveParams struct {
EntityType enum.EntityType `json:"entity_type,omitempty"`
EntityId string `json:"entity_id,omitempty"`
}
type CreatePaymentIntentParams ¶
type CreatePaymentIntentParams struct {
Id string `json:"id,omitempty"`
GatewayAccountId string `json:"gateway_account_id,omitempty"`
GwToken string `json:"gw_token,omitempty"`
PaymentMethodType paymentIntentEnum.PaymentMethodType `json:"payment_method_type,omitempty"`
ReferenceId string `json:"reference_id,omitempty"`
GwPaymentMethodId string `json:"gw_payment_method_id,omitempty"`
AdditionalInformation map[string]interface{} `json:"additional_information,omitempty"`
}
type CreatePaymentMethodParams ¶
type CreatePaymentMethodParams struct {
Type enum.Type `json:"type,omitempty"`
Gateway enum.Gateway `json:"gateway,omitempty"`
GatewayAccountId string `json:"gateway_account_id,omitempty"`
ReferenceId string `json:"reference_id,omitempty"`
TmpToken string `json:"tmp_token,omitempty"`
IssuingCountry string `json:"issuing_country,omitempty"`
AdditionalInformation map[string]interface{} `json:"additional_information,omitempty"`
}
type CreateRequestParams ¶
type CreateRequestParams struct {
CustomerId string `json:"customer_id,omitempty"`
SubscriptionId string `json:"subscription_id,omitempty"`
CurrencyCode string `json:"currency_code,omitempty"`
Addons []*CreateAddonParams `json:"addons,omitempty"`
InvoiceDate *int64 `json:"invoice_date,omitempty"`
Charges []*CreateChargeParams `json:"charges,omitempty"`
InvoiceNote string `json:"invoice_note,omitempty"`
RemoveGeneralNote *bool `json:"remove_general_note,omitempty"`
NotesToRemove []*CreateNotesToRemoveParams `json:"notes_to_remove,omitempty"`
PoNumber string `json:"po_number,omitempty"`
Coupon string `json:"coupon,omitempty"`
CouponIds []string `json:"coupon_ids,omitempty"`
AuthorizationTransactionId string `json:"authorization_transaction_id,omitempty"`
PaymentSourceId string `json:"payment_source_id,omitempty"`
AutoCollection enum.AutoCollection `json:"auto_collection,omitempty"`
ShippingAddress *CreateShippingAddressParams `json:"shipping_address,omitempty"`
Card *CreateCardParams `json:"card,omitempty"`
BankAccount *CreateBankAccountParams `json:"bank_account,omitempty"`
TokenId string `json:"token_id,omitempty"`
PaymentMethod *CreatePaymentMethodParams `json:"payment_method,omitempty"`
PaymentIntent *CreatePaymentIntentParams `json:"payment_intent,omitempty"`
ReplacePrimaryPaymentSource *bool `json:"replace_primary_payment_source,omitempty"`
RetainPaymentSource *bool `json:"retain_payment_source,omitempty"`
}
type CreateShippingAddressParams ¶
type CreateShippingAddressParams struct {
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
Email string `json:"email,omitempty"`
Company string `json:"company,omitempty"`
Phone string `json:"phone,omitempty"`
Line1 string `json:"line1,omitempty"`
Line2 string `json:"line2,omitempty"`
Line3 string `json:"line3,omitempty"`
City string `json:"city,omitempty"`
StateCode string `json:"state_code,omitempty"`
State string `json:"state,omitempty"`
Zip string `json:"zip,omitempty"`
Country string `json:"country,omitempty"`
ValidationStatus enum.ValidationStatus `json:"validation_status,omitempty"`
}
type DeleteLineItemsLineItemParams ¶ added in v3.1.0
type DeleteLineItemsLineItemParams struct {
Id string `json:"id,omitempty"`
}
type DeleteLineItemsRequestParams ¶ added in v3.1.0
type DeleteLineItemsRequestParams struct {
LineItems []*DeleteLineItemsLineItemParams `json:"line_items,omitempty"`
}
type DeleteRequestParams ¶
type Discount ¶
type Discount struct {
Amount int64 `json:"amount"`
Description string `json:"description"`
EntityType invoiceEnum.DiscountEntityType `json:"entity_type"`
EntityId string `json:"entity_id"`
CouponSetCode string `json:"coupon_set_code"`
Object string `json:"object"`
}
type DunningAttempt ¶
type DunningAttempt struct {
Attempt int32 `json:"attempt"`
TransactionId string `json:"transaction_id"`
DunningType enum.DunningType `json:"dunning_type"`
CreatedAt int64 `json:"created_at"`
TxnStatus transactionEnum.Status `json:"txn_status"`
TxnAmount int64 `json:"txn_amount"`
Object string `json:"object"`
}
type Einvoice ¶
type Einvoice struct {
Id string `json:"id"`
ReferenceNumber string `json:"reference_number"`
Status invoiceEnum.EinvoiceStatus `json:"status"`
Message string `json:"message"`
Object string `json:"object"`
}
type ImportInvoiceBillingAddressParams ¶
type ImportInvoiceBillingAddressParams struct {
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
Email string `json:"email,omitempty"`
Company string `json:"company,omitempty"`
Phone string `json:"phone,omitempty"`
Line1 string `json:"line1,omitempty"`
Line2 string `json:"line2,omitempty"`
Line3 string `json:"line3,omitempty"`
City string `json:"city,omitempty"`
StateCode string `json:"state_code,omitempty"`
State string `json:"state,omitempty"`
Zip string `json:"zip,omitempty"`
Country string `json:"country,omitempty"`
ValidationStatus enum.ValidationStatus `json:"validation_status,omitempty"`
}
type ImportInvoiceCreditNoteParams ¶
type ImportInvoiceCreditNoteParams struct {
Id string `json:"id,omitempty"`
}
type ImportInvoiceDiscountParams ¶
type ImportInvoiceDiscountParams 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 ImportInvoiceLineItemParams ¶
type ImportInvoiceLineItemParams struct {
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 invoiceEnum.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 ImportInvoiceLineItemTierParams ¶
type ImportInvoiceLineItemTierParams 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 ImportInvoiceNoteParams ¶
type ImportInvoiceNoteParams struct {
EntityType invoiceEnum.NoteEntityType `json:"entity_type,omitempty"`
EntityId string `json:"entity_id,omitempty"`
Note string `json:"note,omitempty"`
}
type ImportInvoicePaymentParams ¶
type ImportInvoicePaymentParams struct {
Amount *int64 `json:"amount"`
PaymentMethod enum.PaymentMethod `json:"payment_method"`
Date *int64 `json:"date,omitempty"`
ReferenceNumber string `json:"reference_number,omitempty"`
}
type ImportInvoiceRequestParams ¶
type ImportInvoiceRequestParams struct {
Id string `json:"id"`
CurrencyCode string `json:"currency_code,omitempty"`
CustomerId string `json:"customer_id,omitempty"`
SubscriptionId string `json:"subscription_id,omitempty"`
PoNumber string `json:"po_number,omitempty"`
PriceType enum.PriceType `json:"price_type,omitempty"`
TaxOverrideReason enum.TaxOverrideReason `json:"tax_override_reason,omitempty"`
VatNumber string `json:"vat_number,omitempty"`
VatNumberPrefix string `json:"vat_number_prefix,omitempty"`
Date *int64 `json:"date"`
Total *int64 `json:"total"`
RoundOff *int64 `json:"round_off,omitempty"`
Status invoiceEnum.Status `json:"status,omitempty"`
VoidedAt *int64 `json:"voided_at,omitempty"`
VoidReasonCode string `json:"void_reason_code,omitempty"`
IsWrittenOff *bool `json:"is_written_off,omitempty"`
WriteOffAmount *int64 `json:"write_off_amount,omitempty"`
WriteOffDate *int64 `json:"write_off_date,omitempty"`
DueDate *int64 `json:"due_date,omitempty"`
NetTermDays *int32 `json:"net_term_days,omitempty"`
HasAdvanceCharges *bool `json:"has_advance_charges,omitempty"`
UseForProration *bool `json:"use_for_proration,omitempty"`
LineItems []*ImportInvoiceLineItemParams `json:"line_items,omitempty"`
LineItemTiers []*ImportInvoiceLineItemTierParams `json:"line_item_tiers,omitempty"`
Discounts []*ImportInvoiceDiscountParams `json:"discounts,omitempty"`
Taxes []*ImportInvoiceTaxParams `json:"taxes,omitempty"`
CreditNote *ImportInvoiceCreditNoteParams `json:"credit_note,omitempty"`
Payments []*ImportInvoicePaymentParams `json:"payments,omitempty"`
Notes []*ImportInvoiceNoteParams `json:"notes,omitempty"`
BillingAddress *ImportInvoiceBillingAddressParams `json:"billing_address,omitempty"`
ShippingAddress *ImportInvoiceShippingAddressParams `json:"shipping_address,omitempty"`
}
type ImportInvoiceShippingAddressParams ¶
type ImportInvoiceShippingAddressParams struct {
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
Email string `json:"email,omitempty"`
Company string `json:"company,omitempty"`
Phone string `json:"phone,omitempty"`
Line1 string `json:"line1,omitempty"`
Line2 string `json:"line2,omitempty"`
Line3 string `json:"line3,omitempty"`
City string `json:"city,omitempty"`
StateCode string `json:"state_code,omitempty"`
State string `json:"state,omitempty"`
Zip string `json:"zip,omitempty"`
Country string `json:"country,omitempty"`
ValidationStatus enum.ValidationStatus `json:"validation_status,omitempty"`
}
type ImportInvoiceTaxParams ¶
type ImportInvoiceTaxParams 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 Invoice ¶
type Invoice struct {
Id string `json:"id"`
PoNumber string `json:"po_number"`
CustomerId string `json:"customer_id"`
SubscriptionId string `json:"subscription_id"`
Recurring bool `json:"recurring"`
Status invoiceEnum.Status `json:"status"`
VatNumber string `json:"vat_number"`
PriceType enum.PriceType `json:"price_type"`
Date int64 `json:"date"`
DueDate int64 `json:"due_date"`
NetTermDays int32 `json:"net_term_days"`
ExchangeRate float64 `json:"exchange_rate"`
CurrencyCode string `json:"currency_code"`
Total int64 `json:"total"`
AmountPaid int64 `json:"amount_paid"`
AmountAdjusted int64 `json:"amount_adjusted"`
WriteOffAmount int64 `json:"write_off_amount"`
CreditsApplied int64 `json:"credits_applied"`
AmountDue int64 `json:"amount_due"`
PaidAt int64 `json:"paid_at"`
DunningStatus invoiceEnum.DunningStatus `json:"dunning_status"`
NextRetryAt int64 `json:"next_retry_at"`
VoidedAt int64 `json:"voided_at"`
ResourceVersion int64 `json:"resource_version"`
UpdatedAt int64 `json:"updated_at"`
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"`
Tax int64 `json:"tax"`
FirstInvoice bool `json:"first_invoice"`
NewSalesAmount int64 `json:"new_sales_amount"`
HasAdvanceCharges bool `json:"has_advance_charges"`
TermFinalized bool `json:"term_finalized"`
IsGifted bool `json:"is_gifted"`
GeneratedAt int64 `json:"generated_at"`
ExpectedPaymentDate int64 `json:"expected_payment_date"`
AmountToCollect int64 `json:"amount_to_collect"`
RoundOffAmount int64 `json:"round_off_amount"`
LineItems []*LineItem `json:"line_items"`
Discounts []*Discount `json:"discounts"`
LineItemDiscounts []*LineItemDiscount `json:"line_item_discounts"`
Taxes []*Tax `json:"taxes"`
LineItemTaxes []*LineItemTax `json:"line_item_taxes"`
LineItemTiers []*LineItemTier `json:"line_item_tiers"`
LinkedPayments []*LinkedPayment `json:"linked_payments"`
DunningAttempts []*DunningAttempt `json:"dunning_attempts"`
AppliedCredits []*AppliedCredit `json:"applied_credits"`
AdjustmentCreditNotes []*AdjustmentCreditNote `json:"adjustment_credit_notes"`
IssuedCreditNotes []*IssuedCreditNote `json:"issued_credit_notes"`
LinkedOrders []*LinkedOrder `json:"linked_orders"`
Notes []*Note `json:"notes"`
ShippingAddress *ShippingAddress `json:"shipping_address"`
BillingAddress *BillingAddress `json:"billing_address"`
Einvoice *Einvoice `json:"einvoice"`
PaymentOwner string `json:"payment_owner"`
VoidReasonCode string `json:"void_reason_code"`
Deleted bool `json:"deleted"`
VatNumberPrefix string `json:"vat_number_prefix"`
Channel enum.Channel `json:"channel"`
BusinessEntityId string `json:"business_entity_id"`
Object string `json:"object"`
}
type IssuedCreditNote ¶
type IssuedCreditNote struct {
CnId string `json:"cn_id"`
CnReasonCode creditNoteEnum.ReasonCode `json:"cn_reason_code"`
CnCreateReasonCode string `json:"cn_create_reason_code"`
CnDate int64 `json:"cn_date"`
CnTotal int64 `json:"cn_total"`
CnStatus creditNoteEnum.Status `json:"cn_status"`
Object string `json:"object"`
}
type LineItem ¶
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 invoiceEnum.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 ¶
type LineItemDiscount struct {
LineItemId string `json:"line_item_id"`
DiscountType invoiceEnum.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 ¶
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 ¶
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 LinkedOrder ¶
type LinkedOrder struct {
Id string `json:"id"`
DocumentNumber string `json:"document_number"`
Status invoiceEnum.LinkedOrderStatus `json:"status"`
OrderType invoiceEnum.LinkedOrderOrderType `json:"order_type"`
ReferenceId string `json:"reference_id"`
FulfillmentStatus string `json:"fulfillment_status"`
BatchId string `json:"batch_id"`
CreatedAt int64 `json:"created_at"`
Object string `json:"object"`
}
type LinkedPayment ¶
type ListEinvoiceParams ¶
type ListEinvoiceParams struct {
Status *filter.EnumFilter `json:"status,omitempty"`
}
type ListRequestParams ¶
type ListRequestParams struct {
Limit *int32 `json:"limit,omitempty"`
Offset string `json:"offset,omitempty"`
PaidOnAfter *int64 `json:"paid_on_after,omitempty"`
IncludeDeleted *bool `json:"include_deleted,omitempty"`
Id *filter.StringFilter `json:"id,omitempty"`
SubscriptionId *filter.StringFilter `json:"subscription_id,omitempty"`
CustomerId *filter.StringFilter `json:"customer_id,omitempty"`
Recurring *filter.BooleanFilter `json:"recurring,omitempty"`
Status *filter.EnumFilter `json:"status,omitempty"`
PriceType *filter.EnumFilter `json:"price_type,omitempty"`
Date *filter.TimestampFilter `json:"date,omitempty"`
PaidAt *filter.TimestampFilter `json:"paid_at,omitempty"`
Total *filter.NumberFilter `json:"total,omitempty"`
AmountPaid *filter.NumberFilter `json:"amount_paid,omitempty"`
AmountAdjusted *filter.NumberFilter `json:"amount_adjusted,omitempty"`
CreditsApplied *filter.NumberFilter `json:"credits_applied,omitempty"`
AmountDue *filter.NumberFilter `json:"amount_due,omitempty"`
DunningStatus *filter.EnumFilter `json:"dunning_status,omitempty"`
PaymentOwner *filter.StringFilter `json:"payment_owner,omitempty"`
UpdatedAt *filter.TimestampFilter `json:"updated_at,omitempty"`
Channel *filter.EnumFilter `json:"channel,omitempty"`
VoidedAt *filter.TimestampFilter `json:"voided_at,omitempty"`
VoidReasonCode *filter.StringFilter `json:"void_reason_code,omitempty"`
SortBy *filter.SortFilter `json:"sort_by,omitempty"`
Einvoice *ListEinvoiceParams `json:"einvoice,omitempty"`
}
type Note ¶
type Note struct {
EntityType invoiceEnum.NoteEntityType `json:"entity_type"`
Note string `json:"note"`
EntityId string `json:"entity_id"`
Object string `json:"object"`
}
type PdfRequestParams ¶
type PdfRequestParams struct {
DispositionType enum.DispositionType `json:"disposition_type,omitempty"`
}
type RecordPaymentRequestParams ¶
type RecordPaymentRequestParams struct {
Transaction *RecordPaymentTransactionParams `json:"transaction,omitempty"`
Comment string `json:"comment,omitempty"`
}
type RecordPaymentTransactionParams ¶
type RecordPaymentTransactionParams struct {
Amount *int64 `json:"amount,omitempty"`
PaymentMethod enum.PaymentMethod `json:"payment_method"`
ReferenceNumber string `json:"reference_number,omitempty"`
IdAtGateway string `json:"id_at_gateway,omitempty"`
Status transactionEnum.Status `json:"status,omitempty"`
Date *int64 `json:"date,omitempty"`
ErrorCode string `json:"error_code,omitempty"`
ErrorText string `json:"error_text,omitempty"`
}
type RecordRefundCreditNoteParams ¶
type RecordRefundCreditNoteParams struct {
ReasonCode creditNoteEnum.ReasonCode `json:"reason_code,omitempty"`
CreateReasonCode string `json:"create_reason_code,omitempty"`
}
type RecordRefundRequestParams ¶
type RecordRefundRequestParams struct {
Transaction *RecordRefundTransactionParams `json:"transaction,omitempty"`
CreditNote *RecordRefundCreditNoteParams `json:"credit_note,omitempty"`
Comment string `json:"comment,omitempty"`
CustomerNotes string `json:"customer_notes,omitempty"`
}
type RecordRefundTransactionParams ¶
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 RecordTaxWithheldRequestParams ¶ added in v3.2.0
type RecordTaxWithheldRequestParams struct {
TaxWithheld *RecordTaxWithheldTaxWithheldParams `json:"tax_withheld,omitempty"`
}
type RecordTaxWithheldTaxWithheldParams ¶ added in v3.2.0
type RefundCreditNoteParams ¶
type RefundCreditNoteParams struct {
ReasonCode creditNoteEnum.ReasonCode `json:"reason_code,omitempty"`
CreateReasonCode string `json:"create_reason_code,omitempty"`
}
type RefundRequestParams ¶
type RefundRequestParams struct {
RefundAmount *int64 `json:"refund_amount,omitempty"`
CreditNote *RefundCreditNoteParams `json:"credit_note,omitempty"`
Comment string `json:"comment,omitempty"`
CustomerNotes string `json:"customer_notes,omitempty"`
}
type RemoveCreditNoteCreditNoteParams ¶
type RemoveCreditNoteCreditNoteParams struct {
Id string `json:"id"`
}
type RemoveCreditNoteRequestParams ¶
type RemoveCreditNoteRequestParams struct {
CreditNote *RemoveCreditNoteCreditNoteParams `json:"credit_note,omitempty"`
}
type RemovePaymentRequestParams ¶
type RemovePaymentRequestParams struct {
Transaction *RemovePaymentTransactionParams `json:"transaction,omitempty"`
}
type RemovePaymentTransactionParams ¶
type RemovePaymentTransactionParams struct {
Id string `json:"id"`
}
type RemoveTaxWithheldRequestParams ¶ added in v3.2.0
type RemoveTaxWithheldRequestParams struct {
TaxWithheld *RemoveTaxWithheldTaxWithheldParams `json:"tax_withheld,omitempty"`
}
type RemoveTaxWithheldTaxWithheldParams ¶ added in v3.2.0
type RemoveTaxWithheldTaxWithheldParams struct {
Id string `json:"id"`
}
type ShippingAddress ¶
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 StopDunningRequestParams ¶
type StopDunningRequestParams struct {
Comment string `json:"comment,omitempty"`
}
type UpdateDetailsBillingAddressParams ¶
type UpdateDetailsBillingAddressParams struct {
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
Email string `json:"email,omitempty"`
Company string `json:"company,omitempty"`
Phone string `json:"phone,omitempty"`
Line1 string `json:"line1,omitempty"`
Line2 string `json:"line2,omitempty"`
Line3 string `json:"line3,omitempty"`
City string `json:"city,omitempty"`
StateCode string `json:"state_code,omitempty"`
State string `json:"state,omitempty"`
Zip string `json:"zip,omitempty"`
Country string `json:"country,omitempty"`
ValidationStatus enum.ValidationStatus `json:"validation_status,omitempty"`
}
type UpdateDetailsRequestParams ¶
type UpdateDetailsRequestParams struct {
BillingAddress *UpdateDetailsBillingAddressParams `json:"billing_address,omitempty"`
ShippingAddress *UpdateDetailsShippingAddressParams `json:"shipping_address,omitempty"`
VatNumber string `json:"vat_number,omitempty"`
VatNumberPrefix string `json:"vat_number_prefix,omitempty"`
PoNumber string `json:"po_number,omitempty"`
Comment string `json:"comment,omitempty"`
}
type UpdateDetailsShippingAddressParams ¶
type UpdateDetailsShippingAddressParams struct {
FirstName string `json:"first_name,omitempty"`
LastName string `json:"last_name,omitempty"`
Email string `json:"email,omitempty"`
Company string `json:"company,omitempty"`
Phone string `json:"phone,omitempty"`
Line1 string `json:"line1,omitempty"`
Line2 string `json:"line2,omitempty"`
Line3 string `json:"line3,omitempty"`
City string `json:"city,omitempty"`
StateCode string `json:"state_code,omitempty"`
State string `json:"state,omitempty"`
Zip string `json:"zip,omitempty"`
Country string `json:"country,omitempty"`
ValidationStatus enum.ValidationStatus `json:"validation_status,omitempty"`
}
type WriteOffRequestParams ¶
type WriteOffRequestParams struct {
Comment string `json:"comment,omitempty"`
}
Click to show internal directories.
Click to hide internal directories.