Linha de Produto: | Datasul |
Segmento: | Manufatura |
Módulo: | MCC |
Versão Expedida: | 12.1.17 |
Considerações Gerais
Objetivo
Filtrar, organizar e retornar informações referentes a cotações de compra.
Funcionamento
Na forma padrão, realiza-se a chamada por intermédio de um comando RUN normal, passando-se as temp-tables carregadas com as informações necessárias.
A execução na forma persistente é realizada por intermédio da chamada de um comando RUN conforme exemplo a seguir.
A sintaxe para executar a API em modo persistente é:
RUN ccp/ccapi367.p PERSISTENT SET h-handle. |
A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.
| ttQuotationList | Entrada/Saída | |||
| Lista de cotações | Saída | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
| seq-cotac | INTEGER | >>9 | Sequência da Cotação | Sim |
| numero-ordem | INTEGER | zzzzz9,99 | Ordem Compra | Sim |
| nr-processo | INTEGER | 999,999 | Processo | Sim |
| nr-solicit-cotac | DECIMAL | >>>,>>>,>>>,>>>,>>9 | Código Solicitação de cotação | Sim |
| it-codigo | CHARACTER | X(16) | Código do Item | Sim |
| it-codigo-desc | CHARACTER | x(60) | Descrição do item | Não |
| cod-refer | CHARACTER | x(8) | Código complementar do item | Não |
| inform-compl | CHARACTER | x(16) | Informação Complementar do item | Sim |
| cod-estabel | CHARACTER | x(5) | Estabelecimento | Sim |
| cod-emitente | INTEGER | >>>>>>>>9 | Código do fornecedor | Sim |
| nome-abrev | CHARACTER | X(12) | Nome Abreviado do fornecedor | Sim |
| nome-emit | CHARACTER | x(80) | Nome do fornecedor | Sim |
| data-cotacao | DATE | 99/99/9999 | Data Cotação | Sim |
| un | CHARACTER | xx | Unidade Medida | Sim |
| qt-solic | DECIMAL | >>>,>>>,>>9.9999 | Qtde da ordem de compra | Não |
| cdn-fabrican | INTEGER | >>>>>>>>9 | Código Fabricante | Não |
| nom-fabrican | CHARACTER | x(60) | Nome do Fabricante | Sim |
| preco-fornec | DECIMAL | >>>>>,>>>,>>9.99999 | Preço Fornecedor | Sim |
| mo-codigo | INTEGER | >9 | Moeda | Sim |
| mo-codigo-desc | CHARACTER | x(12) | Descrição da moeda | Sim |
| mo-codigo-sigla | CHARACTER | x(4) | Sigla da moeda | Sim |
| cotacao-moeda | DECIMAL | ->>,>>9.99 | Cotação da moeda | Não |
| cod-transp | INTEGER | >>,>>9 | Transportador | Não |
| cod-transp-desc | CHARACTER | X(12) | Nome Abreviado do transportador | Sim |
| taxa-financ | LOGICAL | Sim/Não | Encargos Financeiros | Sim |
| valor-taxa | DECIMAL | >>9.9999 | Taxa Financeira | Sim |
| nr-dias-taxa | INTEGER | >>9 | Dias Taxa Financeira | Sim |
| codigo-ipi | LOGICAL | Sim/Não | IPI Incluso | Sim |
| frete | LOGICAL | Sim/Não | Frete Incluso | Sim |
| reajusta-cotacao | LOGICAL | Sim/Não | Reajusta Cotação | Não |
| possui-reaj | LOGICAL | Sim/Não | Reajuste | Não |
| codigo-icm | INTEGER | >9 | ICMS | Sim |
| valor-frete | DECIMAL | >>>,>>>,>>9.9999 | Valor Frete | Sim |
| dias-validade | INTEGER | >>9 | Dias Validade | Não |
| prazo-entreg | INTEGER | >,>>9 | Prazo Entrega | Sim |
| aliquota-ipi | DECIMAL | >>9.99 | Alíquota IPI | Sim |
| aliquota-icm | DECIMAL | >>9.99 | Alíquota ICMS | Sim |
| aliquota-iss | DECIMAL | >>9.99 | Alíquota ISS | Sim |
| perc-descto | DECIMAL | >9.99999 | % Desconto | Sim |
| valor-descto | DECIMAL | >>>,>>>,>>9.9999 | Valor Desconto | Não |
| cod-cond-pag | INTEGER | >>>9 | Condição Pagamento | Sim |
| cod-cond-pag-desc | CHARACTER | x(30) | Descrição da condição de pagamento | Sim |
| cod-comprado | CHARACTER | X(12) | Comprador | Sim |
| cod-comprado-desc | CHARACTER | X(40) | Nome do comprador | Sim |
| contato | CHARACTER | x(40) | Contato | Sim |
| narrativa | CHARACTER | x(2000) | Narrativa | Sim |
| cot-aprovada | LOGICAL | Sim/Não | Cotação Aprovada | Sim |
| pend-aprov | LOGICAL | yes/no | Pendente de aprovação | Não |
| rejeitada | LOGICAL | yes/no | Rejeitada | Não |
| mapa-cotacao | INTEGER | >9 | Mapa Cotação | Não |
| cod-incoterm | CHARACTER | X(3) | Incoterm | Não |
| cod-pto-contr | INTEGER | >>>>9 | Ponto Controle Base | Não |
| cdn-pais-orig | INTEGER | >>,>>9 | País de Origem | Sim |
| class-fiscal | CHARACTER | 9999.99.99 | Classificação Fiscal | Não |
| regime-impot | INTEGER | 99 | Regime Importação | Não |
| aliquota-ii | DECIMAL | >>9.99 | Alíquota II | Não |
| itinerario | INTEGER | >>,>>9 | Código do Itinerário | Sim |
| log-gerac-autom-despes | LOGICAL | Sim/Não | Geração Automática Despesas | Sim |
| char-1 | CHARACTER | x(100) | Campo livre | Não |
| char-2 | CHARACTER | x(500) | Campo livre | Não |
| int-1 | INTEGER | ->>>>>>>>>9 | Campo livre | Não |
| epc-value | CHARACTER | x(200) | Campo para customização | Não |
ttQuotationsApprove | Entrada/Saída | ||||
Lista de cotações para realizar validações de aprovação | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | |
| numero-ordem | INTEGER | zzzzz9,99 | Ordem Compra | Sim | |
cod-emitente | INTEGER | >>>>>>>>9 | Código do fornecedor | Sim | |
| it-codigo | CHARACTER | x(16) | Código do item | Sim | |
| seq-cotac | INTEGER | >>9 | Sequência da Cotação | Sim | |
| l-ok | LOGICAL | Sim/Não | Cotação pronta para aprovação | Não | |
| l-oc-aprovada | LOGICAL | Sim/Não | Já foi realizada cotação para ordem de compra | Não | |
| l-cot-pendente | LOGICAL | Sim/Não | Cotação pendente de resposta | Não | |
| l-cot-aprovada | LOGICAL | Sim/Não | Cotação já aprovada | Não | |
| l-cot-pend-aprov | LOGICAL | Sim/Não | Cotação pendente de aprovação | Não | |
| l-cot-nao-encontrada | LOGICAL | Sim/Não | Não encontrada cotação | Não | |
| l-oc-nao-encontrada | LOGICAL | Sim/Não | Ordem de compra não encontrada | Não | |
| l-oc-situacao | LOGICAL | Sim/Não | Ordem de compra diferente de "Cotada" e "Em Cotação" | Não | |
| l-cot-mesma-ordem | LOGICAL | Sim/Não | Quando há mais de uma cotação para mesma ordem e emitentes diferentes | Não | |
ttQuotationsApproveResult | Entrada/Saída | ||||
Lista de cotações após realizadas as validações de aprovação | Saída | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | |
| Mesma definição da temp-table ttQuotationsApprove | |||||
| ttListParametersQuotation | Entrada/Saída | |||||||||||||||||||||||
| Parâmetros para a busca da lista de cotações | Entrada | |||||||||||||||||||||||
| Atributo | Tipo | Formato | Descrição | Obrigatório | ||||||||||||||||||||
| sortBy | CHARACTER | x(8) | Define qual será a ordenação das cotações retornadas. As opções disponíveis são:
| Sim | ||||||||||||||||||||
| orderAsc | LOGICAL | yes/no | Indica se a ordenação será ascendente | Sim | ||||||||||||||||||||
| basicFilter | CHARACTER | x(8) | Filtro simples. (Será utilizada para filtrar cotações pelo número da ordem ou código do item). O filtro simples será aplicado considerando os outros filtros. | Não | ||||||||||||||||||||
| cCodEstabelec | CHARACTER | x(5) | Estabelecimento da última cotação consultada anteriormente. Obs.: Utilizado na paginação. Caso seja a primeira vez, enviar em branco. | Sim | ||||||||||||||||||||
| rLastQuotationRowid | ROWID | Rowid do último registro de cotação consultado. Obs.: Utilizado na paginação. Caso seja a primeira vez, enviar como ?. | Sim | |||||||||||||||||||||
| rLastOrderlineRowid | ROWID | Rowid do último registro de ordem de compra consultado. Obs.: Utilizado na paginação. Caso seja a primeira vez, enviar como ?. | Sim | |||||||||||||||||||||
| rLastItQuotationProcessRowid | ROWID | Rowid do último registro de item de processo de solicitação consultado. Obs.: Utilizado na paginação. Caso seja a primeira vez, enviar como ?. | Sim | |||||||||||||||||||||
| siteIni | CHARACTER | x(5) | Código do Estabelecimento inicial | Sim | ||||||||||||||||||||
| siteEnd | CHARACTER | x(5) | Código do Estabelecimento final | Sim | ||||||||||||||||||||
| orderlineIni | INTEGER | zzzzz9,99 | Ordem inicial | Sim | ||||||||||||||||||||
| orderlineEnd | INTEGER | zzzzz9,99 | Ordem final | Sim | ||||||||||||||||||||
| requestQuotationIni | DECIMAL | >>>,>>>,>>>,>>>,>>9 | Código da Solicitação de cotação inicial Obs.: Ao informar algum valor no filtro de solicitação de cotação, somente serão consideradas cotações de ordens que possuam solicitação de cotação. | Sim | ||||||||||||||||||||
| requestQuotationEnd | DECIMAL | >>>,>>>,>>>,>>>,>>9 | Código da Solicitação de cotação final Obs.: Ao informar algum valor no filtro de solicitação de cotação, somente serão consideradas cotações de ordens que possuam solicitação de cotação. | Sim | ||||||||||||||||||||
| itemCodeIni | CHARACTER | X(16) | Código do Item inicial | Sim | ||||||||||||||||||||
| itemCodeEnd | CHARACTER | X(16) | Código do Item final | Sim | ||||||||||||||||||||
| itemDescriptionIni | CHARACTER | x(60) | Descrição do item inicial | Não | ||||||||||||||||||||
| itemDescriptionEnd | CHARACTER | x(60) | Descrição do item final | Não | ||||||||||||||||||||
| itemCompCodeIni | CHARACTER | x(20) | Código Complementar do item inicial | Sim | ||||||||||||||||||||
| itemCompCodeEnd | CHARACTER | x(20) | Código Complementar do item final | Sim | ||||||||||||||||||||
| itemCompInfoIni | CHARACTER | x(16) | Informação Complementar do item inicial | Sim | ||||||||||||||||||||
| itemCompInfoEnd | CHARACTER | x(16) | Informação Complementar do item final | Sim | ||||||||||||||||||||
| vendorCodeIni | INTEGER | >>>>>>>>9 | Fornecedor inicial | Sim | ||||||||||||||||||||
| vendorCodeEnd | INTEGER | >>>>>>>>9 | Fornecedor final | Sim | ||||||||||||||||||||
| withPendency | LOGICAL | yes/no | Considera cotações com pendência de aprovação | Não | ||||||||||||||||||||
| withoutPendency | LOGICAL | yes/no | Considera cotações sem pendência de aprovação | Não | ||||||||||||||||||||
| approved | LOGICAL | yes/no | Considera cotações aprovadas | Não | ||||||||||||||||||||
| rejected | LOGICAL | yes/no | Considera cotações rejeitadas | Não | ||||||||||||||||||||
| withAnswer | LOGICAL | yes/no | Considera cotações respondidas | Não | ||||||||||||||||||||
| withoutAnswer | LOGICAL | yes/no | Considera cotações pendentes de resposta | Não | ||||||||||||||||||||
currentTTQuotationList | Entrada/Saída | ||||
Lista de cotações já consultadas anteriormente (em páginas retornadas anteriormente) | Entrada | ||||
Atributo | Tipo | Formato | Descrição | Obrigatório | |
| numero-ordem | INTEGER | zzzzz9,99 | Ordem Compra | Sim | |
cod-emitente | INTEGER | >>>>>>>>9 | Código do fornecedor | Sim | |
| it-codigo | CHARACTER | x(16) | Código do item | Sim | |
| seq-cotac | INTEGER | >>9 | Sequência da Cotação | Sim | |
| ttNumLastPurchaseOfItem | Entrada/Saída | |||
| Lista de últimas compras do Item | Saída | |||
Atributo | Tipo | Formato | Descrição | Obrigatório |
| purchaseRequisitionId | CHARACTER | x(8) | Número da Ordem de Compra | Não |
| paymentCondition | CHARACTER | x(30) | Descrição da Condição de Pagamento | Não |
| purchaseDate | DATE | 99/99/9999 | Data da Cotação | Não |
| price | DECIMAL | >>>>>,>>>,>>9.99999 | Preço do Fornecedor | Não |
| supplierCNPJ | CHARACTER | x(19) | CNPJ do Fornecedor | Não |
| supplierDescription | CHARACTER | x(80) | Nome do Fornecedor | Não |
| supplierId | CHARACTER | x(9) | Código do Fornecedor | Não |
| itemDescription | CHARACTER | x(60) | Descrição do Item | Não |
| itemId | CHARACTER | x(16) | Código do Item | Não |
| unitOfMeasure | CHARACTER | x(2) | Unidade de Medida | Não |
| unitOfMeasureDescription | CHARACTER | x(15) | Descrição da Unidade de Medida | Não |
| currencyShorthand | CHARACTER | x(4) | Sigla da Moeda | Não |
| ttFieldsReportConfigDefault | Entrada/Saída | ||
| Lista de campos disponíveis para apresentação em colunas | Saída | ||
Atributo | Tipo | Descrição | Obrigatório |
| fieldName | CHARACTER | Nome do campo | Sim |
| fieldLabel | CHARACTER | Descrição do campo | Não |
| fieldShow | LOGICAL | Indica se campo será exibido | Não |
| RowErrors | Entrada/Saída | |
| Lista dos erros ocorridos durante a execução de algum método | Saída | |
Atributo | Tipo | Descrição |
| ErrorSequence | INTEGER | Sequência do Erro |
| ErrorNumber | INTEGER | Código do Erro |
| ErrorDescription | CHARACTER | Descrição do Erro |
| ErrorParameters | CHARACTER | Parâmetros do Erro |
| ErrorType | CHARACTER | Tipo do Erro |
| ErrorHelp | CHARACTER | Ajuda |
| ErrorSubType | CHARACTER | Sub-tipo do Erro |
Quando a API for executada em modo persistente, os seguintes métodos estarão disponíveis para execução:
Métodos de Negócio
REST_POST_getListQuotations | ||
Requisito | Nenhum | |
Sintaxe | RUN REST_POST_getListQuotations in handle (INPUT <temp-table>, INPUT <temp-table>, OUTPUT <character>, OUTPUT <rowid>, OUTPUT <rowid>, OUTPUT <rowid>, OUTPUT <logical>, OUTPUT TABLE <temp-table>). | |
Descrição | Retorna a lista de cotações conforme parâmetros estabelecidos. Os dados são retornados com base no controle de segurança por estabelecimento. São retornados 50 registros por vez. | |
Parâmetros | Descrição | |
ttListParametersQuotation currentTTQuotationList cCodEstabelec rLastQuotaionRowid rLastOrderlineRowid rLastItQuotationProcessRowid lHasNext ttQuotationList | Contém os filtros a serem utilizados para listagem Lista de cotações já consultadas anteriormente (em páginas anteriores) Código do Estabelecimento do último registro retornado (utilizado para paginação) Rowid da última cotação da lista (utilizado para paginação) Rowid da última ordem de compra da lista (utilizado para paginação) Rowid do último item de solicitação de cotação da lista (utilizado para paginação) Indica que existem mais registros a serem apresentados Lista de cotações | |
Retorno | Retorna o estabelecimento da última cotação encontrada, o rowid da última cotação encontrada, o rowid da última ordem encontrada, se existem mais registros a serem apresentados, e uma temp-table contendo a lista de cotações. | |
| EPC | afterLoadList | |
| Executado após a busca dos registros para listagem das cotações | ||
| Parâmetros | Descrição | |
| Handle_ttQuotationList | Handle da temp-table com as informações das cotações: ttQuotationList | |
REST_POST_validateApproveQuotations | ||
Requisito | Nenhum | |
Sintaxe | RUN REST_POST_validateApproveQuotations in handle (INPUT <temp-table>, OUTPUT TABLE <temp-table>, OUTPUT TABLE <temp-table>). | |
Descrição | Realiza validações com a cotação recebida como parâmetro, verificando se esta está disponível para aprovação. | |
Parâmetros | Descrição | |
ttQuotationsApprove ttQuotationsApproveResult RowErrors | Cotação a ser validada pelo método Cotação após validação do método Lista de Erros encontrados na execução do método | |
REST_POST_validateApproveLotQuotations | ||
Requisito | Nenhum | |
Sintaxe | RUN REST_POST_validateApproveLotQuotations in handle (INPUT <temp-table>, OUTPUT TABLE <temp-table>, OUTPUT<character>, OUTPUT TABLE <temp-table>). | |
Descrição | Realiza validações com a lista de cotações recebida como parâmetro, verificando se estas estão disponíveis para aprovação. | |
Parâmetros | Descrição | |
ttQuotationsApprove ttQuotationsApproveResult WarningMsg RowErrors | Lista de cotações a serem validadas pelo método Lista de cotações após validação do método Mensagem de aviso, caso alguma cotação da lista não for considerada Lista de Erros encontrados na execução do método | |
REST_GET_getFieldsColumnsConfigDefault | ||
Requisito | Nenhum | |
Sintaxe | RUN REST_GET_getFieldsColumnsConfigDefault in handle (OUTPUT TABLE <temp-table>). | |
Descrição | Retorna uma lista com os campos disponíveis para apresentação em colunas | |
Parâmetros | Descrição | |
ttFieldsReportConfigDefault | Lista com os campos disponíveis para exibição | |
REST_GET_getLastPurchaseOfItemVendor | ||
Requisito | Nenhum | |
Sintaxe | RUN REST_GET_getLastPurchaseOfItemVendor in handle (INPUT <character>, INPUT <character>, INPUT <character>, INPUT <integer>, OUTPUT TABLE <temp-table>, OUTPUT TABLE <temp-table>). | |
Descrição | Retorna a lista de últimas compras do Item x Fornecedor de acordo com o campo "Número de Últimas Compras" dos Parâmetros de Cotações (OC0101). Obs.: Caso não encontre a quantidade de últimas compras estabelecido nos parâmetros de compras para o Item x Fornecedor x Unidade de Medida passados como parâmetro, o método fará outras duas buscas, por Item x Fornecedor x Unidade de Medida Cadastrada para o Item (CD0204) e Item x Fornecedor sem considerar unidade de medida. | |
Parâmetros | Descrição | |
purchaseRequisitionId cItem unitOfMeasure vendorId ttNumLastPurchaseOfItem RowErrors | Número da ordem de compra (utilizado o estabelecimento da ordem para busca das últimas compras) Código do Item Unidade de medida Código do Fornecedor Lista com as últimas compras Lista de Erros encontrados na execução do método | |
REST_GET_getLastPurchaseOfItem | ||
Requisito | Nenhum | |
Sintaxe | RUN REST_GET_getLastPurchaseOfItem in handle (INPUT <character>, INPUT <character>, INPUT <character>, OUTPUT TABLE <temp-table>, OUTPUT TABLE <temp-table>). | |
Descrição | Retorna a lista de últimas compras do Item de acordo com o campo "Número de Últimas Compras" dos Parâmetros de Cotações (OC0101). | |
Parâmetros | Descrição | |
purchaseRequisitionId site cItem ttLastPurchaseOfItemAux RowErrors | Número da ordem de compra (utilizado o estabelecimento da ordem para busca das últimas compras) Código do Estabelecimento Código do Item Lista com as últimas compras do Item Lista de Erros encontrados na execução do método | |
