# Corvo NFS-e v0.1.1 - API Reference

## Modules

- [CorvoNfse](CorvoNfse.md): Official Elixir SDK for the Corvo NFS-e API.
- [CorvoNfse.Client](CorvoNfse.Client.md): Configuration for a Corvo NFS-e API connection.
- [CorvoNfse.HTTP](CorvoNfse.HTTP.md): Behaviour for the HTTP layer used by `CorvoNfse.Transport`.
- [CorvoNfse.Resources.Billing](CorvoNfse.Resources.Billing.md): Billing plan and quota usage (`/v1/billing`).

- [CorvoNfse.Resources.Certificates](CorvoNfse.Resources.Certificates.md): A1 (`.p12`) certificate management for a company.
- [CorvoNfse.Resources.Companies](CorvoNfse.Resources.Companies.md): Company management: create, list, iterate, get, update and remove.
- [CorvoNfse.Resources.Credits](CorvoNfse.Resources.Credits.md): Credit balance, purchasable plans and the credit ledger.
- [CorvoNfse.Resources.Health](CorvoNfse.Resources.Health.md): The two public (no API key scope required) health checks.
- [CorvoNfse.Resources.Invoices](CorvoNfse.Resources.Invoices.md): NFS-e invoice lifecycle: create, read, list, iterate, events, downloads and
email.
- [CorvoNfse.Resources.Plans](CorvoNfse.Resources.Plans.md): The public price catalog (monthly cycle only). Values are in centavos.
- [CorvoNfse.Resources.Webhooks](CorvoNfse.Resources.Webhooks.md): Webhook configuration and delivery inspection.
- [CorvoNfse.Resources.Webhooks.Deliveries](CorvoNfse.Resources.Webhooks.Deliveries.md): Webhook delivery inspection: `list`, `iterate`, `stats` and `retry`
(`/v1/webhooks/deliveries/...`).

- [CorvoNfse.Transport](CorvoNfse.Transport.md): HTTP plumbing shared by every resource module.
- [CorvoNfse.Types.Billing](CorvoNfse.Types.Billing.md): 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.

- [CorvoNfse.Types.Billing.PlanResponse](CorvoNfse.Types.Billing.PlanResponse.md): Wire shape of `GET /billing/plan` (nested snake_case objects).
- [CorvoNfse.Types.Billing.QuotaStatus](CorvoNfse.Types.Billing.QuotaStatus.md): Wire shape of `GET /billing/usage` (camelCase).
- [CorvoNfse.Types.Certificate](CorvoNfse.Types.Certificate.md): Wire shape of an A1 (`.p12`) certificate stored for a company.

- [CorvoNfse.Types.Common](CorvoNfse.Types.Common.md): Shared wire types.
- [CorvoNfse.Types.Company](CorvoNfse.Types.Company.md): Wire shape of a fiscal company. Optional fields are absent from the JSON when
unset.
- [CorvoNfse.Types.Credits](CorvoNfse.Types.Credits.md): Wire shapes of the credit balance, purchasable plans and the credit ledger.
- [CorvoNfse.Types.Credits.Balance](CorvoNfse.Types.Credits.Balance.md): Wire shape of `GET /credits`.
- [CorvoNfse.Types.Credits.Plan](CorvoNfse.Types.Credits.Plan.md): Wire shape of an entry of `GET /credits/plans`.
- [CorvoNfse.Types.Credits.PlanQuote](CorvoNfse.Types.Credits.PlanQuote.md): Wire shape of an entry of the public catalog (`GET /plans`); prices in centavos.
- [CorvoNfse.Types.Credits.Transaction](CorvoNfse.Types.Credits.Transaction.md): Wire shape of an entry of `GET /credits/history`. `amount` is in credits
(not BRL); fields ending in `Cents` are in centavos.

- [CorvoNfse.Types.Invoice](CorvoNfse.Types.Invoice.md): Wire shape of an NFS-e invoice.
- [CorvoNfse.Types.Webhook](CorvoNfse.Types.Webhook.md): Wire shapes of webhook configs, deliveries and delivery stats, plus the
canonical list of webhook events.

- [CorvoNfse.Types.Webhook.Delivery](CorvoNfse.Types.Webhook.Delivery.md): Wire shape of a webhook delivery attempt.
- [CorvoNfse.Webhooks](CorvoNfse.Webhooks.md): Webhook signature verification.

- Exceptions
  - [CorvoNfse.Error](CorvoNfse.Error.md): The single error type returned by every Corvo NFS-e API call.