...

Aviso
Para que a baixa do Dado complementar criado ocorra no PDV Omni é necessário realizar a abertura de um lote do tipo 16 = DadoComplementarPagto

titleexpandtitleDefinição de requisição

Deck of Cards

id	versções

Card

label	V3.1 (V2)

Requisição

Section

Column

width	50%

Expandir

Exemplo de body da requisição

[
{
"descricao": "string",

"tipoDadoComplementar

"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"obrigatorio": 0,
"

obrigatorio

situacao": 0,
"tamanho": 0,
"tipoDadoComplementar": 0
}
]

Column

width	50%

Definições dos campos do body

Campo

Tipo

Descrição

Obrigatório

Observações

descricao

String

Descrição do dado complementar

Sim

Tamanho máximo: 30 caracteres

idInquilino

String

Identificador do inquilino

Sim

idProprietario

String

Identificador do proprietário

Sim

idRetaguarda

String

Identificador do dado complementar na retaguarda

Sim

Tamanho máximo: 100 caracteres

loteOrigem

String

Identificador do lote em que os dados serão enviados

Sim

obrigatorio

Int

Indica se o dado é obrigatório

Sim

0 - Opcional, 1 - Obrigatório

situacao

Int

Situação do dado complementar

Sim

0 - Inativo, 1 - Ativo

tamanho

Int

Tamanho do dado complementar

Não

tipoDadoComplementar

Int

Tipo do dado complementar

Sim

Código	Tipo
0	Alfanumerico
1	Numerico
2	Data
3	ListaSelecao

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%

Exemplo de body da requisição

[
{
"descricao": "string",
"idInquilino": "string",
"

idRetaguarda

idProprietario": "string",
"

idProprietario

idRetaguarda": "string",
"loteOrigem": "string",
"obrigatorio": 0,
"situacao": 0,
"tamanho": 0,
"tipoDadoComplementar": 0
}
]

Código

Tipo

0

Alfanumerico

1

Numerico

2

Data

3

ListaSelecao

Expandir

title	Definição dos campos de retorno

Column

width

50%

Definições dos campos

do body

Campo	Tipo	Descrição	Obrigatório	Observações
descricao	String	Descrição do dado complementar

Obrigatório

Não	Tamanho máximo: 30 caracteres
tipoDadoComplementar	Int	Tipo do dado

complementar (Descritivo abaixo)

complementar

Não

Código	Tipo
0	Alfanumerico
1	Numerico
2	Data
3	ListaSelecao

Obrigatório

obrigatorio

Int

Indica se o dado é obrigatório

(

Sim

0 - Opcional, 1 -

Obrigatório)

Obrigatório
tamanho	Int	Tamanho do dado complementar

Opcional

Não
situacao	Int	Situação do dado

complementar (

complementar

Sim

0 - Inativo, 1 - Ativo

)

Obrigatório

idInquilino

String

Identificador do inquilino

Obrigatório

Sim
idRetaguarda	String	Identificador do dado complementar na retaguarda

Obrigatório

Sim
idProprietario	String	Identificador do proprietário

Obrigatório

Expandir

title	200 - Ok

Sim
loteOrigem	String	Identificador do lote em que os dados serão enviados

Obrigatório para a integração Expandir

title	TipoDadoComplementar

expandtitle

Sim

Retornos

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

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão Atual

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 4

Nova versão Atual

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