Este método é responsável pela criação de tributação de PisCofins. ao realizarmos uma requisição na API de PisCofins, será enviado um novo PisCofinspara o PDV.

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

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

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

Requisição

Exemplo de body da requisição

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

Definições dos campos do body

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árioSim
loteOrigemstringIdentificador do lote para envio dos dadosSim

Retorno

Exemplo de body de retorno

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

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

Exemplo de body de retorno

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

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

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

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
    }
]

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. Sim
cstCofinsstringCó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 Sim
situacaointSituação do PisCofins Sim0 - Inativo, 1 - Ativo
idInquilinostringIdentificador do inquilinoSim
idRetaguardastringIdentificador do PisCofins na retaguardaSimTamanho máximo: 100 caracteres
idProprietariostringIdentificador do proprietárioSim
loteOrigemstringIdentificador do lote para envio dos dadosSim


Retornos

Exemplo de body de retorno

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

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

Exemplo de body de retorno

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

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

O Dado dinâmico é uma nova forma para envio de dados entre PDV e Retaguarda.

Para o envio de condição de pagamento pelo Dado dinâmico,  realizar um requisição o seguinte endpoint

  • Endpoint: /api/retaguarda/v3/dadosdinamicos/down/{TipoDado}/{VersãoDado}
  • Método: Post
  • Autenticação: Bearer token
  • Permissão: Retaguarda

Versão dado

Versão requisiçãoVersão dado
V3.11
V3.22

A propriedade {Versão Dado}, enviado na URL da requisição, deve ser substituído pela versão do dado que será enviado.

O body da requisição é o mesmo enviado no endpoint padrão. Consulte as outras abas dessa seção para ver o que deve ser enviado na requisição de acordo com a versão dado enviado na URL.