| Card |
|---|
| Requisição| Section |
|---|
| Column |
|---|
| 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 |
|---|
| Definições dos campos do bodyCampo | 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 da modalidadedo imposto cadastrada no sistema de retaguarda/ERP | Sim | Tamanho máximo: 20 caracteres | | reducaoBaseCalculo | string | Valor Alíquota de redução da de base de cálculo cadastrada. | Não |
| | simbolo | stringSímbolo | do imposto Código de imposto cadastrado e identificado pelo PDV. | Sim | Tamaha - 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 | | | 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 |
|
|
Retorno| Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "string",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| code | string | Código de erro | | message | string | Mensagem do erro | | detailedMessage | string | Detalhamento do erro | | helpUrl | string | url de ajuda | | TotalTime | string | Tempo total de busca | | details | lista de objeto | Lista de objeto de erros | | details.guid | string | Identificador do erro | | details.code | string | Código do erro | | details.message | string | Mensagem do erro | | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
| Card |
|---|
| | 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 |
|---|
| 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 |
|---|
| Definições dos campos do bodyCampo | Tipo | Descrição | Obrigatório | Observações |
|---|
| aliquotaTributo | numérico | Aliquota do atributo | Sim |
| | cfop | string | Código Fiscal de Operações e de Prestações | Não | Tamanho máximo: 4 caracteres | | cstCsosn | string | Código de Operação do Simples Nacional | Não | Tamanho máximo: 3 caracteres | | tipo | string | Tipo do imposto | Sim | | | modalidade | string | Descrição do imposto cadastrada no sistema de retaguarda/ERP | Não | Tamanho máximo: 20 caracteres | | indiceTributoImpressora | string | DEFASADO | Não |
| | reducaoBaseCalculo | numérico | Valor Alíquota de redução da de base de cálculo cadastrada. | Não |
| | situacao | int | Situação do imposto | Sim | 0 - inativo, 1 - ativo | | simbolo | string | Símbolo do imposto | Código de imposto cadastrado e identificado pelo PDV. | NãoSim | - 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.
| | idInquilino | string | Identificador do inquilino | Sim |
| | idRetaguarda | string | Identificador do imposto na retaguarda | Sim |
| | idProprietario | string | Identificador do proprietário | Sim |
| | loteOrigem | string | Identificador do lote para envio dos dados | Sim |
|
|
|
|
|
|
|
|
Retornos| Deck of Cards |
|---|
| | Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"success": true,
"message": "Requisição inserida com sucesso!",
"data": null,
"errors": null,
"totalTime": 0,
"numberOfRecords": 0
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| Success | bool | Indica se a criação do compartilhamento foi feita com sucesso | | Message | string | Caso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo | | Data | objeto | Objeto compartilhamento criado | | Errors | Lista | Listas com os erros encontrados no processo | | TotalTime | int | tempo da requisição | | NumberOfRecords | int | número de dados inseridos |
|
|
| Card |
|---|
| | Column |
|---|
| Exemplo de body de retorno{
"code": "string",
"message": "string",
"detailedMessage": "string",
"helpUrl": "string",
"details": [
{
"guid": "string",
"code": "string",
"message": "string",
"detailedMessage": "string"
}
]
} |
| Column |
|---|
| Definições dos campos do retornoCampo | Tipo | Descrição |
|---|
| code | string | Código de erro | | message | string | Mensagem do erro | | detailedMessage | string | Detalhamento do erro | | helpUrl | string | url de ajuda | | TotalTime | string | Tempo total de busca | | details | lista de objeto | Lista de objeto de erros | | details.guid | string | Identificador do erro | | details.code | string | Código do erro | | details.message | string | Mensagem do erro | | details.detailedMessage | string | Detalhamento do erro |
|
|
|
|
|
