Eventos em Lote

Submete eventos em lote para processamento

Este endpoint realiza a recepção de lotes de eventos para processamento assíncrono. O processamento é feito de forma assíncrona e o status pode ser consultado pelo endpoint GET /v1/event/batch/{id}. Suporta eventos de CT-e, CT-e OS e NF-e, identificados automaticamente pela posição 20-22 da chave de acesso (57=CT-e, 67=CT-e OS, 55=NF-e). Para NF-e, o Número Sequencial do Evento (n_seq_evento) é obtido automaticamente do SOT durante a ingestão — não deve (nem pode) ser informado na requisição. Todos os itens de um mesmo lote devem ser do mesmo tipo de documento (não é possível misturar CT-e, CT-e OS e NF-e no mesmo lote) — um lote misto é rejeitado durante a ingestão e permanece com status pending (não é retornado nenhum erro por este endpoint nem pelo GET, já que a validação ocorre de forma assíncrona).

post/v1/event/batch

Request

  • Base URL: https://api.arquivei.com.br
  • URL: https://api.arquivei.com.br/v1/event/batch
  • Auth: none declared. Required headers: X-API-ID, X-API-KEY, X-Use-ApiGateway

Headers

X-API-IDstring required

API ID usado para autenticação.

X-API-KEYstring required

API KEY usado para autenticação.

X-Use-ApiGatewaystring required

Este header indica que a request será roteada pelo API Gateway da Qive e o valor deve ser passado como always.

X-Flow-Identifierstring

Identificador de fluxo para rastreamento.

Request body

ownerstring required

CNPJ/CPF do proprietário dos documentos fiscais.

tp_evento'610110' | '610111' | '110001' | '210210' | '210200' | '210220' | '210240' | '211110' | '211124' | '211128' | '211130' | '211140' | '211150' | '112110' | '112120' | '112130' | '112140' | '112150' | '212110' | '212120' required

Tipo do evento a ser processado, de acordo com a tabela de tipos de eventos da SEFAZ. O código deve ser compatível com o tipo de documento das chaves de acesso informadas em items (todas as chaves de um mesmo lote devem ser do mesmo tipo de documento — ver descrição do endpoint):

  • CT-e/CT-e OS: 610110 (Prestação de Serviço em Desacordo) ou 610111 (Cancelamento da Prestação de Serviço em Desacordo).
  • NF-e: 110001 (Cancelamento de Evento) e os demais códigos suportados por /v1/dfe/nfe/events (ver metadata abaixo para a lista completa e os det_evento_* na seção de Models), exceto que aqui owner_uf e n_seq_evento não são enviados pelo cliente — n_seq_evento é obtido automaticamente do SOT durante a ingestão (ver EventBatchStatusItem.n_seq_evento).
metadataobject required

Dados do evento utilizados para todos os itens que não possuem dados próprios. A estrutura depende do tipo de evento (tp_evento):

CT-e/CT-e OS:

  • 610110 (Prestação de Serviço em Desacordo): { "x_obs": string } — ex.: {"x_obs": "Divergência na descrição do serviço prestado"}
  • 610111 (Cancelamento da Prestação de Serviço em Desacordo): { "n_prot_ev_prest_des": string } — ex.: {"n_prot_ev_prest_des": "135240000012345"}

NF-e — Cancelamento:

  • 110001: ex.: {"tp_evento_aut": "211130", "n_prot_evento": "143230000123456"}

NF-e — Manifestação do Destinatário:

  • 210210 (Ciência da Operação): objeto vazio — ex.: {}
  • 210200 (Confirmação da Operação): objeto vazio — ex.: {}
  • 210220 (Desconhecimento da Operação): objeto vazio — ex.: {}
  • 210240 (Operação Não Realizada): ex.: {"x_just": "Operação não concretizada por divergência comercial"}

NF-e — Destinatário:

  • 211110 (Apropriação de Crédito Presumido): ex.: {"itens": [{"n_item": "1", "v_bc_cred_pres": "1085.00", "c_cred_pres": "02", "g_ibs_cred_pres": {"p_cred_pres": "0.0000", "v_cred_pres": "1.09"}, "g_cbs_cred_pres": {"p_cred_pres": "0.0000", "v_cred_pres": "9.77"}}]}
  • 211124 (Roubo/Perda/Transp. Adquirente): ex.: {"itens": [{"n_item": "3", "v_ibs": "25.00", "v_cbs": "5.50", "g_controle_estoque": {"quantidade": "5.0000", "unidade": "KG"}}]}
  • 211128 (Aceite de Débito): ex.: {"ind_aceitacao": "1"}
  • 211130 (Imobilização de Item): ex.: {"itens": [{"n_item": "10", "v_ibs": "200.00", "v_cbs": "45.00", "g_controle_estoque": {"quantidade": "1.0000", "unidade": "UN"}}]}
  • 211140 (Apropriação de Crédito de Combustível): ex.: {"itens": [{"n_item": "1", "v_ibs": "80.00", "v_cbs": "20.00", "g_controle_estoque": {"quantidade": "50.0000", "unidade": "L"}}]}
  • 211150 (Apropriação de Crédito de Bens): ex.: {"itens": [{"n_item": "2", "v_cred_ibs": "150.50", "v_cred_cbs": "30.10"}]}

NF-e — Emitente:

  • 112110 (Informação de Efetivo Pagamento): ex.: {"ind_quitacao": "1"}
  • 112120 (Importação por conta e ordem — LC-ZFM): ex.: {"itens": [{"n_item": "2", "v_ibs": "150.50", "v_cbs": "30.10", "g_controle_estoque": {"quantidade": "50.0000", "unidade": "KG"}}]}
  • 112130 (Perecimento): ex.: {"itens": [{"n_item": "2", "v_ibs": "150.50", "v_cbs": "30.10", "g_controle_estoque": {"q_perecimento": "50.0000", "u_perecimento": "KG", "v_ibs": "150.50", "v_cbs": "30.10"}}]}
  • 112140 (Fornecimento Não Realizado): ex.: {"itens": [{"n_item": "2", "v_ibs": "150.50", "v_cbs": "30.10", "g_controle_estoque": {"q_nao_fornecida": "50.0000", "u_nao_fornecida": "KG"}}]}
  • 112150 (Data Prevista de Entrega): ex.: {"data_prev_entrega": "2024-12-31"}

NF-e — Sucessora:

  • 212110 (Transferência de Crédito IBS): ex.: {"ind_aceitacao": "1"}
  • 212120 (Transferência de Crédito CBS): ex.: {"ind_aceitacao": "1"}

Consulte as definições det_evento_* na seção de Models para o schema completo de cada código.

itemsobject required

Mapa de itens do lote. A chave é a chave de acesso do documento fiscal e o valor é opcional — se informado, substitui o metadata genérico para aquele item, com a mesma estrutura descrita em metadata (depende do tp_evento do lote). Todas as chaves devem ser do mesmo tipo de documento (CT-e, CT-e OS ou NF-e, nunca uma mistura) — o tipo é identificado automaticamente pela posição 20-22 da chave de acesso (57=CT-e, 67=CT-e OS, 55=NF-e).

Example request

{
  "owner": "97548313000110",
  "tp_evento": "610110",
  "metadata": {
    "x_obs": "Divergência na descrição do serviço prestado"
  },
  "items": {
    "35241297548313000110570010000123451234567890": null,
    "35241297548313000110570010000123451234567891": {
      "x_obs": "Observação específica deste item"
    }
  }
}

Response

Lote de eventos submetido com sucesso.

Example response

{
  "status": {
    "code": 200,
    "message": "OK"
  },
  "data": {
    "event_batch_id": "1913d63a-a646-4dda-b764-effdb19e4b0e"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.