Takeat
Versão da documentação
Financeiro

Documentação

NF-e recebidas

Consulta fiscal por restaurante, manifestação e marca, com todos os campos organizados por assunto.

Rotas e autenticação

RecursoMétodo e caminhoEscopo OAuth
NF-e recebidasGET /v1/nfe-receivednfe-received:read
Detalhe da NF-eGET /v1/nfe-received/info/{nfe_received_id}nfe-received:read

Envie Authorization: Bearer <access_token>. Também é aceita uma sessão autenticada de restaurante, limitada ao restaurante assinado, sem exigir escopos OAuth. Chaves tk_ precisam ser trocadas por tokens. Conceda os novos escopos à credencial/instalação e emita um novo token antes de consumir estes recursos; tokens antigos não recebem permissões novas automaticamente.

Parceiros com mais de um restaurante precisam de restaurant_id na query. O restaurante deve estar autorizado ao parceiro; uma sessão de restaurante rejeita qualquer seleção divergente. Os caminhos /restaurants/... são referências do sistema legado; os contratos públicos abaixo são novos, agrupados e versionados. A operation-api mantém sua consulta legada de marcas.

Sequência de consulta

  1. Liste as marcas e escolha o id da marca.
  2. Consulte GET /v1/nfe-received?start_date=2026-09-01T03:00:00&end_date=2026-09-10T02:59:59&pendente=true&brand_id=3.
  3. Use o id de uma nota em GET /v1/nfe-received/info/1. Esse ID é interno da Takeat, não a chave fiscal.

Filtros e comportamento

  • start_date e end_date são obrigatórios, com data/hora ISO incluindo segundos; sem offset significam UTC. Use Z ou um offset explícito quando possível. O exemplo acima corresponde a 01/09 às 00h até 09/09 às 23h59min59s em UTC−03.
  • Limites de emissão inclusivos, preservando hora/minuto/segundo; intervalo crescente de no máximo 92 dias. A listagem retorna um array completo, sem paginação. Divida períodos grandes quando necessário.
  • pendente=true: manifestação null, ciencia ou desconhecimento. pendente=false ou omitido: somente confirmacao. Outros valores são rejeitados. A consulta não realiza manifestação.
  • A listagem inclui apenas situação autorizada e canceled_at=null na base local, ordenada por emissão e ID crescentes. Não mistura transferências de estoque.
  • brand_id aceita um único inteiro positivo até 2147483647. Ausente: marca padrão, ou primeira por ID se não há padrão. Selecionar a padrão inclui notas históricas com vínculo de marca nulo. Sem marcas e sem filtro, consulta todas as NF-e do restaurante. Marca excluída, inexistente ou de outro restaurante recebe o mesmo 404, sem fallback silencioso.
  • brand_id na resposta preserva o vínculo original. brand pode conter a marca padrão usada para apresentação mesmo quando brand_id=null.
  • O detalhe lê a nota local pelo restaurante e ID antes de consultar a Focus. Usa a credencial fiscal da marca vinculada ou, para nota sem marca, da padrão. Credenciais ficam no servidor. Não há escrita, cache, manifestação ou sincronização.
  • A Focus pode fornecer somente resumo: invoice e protocol ficam nulos quando ausentes. Emissão, emitente, total, situação, manifestação, completude, versão e digest refletem a Focus; os demais campos comuns continuam sendo o snapshot local. Por isso a listagem pode mostrar ciencia enquanto o detalhe já mostra confirmacao.
  • references.provider_id no detalhe é resolvido pelo documento do emitente entre fornecedores não excluídos do restaurante. processing.return_in_progress exige uma referência de devolução não nula com outra nota local em processamento.
  • Identificadores, códigos fiscais, CNPJ/CPF, quantidades e valores da Focus preservam o tipo e a precisão originais. Campos não informados dentro do documento são opcionais; nulos e arrays vazios são preservados. Campos fiscais futuros entram em additional_fields, no documento ou item, sem descarte.

Erros

HTTPChave / motivo
400Parâmetro inválido, datas ausentes/inválidas, intervalo invertido/acima de 92 dias, ID inválido ou restaurante obrigatório
401Credencial ausente, expirada ou inválida
403Escopo ausente ou restaurante não autorizado
404brand_not_found ou nfe_not_found; sem revelar dados de outro restaurante
429Limite de requisições da credencial
500Falha de validação dos dados internos; informe X-Error-Id ao suporte
502fiscal_upstream_error: falha, conteúdo inválido ou timeout na consulta fiscal
503fiscal_not_configured: marca sem credencial fiscal

Erros usam { statusCode, message, key } e X-Error-Id. Erros de validação dos parâmetros retornam 400 com mensagens dos campos. Falhas de validação dos dados internos retornam 500 com uma mensagem segura orientando nova tentativa e contato com o suporte; informe o valor do header X-Error-Id para localizar o erro.

O campo invoice.taxes.ibs_cbs_is_valor_total permanece textual mesmo quando a Focus envia um número JSON: 12.3 é retornado como "12.3". Valores já textuais preservam sua precisão ("12.30" continua "12.30"), e null permanece null.

A Focus tem timeout de 15 segundos, limite de resposta de 5 MiB e não segue redirecionamentos. Seus erros e credenciais não são repassados ao cliente.

Campos comuns da NF-e

A listagem é um array dos objetos abaixo. O detalhe também contém esses campos.

CampoTipoDescrição
idintegerIdentificador do registro na Takeat.
restaurant_idintegerRestaurante autorizado ao qual o registro pertence.
brand_idinteger / nullMarca originalmente vinculada à nota; null em notas antigas sem vínculo.
brandobject / nullMarca vinculada ou marca padrão usada como apresentação para notas sem vínculo.
brand.idintegerIdentificador do registro na Takeat.
brand.namestringNome cadastrado.
brand.fantasy_namestring / nullNome fantasia.
brand.cnpjstring / nullCNPJ preservado como texto, incluindo zeros à esquerda.
identificationobjectIdentificação da nota fiscal.
identification.access_keystringChave de acesso de 44 dígitos, preservada como texto.
identification.numberstring / nullNúmero da nota; na listagem é extraído da chave e preserva os nove dígitos.
identification.seriesstring / nullSérie armazenada localmente, ou null.
identification.statestring / nullUF armazenada localmente, ou null.
identification.typestring / nullCódigo/tipo informado na origem; não é normalizado.
issuerobjectIdentificação do emitente/fornecedor.
issuer.namestringNome cadastrado.
issuer.documentstringDocumento do emitente, preservado como texto.
amountsobjectValores monetários da nota.
amounts.totalstringValor total em texto decimal; a listagem mantém duas casas e o detalhe mantém a precisão da Focus.
statusobjectSituação fiscal e disponibilidade do documento completo.
status.situationstringSituação da nota na origem, como autorizada.
status.completebooleanIndica disponibilidade da NF-e completa; não significa que a operação foi confirmada.
manifestationobjectManifestação do destinatário.
manifestation.typestring / nullCódigo/tipo informado na origem; não é normalizado.
manifestation.manifested_atstring / nullData local da manifestação ou null.
correctionobjectÚltima carta de correção registrada localmente.
correction.numberinteger / nullNúmero sequencial da carta de correção registrada localmente, ou null.
correction.textstring / nullTexto da carta de correção ou null.
correction.issued_atstring / nullData de emissão da carta de correção registrada localmente, em UTC, ou null.
cancellationobjectCancelamento fiscal e cancelamento local são informações distintas.
cancellation.canceled_atstring / nullData de cancelamento fiscal ou null.
cancellation.reasonstring / nullJustificativa do cancelamento ou null.
cancellation.locally_canceled_atstring / nullData de cancelamento local ou null.
referencesobjectReferências locais de integração e fornecedor.
references.return_referencestring / nullReferência da devolução, ou null.
references.referencestring / nullReferência local de emissão/processamento, ou null.
references.urlstring / nullURL armazenada; na imagem, URL derivada usando a configuração de arquivos.
references.provider_idinteger / nullFornecedor Takeat. Na lista é o vínculo armazenado; no detalhe é a busca por documento do emitente entre fornecedores ativos do restaurante.
fiscalobjectMetadados fiscais.
fiscal.versionintegerVersão de distribuição da nota.
fiscal.digeststring / nullDigest da nota, ou null.
fiscal.spedJSONConteúdo fiscal SPED local (JSON) ou null.
timestampsobjectDatas do registro. A emissão do detalhe vem da Focus e pode manter seu offset.
timestamps.issued_atstringData e hora de emissão; a listagem usa UTC e o detalhe preserva o offset da Focus.
timestamps.processing_atstring / nullData de início do processamento local, ou null.
timestamps.created_atstring / nullData de criação do registro local, em UTC.
timestamps.updated_atstring / nullData da última atualização local, em UTC.

Campos adicionais do detalhe

Os nomes fiscais dentro dos grupos conservam a nomenclatura da Focus. Por exemplo: invoice.items[].commercial.valor_unitario_comercial mantém "38.0500000000", e invoice.items[].identification.codigo_ncm mantém "04061010". O leiaute pode omitir campos não aplicáveis; arrays sem itens no exemplo possuem elementos JSON definidos pelo leiaute fiscal, sem inferência de uma estrutura ausente.

CampoTipoDescrição
recipientobjectDocumentos do destinatário informados pela Focus.
recipient.cnpjstring / nullCNPJ preservado como texto, incluindo zeros à esquerda.
recipient.cpfstring / nullCPF preservado como texto; vazio quando a Focus retorna string vazia.
invoiceobject / nullDocumento fiscal completo agrupado por assunto, ou null quando indisponível.
invoice.identificationobjectIdentificação da nota fiscal.
invoice.identification.versaostring / null (opcional)versao. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.chave_nfestring / null (opcional)chave NF-e. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.ufstring / null (opcional)UF. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.codigo_unicostring / null (opcional)codigo unico. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.natureza_operacaostring / null (opcional)natureza operacao. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.modelostring / null (opcional)modelo. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.seriestring / null (opcional)serie. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.numerostring / null (opcional)numero. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.data_emissaostring / null (opcional)data emissao. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.data_entrada_saidastring / null (opcional)data entrada saida. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.tipo_documentostring / null (opcional)tipo documento. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.local_destinostring / null (opcional)local destino. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.municipiostring / null (opcional)municipio. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.formato_impressaostring / null (opcional)formato impressao. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.forma_emissaostring / null (opcional)forma emissao. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.digito_verificadorstring / null (opcional)digito verificador. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.ambientestring / null (opcional)ambiente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.finalidade_emissaostring / null (opcional)finalidade emissao. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.consumidor_finalstring / null (opcional)consumidor final. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.presenca_compradorstring / null (opcional)presenca comprador. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.indicador_intermediariostring / null (opcional)indicador intermediario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.processo_emissaostring / null (opcional)processo emissao. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.identification.versao_aplicativostring / null (opcional)versao aplicativo. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.referencesobjectReferências locais de integração e fornecedor.
invoice.references.notas_referenciadasarray / null (opcional)notas referenciadas. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.references.chaves_acesso_dfe_anterioresarray / null (opcional)chaves acesso dfe anteriores. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.references.chaves_nfe_antecipacao_pagamentoarray / null (opcional)chaves NF-e antecipacao pagamento. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuerobjectIdentificação do emitente/fornecedor.
invoice.issuer.cnpj_emitentestring / null (opcional)CNPJ emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.nome_emitentestring / null (opcional)nome emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.logradouro_emitentestring / null (opcional)logradouro emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.numero_emitentestring / null (opcional)numero emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.complemento_emitentestring / null (opcional)complemento emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.bairro_emitentestring / null (opcional)bairro emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.codigo_municipio_emitentestring / null (opcional)codigo municipio emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.municipio_emitentestring / null (opcional)municipio emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.uf_emitentestring / null (opcional)UF emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.cep_emitentestring / null (opcional)CEP emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.codigo_pais_emitentestring / null (opcional)codigo pais emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.pais_emitentestring / null (opcional)pais emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.telefone_emitentestring / null (opcional)telefone emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.inscricao_estadual_emitentestring / null (opcional)inscricao estadual emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.inscricao_municipal_emitentestring / null (opcional)inscricao municipal emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.cnae_fiscal_emitentestring / null (opcional)CNAE fiscal emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.issuer.regime_tributario_emitentestring / null (opcional)regime tributario emitente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipientobjectDocumentos do destinatário informados pela Focus.
invoice.recipient.cnpj_destinatariostring / null (opcional)CNPJ destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.nome_destinatariostring / null (opcional)nome destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.logradouro_destinatariostring / null (opcional)logradouro destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.numero_destinatariostring / null (opcional)numero destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.bairro_destinatariostring / null (opcional)bairro destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.codigo_municipio_destinatariostring / null (opcional)codigo municipio destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.municipio_destinatariostring / null (opcional)municipio destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.uf_destinatariostring / null (opcional)UF destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.cep_destinatariostring / null (opcional)CEP destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.codigo_pais_destinatariostring / null (opcional)codigo pais destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.pais_destinatariostring / null (opcional)pais destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.telefone_destinatariostring / null (opcional)telefone destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.indicador_inscricao_estadual_destinatariostring / null (opcional)indicador inscricao estadual destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.inscricao_estadual_destinatariostring / null (opcional)inscricao estadual destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.recipient.email_destinatariostring / null (opcional)email destinatario. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.authorized_partiesobjectauthorized parties. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.authorized_parties.pessoas_autorizadasarray / null (opcional)pessoas autorizadas. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.authorized_parties.pessoas_autorizadas[].cnpjstring / null (opcional)CNPJ preservado como texto, incluindo zeros à esquerda.
invoice.taxesobjecttaxes. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.taxes.icms_base_calculostring / null (opcional)ICMS base calculo. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.taxes.icms_valor_totalstring / null (opcional)ICMS valor total. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.taxes.icms_valor_total_desoneradostring / null (opcional)ICMS valor total desonerado. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.taxes.fcp_valor_totalstring / null (opcional)FCP valor total. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.taxes.icms_base_calculo_ststring / null (opcional)ICMS base calculo ST. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.taxes.icms_valor_total_ststring / null (opcional)ICMS valor total ST. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.taxes.fcp_valor_total_ststring / null (opcional)FCP valor total ST. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.taxes.fcp_valor_total_retido_ststring / null (opcional)FCP valor total retido ST. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.taxes.ibs_cbs_base_calculostring / null (opcional)IBS CBS base calculo. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.taxes.ibs_cbs_is_valor_totalstring / null (opcional)IBS CBS is valor total. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.totalsobjecttotals. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.totals.valor_produtosstring / null (opcional)valor produtos. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.totals.valor_fretestring / null (opcional)valor frete. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.totals.valor_segurostring / null (opcional)valor seguro. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.totals.valor_descontostring / null (opcional)valor desconto. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.totals.valor_total_iistring / null (opcional)valor total II. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.totals.valor_ipistring / null (opcional)valor IPI. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.totals.valor_ipi_devolvidostring / null (opcional)valor IPI devolvido. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.totals.valor_pisstring / null (opcional)valor PIS. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.totals.valor_cofinsstring / null (opcional)valor COFINS. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.totals.valor_outras_despesasstring / null (opcional)valor outras despesas. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.totals.valor_totalstring / null (opcional)valor total. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transportobjecttransport. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.modalidade_fretestring / null (opcional)modalidade frete. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.cnpj_transportadorstring / null (opcional)CNPJ transportador. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.nome_transportadorstring / null (opcional)nome transportador. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.inscricao_estadual_transportadorstring / null (opcional)inscricao estadual transportador. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.endereco_transportadorstring / null (opcional)endereco transportador. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.municipio_transportadorstring / null (opcional)municipio transportador. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.uf_transportadorstring / null (opcional)UF transportador. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.reboquesarray / null (opcional)reboques. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.volumesarray / null (opcional)volumes. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.volumes[].quantidadestring / null (opcional)quantidade. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.volumes[].especiestring / null (opcional)especie. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.volumes[].marcastring / null (opcional)marca. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.volumes[].peso_liquidostring / null (opcional)peso liquido. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.volumes[].peso_brutostring / null (opcional)peso bruto. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.transport.volumes[].lacresarray / null (opcional)lacres. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.billingobjectbilling. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.billing.duplicatasarray / null (opcional)duplicatas. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.billing.formas_pagamentoarray / null (opcional)formas pagamento. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.billing.formas_pagamento[].forma_pagamentostring / null (opcional)forma pagamento. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.billing.formas_pagamento[].descricao_pagamentostring / null (opcional)descricao pagamento. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.billing.formas_pagamento[].valor_pagamentostring / null (opcional)valor pagamento. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.billing.formas_pagamento[].tipo_integracaoJSON (opcional)tipo integracao. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.additionalobjectadditional. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.additional.informacoes_adicionais_contribuintestring / null (opcional)informacoes adicionais contribuinte. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.additional.observacoes_contribuintearray / null (opcional)observacoes contribuinte. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.additional.observacoes_fiscoarray / null (opcional)observacoes fisco. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.additional.processos_referenciadosarray / null (opcional)processos referenciados. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.additional.cana_fornecimentosarray / null (opcional)cana fornecimentos. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.additional.cana_deducoesarray / null (opcional)cana deducoes. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.additional.agropecuario_defensivoarray / null (opcional)agropecuario defensivo. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.technical_contactobjecttechnical contact. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.technical_contact.cnpj_responsavel_tecnicostring / null (opcional)CNPJ responsavel tecnico. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.technical_contact.contato_responsavel_tecnicostring / null (opcional)contato responsavel tecnico. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.technical_contact.email_responsavel_tecnicostring / null (opcional)email responsavel tecnico. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.technical_contact.telefone_responsavel_tecnicostring / null (opcional)telefone responsavel tecnico. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.additional_fieldsobjectCampos fiscais adicionais introduzidos pelo provedor, preservados com seus nomes e tipos JSON originais.
invoice.itemsarray (opcional)items. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].identificationobjectIdentificação da nota fiscal.
invoice.items[].identification.numero_itemstring / null (opcional)numero item. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].identification.codigo_produtostring / null (opcional)codigo produto. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].identification.descricaostring / null (opcional)descricao. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].identification.codigo_ncmstring / null (opcional)codigo NCM. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].identification.nvesarray / null (opcional)nves. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].identification.ceststring / null (opcional)CEST. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].identification.cfopstring / null (opcional)CFOP. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].commercialobjectcommercial. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].commercial.codigo_barras_comercialstring / null (opcional)codigo barras comercial. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].commercial.unidade_comercialstring / null (opcional)unidade comercial. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].commercial.quantidade_comercialstring / null (opcional)quantidade comercial. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].commercial.valor_unitario_comercialstring / null (opcional)valor unitario comercial. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxesobjecttaxes. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.infos_credito_presumidoarray / null (opcional)infos credito presumido. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ipi_codigo_enquadramento_legalstring / null (opcional)IPI codigo enquadramento legal. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.icms_percentual_partilhastring / null (opcional)ICMS percentual partilha. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ibs_cbs_situacao_tributariastring / null (opcional)IBS CBS situacao tributaria. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ibs_cbs_classificacao_tributariastring / null (opcional)IBS CBS classificacao tributaria. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ibs_cbs_base_calculostring / null (opcional)IBS CBS base calculo. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ibs_uf_aliquotastring / null (opcional)IBS UF aliquota. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ibs_uf_percentual_reducao_aliquotastring / null (opcional)IBS UF percentual reducao aliquota. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ibs_uf_aliquota_efetivastring / null (opcional)IBS UF aliquota efetiva. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ibs_uf_valorstring / null (opcional)IBS UF valor. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ibs_mun_aliquotastring / null (opcional)IBS municipal aliquota. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ibs_mun_percentual_reducao_aliquotastring / null (opcional)IBS municipal percentual reducao aliquota. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ibs_mun_aliquota_efetivastring / null (opcional)IBS municipal aliquota efetiva. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ibs_mun_valorstring / null (opcional)IBS municipal valor. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ibs_valor_totalstring / null (opcional)IBS valor total. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.cbs_aliquotastring / null (opcional)CBS aliquota. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.cbs_percentual_reducao_aliquotastring / null (opcional)CBS percentual reducao aliquota. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.cbs_aliquota_efetivastring / null (opcional)CBS aliquota efetiva. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.cbs_valorstring / null (opcional)CBS valor. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.icms_origemstring / null (opcional)ICMS origem. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.icms_situacao_tributariastring / null (opcional)ICMS situacao tributaria. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.icms_modalidade_base_calculostring / null (opcional)ICMS modalidade base calculo. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.icms_base_calculostring / null (opcional)ICMS base calculo. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.icms_aliquotastring / null (opcional)ICMS aliquota. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.icms_valorstring / null (opcional)ICMS valor. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.ipi_situacao_tributariastring / null (opcional)IPI situacao tributaria. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.pis_situacao_tributariastring / null (opcional)PIS situacao tributaria. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxes.cofins_situacao_tributariastring / null (opcional)COFINS situacao tributaria. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].amountsobjectValores monetários da nota.
invoice.items[].amounts.valor_brutostring / null (opcional)valor bruto. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].amounts.inclui_no_totalstring / null (opcional)inclui no total. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].amounts.valor_total_itemstring / null (opcional)valor total item. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxableobjecttaxable. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxable.codigo_barras_tributavelstring / null (opcional)codigo barras tributavel. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxable.unidade_tributavelstring / null (opcional)unidade tributavel. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxable.quantidade_tributavelstring / null (opcional)quantidade tributavel. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].taxable.valor_unitario_tributavelstring / null (opcional)valor unitario tributavel. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].additionalobjectadditional. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].additional.documentos_importacaoarray / null (opcional)documentos importacao. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].additional.detalhes_exportacaoarray / null (opcional)detalhes exportacao. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].additional.rastrosarray / null (opcional)rastros. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].additional.armamentosarray / null (opcional)armamentos. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].additional.origens_combustivelarray / null (opcional)origens combustivel. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].additional.observacoes_contribuintearray / null (opcional)observacoes contribuinte. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
invoice.items[].additional_fieldsobjectCampos fiscais adicionais introduzidos pelo provedor, preservados com seus nomes e tipos JSON originais.
protocolobject / nullProtocolo fiscal da Focus ou null.
protocol.versaostring / null (opcional)versao. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
protocol.ambientestring / null (opcional)ambiente. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
protocol.versao_aplicativostring / null (opcional)versao aplicativo. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
protocol.chave_nfestring / null (opcional)chave NF-e. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
protocol.data_recebimentostring / null (opcional)data recebimento. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
protocol.numero_protocolostring / null (opcional)numero protocolo. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
protocol.digest_valuestring / null (opcional)digest value. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
protocol.statusstring / null (opcional)Situação fiscal e disponibilidade do documento completo.
protocol.motivostring / null (opcional)motivo. Campo fiscal da Focus, preservado no formato de origem; ausente quando não informado. Valores decimais e códigos textuais não são convertidos em números.
processingobjectEstado de processamento da devolução na base local.
processing.return_in_progressbooleanExiste nota do restaurante com a referência de devolução e situação processando_autorizacao. Sem referência, false.

Referência e exemplos completos

A referência OpenAPI inclui schemas e exemplos completos da listagem e do detalhe. O guia de consulta JSON da Focus descreve a origem do documento completo. A autenticação da Focus é aplicada somente no servidor.

On this page