POST api/retaguarda/v2/DadoComplementarPagtos

Este método é responsável pela criação de novos Dados complementares de pagamento

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

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

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

Exemplo de body da requisição

[
{
"descricao": "string",
"idInquilino": "string",
"idProprietario": "string",
"idRetaguarda": "string",
"loteOrigem": "string",
"obrigatorio": 0,
"situacao": 0,
"tamanho": 0,
"tipoDadoComplementar": 0
}
]

Definição dos campos de requisição

Campo

Tipo

Descrição

Observações

Obrigatório

descricao

String

Descrição do dado complementar

Tamanho máximo: 30 caracteres

Não

tipoDadoComplementar

Int

Tipo do dado complementar

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

Não

obrigatorio

Int

Indica se o dado é obrigatório

0 - Opcional, 1 - Obrigatório

Sim

tamanho

Int

Tamanho do dado complementar

Não

situacao

Int

Situação do dado complementar

0 - Inativo, 1 - Ativo

Sim

idInquilino

String

Identificador do inquilino

Sim

idRetaguarda

String

Identificador do dado complementar na retaguarda

Sim

idProprietario

String

Identificador do proprietário

Sim

loteOrigem

String

Identificador do lote em que os dados serão enviados

Sim

Definição dos campos de retorno

200 - Ok

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

400 - Bad Request

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

POST api/retaguarda/v2/DadoComplementarPagtos