Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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

Aviso

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

titleexpandtitleDefinição de requisição
Deck of Cards
idversções
Card
labelV3.1 (V2)

Requisição

Section
Column
width50%
Expandir

Exemplo de body da requisição

[
    {
        "aliquotaTributo": "string",
        "idInquilino": "string",
        "

tipo

idProprietario": "string",
        "

modalidade

idRetaguarda": "string",
        "indiceTributoImpressora": "string",
        "loteOrigem": "string",
        "modalidade": "string",
        "reducaoBaseCalculo": "string",
        "simbolo": "string",
        "situacao": 0,
        "tipo": "string",
        "cfop": "string",
        "cstcsosn": "string" }
]

Column
width50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observação

AliquotaTributostringAliquota do impostoSim
idInquilinostringIdentificador do inquilinoSim
idProprietariostringIdentificador do proprietárioSim
idRetaguardastringIdentificador do imposto na retaguardaSimTamanho máximo: 100 caracteres
indiceTributoImpressorastringÍndice do tributo utilizado na impressoraNãoTamanho máximo: 2 caracteres
loteOrigemstringIdentificador do lote para envio dos dadosSim
modalidadestringDescrição da modalidade

Sim

Tamanho máximo: 20 caracteres
reducaoBaseCalculostringValor de redução da base de cálculoNão
simbolostringSímbolo do imposto

Sim

Tamaho máximo: 20 caracteres
situacaointSituação do impostoSim0 - inativo, 1 - ativo
tipostringTipo do imposto Sim
ImpostoValor
ICMS0
ISS1
cfopstringCódigo Fiscal de Operações e PrestaçõesNão

Tamaho máximo: 4 caracteres

cstcsosnstringCódigo de Situação da Operação no Simples NacionalNão

Tamaho máximo: 3 caracteres

Retorno

Deck of Cards
idretornos
Card
label200 - Ok
Column
width50%

Exemplo de body de retorno

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

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

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

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro
Card
labelV3.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
width50%

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",

         "

idProprietario

cfop": "string",
        "

loteOrigem

cstcsosn": "string" 
    }
]

Column
width
50%

Definições dos campos

do body

Campo

Tipo

Descrição

Obrigatório

Observações

aliquotaTributo
string
numéricoAliquota do atributoSim
cfopstringCódigo Fiscal de Operações e de PrestaçõesNãoTamanho máximo: 4 caracteres
cstCsosnstring Código de Operação do Simples NacionalNãoTamanho máximo: 3 caracteres
tipostringTipo do impostoSim
ImpostoValor
ICMS0
ISS1
modalidadestringDescrição do imposto cadastrada no sistema de retaguarda/ERP

Não

Tamanho máximo: 20 caracteres

indiceTributoImpressorastringDEFASADONão
reducaoBaseCalculo
numéricoValor de redução da base de cálculoNão
string
Expandir
title200 - Ok

situacaointSituação do imposto Sim0 - inativo, 1 - ativo
simbolostringSímbolo do imposto

Sim

Tamaha máximo: 20 caracteres

idInquilinostringIdentificador do inquilinoSim
idRetaguardastringIdentificador do imposto na retaguardaSim
idProprietariostringIdentificador do proprietárioSim
loteOrigemstring
Expandir
titleDefinição dos campos de retorno
expandtitle
Identificador do lote para envio dos dadosSim





Retornos

Deck of Cards
idretornos
Card
label200 - Ok
Column
width50%

Exemplo de body de retorno

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

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

SuccessboolIndica se a criação do compartilhamento foi feita com sucesso
MessagestringCaso ocorra erros durante a criação do compartilhamento eles serão enviados nesse campo
DataobjetoObjeto compartilhamento criado
ErrorsListaListas com os erros encontrados no processo
TotalTimeinttempo da requisição
NumberOfRecordsintnúmero de dados inseridos
Card
label400 - Bad Request
Column
width50%

Exemplo de body de retorno

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

Column
width50%

Definições dos campos do retorno

Campo

Tipo

Descrição

codestringCódigo de erro
messagestringMensagem do erro
detailedMessagestringDetalhamento do erro
helpUrlstringurl de ajuda
TotalTimestringTempo total de busca
detailslista de objetoLista de objeto de erros
details.guidstringIdentificador do erro
details.codestringCódigo do erro
details.messagestringMensagem do erro 
details.detailedMessagestringDetalhamento do erro