v1

latestOpenAPI 3.1.12026-07-2371254470.9 KB
Consulta de contrato abrangente de estabelecimentos comerciais

Pesquisar se um estabelecimento comercial possui contrato abrangente

post/estabelecimento/contratos_abrangentes

Request body

documentoUsuarioFinalRecebedorstring required

Número do documento CNPJ ou CPF do usuário final recebedor. 14 dígitos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.

listaCodigoArranjoPagamentostring[] required

Código constante da tabela vigente neste manual.

  • 99T = Usar esta opção para indicar todos os arranjos.

Response

Resposta da consulta de contratos abrangentes.

documentoUsuarioFinalRecebedorstring required

Número do documento CNPJ ou CPF do usuário final recebedor. 14 dígitos para CNPJ e 11 dígitos para CPF e completar com 0 à esquerda, se necessário.

contratoAbrangeTodosArranjosboolean required

devolve true se a busca encontrar algum contrato abrangente que abranja todos os arranjos de pagamento.

listaCodigoArranjoPagamentostring[] required

Retorna uma lista de arranjos de pagamento de acordo com o filtro fornecido na request. Código constante da tabela vigente neste manual.

  • 99T = Usar esta opção para indicar todos os arranjos.