prro

package module

Go to main page

Versions in this module

v0

v0.2.0

Oct 10, 2026

Changes in this version

+ var ErrWebhookLimitReached = errors.New("prro: webhook limit reached")

type WebhookEvent

+ const EventReceiptRegistered

+ type WebhookList struct

+ Limit int

+ Used int

+ Webhooks []WebhookEndpoint

v0.1.1

Oct 7, 2026

Changes in this version

type WebhookDelivery

+ Sequence int64

v0.1.0

Oct 6, 2026

Changes in this version

+ const APIVersion

+ const DefaultBaseURL

+ const Version

+ var ErrForbidden = errors.New("prro: forbidden")

+ var ErrIdempotencyKeyReused = errors.New("prro: idempotency key reused")

+ var ErrNotFound = errors.New("prro: not found")

+ var ErrPaymentRequired = errors.New("prro: payment required")

+ var ErrTaskFailed = errors.New("prro: task failed")

+ var ErrUnauthorized = errors.New("prro: unauthorized")

+ var ErrValidation = errors.New("prro: validation failed")

+ type AbandonedDocument struct

+ Class string

+ CreatedAt time.Time

+ DocumentID string

+ FiscalNumber string

+ Kind ReceiptType

+ LocalNumber int64

+ PayForm string

+ TaskID string

+ Total Amount

+ type Amount string

+ func AmountFromKop(kop int64) Amount

+ func (a Amount) Kop() (int64, error)

+ type Attention struct

+ Reason AttentionReason

+ Since time.Time

+ type AttentionReason string

+ const AttentionAutoCloseFailing

+ const AttentionOfflineSubmissionPaused

+ const AttentionRecurringRemediation

+ type BillingPeriod struct

+ From Date

+ To Date

+ type BillingService service

+ func (s *BillingService) Usage(ctx context.Context, params *UsageParams) (*BillingUsage, error)

+ type BillingUsage struct

+ Balance Kopecks

+ Blocked bool

+ Charged Kopecks

+ Period BillingPeriod

+ Receipts int64

+ SoftLimit Kopecks

+ Tariff Tariff

+ type CallOption func(*callOptions)

+ func WithAsync() CallOption

+ func WithIdempotencyKey(key string) CallOption

+ type CardDetails struct

+ AcquirerID string

+ AcquirerName string

+ AcquirerTaxID string

+ AuthCode string

+ Commission Amount

+ DeviceID string

+ EPZDetails string

+ SystemName string

+ TransactionDate time.Time

+ TransactionNumber string

+ type CashBalance struct

+ Amount Amount

+ AsOf time.Time

+ type CashBalanceDeclaration struct

+ Adjustment Amount

+ Amount Amount

+ Previous Amount

+ type CashRegister struct

+ FiscalNumber string

+ ID string

+ LocalNumber string

+ Mode RegisterMode

+ OrgName string

+ PointAddress string

+ PointName string

+ State RegisterState

+ type CashRegisterState struct

+ Attention *Attention

+ CashBalance *CashBalance

+ CurrentShift *Shift

+ FiscalNumber string

+ ID string

+ LocalNumber string

+ Mode RegisterMode

+ OfflineLimits OfflineLimits

+ OfflineMonthUsedSeconds int64

+ OfflineReady bool

+ OfflineSession *OfflineSession

+ ShiftCloseTimes []string

+ ShiftMode ShiftMode

+ ShiftTotals *ShiftTotals

+ State RegisterState

+ type CashRegistersService service

+ func (s *CashRegistersService) ClearAttention(ctx context.Context, id string) (bool, error)

+ func (s *CashRegistersService) Get(ctx context.Context, id string) (*CashRegisterState, error)

+ func (s *CashRegistersService) List(ctx context.Context) ([]CashRegister, error)

+ func (s *CashRegistersService) SetCashBalance(ctx context.Context, id string, amount Amount) (*CashBalanceDeclaration, error)

+ type Client struct

+ Billing *BillingService

+ CashRegisters *CashRegistersService

+ Invoices *InvoicesService

+ OfflineSessions *OfflineSessionsService

+ Receipts *ReceiptsService

+ Shifts *ShiftsService

+ System *SystemService

+ Tasks *TasksService

+ Webhooks *WebhooksService

+ func NewClient(token string, opts ...Option) *Client

+ type CloseOfflineSessionParams struct

+ Cashier string

+ type CreateWebhookParams struct

+ Events []WebhookEvent

+ Secret string

+ URL string

+ type CreatedWebhook struct

+ Secret string

+ type DPSMode string

+ const DPSDegraded

+ const DPSOffline

+ const DPSOnline

+ type DPSStatus struct

+ Effective DPSMode

+ Failures int

+ LastOKAt time.Time

+ LastProbeAt time.Time

+ LatencyMS int64

+ Samples int

+ Since time.Time

+ Tunables DPSTunables

+ Verdict DPSMode

+ type DPSTunables struct

+ DegradedLatencyMS int64

+ ProbeIntervalSeconds int64

+ WindowSeconds int64

+ type Date string

+ func DateOf(t time.Time) Date

+ func (d Date) Time() (time.Time, error)

+ type DeliveryStatus string

+ const DeliveryDead

+ const DeliveryDelivered

+ const DeliveryDelivering

+ const DeliveryFailed

+ const DeliveryPending

+ type Discount struct

+ Percent string

+ Sum Amount

+ type DocResult struct

+ DocumentID string

+ FiscalNumber string

+ LocalNumber int64

+ Offline bool

+ Original *ReturnOriginal

+ ReceiptURL string

+ RegisterFiscalNumber string

+ TaxURL string

+ type Error struct

+ Code string

+ Details json.RawMessage

+ Fault *Fault

+ Message string

+ StatusCode int

+ TaskID string

+ func (e *Error) Error() string

+ func (e *Error) Unwrap() error

+ type Fault struct

+ Class FaultClass

+ Code string

+ Message string

+ Params map[string]any

+ Remediation []string

+ UpstreamMessage string

+ type FaultClass string

+ const FaultConfig

+ const FaultInternal

+ const FaultPrecursor

+ const FaultRequest

+ const FaultResync

+ const FaultTransient

+ const FaultUserAction

+ type Identity struct

+ AllCashRegisters bool

+ CashRegisters []string

+ ClientID string

+ ExpiresAt time.Time

+ Scopes []string

+ TokenID string

+ func (id *Identity) UnmarshalJSON(b []byte) error

+ type Invoice struct

+ Amount Kopecks

+ CreatedAt time.Time

+ Currency string

+ ID string

+ PeriodEnd Date

+ PeriodStart Date

+ Status InvoiceStatus

+ type InvoiceStatus string

+ const InvoiceDraft

+ const InvoiceIssued

+ const InvoiceOverdue

+ const InvoicePaid

+ type InvoicesService service

+ func (s *InvoicesService) All(ctx context.Context) iter.Seq2[Invoice, error]

+ func (s *InvoicesService) List(ctx context.Context, params *ListInvoicesParams) ([]Invoice, error)

+ type Kopecks string

+ type ListDeliveriesParams struct

+ Limit int

+ Status DeliveryStatus

+ type ListInvoicesParams struct

+ Limit int

+ Offset int

+ type OfflineAbandonResult struct

+ Abandoned []AbandonedDocument

+ Closed bool

+ ClosureSessionID string

+ DPSSessionID int64

+ HeldDocuments int64

+ SessionID string

+ type OfflineLimits struct

+ MonthSeconds int64

+ SessionSeconds int64

+ type OfflineSession struct

+ DPSSessionID int64

+ Documents int64

+ ID string

+ LastSignificantAt time.Time

+ StartedAt time.Time

+ type OfflineSessionsService service

+ func (s *OfflineSessionsService) Abandon(ctx context.Context, registerID string, opts ...CallOption) (*Task, error)

+ func (s *OfflineSessionsService) Close(ctx context.Context, registerID string, params *CloseOfflineSessionParams, ...) (*Task, error)

+ func (s *OfflineSessionsService) Retry(ctx context.Context, registerID string) (int, error)

+ type OpenShiftParams struct

+ Cashier string

+ type Option func(*Client)

+ func WithBaseURL(baseURL string) Option

+ func WithHTTPClient(hc *http.Client) Option

+ func WithLanguage(lang string) Option

+ func WithLogger(l *slog.Logger) Option

+ func WithRetry(maxRetries int) Option

+ func WithUserAgent(ua string) Option

+ type PayFormTotal struct

+ Code int

+ Name string

+ Sum Amount

+ type Payment struct

+ Card *CardDetails

+ Means string

+ Provided Amount

+ Sum Amount

+ Type PaymentType

+ type PaymentType string

+ const PaymentBankTransfer

+ const PaymentCard

+ const PaymentCash

+ const PaymentCertificate

+ const PaymentDirectDebit

+ type ReceiptInput interface

+ type ReceiptItem struct

+ Barcode string

+ Code string

+ Comment string

+ DKPP string

+ Discount *Discount

+ ExciseLabels []string

+ Name string

+ Price Amount

+ Quantity string

+ TaxLetters string

+ UKTZED string

+ UnitCode int

+ UnitName string

+ type ReceiptOriginal struct

+ Date Date

+ FiscalNumber string

+ RegisterFiscalNumber string

+ type ReceiptType string

+ const ReceiptReturn

+ const ReceiptSale

+ const ReceiptServiceIn

+ const ReceiptServiceOut

+ const ReceiptStorno

+ type ReceiptsService service

+ func (s *ReceiptsService) Create(ctx context.Context, in ReceiptInput, opts ...CallOption) (*Task, error)

+ type ReconcileCash struct

+ DPS Amount

+ Match bool

+ Ours Amount

+ type ReconcileReport struct

+ AttentionCleared bool

+ Cash *ReconcileCash

+ CounterNew int64

+ CounterOld int64

+ DPSNextLocalNumber int64

+ DPSShiftOpened bool

+ DPSTesting bool

+ FiscalNumber string

+ OfflineCredentialsRefreshed bool

+ ShiftAbandoned bool

+ ShiftAdopted bool

+ Skipped string

+ Totals *ReconcileTotals

+ type ReconcileTotals struct

+ DPS *ShiftTotalsBrief

+ Forced bool

+ Held string

+ Match bool

+ Ours ShiftTotalsBrief

+ ZReportSource string

+ type RegisterMode string

+ const RegisterProduction

+ const RegisterTest

+ type RegisterState string

+ const RegisterClosed

+ const RegisterOffline

+ const RegisterOpened

+ type ReturnOriginal struct

+ DocumentID string

+ FiscalNumber string

+ Verified bool

+ type ServiceReceipt struct

+ CashRegisterID string

+ Cashier string

+ Comment string

+ SoldAt time.Time

+ Sum Amount

+ Type ReceiptType

+ type SettlementReceipt struct

+ CashRegisterID string

+ Cashier string

+ Comment string

+ Items []ReceiptItem

+ Original *ReceiptOriginal

+ Payments []Payment

+ RoundingStep Amount

+ SoldAt time.Time

+ Type ReceiptType

+ type Shift struct

+ Documents int

+ ID string

+ Number int64

+ OpenedAt time.Time

+ Status ShiftStatus

+ Testing bool

+ type ShiftMode string

+ const ShiftManual

+ const ShiftRoundTheClock

+ const ShiftWorkingHours

+ type ShiftStatus string

+ const ShiftClosed

+ const ShiftClosing

+ const ShiftOpened

+ const ShiftOpening

+ type ShiftTotals struct

+ Returns ShiftTotalsSide

+ Sales ShiftTotalsSide

+ ServiceIn Amount

+ ServiceOut Amount

+ type ShiftTotalsBrief struct

+ Returns Amount

+ ReturnsCount int

+ Sales Amount

+ SalesCount int

+ ServiceInput Amount

+ ServiceOutput Amount

+ type ShiftTotalsSide struct

+ Count int

+ PayForms []PayFormTotal

+ Sum Amount

+ type ShiftsService service

+ func (s *ShiftsService) Close(ctx context.Context, registerID string, opts ...CallOption) (*Task, error)

+ func (s *ShiftsService) Open(ctx context.Context, registerID string, params *OpenShiftParams, ...) (*Task, error)

+ type SystemService service

+ func (s *SystemService) DPS(ctx context.Context) (*DPSStatus, error)

+ func (s *SystemService) Version(ctx context.Context) (string, error)

+ func (s *SystemService) WhoAmI(ctx context.Context) (*Identity, error)

+ type Tariff struct

+ PlanID string

+ PricePerReceipt Kopecks

+ type Task struct

+ CreatedAt time.Time

+ Error string

+ Fault *Fault

+ FinishedAt time.Time

+ ID string

+ Result *TaskResult

+ Status TaskStatus

+ Type TaskType

+ func (t *Task) Done() bool

+ type TaskResult struct

+ CashRegisterID string

+ OfflineAbandon *OfflineAbandonResult

+ OfflineEnd *DocResult

+ Receipt *DocResult

+ Reconcile *ReconcileReport

+ ShiftClose *DocResult

+ ShiftID string

+ ShiftNumber int64

+ ShiftOpen *DocResult

+ Testing bool

+ ZReport *DocResult

+ type TaskStatus string

+ const TaskFailed

+ const TaskPending

+ const TaskProcessing

+ const TaskSucceeded

+ type TaskType string

+ const TaskAbandonOfflineSession

+ const TaskCloseOfflineSession

+ const TaskCloseShift

+ const TaskOpenShift

+ const TaskReceipt

+ const TaskSyncRegister

+ type TasksService service

+ func (s *TasksService) Get(ctx context.Context, id string) (*Task, error)

+ func (s *TasksService) Wait(ctx context.Context, id string) (*Task, error)

+ type UpdateWebhookParams struct

+ Active *bool

+ Events []WebhookEvent

+ URL string

+ type UsageParams struct

+ From Date

+ To Date

+ type WebhookDelivery struct

+ Attempts int

+ CashRegisterID string

+ CreatedAt time.Time

+ Data json.RawMessage

+ DeliveredAt time.Time

+ Event WebhookEvent

+ ID string

+ LastError string

+ NextAttemptAt time.Time

+ Status DeliveryStatus

+ type WebhookEndpoint struct

+ Active bool

+ CreatedAt time.Time

+ Events []WebhookEvent

+ ID string

+ URL string

+ UpdatedAt time.Time

+ type WebhookEvent string

+ const EventClientBalanceLow

+ const EventDPSFlapping

+ const EventDPSModeChanged

+ const EventDPSOffline

+ const EventDPSOnline

+ const EventKeyExpiring

+ const EventPing

+ const EventRegisterNeedsAttention

+ const EventRegisterOffline

+ const EventRegisterOfflineAbandoned

+ const EventRegisterOfflineLimit

+ const EventRegisterOnline

+ const EventRegisterRemediated

+ const EventShiftClosed

+ const EventShiftOpened

+ const EventTaskCompleted

+ const EventTaskFailed

+ type WebhooksService service

+ func (s *WebhooksService) Create(ctx context.Context, params CreateWebhookParams) (*CreatedWebhook, error)

+ func (s *WebhooksService) Delete(ctx context.Context, id string) error

+ func (s *WebhooksService) Deliveries(ctx context.Context, id string, params *ListDeliveriesParams) ([]WebhookDelivery, error)

+ func (s *WebhooksService) List(ctx context.Context) ([]WebhookEndpoint, error)

+ func (s *WebhooksService) Replay(ctx context.Context, id, deliveryID string) (*WebhookDelivery, error)

+ func (s *WebhooksService) Update(ctx context.Context, id string, params UpdateWebhookParams) (*WebhookEndpoint, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL