Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type BalanceTransaction ¶
type BalanceTransaction struct {
mixin.Model[BalanceTransaction]
CustomerId string `json:"customerId"`
Amount int64 `json:"amount"` // positive = credit, negative = debit
Currency currency.Type `json:"currency" orm:"default:usd"`
// "adjustment" | "credit_note" | "invoice_payment" | "deposit" | "bank_transfer" | "refund"
Type string `json:"type"`
Description string `json:"description,omitempty"`
InvoiceId string `json:"invoiceId,omitempty"`
CreditNoteId string `json:"creditNoteId,omitempty"`
SourceRef string `json:"sourceRef,omitempty"` // external reference
EndingBalance int64 `json:"endingBalance"` // balance after this transaction
Metadata Map `json:"metadata,omitempty" datastore:"-"`
Metadata_ string `json:"-" datastore:",noindex"`
}
BalanceTransaction records a single change to a customer's balance. Positive amount = credit (adds to balance), negative = debit.
func New ¶
func New(db *datastore.Datastore) *BalanceTransaction
func (*BalanceTransaction) Load ¶
func (bt *BalanceTransaction) Load(ps []datastore.Property) (err error)
func (*BalanceTransaction) Save ¶
func (bt *BalanceTransaction) Save() (ps []datastore.Property, err error)
func (*BalanceTransaction) Validator ¶
func (bt *BalanceTransaction) Validator() *val.Validator
Click to show internal directories.
Click to hide internal directories.