Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

pi-get-approvers-v1

Requisito

Nenhum.

Sintaxe

RUN pi-get-approvers-v1 in h-handle ( INPUT oInput,

                                                               OUTPUT aOutput,

                                                               OUTPUT lHasNext,

                                                               OUTPUT TABLE RowErrors).

Descrição

Retorna os aprovadores do pedido se o mesmo estiver pendente de aprovação.

  • ccp/api/v1/purchaseOrder: API de comunicação para processamento dos dados.

Retorna uma lista com os aprovadores do pedido de compra gerado.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetro com o número do pedido para busca dos aprovadores.

Exemplo
{
    "pathParams": [
        "approvers",
        "123456"
    ]
}

aOutput

JsonArray

OUTPUT

Retorna uma lista com os aprovadores encontrados.

Exemplo
{
    "total": 1,
    "hasNext": false,
    "items": [
        {
            "code": "faborges",
            "name": "Felipe Augusto Borges",
            "email": ".@totvs.com.br"
        }
    ]
}

lHasNext

Logical

OUTPUT

Retorna se haverá mais registros a serem apresentados.


RowErrors

Temp-table

OUTPUT

Informações sobre os erros ocorridos durante o processo de busca dos dados.

Retorno

Retorna as informações dos aprovadores do pedido de compra gerado ou erros gerados durante o processamento.


Definição de temp-tables RowErrors e PurchaseOrder:Tabelas Temporárias


RowErrors

Entrada/Saída

Temp-table com dados dos erros ocorridos durante o processo

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

ErrorSequence

 INTEGER

Número da sequência do erro

Sim

Não se aplica

ErrorNumber

INTEGER Código do erro 

Sim

Não se aplica

ErrorDescriptionCHARACTER Descrição do erro NãoNão se aplica
ErrorParametersCHARACTER Parâmetros da mensagem de erro NãoNão se aplica
ErrorTypeCHARACTER Tipo do erro NãoNão se aplica
ErrorHelpCHARACTER Texto de ajuda da mensagem de erro NãoNão se aplica
ErrorSubTypeCHARACTERSubtipo do erroNãoNão se aplica

PurchaseOrder

Entrada/Saída

Temp-table com dados do(s) pedido(s) de compra.

Saída

Atributo

Nome do objeto

Tipo

Descrição

Obrigatório

Evolução

num-pedido

purchaseOrder

 INTEGER

Número do pedido de compra

Sim

Não se aplica

cod-emitente

vendorCode

INTEGER Código do emitente

Sim

Não se aplica

nome-abrev-emitshortNameCHARACTER Descrição do emitenteNãoNão se aplica
cod-estabelsiteCodeCHARACTER Código do estabelecimentoSimNão se aplica
cnpjdocumentNumberCHARACTER CNPJ do estabelecimentoNãoNão se aplica
data-pedidoorderDateDATEData do pedido de compra SimNão se aplica
contr-fornsupplyContractLOGICALContrato fornecedorNãoNão se aplica
naturezanatureINTEGERNatureza do pedidoSimNão se aplica
natureza-txtnatureTxtCHARACTERDescrição da naturezaNãoNão se aplica
situacaosituationINTEGERSituação do pedidoSimNão se aplica

ttDiscardOrders

Entrada/Saída

Temp-table com número das ordens de compra que serão desconsideradas na geração do pedido de compra.

Saída

Atributo

Tipo

Descrição

Obrigatório

Evolução

num-ordem

 INTEGER

Número da ordem de compra

Não

Não se aplica

ttApprovalUser

Entrada/Saída

Temp-table com dados dos aprovadores do pedido de compra quando o mesmo está pendente de aprovação.

Saída

Atributo

Nome do objeto

Tipo

Descrição

Obrigatório

Evolução

cod-usuar

code

 CHARACTER 

Código do usuário aprovador

Sim

Não se aplica

nome-usuar

name

CHARACTER Nome do usuário aprovador

Sim

Não se aplica

e-mailemailCHARACTER E-mail do usuário aprovadorNãoNão se aplica