Documentation
¶
Index ¶
- type CreatePaymentTermEndpoint
- type CreatePaymentTermRequest
- type DeletePaymentTermEndpoint
- type DeletePaymentTermRequest
- type ListPaymentTermsEndpoint
- type ListPaymentTermsRequest
- type PaymentTermSvc
- type PaymentTermSvcConfig
- type RetrievePaymentTermEndpoint
- type RetrievePaymentTermRequest
- type UpdatePaymentTermEndpoint
- type UpdatePaymentTermRequest
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type CreatePaymentTermEndpoint ¶
type CreatePaymentTermEndpoint struct{}
Creates a payment term.
The new term is owned by your account and starts with status `active`.
func (*CreatePaymentTermEndpoint) Materialize ¶
func (e *CreatePaymentTermEndpoint) Materialize() *apiendpoint.APIEndpoint[*CreatePaymentTermRequest, *apiresource.PaymentTerm]
type CreatePaymentTermRequest ¶
type CreatePaymentTermRequest struct {
// Display name (e.g. `Net 30`).
//
// Must be unique among the payment terms visible to your account, including system defaults.
Name string `json:"name" validate:"required,max=255"`
}
Request to create a payment term.
func (*CreatePaymentTermRequest) SchemaExample ¶
func (*CreatePaymentTermRequest) SchemaExample() any
type DeletePaymentTermEndpoint ¶
type DeletePaymentTermEndpoint struct{}
Deletes a payment term.
Only payment terms created by your account can be deleted; system-owned default terms cannot be.
func (*DeletePaymentTermEndpoint) Materialize ¶
func (e *DeletePaymentTermEndpoint) Materialize() *apiendpoint.APIEndpoint[*DeletePaymentTermRequest, *apiresource.EmptyResource]
type DeletePaymentTermRequest ¶
type DeletePaymentTermRequest struct {
// Payment term ID.
PaymentTermID string `path:"id" validate:"required"`
}
Request to delete a payment term.
type ListPaymentTermsEndpoint ¶
type ListPaymentTermsEndpoint struct{}
Returns a paginated list of payment terms.
The list includes both payment terms created by your account and OpenMRP-provided system defaults.
func (*ListPaymentTermsEndpoint) Materialize ¶
func (e *ListPaymentTermsEndpoint) Materialize() *apiendpoint.APIEndpoint[*ListPaymentTermsRequest, *apiresource.List[apiresource.PaymentTerm]]
type ListPaymentTermsRequest ¶
type ListPaymentTermsRequest struct {
apiresource.PaginationRequest
}
Request to list payment terms.
type PaymentTermSvc ¶
type PaymentTermSvc interface {
ListPaymentTerms(ctx context.Context, req *ListPaymentTermsRequest) (*apiresource.List[apiresource.PaymentTerm], *apierror.APIError)
GetPaymentTerm(ctx context.Context, req *RetrievePaymentTermRequest) (*apiresource.PaymentTerm, *apierror.APIError)
CreatePaymentTerm(ctx context.Context, req *CreatePaymentTermRequest) (*apiresource.PaymentTerm, *apierror.APIError)
UpdatePaymentTerm(ctx context.Context, req *UpdatePaymentTermRequest) (*apiresource.PaymentTerm, *apierror.APIError)
DeletePaymentTerm(ctx context.Context, req *DeletePaymentTermRequest) (*apiresource.EmptyResource, *apierror.APIError)
}
func NewPaymentTermSvc ¶
func NewPaymentTermSvc(config *PaymentTermSvcConfig) PaymentTermSvc
type PaymentTermSvcConfig ¶
type PaymentTermSvcConfig struct {
// CoreClient (required) is the core-service gRPC client.
CoreClient pb.CoreServiceClient
}
type RetrievePaymentTermEndpoint ¶
type RetrievePaymentTermEndpoint struct{}
Returns a payment term by ID.
Both payment terms created by your account and OpenMRP-provided system defaults can be retrieved.
func (*RetrievePaymentTermEndpoint) Materialize ¶
func (e *RetrievePaymentTermEndpoint) Materialize() *apiendpoint.APIEndpoint[*RetrievePaymentTermRequest, *apiresource.PaymentTerm]
type RetrievePaymentTermRequest ¶
type RetrievePaymentTermRequest struct {
// Payment term ID.
PaymentTermID string `path:"id" validate:"required"`
}
Request to retrieve a payment term.
type UpdatePaymentTermEndpoint ¶
type UpdatePaymentTermEndpoint struct{}
Partially updates a payment term.
Only payment terms created by your account can be updated; system-owned default terms cannot be.
func (*UpdatePaymentTermEndpoint) Materialize ¶
func (e *UpdatePaymentTermEndpoint) Materialize() *apiendpoint.APIEndpoint[*UpdatePaymentTermRequest, *apiresource.PaymentTerm]
type UpdatePaymentTermRequest ¶
type UpdatePaymentTermRequest struct {
// Payment term ID.
PaymentTermID string `path:"id" validate:"required"`
// New display name for the payment term.
//
// Must be unique among the payment terms visible to your account, including system defaults.
Name field.Optional[string] `json:"name,omitzero" validate:"omitempty,max=255"`
}
Request to partially update a payment term.
func (*UpdatePaymentTermRequest) SchemaExample ¶
func (*UpdatePaymentTermRequest) SchemaExample() any