Integração da Nota Fiscal de Entrada via API

Na plataforma Senior X, siga o caminho: Tecnologia > Customização > Events Hub > Webhooks. Nessa seção, você deverá criar dois registros que serão responsáveis por notificar seu sistema sempre que um evento ocorrer.

1. Criação de Webhooks:
   • Crie um registro para o evento api.senior.com.br/erpx_sup_int/facade/invoiceIntegratedSuccess, que indica a integração com sucesso de uma nota fiscal.
   • Crie outro registro para o evento api.senior.com.br/erpx_sup_int/facade/invoiceIntegratedError que indica a integração com erro de uma nota fiscal.
2. Configuração:
   • Para cada evento, adicione a URL que deverá ser chamada quando o evento ocorrer;
   • Inclua as credenciais de autenticação, caso sejam necessárias;
   • Se desejar, é possível cadastrar múltiplas URLs para o mesmo evento;
   • Certifique-se de ativar o endpoint após a configuração.
3. Verificação de logs:
   • Em caso de falhas na integração, você pode verificar os logs. Acesse a seção Ações no endpoint cadastrado e clique em Detalhes para visualizar as informações.

notaFiscalId (UUID): Identificador único da nota fiscal de entrada. Deve ser informado diretamente na URL como parte do endpoint.

A resposta da API retorna um objeto contendo os seguintes campos:

• id (UUID): Identificador único da nota fiscal.
• company (genericRecord): Dados da empresa associada à nota fiscal.
  • id: Identificador único da empresa.
  • code: Código da empresa.
  • name: Nome da empresa.
• branch (person): Dados da filial associada à nota fiscal.
  • id: Identificador único da filial.
  • code: Código da filial.
  • name: Nome da filial.
  • documentNumber: CPF ou CNPJ da filial.
• sender (person): Dados do remetente (fornecedor).
  • id: Identificador único do remetente.
  • code: Código do remetente.
  • name: Nome do remetente.
  • documentNumber: CPF ou CNPJ do remetente.
• fiscalSeries (genericRecord): Dados da série fiscal da nota.
  • id: Identificador único da série.
  • code: Código da série.
  • name: Descrição da série.
• invoiceNumber (string): Número da nota fiscal.
• entryDate (date): Data de entrada da nota fiscal.
• issueDate (date): Data de emissão da nota fiscal.
• productTransaction (transaction): Dados da transação de produtos.
  • id: Identificador único da transação.
  • code: Código da transação.
  • name: Descrição da transação.
  • cfop: Código Fiscal de Operações e Prestações (CFOP).
• serviceTransaction (transaction): Dados da transação de serviços.
  • id: Identificador único da transação.
  • code: Código da transação.
  • name: Descrição da transação.
  • cfop: Código Fiscal de Operações e Prestações (CFOP).
• invoiceKey (string): Chave da nota fiscal.
• observation (string): Observações da nota fiscal.
• payment (paymentData): Dados de pagamento.
  • paymentCondition: Código da condição de pagamento.
  • expirationDateIndicator: Base para cálculo do vencimento (data de emissão ou entrada).
  • recalculateInstallments: permite definir se as parcelas da nota fiscal serão recalculadas automaticamente ou mantidas conforme enviadas no payload.
• Installments (invoiceInstallments): Dados das parcelas.
  • titleType: Tipo do título.
  • titleNumber: Número do título.
  • sequence: Sequência da parcela.
  • percentage: Percentual referente ao valor total.
  • paymentMethod: Forma de pagamento.
  • dueDate: Data de vencimento da parcela.
  • amount: Valor da parcela.
  • barCode: Código de barras para pagamento.
  • observation: Observações adicionais da parcela.
• items (invoiceItem*): Lista de itens da nota fiscal (produtos ou serviços).
  • transaction (transaction): Dados da transação do item.
  • entryUnit (string): Unidade de medida.
  • quantity (money): Quantidade do item.
  • unitPrice (money): Preço unitário do item.
  • warehouse (genericRecord): Dados do depósito.
  • discountValue (money): Valor de desconto aplicado ao item.
  • financialAccount: Conta financeira do item.
  • costCenter: Centro de custos do item.
  • batch (batch*): Informações de lote do item.
  • distributionSeries (distribuitionSeries*): Informações de série de distribuição do item.
  • taxes: campos referentes aos impostos ICMS, ICMS Efetivamente Creditado, PIS Recuperar e COFINS Recuperar. Campo opcional. Caso não seja informado, o sistema calcula automaticamente os impostos conforme definido no perfil tributário.
    • taxType: Tipo de imposto aplicado.
      • PIS_RECUPERAR
      • COFINS_RECUPERAR
      • ICMS
      • ICMS_CREDITADO
    • cst: Código da situação tributária.
    • origin: Origem fiscal da mercadoria.
    • taxBase: Base de cálculo do imposto (valor sobre o qual o imposto será calculado).
    • TaxRate: Alíquota do imposto (percentual aplicado sobre a base de cálculo).
    • TaxValue: Valor do imposto calculado.
    • taxReductionPercentage: Percentual de redução da base de cálculo do imposto.
    • otherValues: Outros valores.
    • exemptValues: Valor isentas.
    • manualTax: Indica se o imposto foi inserido manualmente.
• otherValues: Dados referentes à seção Outros Valores das Informações Adicionais da Nota Fiscal de Entrada.
• insuranceValue: Valor de seguro.
• packagingValue: Valor de embalagens.
• chargesValue: Valor de encargos.
• thirdPartyValue: Valor cobrado em nome de terceiros.
• otherExpensesValue: Valor de outras despesas.
• highlightedOtherExpensesValue: Valor de outras despesas destacado.
• additionalDiscountValue: Valor de desconto adicional.
• additionalDiscountPercentage: Percentual de desconto adicional.
• roundingValue: Valor de arredondamento.

• 200: Consulta realizada com sucesso.
• 400: Requisição inválida (parâmetros obrigatórios não fornecidos ou incorretos).
• 401: Usuário não autenticado.
• 403: Usuário sem permissão para acessar os dados.
• 404: Nota fiscal não encontrada para o identificador fornecido.

• company (genericRecord): Dados da empresa. Campo obrigatório. Pode ser informado o id ou o code, sendo o id prioritário na busca.
• branch (person): Dados da filial. Campo obrigatório. Podem ser informados o id, code e documentNumber, com prioridade de busca na ordem descrita.
• sender (person): Dados do fornecedor. Campo obrigatório. Podem ser informados o id, code e documentNumber, com prioridade de busca na ordem descrita.
• series (genericRecord): Dados da série da nota. Campo obrigatório. Pode ser informado o id ou o code, sendo o id prioritário na busca.
• invoiceNumber (integer): Número da nota fiscal. Campo obrigatório.
• entryDate (dateTime): Data de entrada da nota. Campo opcional.
• issueDate (dateTime): Data de emissão da nota. Campo opcional.
• productTransaction (transaction): Dados da transação de produto. Campo opcional, caso não sejam informados produtos. Pode ser informado id, code ou cfop. A prioridade de busca será pelo id, e para code ou cfop, o primeiro registro encontrado será utilizado.
• serviceTransaction (transaction): Dados da transação de serviço. Campo opcional, caso não sejam informados serviços. Pode ser informado id, code ou cfop. A prioridade de busca será pelo id, e para code ou cfop, o primeiro registro encontrado será utilizado.
• invoiceKey (string): Chave da nota fiscal. Campo opcional.
• observation (string): Observação da nota fiscal. Campo opcional, com limite de 1000 caracteres.
• payment (paymentData): Dados de pagamento. Campo opcional. Caso informado, preencher também:
  • paymentCondition (genericRecord): Código ou ID da condição de pagamento. Campo opcional.
  • expirationDateIndicator: Tipo de data para cálculo do vencimento.
• otherValues: Dados referentes à seção Outros Valores das Informações Adicionais da Nota Fiscal de Entrada.
  • insuranceValue: Valor de seguro.
  • packagingValue: Valor de embalagens.
  • chargesValue: Valor de encargos.
  • thirdPartyValue: Valor cobrado em nome de terceiros.
  • otherExpensesValue: Valor de outras despesas.
  • highlightedOtherExpensesValue: Valor de outras despesas destacado.
  • additionalDiscountValue: Valor de desconto adicional. Se este parâmetro for utilizado, não é permitido informar o campo additionalDiscountPercentage.
  • additionalDiscountPercentage: Percentual de desconto adicional. Se este parâmetro for utilizado, não é permitido informar o campo additionalDiscountValue.
  • roundingValue: Valor de arredondamento.

A lista de itens (items) é obrigatória e deve conter os seguintes campos:

• id (string?): Identificador único do item. Campo opcional. Deve ser informado caso não seja informado o code.
• code (string): Código do item. Campo opcional. Deve ser informado caso não seja informado o id.
• transaction (transaction): Dados obrigatórios da transação do item ou serviço. Pode ser informado id, code ou cfop. A prioridade de busca será pelo id, e para code ou cfop, o primeiro registro encontrado será utilizado.
• entryUnit (string): Código da unidade de medida. Campo opcional.
• quantity (money): Quantidade do item. Campo obrigatório.
• unitPrice (money): Preço unitário do item. Campo opcional.
• warehouse (genericRecord): Dados do depósito. Campo opcional. Pode ser informado o id ou o code, sendo o id prioritário na busca.
• discountValue (money): Valor de desconto aplicado ao item. Campo opcional.
• financialAccount: Conta financeira do item. Somente contas financeiras do tipo Analítica podem ser informadas. Campo opcional. É possível informar o id ou o code, sendo o id prioritário na busca.
• costCenter: Centro de custos do item. Somente centros de custos do tipo Analítico podem ser informados. Campo opcional. É possível informar o id ou o code, sendo o id prioritário na busca.
• batch (batch*): Lista de lotes do produto. Campo opcional. Caso informado, os campos obrigatórios são:
  • code: Código do lote.
  • batchQuantity: Quantidade do lote.
  • Campos opcionais: manufactureDate (data de fabricação) e expirationDate (data de validade).
• distributionSeries (distribuitionSeries*): Lista de séries do produto. Campo opcional. Caso informado, o campo obrigatório é:
  • seriesNumber: Número da série.
  • Campos opcionais: manufactureDate (data de fabricação) e expirationDate (data de validade).
• taxes: campos referentes aos impostos ICMS, ICMS Efetivamente Creditado, PIS Recuperar e COFINS Recuperar. Campo opcional. Caso não seja informado, o sistema calcula automaticamente os impostos conforme definido no perfil tributário.
  • taxType: Tipo de imposto aplicado.
    • PIS_RECUPERAR
    • COFINS_RECUPERAR
    • ICMS
    • ICMS_CREDITADO
  • cst: Código da situação tributária.
  • origin: Origem fiscal da mercadoria.
  • taxBase: Base de cálculo do imposto (valor sobre o qual o imposto será calculado).
  • TaxRate: Alíquota do imposto (percentual aplicado sobre a base de cálculo).
  • TaxValue: Valor do imposto calculado.
  • taxReductionPercentage: Percentual de redução da base de cálculo do imposto.
  • otherValues: Outros valores.
  • exemptValues: Valor isentas.
  • manualTax: Indica se o imposto foi inserido manualmente.

invoiceId:(UUID): Identificador único da nota fiscal de entrada.

• invoiceId: Identificador da nota fiscal;
• observation: Motivo do bloqueio;
• origin: Origem do bloqueio.

• Sucesso no bloqueio: O campo locked retorna com o valor True;
• Sucesso no desbloqueio: O campo locked retorna com o valor False.

• Caso a nota não esteja com o status Em Digitação: 
  • message: Não é possível bloquear uma nota fiscal com situação diferente de EM DIGITAÇÃO;
  • errorCode: 400;
  • reason: BAD_REQUEST.
• Caso a nota não seja de emissão de terceiro:
  • message: Não é possível bloquear uma nota fiscal de emissão própria;
  • errorCode: 400;
  • reason: BAD_REQUEST.

• company (genericRecord): Dados da empresa. Campo obrigatório. Pode ser informado o id ou o code, sendo o id prioritário na busca.
• branch (person): Dados da filial. Campo obrigatório. Podem ser informados o id, code ou documentNumber, com a prioridade para a busca na ordem descrita.
• issuerDocumentNumber (string): CPF, CNPJ ou NIF (Número de Identificação Fiscal) do emissor. Campo obrigatório.
• issuerName (string): Nome do emissor. Campo obrigatório.
• stateAbbreviation (string): UF do emissor. Campo obrigatório.
• issueDate (dateTime): Data de emissão da nota. Campo obrigatório.
• invoiceModel (integer): Modelo da nota (55 ou 57). Campo obrigatório.
• invoiceNumber (integer): Número da nota fiscal. Campo obrigatório.
• invoiceSeries (integer): Número da série da nota. Campo obrigatório.
• invoiceAmount (decimal): Valor total da nota fiscal. Campo obrigatório.
• invoiceVersion (string): Versão do XML da nota fiscal. Campo obrigatório.
• xmlFile (string): XML completo da Nota Fiscal de Entrada. Campo obrigatório.
• documentType (documentType): Tipo de documento da nota. Campo obrigatório.
• accessKey (string): Chave de acesso à nota na SEFAZ. Campo obrigatório.

O identificador da representação da nota fiscal a ser consultada ou excluída deve ser incluído no final da URL. Deve ser informado também o verbo HTTP correspondente, GET ou DELETE.