Definições dos campos do body

Retorno

Deck of Cards

id	a

Card

label	Descrição dos campos e regras

Informação	Coluna	Obrigatório	Tipo	Tamanho	Descrição
Alíquota ICMS	aliquota_produto	Não	Numérico		Alíquota de ICMS cadastrada. Para emissão da XML da venda, esse campo é utilizado para o o preenchimento da TAG pICMS e para o cálculo da TAG vICMS.
Tipo imposto	tipo	Sim	Texto	20	Define o imposto é ICMS ou ISS. 0 - Imposto de ICMS 1 - Imposto de ISS
Descrição do imposto	modalidade	Não	Texto	20	Descrição do imposto cadastrada no sistema de retaguarda/ERP
Índice tributo	indice_tributo_impressora	Não	Texto	2	Defasado
Alíquota de redução	reducao_base_calculo	Não	Numérico		Alíquota de redução de base de cálculo cadastrada. Para emissão da XML da venda, esse campo é utilizado para o o preenchimento da TAG pRedBC e para o cálculo da TAG vBC do imposto.
Situação	situacao	Sim	Inteiro		Define se o imposto em questão está ativo ou inativo. 0 - Inativo 1 - Ativo
Data de cadastro	data_cadastro	Sim	Data		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente.
Data de atualização	data_atualizacao	Sim	Data		Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
Código do imposto cadastrado	simbolo	Não	Texto	20	Código de imposto cadastrado e identificado pelo PDV. Quando o símbolo for cadastrado com determinado valor, o PDV irá tratar o item de acordo com o símbolo. FF - Item de substituição II - Item isento NN - Item não incide S - Serviço Demais valores (TT, 12, 17, 18, 25, T0, T1, ETC ) - Item tributado Essa informação impacta diretamente no CST de ICMS do item e também ao CFOP do item na venda. Mais informações descritas no quadro de informações abaixo.
Identificação no retaguarda	id_retaguarda	Não	Texto	100
CFOP	cfop	Não	Texto	4	Código Fiscal de Operações e de Prestações (CFOP) é um código do sistema tributarista brasileiro, determinado pelo governo. É indicado nas emissões de notas fiscais, declarações, guias e escrituração de livros. É utilizado em uma operação fiscal e define se a nota emitida recolhe ou não impostos, movimento de estoque e financeiro. (Exemplos abaixo).
CST/CSOSN	cst_csosn	Não	Texto	3	A sigla CST significa Código de Situação Tributária, o classificador que determina a incidência do Imposto sobre Circulação de Mercadorias e Serviços (ICMS). Baseando-se em informações como a procedência da mercadoria e o modelo de tributação adotado pela empresa. A sigla CSOSN significa Código de Operação do Simples Nacional e trata-se de uma lista enumerada de operações de uma empresa que estabelece critérios tributários para cada situação que não há alguma classificação enquadrada no regime do Simples Nacional. (Exemplos abaixo).

Informações

title	CST e CFOP

Quando os campos de CFOP e/ou CST/CSOSN não estiverem preenchidos, o PDV seguirá o padrão conforme o quadro abaixo:

Caso o regime da loja seja REGIME NORMAL a regra será

Símbolo	Modelo Fiscal	CST	CFOP
S	SAT/NFCe	-	5933
FF	SAT/NFCe	60	5405
II	SAT/NFCe	40	5102
NN	SAT/NFCe	41	5102
TT (Com redução)	SAT/NFCe	20	5102
TT (Sem redução)	SAT/NFCe	00	5102

Caso o regime da loja seja SIMPLES NACIONAL a regra será

Símbolo	Modelo Fiscal	CSOSN	CFOP
S	SAT/NFCe	-	5933
FF	SAT/NFCe	500	5405
II	SAT	102	5102
II	NFCe	400	5102
NN	SAT/NFCe	300	5102
TT	SAT/NFCe	102	5102

Requisição

Card

label	Microserviço	Como integrar

Para maiores informações de como integrar o Imposto, clique aqui.

POST api/retaguarda/v2/Impostos

Este método é responsável pela criação de novos Impostos

Endpoints:
- /api/retaguarda/v2/Impostos
- /api/retaguarda/v3/Impostos
Método: Post
Autenticação: Bearer token
Permissão: Retaguarda

Este endpoint recebe uma lista de Impostos para que possam ser enviados vários na mesma requisição

Aviso
Para que a baixa do Imposto criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 7 = Impostos

Deck of Cards

id	b

Card

label	V3.1 (V2)

Section

Column

width	50%

Exemplo de body da requisição

[
{
"aliquotaTributo": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"indiceTributoImpressora": "string",
"loteOrigem": "string",
"modalidade": "string",
"reducaoBaseCalculo": "string",
"simbolo": "string",
"situacao": 0,
"tipo": "string",
"cfop": "string",
"cstcsosn": "string" }
]

Column

width	50%

Campo

Tipo

Descrição

Obrigatório

Observação

AliquotaTributo

string

Aliquota do imposto

Sim

idInquilino

string

Identificador do inquilino

Sim

idProprietario

string

Identificador do proprietário

Sim

idRetaguarda

string

Identificador do imposto na retaguarda

Sim

Tamanho máximo: 100 caracteres

indiceTributoImpressora

string

Índice do tributo utilizado na impressora

Não

Tamanho máximo: 2 caracteres

loteOrigem

string

Identificador do lote para envio dos dados

Sim

modalidade

string

Descrição do imposto cadastrada no sistema de retaguarda/ERP

Sim

Tamanho máximo: 20 caracteres

reducaoBaseCalculo

string

Alíquota de redução de base de cálculo cadastrada.

Não

simbolo

string

Código de imposto cadastrado e identificado pelo PDV.

Sim

Tamaho máximo: 20 caracteres
Quando o símbolo for cadastrado com determinado valor, o PDV irá tratar o item de acordo com o símbolo.
- FF - Item de substituição
- II - Item isento
- NN - Item não incide
- S - Serviço
- Demais valores (TT, 12, 17, 18, 25, T0, T1, ETC ) - Item tributado
Essa informação impacta diretamente no CST de ICMS do item e também ao CFOP do item na venda.
Mais informações descritas no quadro de informações abaixo.

situacao

int

Situação do imposto

Sim

0 - inativo, 1 - ativo

tipo

string

Tipo do imposto

Sim

Imposto

Valor

ICMS

0

ISS

1

cfop

string

Código Fiscal de Operações e Prestações

Não

Tamaho máximo: 4 caracteres

cstcsosn

string

Código de Situação da Operação no Simples Nacional

Não

Tamaho máximo: 3 caracteres

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

{
"success": true,
"message": "string",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Column

width	50%

Definições dos campos do retorno

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucessoMessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campoDataobjetoObjeto compartilhamento criadoErrorsListaListas com os erros encontrados no processoTotalTimeinttempo da requisiçãoNumberOfRecordsintnúmero de dados inseridos Card

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}

Column

width	50%

Definições dos campos do retorno

Campo

Tipo

Descrição

codestringCódigo de erromessagestringMensagem do errodetailedMessagestringDetalhamento do errohelpUrlstringurl de ajudaTotalTimestringTempo total de buscadetailslista de objetoLista de objeto de errosdetails.guidstringIdentificador do errodetails.codestringCódigo do errodetails.messagestringMensagem do erro details.detailedMessagestringDetalhamento do erro Card

label	V3.2

Informações
Este endpoint ainda está em processo de manutenção, as informações estão disponibilizadas apenas para consulta, não sendo possível realizar a requisição.

Requisição

Section

Column

width	50%

Exemplo de body da requisição

[
{
"aliquotaTributo": "string",
"cfop": "string",
"cstcsosn": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"modalidade": "string",
"reducaoBaseCalculo": "string",
"simbolo": "string",
"situacao": 0,
"tipo": "string",

"cfop": "string",
"cstcsosn": "string"
}
]

Column

width	50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

aliquotaTributonuméricoAliquota do atributoSimcfopstringCódigo Fiscal de Operações e de PrestaçõesNãoTamanho máximo: 4 caracterescstCsosnstring Código de Operação do Simples NacionalNãoTamanho máximo: 3 caracterestipostringTipo do impostoSimImpostoValorICMS0ISS1modalidadestringDescrição do imposto cadastrada no sistema de retaguarda/ERP

Não

Tamanho máximo: 20 caracteres

indiceTributoImpressorastringDEFASADONãoreducaoBaseCalculonumérico

Alíquota de redução de base de cálculo cadastrada.

NãosituacaointSituação do imposto Sim0 - inativo, 1 - ativosimbolostring

Código de imposto cadastrado e identificado pelo PDV.

Não

Tamaha máximo: 20 caracteres
Código de imposto cadastrado e identificado pelo PDV.
Quando o símbolo for cadastrado com determinado valor, o PDV irá tratar o item de acordo com o símbolo.
- FF - Item de substituição
- II - Item isento
- NN - Item não incide
- S - Serviço
- Demais valores (TT, 12, 17, 18, 25, T0, T1, ETC ) - Item tributado
Essa informação impacta diretamente no CST de ICMS do item e também ao CFOP do item na venda.
Mais informações descritas no quadro de informações abaixo.

idInquilinostringIdentificador do inquilinoSimidRetaguardastringIdentificador do imposto na retaguardaSimidProprietariostringIdentificador do proprietárioSimloteOrigemstringIdentificador do lote para envio dos dadosSim

Retornos

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
}

Column

width	50%

Definições dos campos do retorno

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucessoMessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campoDataobjetoObjeto compartilhamento criadoErrorsListaListas com os erros encontrados no processoTotalTimeinttempo da requisiçãoNumberOfRecordsintnúmero de dados inseridos Card

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
}

Column

width	50%

Definições dos campos do retorno

Campo

Tipo

Descrição

codestringCódigo de erromessagestringMensagem do errodetailedMessagestringDetalhamento do errohelpUrlstringurl de ajudaTotalTimestringTempo total de buscadetailslista de objetoLista de objeto de errosdetails.guidstringIdentificador do errodetails.codestringCódigo do errodetails.messagestringMensagem do erro details.detailedMessagestringDetalhamento do erro

Árvore de páginas

Versões comparadas

Versão antiga 13

Nova versão Atual

Chave

Definições dos campos do body

Retorno

Requisição

Exemplo de body da requisição

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 13

Nova versão Atual

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retorno

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno