Ativando o Serviço de Inbound
Antes de receber documentos, você precisa ativar o serviço de inbound para cada CNPJ que deseja monitorar.
Sumário
Ativar Inbound de NF-e
POST /v2/companies/{company_id}/inbound/productinvoices
Authorization: ApiKey {api_key}
Content-Type: application/json
{
"StartFromNsu": 0,
"StartFromDate": "2024-01-01T00:00:00Z",
"EnvironmentSEFAZ": "Production",
"AutomaticManifesting": {
"MinutesToWaitAwarenessOperation": 60
},
"WebhookVersion": 2
}
Campos do corpo:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
StartFromNsu | long | Não | NSU inicial. 0 = busca desde o início. Use um NSU específico para sincronizar com histórico |
StartFromDate | DateTime | Não | Data inicial para busca. Padrão: 90 dias atrás |
EnvironmentSEFAZ | string | Sim | "Production" (produção SEFAZ) ou "Test" (homologação SEFAZ) |
EventType | string | Não | Filtro de tipos de evento (códigos separados por vírgula). null = todos |
Schema | int | Não | 0=NF-e + Eventos, 1=Somente NF-e, 2=Somente Eventos |
AutomaticManifesting.MinutesToWaitAwarenessOperation | int | Não | Minutos aguardados antes de auto-manifestar ciência. Mínimo: 5 |
WebhookVersion | int | Não | Versão do formato de webhook. Use 2 (mais recente) |
Resposta de sucesso (200):
{
"companyId": "comp_123",
"environmentSEFAZ": "Production",
"startFromNsu": 0,
"startFromDate": "2024-01-01T00:00:00Z",
"status": "Active",
"createdOn": "2024-03-15T10:30:00Z"
}
Ativar Inbound de CT-e
POST /v2/companies/{company_id}/inbound/transportationinvoices
Authorization: ApiKey {api_key}
Content-Type: application/json
{
"StartFromNsu": 0,
"StartFromDate": "2024-01-01T00:00:00Z",
"EnvironmentSEFAZ": "Production"
}
Verificar Configuração Atual
GET /v2/companies/{company_id}/inbound/productinvoices
Authorization: ApiKey {api_key}
Desativar Inbound
DELETE /v2/companies/{company_id}/inbound/productinvoices
Authorization: ApiKey {api_key}
Referência completa da API
Veja também
- Ativar via painel — alternativa sem código
- Configurar webhook
- Endpoints de NF-e
- Endpoints de CT-e
- Tipos e enums