TOTVS Varejo PDV Omni

Árvore de páginas

Versões comparadas

Versão antiga 7

changes.mady.by.user William da Silva Sombra

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user William da Silva Sombra

Gravado em

Chave

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

Definições dos campos do body

Retorno

Deck of Cards
idv1
Card
labelDescrição dos campos e regras

O PIS e COFINS poderá ter a seguintes informações:


Informação

Coluna

Obrigatório

Tipo

Tamanho

Descrição

CST do PIScst_pisNãoTexto3

Código de Situação Tributária para o Programa de Integração Social (PIS).

Para emissão da XML, essa TAG corresponderá a TAG CST dentro do grupo de PIS que faz parte do grupo de IMPOSTO.

Alíquota do PISaliquota_pisSimNumérico

Alíquota para o cálculo do valor PIS.

Para emissão da XML, essa TAG corresponderá a TAG pPIS dentro do grupo de PIS que faz parte do grupo de IMPOSTO.

CST do COFINScst_cofinsNãoTexto3

Código de Situação Tributária para a Contribuição para o Financiamento da Seguridade Social (COFINS).

Para emissão da XML, essa TAG corresponderá a TAG CST dentro do grupo de COFINS que faz parte do grupo de IMPOSTO.

Alíquota do COFINSaliquota_cofinsSimNumérico

Alíquota para o cálculo do valor COFINS

Para emissão da XML, essa TAG corresponderá a TAG pCOFINS dentro do grupo de COFINS que faz parte do grupo de IMPOSTO.

SituaçãosituacaoNãoInteiro

Define se o pis e cofins em questão está ativo ou inativo.

  • 0 - Inativo
  • 1 - Ativo
Identificação no retaguardaid_retaguardaNãoTexto100
Data de cadastrodata_cadastroSimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi cadastrado localmente
Data de atualizaçãodata_atualizacaoSimData
Exemplo "2024-03-20 20:56:43.15725". Corresponde a data em que o dado foi atualizado localmente.
Informações
titleDedução de ICMS

Para a emissão da XML, caso seja fiscalmente necessário realizar a dedução do ICMS tributado da base de cálculo do PIS e COFINS é necessário habilitar o parâmetro chave 9290 - "Deduzir o ICMS tributado do cálculo do Pis e Cofins"

Requisição

Card
labelComo integrar

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

  • Endpoint: /api/retaguarda/v2/PisCofins
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda

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

Aviso

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

Deck of Cards
idversções
Card
labelV3.1 (V2)
Section
Column
width50%

Exemplo de body da requisição

[
    {
        "aliquotaCofins": "string",
        "aliquotaPis": "string",
        "cstCofins": "string",
        "cstPis": "string",
        "idInquilino": "string",
        "idProprietario": "string",
        "idRetaguarda": "string",
        "loteOrigem": "string",
        "situacao": 0
    }
]

Column
width50%

Campo

Tipo

Descrição

Obrigatório

Observações

cstPis

string

CST do Pis

Não

Tamanho máximo: 3 caracteres

aliquotaPisstringAliquota do PisNão
cstCofinsstringCST Cofins

Não

Tamanho máximo: 3 caracteres

aliquotaCofinsstringAliquota CofinsNão
situacaointSituação do PisCofinsSim0 - Inativo, 1 - Ativo
idInquilinostringIdentificador do inquilinoSim
idRetaguardastringIdentificador do PisCofins na retaguardaSimTamanho máximo: 100 caracteres
idProprietariostringIdentificador do proprietárioSimloteOrigemstringIdentificador do lote para envio dos dadosSim
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 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
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 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
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

[
    {
        "aliquotaCofins": 0.0,
        "aliquotaPis": 0.0,
        "cstCofins": "string",
        "cstPis": "string",
        "idInquilino": "string",
        "idProprietario": "string",
        "idRetaguarda": "string",
        "loteOrigem": "string",
        "situacao": 0
    }
]

Column
width50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

cstPisstringCódigo de Situação Tributária para o Programa de Integração Social (PIS).

Não

Tamanho máximo: 3 caracteres

aliquotaPisnuméricoAlíquota para o cálculo do valor PIS. SimcstCofinsstringCódigo de Situação Tributária para a Contribuição para o Financiamento da Seguridade Social (COFINS).

Não

Tamanho máximo: 3 caracteres

aliquotaCofinsnuméricoAlíquota para o cálculo do valor COFINS SimsituacaointSituação do PisCofins Sim0 - Inativo, 1 - AtivoidInquilinostringIdentificador do inquilinoSimidRetaguardastringIdentificador do PisCofins na retaguardaSimTamanho máximo: 100 caracteresidProprietariostringIdentificador do proprietárioSimloteOrigemstringIdentificador 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 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
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 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

Para maiores informações de como integrar PIS e COFINS, clique aqui.