receivableep

type EmailReceivablesForCustomerEndpoint struct{}

type EmailReceivablesForCustomerRequest struct {
	// ID of the customer account the statement is prepared for.
	AccountID string `json:"-" path:"account_id" validate:"required"`
	// Email addresses to send the statement of account to.
	//
	// The statement goes only to these addresses; the customer's own notification contacts are not added.
	RecipientEmails []string `json:"recipient_emails" validate:"required,min=1"`
}

type ExportReceivablesByCustomerEndpoint struct{}

type ExportReceivablesByCustomerRequest struct {
	// ID of the customer account whose outstanding balances are exported.
	AccountID string `json:"-" path:"account_id" validate:"required"`
	// Compute receivable balances as of this timestamp.
	//
	// Only invoices created before the cutoff are included, only payments whose funds had landed by then are subtracted from each remaining balance, and entries already settled by the cutoff drop out. When omitted, current balances are returned for every unpaid invoice.
	CutoffDate *time.Time `query:"cutoff_at"`
}

type ListReceivablesByCustomerEndpoint struct{}

type ListReceivablesByCustomerRequest struct {
	apiresource.PaginationRequest
	// ID of the customer account whose outstanding balances are listed.
	AccountID string `json:"-" path:"account_id" validate:"required"`
	// Compute receivable balances as of this timestamp.
	//
	// Only invoices created before the cutoff are included, only payments whose funds had landed by then are subtracted from each remaining balance, and entries already settled by the cutoff drop out. When omitted, current balances are returned for every unpaid invoice.
	CutoffDate *time.Time `query:"cutoff_at"`
}

type ListReceivablesEndpoint struct{}

type ListReceivablesRequest struct {
	apiresource.PaginationRequest
	// Compute receivable balances as of this timestamp.
	//
	// Only invoices created before the cutoff are included, only payments whose funds had landed by then are subtracted from each remaining balance, and entries already settled by the cutoff drop out. When omitted, current balances are returned for every unpaid invoice.
	CutoffDate *time.Time `query:"cutoff_at"`
}

type ReceivableSvc interface {
	ListReceivables(ctx context.Context, req *ListReceivablesRequest) (*apiresource.List[apiresource.ReceivableEntry], *apierror.APIError)
	ListReceivablesByCustomer(ctx context.Context, req *ListReceivablesByCustomerRequest) (*apiresource.List[apiresource.ReceivableEntry], *apierror.APIError)
	ExportReceivablesByCustomer(ctx context.Context, req *ExportReceivablesByCustomerRequest) (*httptransport.FileDownload, *apierror.APIError)
	EmailReceivablesForCustomer(ctx context.Context, req *EmailReceivablesForCustomerRequest) (*apiresource.EmptyResource, *apierror.APIError)
}

type ReceivableSvcConfig struct {
	// CoreClient (required) is the core-service gRPC client.
	CoreClient pb.CoreServiceClient
}