- 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çãoExemplo 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 bodyCampo | Tipo | Descrição | Obrigatório | Observações |
---|
cstPis | string | CST do Pis | Não | Tamanho máximo: 3 caracteres | aliquotaPis | string | Aliquota do Pis | Não |
| cstCofins | string | CST Cofins | Não | Tamanho máximo: 3 caracteres | aliquotaCofins | string | Aliquota Cofins | Não |
| situacao | int | Situação do PisCofins | Sim | 0 - Inativo, 1 - Ativo | idInquilino | string | Identificador do inquilino | Sim |
| idRetaguarda | string | Identificador do PisCofins na retaguarda | Sim | Tamanho máximo: 100 caracteres | idProprietario | string | Identificador do proprietário | Sim |
| loteOrigem | string | Identificador do lote para envio dos dados | Sim |
|
|
|
RetornoExemplo 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 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 |
|
|
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 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 |
|
|
|
|
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çãoExemplo 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 bodyCampo | Tipo | Descrição | Obrigatório | Observações |
---|
cstPis | string | Código de Situação Tributária para o Programa de Integração Social (PIS). | Não | Tamanho máximo: 3 caracteres | aliquotaPis | numérico | Alíquota para o cálculo do valor PIS. | Sim |
| cstCofins | string | Código de Situação Tributária para a Contribuição para o Financiamento da Seguridade Social (COFINS). | Não | Tamanho máximo: 3 caracteres | aliquotaCofins | numérico | Alíquota para o cálculo do valor COFINS | Sim |
| situacao | int | Situação do PisCofins | Sim | 0 - Inativo, 1 - Ativo | idInquilino | string | Identificador do inquilino | Sim |
| idRetaguarda | string | Identificador do PisCofins na retaguarda | Sim | Tamanho máximo: 100 caracteres | idProprietario | string | Identificador do proprietário | Sim |
| loteOrigem | string | Identificador do lote para envio dos dados | Sim |
|
|
|
RetornosExemplo 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 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 |
|
|
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 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 |
|
|
|
|
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 dadoVersão requisição | Versão dado |
---|
V3.1 | 1 | V3.2 | 2 |
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. |
|
|
|