# Spedy ## Docs - [Alterar Cliente](https://docs.spedy.com.br/api-reference/clientes/alterar-cliente.md) - [Criar Cliente](https://docs.spedy.com.br/api-reference/clientes/criar-cliente.md): Cadastra um cliente (destinatário das notas). Clientes pertencem à **conta** e são compartilhados por todas as empresas. - [Excluir Cliente](https://docs.spedy.com.br/api-reference/clientes/excluir-cliente.md) - [Listar Clientes](https://docs.spedy.com.br/api-reference/clientes/listar-clientes.md): Lista os clientes da conta (compartilhados entre empresas), com paginação e filtros. - [Obter Cliente](https://docs.spedy.com.br/api-reference/clientes/obter-cliente.md) - [Adicionar certificado](https://docs.spedy.com.br/api-reference/empresas/adicionar-certificado.md): Envia o certificado digital A1 (`.pfx`) e a senha da empresa, via `multipart/form-data`. O certificado assina NF-e/NFC-e e, quando o município exige, NFS-e. Cada empresa mantém apenas **um** certificado ativo: o último enviado substitui o anterior. - [Alterar configurações](https://docs.spedy.com.br/api-reference/empresas/alterar-configurações.md): Atualiza as configurações de emissão da empresa, organizadas em quatro blocos **independentes**: - **general** — comportamento geral e o **responsável técnico** (`infRespTec` da NF-e/NFC-e), casas decimais dos valores e o flag de campos da Reforma Tributária. - **productInvoice**… - [Alterar Empresa](https://docs.spedy.com.br/api-reference/empresas/alterar-empresa.md) - [Criar Empresa](https://docs.spedy.com.br/api-reference/empresas/criar-empresa.md): Cadastra uma empresa emissora (CNPJ, razão social, endereço). Requer a chave da **empresa titular** — a única autorizada a gerenciar empresas. A resposta traz a `X-Api-Key` da nova empresa. - [Excluir Empresa](https://docs.spedy.com.br/api-reference/empresas/excluir-empresa.md) - [Listar Empresas](https://docs.spedy.com.br/api-reference/empresas/listar-empresas.md): Lista as empresas da conta, com paginação e filtros. - [Obter certificados](https://docs.spedy.com.br/api-reference/empresas/obter-certificados.md): Lista os certificados digitais cadastrados na empresa, indicando qual está ativo (`isActive`) e a data de validade (`expirationAt`) de cada um. - [Obter configurações](https://docs.spedy.com.br/api-reference/empresas/obter-configurações.md): Retorna as configurações de emissão da empresa (blocos `general`, `productInvoice`, `consumerInvoice` e `serviceInvoice`) — série, numeração, ambiente, CSC e responsável técnico. - [Obter Empresa](https://docs.spedy.com.br/api-reference/empresas/obter-empresa.md) - [Cancelar NF-e](https://docs.spedy.com.br/api-reference/nf-e/cancelar-nf-e.md): Cancela uma nota **autorizada**, dentro do prazo legal, informando a justificativa (`reason`). O cancelamento é processado de forma **assíncrona** até o status `canceled` — acompanhe por webhook ou consulta. Prazos e regras variam por UF (NF-e/NFC-e) e por município (NFS-e). - [Carta de Correção](https://docs.spedy.com.br/api-reference/nf-e/carta-de-correção.md): Registra uma carta de correção (CC-e) para uma NF-e **autorizada**, corrigindo dados **acessórios** sem cancelá-la — é exclusiva de NF-e. Não pode alterar valores, tributos, dados do destinatário nem datas; nesses casos, cancele e reemita. O texto (`letter`) exige de 15 a 1000 caracteres. Cada cha… - [Consultar nota fiscal](https://docs.spedy.com.br/api-reference/nf-e/consultar-nota-fiscal.md): Consulta o status da NF-e diretamente na SEFAZ e reconcilia o resultado no Spedy. Use esta consulta para **reconciliar** uma nota cujo status no Spedy pode estar desatualizado em relação à SEFAZ: - Nota marcada como **Rejeitada** no Spedy mas que consta **autorizada** n… - [Criar NF-e](https://docs.spedy.com.br/api-reference/nf-e/criar-nf-e.md): Cria uma **NF-e** (nota de produto, modelo 55) e a enfileira para emissão junto à SEFAZ. A emissão é **assíncrona**: a resposta `2xx` confirma que a solicitação foi aceita, não que a nota foi autorizada — acompanhe o resultado por webhook ou consulta. **integrationId** — Identificad… - [Download do PDF da NF-e](https://docs.spedy.com.br/api-reference/nf-e/download-do-pdf-da-nf-e.md): Baixa o **PDF do documento auxiliar** (DANFE, DANFE-NFC-e ou DANFSe) — a representação visual da nota, para impressão ou envio ao cliente. Disponível após a autorização. - [Download do XML da NF-e](https://docs.spedy.com.br/api-reference/nf-e/download-do-xml-da-nf-e.md): Baixa o **XML autorizado** da nota — o documento fiscal em si, assinado e válido perante o fisco. Disponível após a autorização. - [Inutilização de numeração](https://docs.spedy.com.br/api-reference/nf-e/inutilização-de-numeração.md): Formaliza junto à SEFAZ que uma faixa de numeração (`series` + intervalo `initialNumber`..`finalNumber`) **não será usada**, regularizando uma quebra de sequência. Não é cancelamento: aplica-se a números que **nunca** foram autorizados. A justificativa (`reason`) exige no mínimo 15 caracteres. O r… - [Listar inutilizações](https://docs.spedy.com.br/api-reference/nf-e/listar-inutilizações.md): Lista as inutilizações de numeração já solicitadas pela empresa, paginadas, com o `status` de cada uma. - [Listar Notas Fiscais](https://docs.spedy.com.br/api-reference/nf-e/listar-notas-fiscais.md): Lista as notas fiscais da empresa, das mais recentes para as mais antigas, com paginação e filtros por período de competência, `status`, `integrationId`, `transactionId` e dados do destinatário. - [Obter NF-e](https://docs.spedy.com.br/api-reference/nf-e/obter-nf-e.md): Retorna a nota pelo `id`, com o `status` atual e o resultado do último processamento (`processingDetail`). Use para acompanhar o status quando não usa webhooks. - [PDF da Carta de Correção](https://docs.spedy.com.br/api-reference/nf-e/pdf-da-carta-de-correção.md): Baixa o PDF de um evento de carta de correção específico, identificado por `eventId`. - [Reemitir nota fiscal](https://docs.spedy.com.br/api-reference/nf-e/reemitir-nota-fiscal.md): Reprocessa a emissão de uma nota que ficou **pendente** ou falhou por erro transitório — por exemplo, após corrigir uma configuração da empresa. Não cria uma nota nova nem altera os dados: apenas reenvia a nota existente para a autoridade. Aceita `effectiveDate` opcional (data de competência). - [Reenviar e-mail](https://docs.spedy.com.br/api-reference/nf-e/reenviar-e-mail.md): Reenvia ao destinatário o e-mail com a nota autorizada (PDF/XML). Útil quando o envio automático falhou ou o cliente pede a segunda via. Requer e-mail cadastrado no destinatário. - [XML da Carta de Correção](https://docs.spedy.com.br/api-reference/nf-e/xml-da-carta-de-correção.md): Baixa o XML de um evento de carta de correção específico, identificado por `eventId`. - [Cancelar NFC-e](https://docs.spedy.com.br/api-reference/nfc-e/cancelar-nfc-e.md): Cancela uma nota **autorizada**, dentro do prazo legal, informando a justificativa (`reason`). O cancelamento é processado de forma **assíncrona** até o status `canceled` — acompanhe por webhook ou consulta. Prazos e regras variam por UF (NF-e/NFC-e) e por município (NFS-e). - [Consultar nota fiscal](https://docs.spedy.com.br/api-reference/nfc-e/consultar-nota-fiscal.md): Consulta o status da NFC-e diretamente na SEFAZ e reconcilia o resultado no Spedy. Use esta consulta para **reconciliar** uma nota cujo status no Spedy pode estar desatualizado em relação à SEFAZ: - Nota marcada como **Rejeitada** no Spedy mas que consta **autorizada**… - [Criar NFC-e](https://docs.spedy.com.br/api-reference/nfc-e/criar-nfc-e.md): Cria uma **NFC-e** (nota ao consumidor, modelo 65) e a enfileira para emissão junto à SEFAZ. A emissão é **assíncrona**: a resposta `2xx` confirma que a solicitação foi aceita, não que a nota foi autorizada — acompanhe o resultado por webhook ou consulta. **integrationId** — Identif… - [Download do PDF da NFC-e](https://docs.spedy.com.br/api-reference/nfc-e/download-do-pdf-da-nfc-e.md): Baixa o **PDF do documento auxiliar** (DANFE, DANFE-NFC-e ou DANFSe) — a representação visual da nota, para impressão ou envio ao cliente. Disponível após a autorização. - [Download do XML da NFC-e](https://docs.spedy.com.br/api-reference/nfc-e/download-do-xml-da-nfc-e.md): Baixa o **XML autorizado** da nota — o documento fiscal em si, assinado e válido perante o fisco. Disponível após a autorização. - [Inutilização de numeração](https://docs.spedy.com.br/api-reference/nfc-e/inutilização-de-numeração.md): Formaliza junto à SEFAZ que uma faixa de numeração (`series` + intervalo `initialNumber`..`finalNumber`) **não será usada**, regularizando uma quebra de sequência. Não é cancelamento: aplica-se a números que **nunca** foram autorizados. A justificativa (`reason`) exige no mínimo 15 caracteres. O r… - [Listar inutilizações](https://docs.spedy.com.br/api-reference/nfc-e/listar-inutilizações.md): Lista as inutilizações de numeração já solicitadas pela empresa, paginadas, com o `status` de cada uma. - [Listar Notas Fiscais](https://docs.spedy.com.br/api-reference/nfc-e/listar-notas-fiscais.md): Lista as notas fiscais da empresa, das mais recentes para as mais antigas, com paginação e filtros por período de competência, `status`, `integrationId`, `transactionId` e dados do destinatário. - [Obter NFC-e](https://docs.spedy.com.br/api-reference/nfc-e/obter-nfc-e.md): Retorna a nota pelo `id`, com o `status` atual e o resultado do último processamento (`processingDetail`). Use para acompanhar o status quando não usa webhooks. - [Reemitir nota fiscal](https://docs.spedy.com.br/api-reference/nfc-e/reemitir-nota-fiscal.md): Reprocessa a emissão de uma nota que ficou **pendente** ou falhou por erro transitório — por exemplo, após corrigir uma configuração da empresa. Não cria uma nota nova nem altera os dados: apenas reenvia a nota existente para a autoridade. Aceita `effectiveDate` opcional (data de competência). - [Reenviar e-mail](https://docs.spedy.com.br/api-reference/nfc-e/reenviar-e-mail.md): Reenvia ao destinatário o e-mail com a nota autorizada (PDF/XML). Útil quando o envio automático falhou ou o cliente pede a segunda via. Requer e-mail cadastrado no destinatário. - [Cancelar NFS-e](https://docs.spedy.com.br/api-reference/nfs-e/cancelar-nfs-e.md): Cancela uma nota **autorizada**, dentro do prazo legal, informando a justificativa (`reason`). O cancelamento é processado de forma **assíncrona** até o status `canceled` — acompanhe por webhook ou consulta. Prazos e regras variam por UF (NF-e/NFC-e) e por município (NFS-e). - [Cidades integradas](https://docs.spedy.com.br/api-reference/nfs-e/cidades-integradas.md): Retorna a lista de municípios disponíveis para emissão de NFS-e, incluindo as configurações do provedor de cada cidade. Use este endpoint para verificar, antes de integrar, quais requisitos técnicos um município exige: **Campos do objeto `provider.options`:**… - [Consultar nota fiscal](https://docs.spedy.com.br/api-reference/nfs-e/consultar-nota-fiscal.md): Consulta o status da NFS-e diretamente na prefeitura e reconcilia o resultado no Spedy. Use esta consulta para **reconciliar** uma nota cujo status no Spedy pode estar desatualizado em relação à prefeitura: - Nota marcada como **Rejeitada** no Spedy mas que consta **aut… - [Criar NFS-e](https://docs.spedy.com.br/api-reference/nfs-e/criar-nfs-e.md): Cria uma **NFS-e** (nota de serviço) e a enfileira para emissão junto à prefeitura/provedor municipal. A emissão é **assíncrona**: a resposta `2xx` confirma que a solicitação foi aceita, não que a nota foi autorizada — acompanhe o resultado por webhook ou consulta. **integrationId**… - [Download do PDF da NFS-e](https://docs.spedy.com.br/api-reference/nfs-e/download-do-pdf-da-nfs-e.md): Baixa o **PDF do documento auxiliar** (DANFE, DANFE-NFC-e ou DANFSe) — a representação visual da nota, para impressão ou envio ao cliente. Disponível após a autorização. - [Download do XML da NFS-e](https://docs.spedy.com.br/api-reference/nfs-e/download-do-xml-da-nfs-e.md): Baixa o **XML autorizado** da nota — o documento fiscal em si, assinado e válido perante o fisco. Disponível após a autorização. - [Listar Notas Fiscais](https://docs.spedy.com.br/api-reference/nfs-e/listar-notas-fiscais.md): Lista as notas fiscais da empresa, das mais recentes para as mais antigas, com paginação e filtros por período de competência, `status`, `integrationId`, `transactionId` e dados do destinatário. - [Obter NFS-e](https://docs.spedy.com.br/api-reference/nfs-e/obter-nfs-e.md): Retorna a nota pelo `id`, com o `status` atual e o resultado do último processamento (`processingDetail`). Use para acompanhar o status quando não usa webhooks. - [Reemitir nota fiscal](https://docs.spedy.com.br/api-reference/nfs-e/reemitir-nota-fiscal.md): Reprocessa a emissão de uma nota que ficou **pendente** ou falhou por erro transitório — por exemplo, após corrigir uma configuração da empresa. Não cria uma nota nova nem altera os dados: apenas reenvia a nota existente para a autoridade. Aceita `effectiveDate` opcional (data de competência). - [Reenviar e-mail](https://docs.spedy.com.br/api-reference/nfs-e/reenviar-e-mail.md): Reenvia ao destinatário o e-mail com a nota autorizada (PDF/XML). Útil quando o envio automático falhou ou o cliente pede a segunda via. Requer e-mail cadastrado no destinatário. - [Alterar Produto](https://docs.spedy.com.br/api-reference/produtos/alterar-produto.md) - [Criar Produto](https://docs.spedy.com.br/api-reference/produtos/criar-produto.md): Cadastra um produto de catálogo com seus dados fiscais (NCM, código, descrição). Pertence à **conta**, compartilhado entre empresas. - [Excluir Produto](https://docs.spedy.com.br/api-reference/produtos/excluir-produto.md) - [Listar Produtos](https://docs.spedy.com.br/api-reference/produtos/listar-produtos.md): Lista os produtos do catálogo da conta (compartilhados entre empresas), com paginação e filtros. - [Obter Produto](https://docs.spedy.com.br/api-reference/produtos/obter-produto.md) - [Alterar status](https://docs.spedy.com.br/api-reference/vendas/alterar-status.md): Atualiza o status da venda (ex.: marcar como paga). Isso pode disparar a emissão automática da nota quando o `autoIssueMode` da venda depende do pagamento (ex.: `afterPayment`). - [Cancelar venda](https://docs.spedy.com.br/api-reference/vendas/cancelar-venda.md): Cancela uma venda, informando o motivo. Se a venda tiver uma ou mais notas autorizadas, a Spedy também tenta cancelá-las — sempre respeitando as regras e prazos fiscais de cada modelo. - [Criar Venda](https://docs.spedy.com.br/api-reference/vendas/criar-venda.md): Cria uma venda (cliente, itens, valores). Conforme o `autoIssueMode` da venda, a nota é emitida automaticamente (ex.: na criação ou após o pagamento). - [Emitir notas fiscais da venda](https://docs.spedy.com.br/api-reference/vendas/emitir-notas-fiscais-da-venda.md): Dispara explicitamente a emissão das notas de uma venda — útil quando o `autoIssueMode` é `disabled` ou quando a emissão automática não ocorreu. Aceita `effectiveDate` opcional (data de competência). - [Listar Vendas](https://docs.spedy.com.br/api-reference/vendas/listar-vendas.md): Lista as vendas da empresa, com paginação e filtros. - [Alterar Webhook](https://docs.spedy.com.br/api-reference/webhooks/alterar-webhook.md) - [Criar Webhook](https://docs.spedy.com.br/api-reference/webhooks/criar-webhook.md): Webhooks são configurados por **conta**, não por empresa. Uma única configuração recebe eventos de todas as empresas da conta. Para identificar qual empresa gerou o evento, utilize o objeto `company` presente no payload. **Eventos disponíveis:** | Evento | Descrição |… - [Desabilitar Webhook](https://docs.spedy.com.br/api-reference/webhooks/desabilitar-webhook.md): Interrompe o envio de eventos para o webhook (ex.: durante manutenção no seu endpoint). Reative depois com **Habilitar Webhook**. Eventos ocorridos enquanto desabilitado não são reenviados. - [Excluir Webhook](https://docs.spedy.com.br/api-reference/webhooks/excluir-webhook.md) - [Habilitar Webhook](https://docs.spedy.com.br/api-reference/webhooks/habilitar-webhook.md): Reativa um webhook desabilitado — manualmente ou após ser desligado automaticamente por esgotar as retentativas de entrega. Eventos ocorridos enquanto ele esteve desabilitado não são reenviados. - [Listar Webhooks](https://docs.spedy.com.br/api-reference/webhooks/listar-webhooks.md): Lista os webhooks da conta. Um webhook é por conta e recebe eventos de todas as empresas. - [Obter Webhook](https://docs.spedy.com.br/api-reference/webhooks/obter-webhook.md) - [Changelog](https://docs.spedy.com.br/pages/changelog/index.md): Histórico de mudanças da API da Spedy. - [Cancelamento, correção e inutilização](https://docs.spedy.com.br/pages/guides/cancelamento-correcao-inutilizacao.md): Como cancelar, corrigir e inutilizar documentos fiscais. - [Certificado digital A1](https://docs.spedy.com.br/pages/guides/certificado-digital.md): Como configurar e enviar seu certificado digital A1. - [Ciclo de vida da nota](https://docs.spedy.com.br/pages/guides/ciclo-de-vida-da-nota.md): Os estados e transições de uma nota fiscal na Spedy. - [Conceitos e modelo de dados](https://docs.spedy.com.br/pages/guides/conceitos-modelo-de-dados.md): Principais conceitos e modelo de dados da API da Spedy. - [Configuração inicial](https://docs.spedy.com.br/pages/guides/configuracao-inicial.md): Passo a passo para configurar sua conta na Spedy. - [Contingência](https://docs.spedy.com.br/pages/guides/contingencia.md): Como funciona a emissão em contingência na Spedy. - [Emissão de NFC-e](https://docs.spedy.com.br/pages/guides/emissao-nfce.md): Como emitir Notas Fiscais de Consumidor Eletrônicas (NFC-e) pela API da Spedy. - [Emissão de NF-e](https://docs.spedy.com.br/pages/guides/emissao-nfe.md): Como emitir Notas Fiscais Eletrônicas (NF-e) pela API da Spedy. - [Emissão de NFS-e](https://docs.spedy.com.br/pages/guides/emissao-nfse.md): Como emitir Notas Fiscais de Serviço Eletrônicas (NFS-e) pela API da Spedy. - [Fluxo de emissão](https://docs.spedy.com.br/pages/guides/fluxo-de-emissao.md): Visão geral do fluxo de emissão de documentos fiscais. - [Reforma Tributária](https://docs.spedy.com.br/pages/guides/reforma-tributaria.md): Impactos e adaptações da Spedy à Reforma Tributária. - [Regimes e códigos fiscais](https://docs.spedy.com.br/pages/guides/regimes-e-codigos-fiscais.md): Regimes tributários e códigos fiscais de produto (NF-e/NFC-e) e de serviço (NFS-e). - [Emissão síncrona vs assíncrona](https://docs.spedy.com.br/pages/guides/sincrono-vs-assincrono.md): Diferenças entre emissão síncrona e assíncrona de notas fiscais. - [Erros e rejeições](https://docs.spedy.com.br/pages/reference/erros-e-rejeicoes.md): Erros HTTP da API, rejeições fiscais e os códigos internos da Spedy (SPD). - [Introdução à referência](https://docs.spedy.com.br/pages/reference/introducao.md): Como usar a referência da API da Spedy. - [Ambiente de testes](https://docs.spedy.com.br/pages/start/ambiente-de-testes.md): Como usar o ambiente de testes (sandbox) da Spedy. - [Autenticação](https://docs.spedy.com.br/pages/start/autenticacao.md): Como autenticar suas requisições na API da Spedy. - [Erros e respostas](https://docs.spedy.com.br/pages/start/erros-e-respostas.md): Como a API da Spedy sinaliza erros e como tratá-los. - [Exemplos de requisição](https://docs.spedy.com.br/pages/start/exemplos-de-requisicao.md): Convenções da API e exemplos prontos dos principais fluxos da Spedy. - [Glossário fiscal](https://docs.spedy.com.br/pages/start/glossario-fiscal.md): Termos fiscais usados na documentação da API da Spedy, explicados de forma direta. - [Checklist de produção](https://docs.spedy.com.br/pages/start/go-live.md): Checklist para ir para produção com a API da Spedy. - [Idempotência e reprocessamento](https://docs.spedy.com.br/pages/start/idempotencia.md): Reenvie requisições com segurança usando transactionId e integrationId. - [Introdução](https://docs.spedy.com.br/pages/start/introducao.md): Visão geral da API da Spedy: o que ela faz, para quem é e por onde começar. - [Primeiros passos](https://docs.spedy.com.br/pages/start/primeiros-passos.md): Do zero até a primeira nota fiscal emitida em sandbox. - [Rate limit](https://docs.spedy.com.br/pages/start/rate-limit.md): Limites de requisições da API da Spedy e como lidar com o erro 429. - [Eventos e payload](https://docs.spedy.com.br/pages/webhooks/eventos-e-payload.md): Tipos de eventos e formato do payload dos webhooks. - [Gerenciamento de webhooks](https://docs.spedy.com.br/pages/webhooks/gerenciamento.md): Como criar, editar e remover webhooks na Spedy. - [Webhooks: visão geral](https://docs.spedy.com.br/pages/webhooks/visao-geral.md): Visão geral do sistema de webhooks da Spedy. ## OpenAPI Specs - [v1](https://docs.spedy.com.br/openapi/v1.json)