Versions in this module Expand all Collapse all v1 v1.0.1 Nov 2, 2026 Changes in this version + const BillKindCreditNote + const BillKindDebtCollection + const BillKindInvoice + const BillKindPaymentConfirmation + const BillKindReceipt + const BillKindReminder + const BillLetterKindDebtCollection + const BillLetterKindReminder + const CodeExtractionTimeout + const CodeInvalidPayload + const CodeInvalidSignature + const CodeNetworkError + const CodeSignatureTooOld + const CodeTimeout + const CodeUnexpectedResponse + const DefaultBaseURL + const DefaultMaxRetries + const DefaultPollInterval + const DefaultTimeout + const DefaultWaitTimeout + const DefaultWebhookTolerance + const DeliveryHeader + const DocumentApprovalStateApproved + const DocumentApprovalStateChangesRequested + const DocumentApprovalStateDraft + const DocumentApprovalStateReady + const DocumentSourceAPI + const DocumentSourceDashboard + const DocumentSourceEmail + const DocumentSourceSandbox + const DocumentSourceStorage + const DocumentStatusDone + const DocumentStatusFailed + const DocumentStatusPending + const DocumentStatusProcessing + const EventHeader + const ExtractionCategorySourceMemory + const ExtractionCategorySourceModel + const ExtractionCategorySourceUser + const ExtractionDocumentKindCreditNote + const ExtractionDocumentKindDebtCollection + const ExtractionDocumentKindInvoice + const ExtractionDocumentKindPaymentConfirmation + const ExtractionDocumentKindReceipt + const ExtractionDocumentKindReminder + const ExtractionJobStatusFailed + const ExtractionJobStatusQueued + const ExtractionJobStatusRunning + const ExtractionJobStatusSucceeded + const ExtractionStatusDone + const ExtractionStatusFailed + const ExtractionStatusPending + const FraudIndicatorSeverityHigh + const FraudIndicatorSeverityLow + const FraudIndicatorSeverityMedium + const FraudIndicatorSourceEngine + const FraudIndicatorSourceModel + const HeldEmailHoldReasonNewSender + const HeldEmailHoldReasonNoPlan + const HeldEmailHoldReasonQuotaUsed + const HeldEmailHoldReasonUnverifiedSender + const HeldEmailSenderFailed + const HeldEmailSenderUnknown + const HeldEmailSenderVerified + const QualityIssuesBlurry + const QualityIssuesCropped + const QualityIssuesHandwritten + const QualityIssuesLowContrast + const QualityIssuesPartial + const QualityIssuesRotated + const ReviewReasonAmountAnomaly + const ReviewReasonAmountOverLimit + const ReviewReasonBankDetailsChanged + const ReviewReasonDuplicate + const ReviewReasonLowConfidence + const ReviewReasonMissingPoNumber + const ReviewReasonPoorQuality + const ReviewReasonTotalMismatch + const ReviewReasonUnusualVendor + const ReviewStatusDismissed + const ReviewStatusPending + const ReviewStatusResolved + const SignatureHeader + const StatsOverviewPlanGrowth + const StatsOverviewPlanScale + const StatsOverviewPlanStarter + const Version + var ErrMissingAPIKey = errors.New(...) + func DateOf(t time.Time) string + func MonthOf(t time.Time) string + type BatchResult = generated.ExtractDocumentBatch200JSONResponseBody + type BatchResultItem = generated.BatchResultItem + type Bill = generated.Bill + type BillChain = generated.BillDetail_Chain + type BillChainMember = generated.BillChainMember + type BillDetail = generated.BillDetail + type BillKind = generated.BillKind + type BillLetter = generated.BillLetter + type BillLetterKind = generated.BillLetterKind + type BillRecord = generated.BillRecord + type BillRelated = generated.BillRelated + type BillWarning = generated.BillChainMember_Warnings + type BillsDue = generated.BillsDue + type BillsService struct + func (s *BillsService) Get(ctx context.Context, id string) (*BillDetail, error) + func (s *BillsService) GetFile(ctx context.Context, id string) (*Download, error) + func (s *BillsService) List(ctx context.Context, params *ListBillsParams) ([]Bill, error) + func (s *BillsService) MarkPaid(ctx context.Context, id string) (*BillRecord, error) + func (s *BillsService) MarkUnpaid(ctx context.Context, id string) (*BillRecord, error) + func (s *BillsService) Stats(ctx context.Context, params *BillsStatsParams) (*BillsStats, error) + func (s *BillsService) Summary(ctx context.Context, params *BillsSummaryParams) (*BillsSummary, error) + type BillsStats = generated.BillsStats + type BillsStatsMonth = generated.BillsStats_Trend + type BillsStatsParams struct + Month string + Sender string + type BillsStatsSender = generated.BillsStats_Senders + type BillsStatsTopSender = generated.BillsStats_TopSenders + type BillsStatsTotal = generated.BillsStats_Totals + type BillsSummary = generated.BillsSummary + type BillsSummaryParams struct + Days int + Today string + type Category = generated.Category + type Client struct + Bills *BillsService + HeldEmails *HeldEmailsService + func New(apiKey string, opts ...Option) (*Client, error) + func (c *Client) CreateWebhookEndpoint(ctx context.Context, params CreateWebhookEndpointParams) (*WebhookEndpointWithSecret, error) + func (c *Client) DeleteWebhookEndpoint(ctx context.Context, id string) error + func (c *Client) Extract(ctx context.Context, file File, params *ExtractParams) (*ExtractResult, error) + func (c *Client) ExtractAndWait(ctx context.Context, file File, params *ExtractAndWaitParams) (*ExtractResult, error) + func (c *Client) ExtractBatch(ctx context.Context, files []File) (*BatchResult, error) + func (c *Client) GetDocument(ctx context.Context, id string) (*DocumentDetail, error) + func (c *Client) GetDocumentFile(ctx context.Context, id string) (*Download, error) + func (c *Client) GetStats(ctx context.Context) (*StatsOverview, error) + func (c *Client) GetUsage(ctx context.Context) (*Usage, error) + func (c *Client) ListCategories(ctx context.Context) ([]Category, error) + func (c *Client) ListDocuments(ctx context.Context, params *ListDocumentsParams) ([]DocumentListItem, error) + func (c *Client) ListReviewQueue(ctx context.Context, params *ListReviewQueueParams) ([]ReviewQueueListItem, error) + func (c *Client) ListWebhookEndpoints(ctx context.Context) (*WebhookEndpointList, error) + func (c *Client) ResolveReviewItem(ctx context.Context, id string, status ReviewStatus) (*ReviewQueueItem, error) + func (c *Client) WaitForExtraction(ctx context.Context, documentID string, params *WaitParams) (*Extraction, error) + type CreateWebhookEndpointParams struct + Description string + Events []EventType + URL string + type CustomValue = generated.CustomValue + type Discovery = generated.Discovery + type Document = generated.Document + type DocumentApproval = generated.DocumentApproval + type DocumentApprovalState = generated.DocumentApprovalState + type DocumentDetail = generated.GetDocument200JSONResponseBody + type DocumentListItem = generated.DocumentListItem + type DocumentSource = generated.DocumentSource + type DocumentStatus = generated.DocumentStatus + type Download struct + ContentType string + Data []byte + Filename string + type ErrorDetail = generated.ErrorDetail + type EventType string + const EventAll + const EventDocumentCreated + const EventDocumentRequestFulfilled + const EventExtractionCompleted + const EventExtractionFailed + const EventReviewItemCreated + const EventReviewItemResolved + type ExtractAndWaitParams struct + IdempotencyKey string + PollInterval time.Duration + Timeout time.Duration + type ExtractParams struct + IdempotencyKey string + type ExtractResult struct + Document Document + Duplicate bool + Extraction *Extraction + type Extraction = generated.Extraction + type ExtractionCategorySource = generated.ExtractionCategorySource + type ExtractionDocumentKind = generated.ExtractionDocumentKind + type ExtractionJob = generated.ExtractionJob + type ExtractionJobStatus = generated.ExtractionJobStatus + type ExtractionStatus = generated.ExtractionStatus + type File struct + ContentType string + Data []byte + Filename string + func FileFromBytes(filename string, data []byte) File + func FileFromPath(path string) (File, error) + func FileFromReader(filename string, r io.Reader) (File, error) + type FraudIndicator = generated.FraudIndicator + type FraudIndicatorSeverity = generated.FraudIndicatorSeverity + type FraudIndicatorSource = generated.FraudIndicatorSource + type HeldEmail = generated.HeldEmail + type HeldEmailFile = generated.HeldEmailFile + type HeldEmailHoldReason = generated.HeldEmailHoldReason + type HeldEmailSender = generated.HeldEmailSender + type HeldEmailsService struct + func (s *HeldEmailsService) List(ctx context.Context) ([]HeldEmail, error) + type InvoistError struct + Body []byte + Code string + Err error + Message string + RequestID string + Status int + func (e *InvoistError) Error() string + func (e *InvoistError) IsAuthError() bool + func (e *InvoistError) IsNotFound() bool + func (e *InvoistError) IsPermissionError() bool + func (e *InvoistError) IsRateLimited() bool + func (e *InvoistError) IsRetryable() bool + func (e *InvoistError) Unwrap() error + type LineItem = generated.LineItem + type ListBillsParams struct + Limit int + Month string + Offset int + Paid *bool + Q string + Sender string + type ListDocumentsParams struct + Category string + Flagged bool + Limit int + Offset int + Q string + Status DocumentStatus + type ListReviewQueueParams struct + Status ReviewStatus + type Option func(*Client) + func WithBaseURL(baseURL string) Option + func WithHTTPClient(hc *http.Client) Option + func WithMaxRetries(n int) Option + func WithTimeout(d time.Duration) Option + type Quality = generated.Quality + type QualityIssues = generated.QualityIssues + type RegionBox = generated.RegionBox + type ReviewQueueItem = generated.ReviewQueueItem + type ReviewQueueListItem = generated.ReviewQueueListItem + type ReviewReason = generated.ReviewReason + type ReviewStatus = generated.ReviewStatus + type StatsOverview = generated.StatsOverview + type StatsOverviewPlan = generated.StatsOverviewPlan + type Usage = generated.Usage + type UsageDay = generated.Usage_ByDay + type WaitParams struct + PollInterval time.Duration + Timeout time.Duration + type WebhookEndpoint = generated.WebhookEndpoint + type WebhookEndpointList = generated.ListWebhookEndpoints200JSONResponseBody + type WebhookEndpointWithSecret = generated.WebhookEndpointWithSecret + type WebhookEvent struct + CreatedAt time.Time + Data json.RawMessage + ID string + Type EventType + func VerifyWebhook(payload []byte, signatureHeader, secret string, opts ...WebhookOption) (*WebhookEvent, error) + func (e *WebhookEvent) DecodeData(v any) error + type WebhookOption func(*webhookOptions) + func WithNow(t time.Time) WebhookOption + func WithTolerance(d time.Duration) WebhookOption