invoice

Documentation

Index

• Variables
• type CustomerService
• type Filter
• type Invoice
• type Repository
• type Service
  • func NewService(stripeClient *client.API, invoiceRepository Repository, ...) *Service
  • func (s *Service) Close() error
  • func (s *Service) DeleteByCustomer(ctx context.Context, c customer.Customer) error
  • func (s *Service) GetUpcoming(ctx context.Context, customerID string) (Invoice, error)
  • func (s *Service) Init(ctx context.Context) error
  • func (s *Service) List(ctx context.Context, filter Filter) ([]Invoice, error)
  • func (s *Service) ListAll(ctx context.Context, filter Filter) ([]Invoice, error)
  • func (s *Service) SyncWithProvider(ctx context.Context, customr customer.Customer) error

Variables

var (
	ErrNotFound      = fmt.Errorf("invoice not found")
	ErrInvalidDetail = fmt.Errorf("invalid invoice detail")
)

Types

type CustomerService

type CustomerService interface {
	GetByID(ctx context.Context, id string) (customer.Customer, error)
	List(ctx context.Context, filter customer.Filter) ([]customer.Customer, error)
}

type Filter

type Filter struct {
	CustomerID  string
	NonZeroOnly bool

	Pagination *pagination.Pagination
}

type Invoice

type Invoice struct {
	ID            string
	CustomerID    string
	ProviderID    string
	State         string
	Currency      string
	Amount        int64
	HostedURL     string
	DueAt         time.Time
	EffectiveAt   time.Time
	CreatedAt     time.Time
	PeriodStartAt time.Time
	PeriodEndAt   time.Time

	Metadata metadata.Metadata
}

type Repository

type Repository interface {
	Create(ctx context.Context, invoice Invoice) (Invoice, error)
	GetByID(ctx context.Context, id string) (Invoice, error)
	List(ctx context.Context, filter Filter) ([]Invoice, error)
	UpdateByID(ctx context.Context, invoice Invoice) (Invoice, error)
	Delete(ctx context.Context, id string) error
}

type Service

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

func NewService

func NewService(stripeClient *client.API, invoiceRepository Repository,
	customerService CustomerService, cfg billing.Config) *Service

func (*Service) Close

func (s *Service) Close() error

func (*Service) DeleteByCustomer

func (s *Service) DeleteByCustomer(ctx context.Context, c customer.Customer) error

func (*Service) GetUpcoming

func (s *Service) GetUpcoming(ctx context.Context, customerID string) (Invoice, error)

func (*Service) Init

func (s *Service) Init(ctx context.Context) error

func (*Service) List

func (s *Service) List(ctx context.Context, filter Filter) ([]Invoice, error)

List currently queries stripe for invoices, but it should be refactored to query our own database

func (*Service) ListAll

func (s *Service) ListAll(ctx context.Context, filter Filter) ([]Invoice, error)

ListAll should only be called by admin users

func (*Service) SyncWithProvider

func (s *Service) SyncWithProvider(ctx context.Context, customr customer.Customer) error