GET Imposto Regra
Endpoint responsável por retornar as regras de cálculo de imposto cadastradas pelo fornecedor.
Endpoint GET
URL
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta dos impostos:
pagina: Página a ser exibida.
-
Página inicial e default 1.
-
Parâmetro não obrigatório.
porPagina: Quantidade de registros a serem exibidas por página.
-
Default 500 registros por página.
-
Máxima de 500 registros por página permitida.
-
Parâmetro não obrigatório.
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/calculo-impostos/regras?pagina=1&porPagina=2' \
--header 'Authorization: Bearer ...'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados com status code 200.
Exemplo de retorno:
{
"data": [
{
"idImposto": 9151167,
"id": null,
"clienteCnpj": "03753945000172",
"eanDUN": "17896512901399",
"palletMultiploDun": 0,
"ufDestino": "AL",
"ncm": "30049099N",
"nivelAumento": "",
"icmsEstadual": 19,
"icmsInterEstadual": 7,
"icmsReducao": 0,
"stAjuste": 52.76,
"precoUnidadePauta": 0,
"aliquotaICMS": 7,
"aliquotaICMSST": 7,
"aliquotaFCP": 0,
"aliquotaDifal": 0,
"stReducao": 0
},
{
"idImposto": 9151168,
"id": null,
"clienteCnpj": "03753945000172",
"eanDUN": "17896512901405",
"palletMultiploDun": 0,
"ufDestino": "AL",
"ncm": "30049099N",
"nivelAumento": "",
"icmsEstadual": 19,
"icmsInterEstadual": 7,
"icmsReducao": 0,
"stAjuste": 52.76,
"precoUnidadePauta": 0,
"aliquotaICMS": 7,
"aliquotaICMSST": 7,
"aliquotaFCP": 0,
"aliquotaDifal": 0,
"stReducao": 0
}
],
"total": 1101
}
Elementos da Resposta
data: Lista com as informações dos impostos.
idImposto: Identificador (ID) do imposto na base yandeh.
Tipo: Integer.
id: Identificador (ID) criado pelo fornecedor para a regra de imposto.
Tipo: String.
clienteCnpj: CNPJ do cliente.
Tipo: String
eanDUN: Código EAN ou DUN do produto.
Tipo: String
palletMultiploDun: Múltiplo de venda para comercialização da embalagem.
Tipo: Integer.
ufDestino: Unidade federativa do cliente.
Tipo: String.
ncm:Código da natureza do produto no Mercosul.
Tipo: String.
nivelAumento: Código atribuído no cadastro do cliente para determinar a régua da regra de cálculo que o cliente deve ser enquadrado.
Tipo: String.
icmsEstadual: Percentual de alíquota de ICMS estadual.
Tipo: Double
icmsInterEstadual: Percentual de alíquota de ICMS interestadual.
Tipo: Double.
icmsReducao: Percentual de alíquota de redução do ICMS estadual.
Tipo: Double.
stAjuste: Percentual de alíquota de ajuste da ST (substituição tributária).
Tipo: Double.
precoUnidadePauta: Preço de pauta.
Tipo: Double.
aliquotaICMS: Percentual de alíquota de ICMS base
Tipo: Double.
aliquotaICMSST: Percentual de alíquota de ICMS base da ST (substituição tributária).
Tipo: Double.
aliquotaFCP: Percentual de alíquota do fundo de combate à pobreza.
Tipo: Integer.
aliquotaDifal: Percentual de alíquota da diferença do ICMS do estado de origem para o estado de destino. É a diferença entre as alíquotas de ICMS Estadual e ICMS Interestadual.
Tipo: Double.
stReducao: Percentual de alíquota de redução da ST (substituição tributária).
Tipo: Double.
total: Total de registros disponíveis na requisição.
Tipo: Integer.
POST Imposto Regra
Endpoint responsável pelo cadastro de regras de impostos.
Endpoint POST
URL
Sintaxe da Requisição
-
Tipo de requisição: POST.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
[
{
"id": "1234",
"clienteCnpj": "12345678000195",
"eanDUN": "7896512953971",
"ufDestino": "SP",
"ncm": "45",
"nivelAumento": "3",
"icmsEstadual": 1.1,
"icmsInterEstadual": 15.1,
"icmsReducao": 10.5,
"stAjuste": 5,
"stReducao": 4,
"precoUnidadePauta": 2,
"aliquotaICMS": 2,
"aliquotaICMSST": 1,
"aliquotaFCP": 1,
"aliquotaDifal": 10
}
]
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/calculo-impostos/regras' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data '[
{
"id": "1234",
"clienteCnpj": "12345678000195",
"eanDUN": "7896512953971",
"ufDestino": "SP",
"ncm": "45",
"nivelAumento": "3",
"icmsEstadual": 1.1,
"icmsInterEstadual": 15.1,
"icmsReducao": 10.5,
"stAjuste": 5,
"stReducao": 4,
"precoUnidadePauta": 2,
"aliquotaICMS": 2,
"aliquotaICMSST": 1,
"aliquotaFCP": 1,
"aliquotaDifal": 10
}
]'
Elementos da Requisição
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
Todos os registros cadastrados
id: Identificador (ID) criado pelo fornecedor para a regra de imposto.
Tipo: String.
clienteCnpj: CNPJ do cliente.
Tipo: String
eanDUN: Código EAN ou DUN do produto.
Tipo: String
ufDestino: Unidade federativa do cliente.
Tipo: String.
ncm:Código da natureza do produto no Mercosul.
Tipo: String.
nivelAumento: Código atribuído no cadastro do cliente para determinar a régua da regra de cálculo que o cliente deve ser enquadrado.
Tipo: String.
icmsEstadual: Percentual de alíquota de ICMS estadual.
Tipo: Double
icmsInterEstadual: Percentual de alíquota de ICMS interestadual.
Tipo: Double.
icmsReducao: Percentual de alíquota de redução do ICMS estadual.
Tipo: Double.
stAjuste: Percentual de alíquota de ajuste da ST (substituição tributária).
Tipo: Double.
precoUnidadePauta: Preço de pauta.
Tipo: Double.
aliquotaICMS: Percentual de alíquota de ICMS base
Tipo: Double.
aliquotaICMSST: Percentual de alíquota de ICMS base da ST (substituição tributária).
Tipo: Double.
aliquotaFCP: Percentual de alíquota do fundo de combate à pobreza.
Tipo: Integer.
aliquotaDifal: Percentual de alíquota da diferença do ICMS do estado de origem para o estado de destino. É a diferença entre as alíquotas de ICMS Estadual e ICMS Interestadual.
Tipo: Double.
stReducao: Percentual de alíquota de redução da ST (substituição tributária).
Tipo: Double.
{
"mensagem": "Informações cadastradas com sucesso."
}
Cadastro realizado de forma parcial
Se alguns registros forem informados corretamente e outros não, o endpoint retornará multi-status com status code 207.
Exemplo de retorno:
{
"mensagem": "Informações parcialmente cadastradas, outras apresentaram erros.",
"detalhes": [
{
"id": "1234",
"clienteCnpj": "04039770000100",
"eanDUN": "7896512953971",
"ufDestino": "SP",
"ncm": "45",
"nivelAumento": "3",
"icmsEstadual": 1.1,
"icmsInterEstadual": 15.1,
"icmsReducao": 10.5,
"stAjuste": 5,
"stReducao": 4,
"precoUnidadePauta": 2,
"aliquotaICMS": 2,
"aliquotaICMSST": 1,
"aliquotaFCP": 1,
"aliquotaDifal": 10,
"erro_msg": "Esse cliente não tem vinculo com fornecedor"
}
]
}
Respostas para erros
400 Bad Request - Informações já cadastradas
{
"mensagem": "Não há dados para serem cadastrados."
}
400 Bad Request - Todos os registros inválidos : Cliente inexistente
{
"mensagem": "Todos os impostos contém erros.",
"detalhe": [
{
"id": "1234",
"clienteCnpj": "04039770000100",
"eanDUN": "7896512953971",
"ufDestino": "SP",
"ncm": "45",
"nivelAumento": "3",
"icmsEstadual": 1.1,
"icmsInterEstadual": 15.1,
"icmsReducao": 10.5,
"stAjuste": 5,
"stReducao": 4,
"precoUnidadePauta": 2,
"aliquotaICMS": 2,
"aliquotaICMSST": 1,
"aliquotaFCP": 1,
"aliquotaDifal": 10,
"erro_msg": "Esse cliente não tem vinculo com fornecedor"
}
]
}
PUT Imposto Regra
Endpoint PUT
Endpoint responsável por atualizar as regras de impostos do fornecedor.
URL
Sintaxe da Requisição
-
Tipo de requisição: PUT.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
Importante: Informe apenas os campos que precisam ser atualizados
[
{
"idImposto": "1",
"id": "1234",
"clienteCnpj": "12345678000195",
"eanDUN": "7896512953971",
"ufDestino": "SP",
"ncm": "45",
"nivelAumento": "3",
"icmsEstadual": 1.1,
"icmsInterEstadual": 15.1,
"icmsReducao": 10.5,
"stAjuste": 5,
"stReducao": 4,
"precoUnidadePauta": 2,
"aliquotaICMS": 2,
"aliquotaICMSST": 1,
"aliquotaFCP": 1,
"aliquotaDifal": 10
}
]
Exemplo
curl --location --request PUT 'https://yandeh-seller-integration.yandeh.com.br/calculo-impostos/regras' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data '[
{
"idImposto": "7655515",
"id": "1234",
"clienteCnpj": "04039770000107",
"eanDUN": "7896512953971",
"ufDestino": "SP",
"icmsInterEstadual": 15.15,
"aliquotaICMSST": 2
}
]'
Elementos da Requisição
idImposto: Identificador (ID) do imposto na base yandeh.
Tipo: Integer.
id: Identificador (ID) criado pelo fornecedor para a regra de imposto.
Tipo: String.
clienteCnpj: CNPJ do cliente.
Tipo: String
eanDUN: Código EAN ou DUN do produto.
Tipo: String
ufDestino: Unidade federativa do cliente.
Tipo: String.
ncm:Código da natureza do produto no Mercosul.
Tipo: String.
nivelAumento: Código atribuído no cadastro do cliente para determinar a régua da regra de cálculo que o cliente deve ser enquadrado.
Tipo: String.
icmsEstadual: Percentual de alíquota de ICMS estadual.
Tipo: Double
icmsInterEstadual: Percentual de alíquota de ICMS interestadual.
Tipo: Double.
icmsReducao: Percentual de alíquota de redução do ICMS estadual.
Tipo: Double.
stAjuste: Percentual de alíquota de ajuste da ST (substituição tributária).
Tipo: Double.
precoUnidadePauta: Preço de pauta.
Tipo: Double.
aliquotaICMS: Percentual de alíquota de ICMS base
Tipo: Double.
aliquotaICMSST: Percentual de alíquota de ICMS base da ST (substituição tributária).
Tipo: Double.
aliquotaFCP: Percentual de alíquota do fundo de combate à pobreza.
Tipo: Integer.
aliquotaDifal: Percentual de alíquota da diferença do ICMS do estado de origem para o estado de destino. É a diferença entre as alíquotas de ICMS Estadual e ICMS Interestadual.
Tipo: Double.
stReducao: Percentual de alíquota de redução da ST (substituição tributária).
Tipo: Double.
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
Todos os registros atualizados
{
"mensagem": "Informações atualizadas com sucesso."
}
Atualização realizado de forma parcial
Se alguns registros forem informados corretamente e outros não, o endpoint retornará multi-status com status code 207.
Exemplo de retorno:
{
"mensagem": "Informações parcialmente atualizadas, outras não foram encontradas para atualização",
"detalhes": [
{
"id": "7655510",
"erro": "Não encontrado para atualização"
}
]
}
DELETE Imposto Regra
Endpoint responsável pela remoção das regras de impostos do fornecedor.
Endpoint DELETE
URL
Sintaxe da Requisição
-
Tipo de requisição: DELETE.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
[
{
"idImposto": "123"
}
]
Exemplo
curl --location --request DELETE 'https://yandeh-seller-integration.yandeh.com.br/calculo-impostos/regras' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data '[
{
"idImposto": "7655515"
}
]'
Elementos da Requisição
idImposto: Identificador (ID) do imposto na base yandeh.
Tipo: String.
Sintaxe da Resposta
Todos os registros deletados
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
{
"mensagem": "Informações deletadas com sucesso."
}
Deleção realizado de forma parcial
Se alguns registros forem informados corretamente e outros não, o endpoint retornará multi-status com status code 207.
Exemplo de retorno:
{
"mensagem": "Informações parcialmente deletadas, outras não foram encontradas para deleção",
"detalhes": [
{
"id": "7655510",
"erro": "Não encontrado para deleção"
}
]
}
Respostas para erros
400 Bad Request - Identificador (ID) inválido
{
"mensagem": "Informações não encontradas para deleção"
}
GET Imposto Cliente
Endpoint responsável por retornar as regras de impostos cadastradas a nível cliente.
Endpoint GET
URL
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta dos clientes:
pagina: Página a ser exibida.
-
Página inicial e default 1.
-
Parâmetro não obrigatório.
porPagina: Quantidade de registros a serem exibidas por página.
-
Default 500 registros por página.
-
Parâmetro não obrigatório.
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/calculo-impostos/cliente?pagina=1&porPagina=2' \
--header 'Authorization: Bearer ...'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados com status code 200.
Exemplo de retorno:
{
"listaImpostoCliente": [
{
"clienteCnpj": "49800104000100",
"nivelAumento": "",
"calculaICMS": true,
"calculaICMSReducao": true,
"calculaST": true,
"calculaIPI": true,
"zonaFranca": false,
"agregaIPIICMS": false
},
{
"clienteCnpj": "21003178000204",
"nivelAumento": "",
"calculaICMS": true,
"calculaICMSReducao": true,
"calculaST": false,
"calculaIPI": true,
"zonaFranca": false,
"agregaIPIICMS": false
}
]
}
Elementos da Resposta
listaImpostoCliente: Lista com as informações das regras por cliente.
clienteCnpj: CNPJ do cliente.
Tipo: String.
nivelAumento: Classificação fiscal do cliente para identificar a regra de exceção que o cliente possui para cálculos de impostos.
Tipo: String.
calculaICMS: Indicador que define se o cliente realiza o cálculo de ICMS.
Tipo: Booleano
calculaICMSReducao: Indicador que define se o cliente realiza o cálculo de ICMS redução.
Tipo: Booleano
calculaST: Indicador que define se o cliente realiza o cálculo de ST.
Tipo: Booleano.
calculaIPI: Indicador que define se o cliente realiza o cálculo de IPI.
Tipo: Booleano.
zonaFranca: Indicador que define se o cliente está inserido nas regras da xona Franca de Manaus.
Tipo: Booleano.
agregaIPI_ICMS: Identificador que define se o cliente deve agregar a alíquota de IPI no valor de ICMS.
Tipo: Booleano.
POST Imposto Cliente
Endpoint POST
Endpoint utilizado para registrar as regras de impostos associada ao cliente.
URL
Sintaxe da Requisição
-
Tipo de requisição: POST.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
[
{
"clienteCnpj": "09477652001753",
"nivelAumento": "",
"calculaICMS": false,
"calculaICMSReducao": false,
"calculaST": false,
"calculaIPI": false,
"zonaFranca": false,
"agregaIPI_ICMS": false
}
]
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/calculo-impostos/cliente' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data '[
{
"clienteCnpj": "04039770000107",
"nivelAumento": "",
"calculaICMS": false,
"calculaICMSReducao": false,
"calculaST": false,
"calculaIPI": false,
"zonaFranca": false,
"agregaIPI_ICMS": false
}
]'
Elementos da Requisição
clienteCnpj: CNPJ do cliente.
Tipo: String.
nivelAumento: Classificação fiscal do cliente para identificar a regra de exceção que o cliente possui para cálculos de impostos.
Tipo: String.
calculaICMS: Indicador que define se o cliente realiza o cálculo de ICMS.
Tipo: Booleano
calculaICMSReducao: Indicador que define se o cliente realiza o cálculo de ICMS redução.
Tipo: Booleano
calculaST: Indicador que define se o cliente realiza o cálculo de ST.
Tipo: Booleano.
calculaIPI: Indicador que define se o cliente realiza o cálculo de IPI.
Tipo: Booleano.
zonaFranca: Indicador que define se o cliente está inserido nas regras da xona Franca de Manaus.
Tipo: Booleano.
agregaIPI_ICMS: Identificador que define se o cliente deve agregar a alíquota de IPI no valor de ICMS.
Tipo: Booleano.
Sintaxe da Resposta
Todos os registros cadastrados
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
{
"mensagem": "Informações cadastradas com sucesso."
}
Cadastro realizado de forma parcial
Se alguns registros forem informados corretamente e outros não, o endpoint retornará multi-status com status code 207.
Exemplo de retorno:
{
"mensagem": "Informações parcialmente cadastradas, outras apresentaram erro",
"detalhe": [
{
"clienteCnpj": "12345678000195",
"mensagem": "O cliente não possui vinculo com o fornecedor."
}
]
}
Respostas para erros
{
"mensagem": "Não foi possível cadastrar, clienteCnpj é obrigatório e deve ser informado."
}
400 Bad Request - Campos obrigatórios não informados
PUT Imposto Cliente
Endpoint PUT
Endpoint utilizado para atualizar as regras de impostos associada ao cliente.
URL
Sintaxe da Requisição
-
Tipo de requisição: PUT.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
Importante: Informe apenas os campos que precisam ser atualizados
[
{
"clienteCnpj": "09477652001753",
"nivelAumento": "",
"calculaICMS": false,
"calculaICMSReducao": false,
"calculaST": false,
"calculaIPI": false,
"zonaFranca": false,
"agregaIPI_ICMS": false
}
]
Exemplo
curl --location --request PUT 'https://yandeh-seller-integration.yandeh.com.br/calculo-impostos/cliente' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data '[
{
"clienteCnpj": "20007808000195",
"nivelAumento": "",
"calculaICMS": true
"calculaICMSReducao": true
"calculaST": false,
"calculaIPI": true
"zonaFranca": false,
"agregaIPI_ICMS": false
}
]'
Elementos da Requisição
clienteCnpj: CNPJ do cliente.
Tipo: String.
nivelAumento: Classificação fiscal do cliente para identificar a regra de exceção que o cliente possui para cálculos de impostos.
Tipo: String.
calculaICMS: Indicador que define se o cliente realiza o cálculo de ICMS.
Tipo: Booleano
calculaICMSReducao: Indicador que define se o cliente realiza o cálculo de ICMS redução.
Tipo: Booleano
calculaST: Indicador que define se o cliente realiza o cálculo de ST.
Tipo: Booleano.
calculaIPI: Indicador que define se o cliente realiza o cálculo de IPI.
Tipo: Booleano.
zonaFranca: Indicador que define se o cliente está inserido nas regras da xona Franca de Manaus.
Tipo: Booleano.
agregaIPI_ICMS: Identificador que define se o cliente deve agregar a alíquota de IPI no valor de ICMS.
Tipo: Booleano.
Sintaxe da Resposta
Todos os registros atualizados
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
{
"mensagem": "Informações cadastradas com sucesso."
}
Atualização realizado de forma parcial
Se alguns registros forem informados corretamente e outros não, o endpoint retornará multi-status com status code 207.
Exemplo de retorno:
{
"mensagem": "Informações parcialmente cadastradas, outras apresentaram erro",
"detalhe": [
{
"clienteCnpj": "12345678000195",
"mensagem": "O cliente não possui vinculo com o fornecedor."
}
]
}
DELETE Imposto Cliente
Endpoint DELETE
Endpoint utilizado para remover as regras de impostos associada ao cliente.
URL
Sintaxe da Requisição
-
Tipo de requisição: DELETE.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
{
"clienteCnpj": [ "12345678000195" ]
}
Exemplo
curl --location --request DELETE 'https://yandeh-seller-integration.yandeh.com.br/calculo-impostos/cliente' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data '{
"clienteCnpj": [ "06159713000189" ]
}'
Elementos da Requisição
clienteCnpj: CNPJ do cliente.
Tipo: String.
Sintaxe da Resposta
Todos os registros deletados
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
Deleção realizado de forma parcial
Se alguns registros forem informados corretamente e outros não, o endpoint retornará multi-status com status code 207.
Exemplo de retorno:
{
"mensagem": "Informações parcialmente deletadas, outras apresentaram erro",
"detalhe": [
{
"clienteCnpj": "12345678000195",
"mensagem": "O cliente não possui vinculo com o fornecedor."
}
]
}
Respostas para erros
{
"mensagem": "Nenhum calculos de imposto para ser deletado."
}
400 Bad Request - Impostos para o cliente não localizado.
GET Imposto Produto
Endpoint responsável por retornar as regras de impostos cadastradas a nível produto.
Endpoint GET
URL
Parâmetros da requisição
Informe os parâmetros abaixo para realizar a consulta dos impostos :
pagina: Página a ser exibida.
-
Página inicial e default 1.
-
Parâmetro não obrigatório.
porPagina: Quantidade de registros a serem exibidas por página.
-
Default 500 registros por página.
-
Máxima de 500 registros por página permitida.
-
Parâmetro não obrigatório.
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/calculo-impostos/produto?porPagina=2' \
--header 'Authorization: Bearer ...'
Sintaxe da Resposta
Se os parâmetros forem informados corretamente, o endpoint retornará os dados com status code 200.
Exemplo de retorno:
{
"data": [
{
"idImposto": 1611,
"eanDUN": "17896512983388",
"calculaICMS": true,
"calculaICMSReducao": false,
"calculaST": true,
"calculaIPI": true,
"zonaFranca": false,
"agregaIPIICMS": false,
"calculaPIS": false,
"calculaCOFINS": false,
"aliquotaPIS": 0,
"aliquotaCOFINS": 0,
"aliquotaIPI": 0,
"ncm": "33030020N",
"ncmTipi": null,
"ncmOrigem": "N"
},
{
"idImposto": 932,
"eanDUN": "7896512970336",
"calculaICMS": true,
"calculaICMSReducao": false,
"calculaST": false,
"calculaIPI": true,
"zonaFranca": false,
"agregaIPIICMS": false,
"calculaPIS": false,
"calculaCOFINS": false,
"aliquotaPIS": 0.0165,
"aliquotaCOFINS": 0.076,
"aliquotaIPI": 0,
"ncm": "33029099N",
"ncmTipi": null,
"ncmOrigem": "N"
}
],
"total": "1539"
}
Elementos da Resposta
data: Lista com as informações dos impostos.
idImposto: Identificador (ID) do imposto na base yandeh.
Tipo: Integer.
eanDUN: Código EAN ou DUN do produto.
Tipo: String
calculaICMS: Indicador que define se o produto realiza o cálculo de ICMS.
Tipo: Booleano.
calculaICMSReducao: Indicador que define se o produto realiza o cálculo de ICMS redução.
Tipo: Booleano.
calculaST: Indicador que define se o produto realiza o cálculo de ST.
Tipo: Booleano.
calculaIPI: Indicador que define se o produto realiza o cálculo de IPI.
Tipo: Booleano.
zonaFranca: Indicador que define se o produto está inserido nas regras da xona Franca de Manaus.
Tipo: Booleano
agregaIPIICMS: Identificador que define se o produto deve agregar a alíquota de IPI no valor de ICMS.
Tipo: ncmOrigem.
calculaPIS: Indicador que define se o produto realiza o cálculo de PIS .
Tipo: Booleano.
calculaCOFINS:Indicador que define se o produto realiza o cálculo de COFINS.
Tipo: Booleano.
aliquotaPIS: Valor porcentual de alíquota PIS.
Tipo: Double.
aliquotaCOFINS: Valor porcentual de alíquota COFINS.
Tipo: Double.
aliquotaIPI: Valor porcentual de alíquota IPI.
Tipo: Double.
ncm: Código da natureza do produto no Mercosul.
Tipo: String.
ncmTipi: Código da natureza do produto IPI para o NCM.
Tipo: Integer.
ncmOrigem:Origem do produto (N = nacional / I = Internacional).
Tipo: String.
total: Total de registros disponíveis na requisição.
Tipo: Integer.
POST Imposto Produto
Endpoint POST
Endpoint utilizado para registrar as regras de impostos associada ao produto.
URL
Sintaxe da Requisição
-
Tipo de requisição: POST.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
[
{
"eanDUN": "7896512953971",
"palletMultiploDun": 10,
"calculaICMS": true,
"calculaICMSReducao": true,
"calculaST": true,
"calculaIPI": true,
"zonaFranca": false,
"agregaIPIICMS": true,
"calculaPIS": true,
"calculaCOFINS": true,
"aliquotaPIS": 1,
"aliquotaCOFINS": 1,
"aliquotaIPI": 10,
"ncm": "3439049301",
"ncmTipi": 3439049301,
"ncmOrigem": "N"
}
]
Exemplo
curl --location 'https://yandeh-seller-integration.yandeh.com.br/calculo-impostos/produto' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data ' [
{
"eanDUN": "7896512953971",
"palletMultiploDun": 10,
"calculaICMS": true,
"calculaICMSReducao": true,
"calculaST": true,
"calculaIPI": true,
"zonaFranca": true,
"agregaIPIICMS": true,
"calculaPIS": true,
"calculaCOFINS": true,
"aliquotaPIS": 1,
"aliquotaCOFINS": 1,
"aliquotaIPI": 10,
"ncm": "3439049301N",
"ncmTipi": 3439049301,
"ncmOrigem": "N"
}
]'
Elementos da Requisição
eanDUN: Código EAN ou DUN do produto.
Tipo: String
palletMultiploDun: Múltiplo de venda para comercialização da embalagem.
Tipo: Integer.
calculaICMS: Indicador que define se o produto realiza o cálculo de ICMS.
Tipo: Booleano.
calculaICMSReducao: Indicador que define se o produto realiza o cálculo de ICMS redução.
Tipo: Booleano.
calculaST: Indicador que define se o produto realiza o cálculo de ST.
Tipo: Booleano.
calculaIPI: Indicador que define se o produto realiza o cálculo de IPI.
Tipo: Booleano.
zonaFranca: Indicador que define se o produto está inserido nas regras da xona Franca de Manaus.
Tipo: Booleano
agregaIPIICMS: Identificador que define se o produto deve agregar a alíquota de IPI no valor de ICMS.
Tipo: ncmOrigem.
calculaPIS: Indicador que define se o produto realiza o cálculo de PIS .
Tipo: Booleano.
calculaCOFINS:Indicador que define se o produto realiza o cálculo de COFINS.
Tipo: Booleano.
aliquotaPIS: Valor porcentual de alíquota PIS.
Tipo: Double.
aliquotaCOFINS: Valor porcentual de alíquota COFINS.
Tipo: Double.
aliquotaIPI: Valor porcentual de alíquota IPI.
Tipo: Double.
ncm: Código da natureza do produto no Mercosul.
Tipo: String.
ncmTipi: Código da natureza do produto IPI para o NCM.
Não obrigatório cas o ncm esteja preenchido.
Tipo: Integer.
ncmOrigem:Origem do produto (N = nacional / I = Internacional).
Não obrigatório cas o ncm esteja preenchido.
Tipo: String.
Sintaxe da Resposta
Todos os registros cadastrados
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
{
"data": {
"mensagem": "Informações cadastradas com sucesso."
}
}
Cadastro realizado de forma parcial
Se alguns registros forem informados corretamente e outros não, o endpoint retornará multi-status com status code 207.
Exemplo de retorno:
{
"data": {
"mensagem": "Informações parcialmente cadastradas, outras apresentaram erro.",
"detalhes": [
{
"eanDUN": "7896512953971",
"calculaICMS": true,
"calculaICMSReducao": true,
"calculaST": true,
"calculaIPI": true,
"zonaFranca": true,
"agregaIPIICMS": true,
"calculaPIS": true,
"calculaCOFINS": true,
"aliquotaPIS": 1,
"aliquotaCOFINS": 1,
"aliquotaIPI": 10,
"erro_msg": "Não é permitido criar imposto para esse EAN"
}
]
}
}
Respostas para erros
{
"detalhes": [
{
"eanDUN": "7896512953971",
"palletMultiploDun": 1,
"calculaICMS": true,
"calculaICMSReducao": true,
"calculaST": true,
"calculaIPI": true,
"zonaFranca": true,
"agregaIPI_ICMS": true,
"calculaPIS": true,
"calculaCOFINS": true,
"aliquotaPIS": 1,
"aliquotaCOFINS": 1,
"aliquotaIPI": 1,
"erro_msg": "Imposto ja existente"
}
]
}
400 Bad Request - Impostos já cadastrados
400 Bad Request - Produto não cadastrado
{
"detalhes": "Nenhum EAN informado possui vínculo com o fornecedor."
}
PUT Imposto Produtos
Endpoint PUT
Endpoint utilizado para atualizar as regras de impostos associada ao produto.
URL
Sintaxe da Requisição
-
Tipo de requisição: PUT.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
Importante: Informe apenas os campos que precisam ser atualizados
[
{
"eanDUN": "7896512953971",
"calculaICMS": true,
"calculaICMSReducao": true,
"calculaST": true,
"calculaIPI": true,
"zonaFranca": true,
"agregaIPIICMS": true,
"calculaPIS": true,
"calculaCOFINS": true,
"aliquotaPIS": 1,
"aliquotaCOFINS": 1.5,
"aliquotaIPI": 10,
"ncm": "3439049301N",
"ncmTipi": 3439049301,
"ncmOrigem": "N"
}
]
Exemplo
curl --location --request PUT 'https://yandeh-seller-integration.yandeh.com.br/calculo-impostos/produto' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data '[
{
"eanDUN": "7896512953971",
"calculaICMS": false,
"calculaICMSReducao": false,
"calculaST": false,
"calculaIPI": false
}
]'
Elementos da Requisição
eanDUN: Código EAN ou DUN do produto.
Tipo: String
palletMultiploDun: Múltiplo de venda para comercialização da embalagem.
Tipo: Integer.
calculaICMS: Indicador que define se o produto realiza o cálculo de ICMS.
Tipo: Booleano.
calculaICMSReducao: Indicador que define se o produto realiza o cálculo de ICMS redução.
Tipo: Booleano.
calculaST: Indicador que define se o produto realiza o cálculo de ST.
Tipo: Booleano.
calculaIPI: Indicador que define se o produto realiza o cálculo de IPI.
Tipo: Booleano.
zonaFranca: Indicador que define se o produto está inserido nas regras da xona Franca de Manaus.
Tipo: Booleano
agregaIPIICMS: Identificador que define se o produto deve agregar a alíquota de IPI no valor de ICMS.
Tipo: ncmOrigem.
calculaPIS: Indicador que define se o produto realiza o cálculo de PIS .
Tipo: Booleano.
calculaCOFINS:Indicador que define se o produto realiza o cálculo de COFINS.
Tipo: Booleano.
aliquotaPIS: Valor porcentual de alíquota PIS.
Tipo: Double.
aliquotaCOFINS: Valor porcentual de alíquota COFINS.
Tipo: Double.
aliquotaIPI: Valor porcentual de alíquota IPI.
Tipo: Double.
ncm: Código da natureza do produto no Mercosul.
Tipo: String.
ncmTipi: Código da natureza do produto IPI para o NCM.
Não obrigatório cas o ncm esteja preenchido.
Tipo: Integer.
ncmOrigem:Origem do produto (N = nacional / I = Internacional).
Não obrigatório cas o ncm esteja preenchido.
Tipo: String.
Sintaxe da Resposta
Todos os registros atualizados
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
{
"mensagem": "Atualizações realizadas com sucesso!"
}
Atualização realizado de forma parcial
Se alguns registros forem informados corretamente e outros não, o endpoint retornará multi-status com status code 207.
Exemplo de retorno:
{
"mensagem": "Informações parcialmente atualizadas, outras apresentaram erros.",
"data": [
{
"eanDUN": "123",
"palletMultiploDun": 0,
"calculaICMS": true,
"calculaICMSReducao": true,
"calculaST": true,
"calculaIPI": true,
"zonaFranca": true,
"agregaIPIICMS": true,
"calculaPIS": true,
"calculaCOFINS": true,
"aliquotaPIS": 1,
"aliquotaCOFINS": 1.5,
"aliquotaIPI": 10,
"erro_msg": "Não é permitido criar imposto para esse EAN"
}
]
}
Respostas para erros
{
"detalhe": "Nenhum dos eans informados pertence ao estoque do fornecedor."
}
400 Bad Request - Produto não cadastrado
DELETE Imposto Produto
Endpoint DELETE
Endpoint utilizado para remover as regras de impostos associada ao produto.
URL
Sintaxe da Requisição
-
Tipo de requisição: DELETE.
-
Cabeçalho (Headers):
-
Content-Type: application/json
-
Authorization: Bearer <token>
-
-
Corpo da requisição:
Envio do JSON como exemplo abaixo:
[
{
"idImposto": "123"
}
]
Exemplo
curl --location --request DELETE 'https://yandeh-seller-integration.yandeh.com.br/calculo-impostos/produto' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ...' \
--data ' [
{
"idImposto": "123"
}
]'
Elementos da Requisição
idImposto: Identificador (ID) do imposto na base yandeh.
Tipo: String.
Sintaxe da Resposta
Todos os registros deletados
Se os parâmetros forem informados corretamente, o endpoint retornará sucesso com status code 200.
Exemplo de retorno:
{
"mensagem": "Informações deletadas com sucesso."
}
Deleção realizado de forma parcial
Se alguns registros forem informados corretamente e outros não, o endpoint retornará multi-status com status code 207.
Exemplo de retorno:
{
"mensagem": "Informações parcialmente deletadas, outras não foram encontradas para deleção",
"detalhes": [
{
"id": "7655510",
"erro": "Não encontrado para deleção"
}
]
}
Respostas para erros
400 Bad Request - Identificador (ID) inválido
{
"mensagem": "Informações não encontradas para deleção"
}