Exportação de limite de crédito (v.1)

A consulta disponibiliza os dados dos limites de crédito dos correntistas. Dessa forma, é possível selecionar e filtrar os campos desejados, aplicando as regras e validações necessárias para que os dados sejam inseridos com sucesso na base do sistema terceiro.

Filtros

Nenhum filtro é obrigatório para se obter os resultados. No entanto, recomenda-se a utilização de alguns dos filtros listados abaixo, para otimizar a consulta.

Existe ainda a possibilidade de retornar os dados de atribuições vinculadas, aos correntistas do grupo de crédito, como propostas, pedido, titulos, cheques, adiantamentos etc... Para isso, estão disponíveis os filtros de lista, que pode ser utilizado com os valores "S" (Sim) ou "N" (Não). Por padrão, o valor considerado é "N", ou seja, as atribuições não serão incluídas na resposta, a menos que indicado o contrário.

Alguns campos podem ser utilizados como filtros para tornar a sua consulta mais específica. A seguir, estão listadas as opções disponíveis para filtragem:

grupo

aplicacao ([A]mbos, [V]enda, [F]at/financeiro)

periodo_inicio

periodo_fim

correntista

situacao_periodo ([A]tivo, [I]nativo, [E]xpirado)

lista_propostas ([S]im, [N]ão)

lista_pedidos ([S]im, [N]ão)

lista_titulos ([S]im, [N]ão)

lista_cheques ([S]im, [N]ão)

lista_adiantamentos ([S]im, [N]ão)

lista_nccs ([S]im, [N]ão)

Retorno

Caso houver erro, será retornar uma TAG única "erro", informando os detalhes do erro.

Fonte dos dados

PCAD096 - Informações de crédito por grupo de correntistas

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Exemplo

{
	"tipoComando": "ASDCOMANDOJSONTMP",
	"grupoComando": "EXP_LIMITE_CREDITO_V1"
}

Respostas

🟢200Sucesso

application/json

Bodyapplication/json

Exemplo

[
	{
		"grupo": "<integer>",
		"aplicacao_grupo": "<string>",
		"descricao": "<string>",
		"fechado": "<string>",
		"considerar_pedido": "<string>",
		"considerar_proposta": "<string>",
		"grupo_empresa": "<integer>",
		"descricao_grupo_empresa": "<string>",
		"periodos": [
			{
				"sequencial": "<integer>",
				"data_inicial": "<string>",
				"data_final": "<string>",
				"credito": "<integer>",
				"observacao": "<string>",
				"situacao": "<string>"
			}
		],
		"correntistas": [
			{
				"codigo_cliente": "<integer>",
				"cnpj_cpf_alfanumerico": "<string>",
				"nome_cliente": "<string>",
				"codigo_cidade": "<integer>",
				"nome_cidade": "<string>",
				"uf": "<string>",
				"conceito": "<integer>",
				"desc_conceito": "<string>",
				"valor_utilizado": "<integer>",
				"propostas": [
					{
						"base": "<string>",
						"empresa": "<integer>",
						"proposta": "<integer>",
						"seq_item": "<integer>",
						"codigo_item": "<string>",
						"desc_item": "<string>",
						"seq_entrega": "<integer>",
						"previsao_entrega": "<string>",
						"valor": "<integer>"
					}
				],
				"pedidos": [
					{
						"base": "<string>",
						"empresa": "<integer>",
						"pedido": "<integer>",
						"seq_item": "<integer>",
						"codigo_item": "<string>",
						"desc_item": "<string>",
						"seq_entrega": "<integer>",
						"previsao_entrega": "<string>",
						"valor": "<integer>"
					}
				],
				"titulos": [
					{
						"base": "<string>",
						"empresa": "<integer>",
						"documento": "<string>",
						"diferencial": "<string>",
						"serie": "<string>",
						"vencimento": "<string>",
						"valor": "<integer>"
					}
				],
				"cheques": [
					{
						"base": "<string>",
						"empresa": "<integer>",
						"documento": "<integer>",
						"vencimento": "<string>",
						"valor": "<integer>"
					}
				],
				"adiantamentos": [
					{
						"base": "<string>",
						"empresa": "<integer>",
						"documento": "<integer>",
						"vencimento": "<string>",
						"valor": "<integer>"
					}
				],
				"nccs": [
					{
						"base": "<string>",
						"empresa": "<integer>",
						"documento": "<string>",
						"diferencial": "<string>",
						"serie": "<string>",
						"vencimento": "<string>",
						"valor": "<integer>"
					}
				]
			}
		]
	}
]

Filtros#

Fonte dos dados#

Requisição

Respostas

Filtros

Fonte dos dados