OmieapiDocumentaçãoOperações
← Referência das operações

FaturarLoteCTealtera dados

Gera uma fatura por lote para um grupo de CT-es.

Identificação

Operaçãoprodutos/cte:FaturarLoteCTe
ServiçoConhecimentoTransporte
MóduloProdutos
Endpoint/api/v1/produtos/cte/

Parâmetros

CampoTipoDescrição
CNPJClientestringCNPJ do Cliente. Preenchimento obrigatório.
cAppId obrigatóriostringIdentificação do aplicativo que emitiu o CT-e. Preenchimento obrigatório. Exemplo: Maquina01 PS: Informe o código que identifica a instalação do aplicativo. Caso o cliente tenha 2 Emissores de CT-e instalados, ele deve indicar: "01" e "02" ou "10" e "20" ou ainda informar o Serial do HD da máquina.
cAppNome obrigatóriostringNome do Aplicativo que emitiu o CT-e. Preenchimento obrigatório. Exemplo: GeradorCT-e
cAppVersao obrigatóriostringVersão do Aplicativo que emitiu o CT-e. Preenchimento obrigatório. Exemplo: 1.02.01
cCategoriastringCódigo da Categoria para geração do título no financeiro.
cConcluirFatura obrigatóriostringConcluir o faturamento. Indica que o envio de CTes está concluído para o lote e que pode realizar o faturamento do mesmo. Possíveis valores: S - Sim, encerra o processo de envio de CTes e realiza o faturamento. Nesse momento, você deve informar as tags CNPJCliente, cCategoria, nContaCorrente, dVencimento e nValorFatura e complementar com as tags cNumeroFatura e departamentos, se necessário. N - Não, indica que uma lista de CTes deve ser adicionada ao lote. As tags cCategoria, nContaCorrente, dVencimento, nValorFatura, cNumeroFatura e departamentos não devem ser ser informadas.
cListaChavesCTesstringLista de chave de CTes. As chaves devem ser informadas com o separador | (carácter pipe).
cNumeroFaturastringNúmero da Fatura.
dVencimentostringData de vencimento da fatura. Preenchimento obrigatório. Formato: dd/mm/aaaa.
departamentoslista de objectDistribuição por Departamentos. Preenchimento Opcional.
itensFaturaLotelista de objectItens da Fatura.
nClienteintegerCódigo do Cliente para geração do título no financeiro. Preenchimento Opcional.
nContaCorrenteintegerId da Conta Corrente no Omie para a geração do título no financeiro.
nIdFaturamentoLoteintegerId do faturamento. Para indicar o início de um novo lote envie 0 (zero) nesse campo. Como resposta você receberá o nIdFaturamento gerado pelo Omie automaticamente. Nos próximos envios informe o nIdFaturamento recebido para adicionar novos CTes ao lote. Para concluir o envio de CTes e gerar a fatura do lote informe "S" na tag cConcluirFatura. Na última chamada desse método você pode enviar apenas a tag cConcluirFatura. Opcionalmente, você pode enviar os CTes restantes.
nValorFaturanumberValor da Fatura. Preenchimento Obrigatório.

Exemplo de chamada

{
  "cAppNome": "GeradorCTe",
  "cAppVersao": "1.01.02",
  "cAppId": "Cte01",
  "nIdFaturamento": 0,
  "CNPJCliente": "",
  "cConcluirFatura": "N",
  "itensFatura": [
    {
      "nSeq": 1,
      "cChaveCte": "",
      "nValorCte": 30
    },
    {
      "nSeq": 2,
      "cChaveCte": "",
      "nValorCte": 70
    }
  ]
}
Esta operação altera dados de verdade, na hora. Não existe ambiente de ensaio neste endereço.
api.omie.com.br/mcp · Documentação · Operações