Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API

Dados do Documento
Nome	API Fachada Condição de Pagamento
Descrição
Nome Físico	fchcrm/fchcrm1041api.p
Include com Parâmetros	fchcrm/fchcrm1041.i
Release Inicial	12.1.8
Versão de Integração	N/A
Data Liberação	N/A
Banco	Mdtcrm
Tabela	crm_erp_cond_pagto
Aplicativo	Portal CRM

Objetivo

Realizar a manutenção de condição de pagamento.

Nos atributos das tabelas temporárias de entrada e saída:

ttCondicaoPagamento
Atributo	Tipo	Formato	Descrição	Obrigatório
num_id	integer		Cod. identificador	Sim
cod_cond_pagto_erp	character		Código condição pagamento ERP	Sim
nom_cond_pagto	character		Nome condição pagamento	Sim
log_integrad_erp	logical		Integrado ERP	Sim

Quando a API/BO for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:

findPaymentCondition
Requisito	N/A
Sintaxe	findPaymentCondition (INPUT i_start, INPUT i_end, INPUT c_properties, INPUT c_values, INPUT c_orderBy, INPUT c_asc, INPUT l_count, INPUT i_type, OUTPUT i_count, OUTPUT DATASET DSCRMCondicaoPagamento, OUTPUT TABLE RowErrors)
Descrição	Retorna os registros (query) conforme parâmetros informados.
	Parâmetros	Descrição
	i_start	Valor inicial da faixa de registros
	i_end	Valor final da faixa de registros
	c_properties	Propriedades
	c_values	Valores
	c_orderBy	Campo para ordenação
	c_asc	Ascendente ou Decrescente
	l_count	Contador
	i_type	Tipo
	i_count	Quantidade de registros selecionados
	DATASET DSCRMCondicaoPagamento	Dataset com os registros selecionados
	TABLE RowErros	Tabela de erros
Retorno	A API/BO irá retornar os registros selecionados e a quantidade. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getAllPaymentConditions
Requisito	N/A
Sintaxe	getAllPaymentConditions (OUTPUT TABLE ttCondicaoPagamento, OUTPUT TABLE RowErrors)
Descrição	Retorna todas as condições de pagamento.
	Parâmetros	Descrição
	TABLE ttCondicaoPagamento	Tabela Condição Pagamento
	TABLE RowErrors	Tabela de erros
Retorno	A API/BO irá retornar todas as condições de pagamento cadastrados. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.

getPaymentCondition
Requisito	N/A
Sintaxe	getPaymentCondition (INPUT i_id, OUTPUT DATASET DSCRMCondicaoPagamento, OUTPUT TABLE RowErrors)
Descrição	Retorna o detalhe da condição de pagamento solicitada.
	Parâmetros	Descrição
	PP_id	Codigo Identificador Sequencial
	DATASET DSCRMCondicaoPagamento	Dataset com os registros selecionados
	TABLE RowErrors	Tabela de erros
Retorno	A API/BO irá retornar o detalhe da condição de pagamento solicitada. Caso ocorra erros, retorna a tabela de erros encontrados para o programa.