...

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

titleexpandtitleDefinição de requisição

Deck of Cards

id	versções

Card

label	V3.1 (V2)

Requisição

Section

Column

width	50%

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

width	50%

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

Retorno

Deck of Cards

id	retornos

Card

label	200 - Ok

Column

width	50%

Exemplo de body de retorno

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

Column

width	50%

Definições dos campos do retorno

Campo	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

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

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

Column

width	50%

Definições dos campos do retorno

Campo	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

label	V3.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

width	50%

Expandir

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

width

50%

Definições dos campos

do body

Campo	Tipo	Descrição	Obrigatório	Observações

Obrigatório


cstPis	string	Código de Situação Tributária para o Programa de Integração Social (PIS).	Não	Tamanho máximo: 3 caracteres

Não


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

Não


aliquotaCofins	numérico	Alíquota para o cálculo do valor COFINS	Sim
situacao	int	Situação do PisCofins	Sim	0 - Inativo, 1 - Ativo

Sim

idInquilino	string	Identificador do inquilino	Sim
idRetaguarda	string	Identificador do PisCofins na retaguarda	Sim	Tamanho máximo: 100 caracteres

Sim


idProprietario	string	Identificador do proprietário	Sim
loteOrigem	string	Identificador do lote para envio dos dados	Sim

expand

Retornos

Deck of Cards

title	Definição dos campos de retorno

titleexpandtitle

id	retornos

Card

label

Expandir

	200 - Ok

Column

width	50%

Exemplo de body de retorno

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

Column

width	50%

Definições dos campos do retorno

Campo	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

label	400 - Bad Request

Column

width	50%

Exemplo de body de retorno

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

Column

width	50%

Definições dos campos do retorno

Campo	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

Árvore de páginas

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retorno

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos

do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 3

Nova versão 4

Chave

Requisição

Exemplo de body da requisição

Definições dos campos do body

Retorno

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno

Requisição

Exemplo de body da requisição

Definições dos campos

do body

Retornos

Exemplo de body de retorno

Definições dos campos do retorno

Exemplo de body de retorno

Definições dos campos do retorno