Todas as coleções
APIs
Exemplos de API
Alterando um recebimento via API
Alterando um recebimento via API

Nesse artigo, descubra como alterar o recebimento de uma nota via API

Hugo Alves avatar
Escrito por Hugo Alves
Atualizado há mais de uma semana

Antes que possa começar de fato os testes com a nossa API, é importante que conheça alguns processos básicos:

💡 #DicaDoBem: Atualmente, conseguimos testar as nossas API’s diretamente pelo site do Developer, porém, existem alguns programas que também podem realizar esse processo, como é o caso do Postman, Insomnia e o ThunderClient (uma extensão do VS Code)

Para o nosso teste, vamos utilizar diretamente o Developer. Assim como, vamos utilizar o APP KEY e o APP SECRET padrões, mas se preferir, pode alterar para o seu 😉


Depois que uma nota de entrada é importada no sistema, conseguimos alterar algumas informações. Vamos pegar a seguinte nota como exemplo para trabalharmos os nossos exemplos:

Primeiro, vamos consultar para ver quais são os dados retornados: ConsultarRecebimento

Para isso, vou utilizar a seguinte requisição, usando como base a chave de acesso da nota:

{"cChaveNfe": "XXXXXXX"}

No retorno, vamos ter algumas informações muito importantes. A primeira delas é no próprio cabeçalho, aonde vai nos retornar a tag “nIdReceb”, que podemos usar no lugar da chave de acesso daqui para a frente


Agora, vamos utilizar o método: Alterar Recebimento

Outro detalhe importante, é a estrutura da API, ou seja, qual a ordem das tags e como utilizá-las. Dito isso, faremos as seguintes alterações abaixo:

{
"ide": {
"nIdReceb": 5378752907
},
"itensRecebimentoEditar": [
{

"itensIde": {
"nSequencia": 3,
"cAcao": "IGNORAR"
}
},
{
"itensIde": {
"nSequencia": 4,
"cAcao": "IGNORAR"
}
},
{
"itensIde": {
"nSequencia": 5,
"cAcao": "IGNORAR"
}
},
{
"itensIde": {
"nSequencia": 6,
"cAcao": "IGNORAR"
}
}
]
}

Observe que na documentação indica que o parâmetro “itensRecebimentoEditar” é um array:

E a tag “itensIde” é a identificação do item na nota, por isso se for indicar mais de um, deve ir separado, como valores do array

Em termos práticos, a requisição que mandamos indica o seguinte:

Feito isso, vamos associar o primeiro item da nota, com um item dentro do nosso sistema

A requisição é bem parecida, veja:

{
"ide": {
"nIdReceb": 5378752907
},
"itensRecebimentoEditar": [
{
"itensIde": {
"nSequencia": 1,
"cAcao": "ASSOCIAR-PRODUTO",
"nIdProdutoExistente": 749931217
}
}
]
}

Por fim, vamos então alterar o CFOP dos dois primeiros itens, utilizando a seguinte requisição:

{
"ide": {
"nIdReceb": 5378752907
},
"itensRecebimentoEditar": [
{
"itensIde": {
"nSequencia": 1,
"cAcao": "EDITAR"
},
"itensAjustes": {
"cCFOPEntrada": "1.102"
}
},
{
"itensIde": {
"nSequencia": 2,
"cAcao": "EDITAR"
},
"itensAjustes": {
"cCFOPEntrada": "1.101"
}
}
]
}

Caso quisesse informar o CFOP dos demais itens, basta replicar a ação no mesmo código

Visualmente falando, o que fizemos agora com essa última requisição foi o seguinte:

Todos os outros processos nesse método podem ser feitos seguindo como padrão os exemplos acima


📌 Separamos alguns artigos interessantes para você:

Respondeu à sua pergunta?