API Reference Corvo NFS-e v#0.1.1

Copy Markdown View Source

Modules

Official Elixir SDK for the Corvo NFS-e API.

Configuration for a Corvo NFS-e API connection.

The single error type returned by every Corvo NFS-e API call.

Behaviour for the HTTP layer used by CorvoNfse.Transport.

Billing plan and quota usage (/v1/billing).

A1 (.p12) certificate management for a company.

Company management: create, list, iterate, get, update and remove.

Credit balance, purchasable plans and the credit ledger.

The two public (no API key scope required) health checks.

NFS-e invoice lifecycle: create, read, list, iterate, events, downloads and email.

The public price catalog (monthly cycle only). Values are in centavos.

Webhook configuration and delivery inspection.

Webhook delivery inspection: list, iterate, stats and retry (/v1/webhooks/deliveries/...).

HTTP plumbing shared by every resource module.

Wire shapes of the billing plan (snake_case fields, nested plan, subscription and usage objects - exactly as the server sends them) and the camelCase quota status.

Wire shape of GET /billing/plan (nested snake_case objects).

Wire shape of GET /billing/usage (camelCase).

Wire shape of an A1 (.p12) certificate stored for a company.

Shared wire types.

Wire shape of a fiscal company. Optional fields are absent from the JSON when unset.

Wire shapes of the credit balance, purchasable plans and the credit ledger.

Wire shape of GET /credits.

Wire shape of an entry of GET /credits/plans.

Wire shape of an entry of the public catalog (GET /plans); prices in centavos.

Wire shape of an entry of GET /credits/history. amount is in credits (not BRL); fields ending in Cents are in centavos.

Wire shape of an NFS-e invoice.

Wire shapes of webhook configs, deliveries and delivery stats, plus the canonical list of webhook events.

Wire shape of a webhook delivery attempt.

Webhook signature verification.