Documento de API

Produto:	Datasul
Ocorrência:	Documentação de API
Nome físico:	ccp/v1/purchaseOrder.p

Objetivo

Realiza a validação e geração de pedidos em lote e consulta informações de pedidos de compra.

Funcionamento

A API fornece uma série de métodos que podem ser executados individualmente para geração e consulta de pedido de compmracompra.

A sintaxe para a chamada da API, que deve ser de forma persistente:

...

A variável denominada h-handle irá receber o “handle” do programa, permitindo o acesso aos “métodos” internos da API.

Métodos Negócio

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

pi-get-v1

Requisito

Nenhum.

Sintaxe

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

OUTPUT oOutput,

OUTPUT TABLE RowErrors).

Descrição

Repassa o número do pedido para a busca de um registro.

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

Retorna um registro de pedido de compra.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetro para a busca do pedido de compra:

número do pedido

Exemplo
{ "pathParams": [ "123543" ] }

oOutput

JsonObject

OUTPUT

Retorno contendo informações do pedido de compra.

Exemplo

{
    "natureTxt": "Compra",
    "siteCode": "1",
    "nature": 1,
    "documentNumber": "53113791000122",
    "purchaseOrder": 994033,
    "shortName": "COTROLEDb",
    "supplyContract": false,
    "orderDate": "2023-02-01",
    "situation": 2,
    "vendorCode": 1
}

RowErrors

Temp-table

OUTPUT

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

Retorno

Retorna um registro de pedido de compra ou erros gerados durante o processamento.

pi-query-v1

Requisito

Nenhum.

Descrição

Retorna informações de mais de um pedido de compra.

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

Retorna uma lista de pedidos de compra.

Parâmetros

Tipo

Input/Output

Descrição

Sintaxe

RUN pi-query-v1 in h-handle ( INPUT oInput,

OUTPUT oOutput,

OUTPUT lHasNext,

OUTPUT TABLE RowErrors).

Descrição

Retorna informações de mais de um pedido de compra.

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

Retorna uma lista de pedidos de compra.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

aOutput

JsonArray

OUTPUT

Retorno contendo a lista dos pedidos de compra encontrados.

Exemplo
{ "total": 20, "hasNext": true, "items": [

oInput

JsonObject

INPUT

aOutput

JsonArray

OUTPUT

Retorno contendo a lista dos pedidos de compra encontrados.

Exemplo

{
    "total": 20,
    "hasNext": true,
    "items": [
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "07977026000214",
            "purchaseOrder": 1,
            "shortName": "3",
            "supplyContract": false,
            "orderDate": "2023-09-20",
            "situation": 1,
            "vendorCode": 3
        },
        {
            "natureTxt": "Serviço",
            "siteCode": "1",{
            "naturenatureTxt": 2"Compra",
            "documentNumbersiteCode": "531137910001221",
            "nature": 1,
            "documentNumber": "07977026000214",
            "purchaseOrder": 21,
            "shortName": "COTROLEDb3",
            "supplyContract": false,
            "orderDate": "2023-09-2620",
            "situation": 1,
            "vendorCode": 13
        },
        {
            "natureTxt": "CompraServiço",
            "siteCode": "1",
            "nature": 12,
            "documentNumber": "53113791000122",
            "purchaseOrder": 32,
            "shortName": "COTROLEDb",
            "supplyContract": false,
            "orderDate": "2023-09-2826",
            "situation": 21,
            "vendorCode": 1
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "53113791000122",
            "purchaseOrder": 43,
            "shortName": "COTROLEDb",
            "supplyContract": false,
            "orderDate": "2023-1209-28",
            "situation": 2,
            "vendorCode": 1
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "53113791000122",
            "purchaseOrder": 54,
            "shortName": "COTROLEDb",
            "supplyContract": false,
            "orderDate": "2023-12-28",
            "situation": 2,
            "vendorCode": 1
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "9999999999853113791000122",
            "purchaseOrder": 65,
            "shortName": "ESTRANGEIROCOTROLEDb",
            "supplyContract": false,
            "orderDate": "2023-12-28",
            "situation": 12,
            "vendorCode": 141
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "99999999998",
            "purchaseOrder": 76,
            "shortName": "ESTRANGEIRO",
            "supplyContract": false,
            "orderDate": "2023-12-28",
            "situation": 1,
            "vendorCode": 14
        },
        {
            "natureTxt": "ServiçoCompra",
            "siteCode": "1",
            "nature": 21,
            "documentNumber": "5311379100012299999999998",
            "purchaseOrder": 87,
            "shortName": "COTROLEDbESTRANGEIRO",
            "supplyContract": false,
            "orderDate": "20242023-0112-0828",
            "situation": 21,
            "vendorCode": 114
        },
        {
            "natureTxt": "Serviço",
            "siteCode": "1",
            "nature": 2,
            "documentNumber": "53113791000122",
            "purchaseOrder": 98,
            "shortName": "COTROLEDb",
            "supplyContract": false,
            "orderDate": "2024-01-08",
            "situation": 2,
            "vendorCode": 1
        },
        {
            "natureTxt": "CompraServiço",
            "siteCode": "1",
            "nature": 12,
            "documentNumber": "53113791000122",
            "purchaseOrder": 509,
            "shortName": "COTROLEDb",
            "supplyContract": false,
            "orderDate": "20232024-1001-2708",
            "situation": 2,
            "vendorCode": 1
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "9999999999853113791000122",
            "purchaseOrder": 8850,
            "shortName": "ESTRANGEIROCOTROLEDb",
            "supplyContract": false,
            "orderDate": "20142023-0110-0627",
            "situation": 2,
            "vendorCode": 141
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "5311379100012299999999998",
            "purchaseOrder": 9088,
            "shortName": "COTROLEDbESTRANGEIRO",
            "supplyContract": false,
            "orderDate": "20232014-1001-2706",
            "situation": 2,
            "vendorCode": 114
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "53113791000122",
            "purchaseOrder": 17490,
            "shortName": "COTROLEDb",
            "supplyContract": false,
            "orderDate": "20172023-1210-0827",
            "situation": 12,
            "vendorCode": 1
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "53113791000122",
            "purchaseOrder": 175174,
            "shortName": "COTROLEDb",
            "supplyContract": false,
            "orderDate": "2017-12-08",
            "situation": 21,
            "vendorCode": 1
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "9999999999853113791000122",
            "purchaseOrder": 176175,
            "shortName": "ESTRANGEIROCOTROLEDb",
            "supplyContract": false,
            "orderDate": "2017-12-08",
            "situation": 2,
            "vendorCode": 141
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "99999999998",
            "purchaseOrder": 177176,
            "shortName": "ESTRANGEIRO",
            "supplyContract": false,
            "orderDate": "2017-12-08",
            "situation": 2,
            "vendorCode": 14
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "99999999998",
            "purchaseOrder": 178177,
            "shortName": "ESTRANGEIRO",
            "supplyContract": false,
            "orderDate": "2017-12-08",
            "situation": 2,
            "vendorCode": 14
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "99999999998",
            "purchaseOrder": 179178,
            "shortName": "ESTRANGEIRO",
            "supplyContract": false,
            "orderDate": "2017-12-08",
            "situation": 2,
            "vendorCode": 14
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "99999999998",
            "purchaseOrder": 180179,
            "shortName": "ESTRANGEIRO",
            "supplyContract": false,
            "orderDate": "2017-12-08",
            "situation": 2,
            "vendorCode": 14
        },
        {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "99999999998",
            "purchaseOrder": 181180,
            "shortName": "ESTRANGEIRO",
            "supplyContract": false,
            "orderDate": "2017-12-08",
            "situation": 2,
            "vendorCode": 14
        },
    ]
}

lHasNext

Logical

OUTPUT

Retorna se haverá mais registros a serem apresentados.

RowErrors

Temp-table

OUTPUT

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

Retorno

Retorna uma lista de pedidos de compra ou erros gerados durante o processamento dos dados.

    {
            "natureTxt": "Compra",
            "siteCode": "1",
            "nature": 1,
            "documentNumber": "99999999998",
            "purchaseOrder": 181,
            "shortName": "ESTRANGEIRO",
            "supplyContract": false,
            "orderDate": "2017-12-08",
            "situation": 2,
            "vendorCode": 14
        }
    ]
}

lHasNext

Logical

OUTPUT

Retorna se haverá mais registros a serem apresentados.

RowErrors

Temp-table

OUTPUT

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

Retorno

Retorna uma lista de pedidos de compra ou erros gerados durante o processamento dos dados.

pi-create-purch-requisition

Requisito

Nenhum.

Sintaxe

RUN pi-create-purch-requisition in h-handle ( INPUT oPayload,

OUTPUT TABLE ttSummaryPurchRequisition).

Descrição

Cria a temp-table com as ordens de compra vinculadas a sugestão do pedido para a geração do pedido de compra.

Retorna a temp-table com as ordens de compra.

Parâmetros

Tipo

Input/Output

Descrição

oPayload

JsonObject

INPUT

Parâmetro com o objeto do payload para abstração dos dados.

Exemplo
{ "responsible": "dmansupimpa3", "deliveryEntity": 1, "messageCode

pi-create-purch-requisition

Requisito

Nenhum.

Descrição

Cria a temp-table com as ordens de compra vinculadas a sugestão do pedido para a geração do pedido de compra.

Retorna a temp-table com as ordens de compra.

Parâmetros

Tipo

Input/Output

Descrição

oPayload

JsonObject

INPUT

Parâmetro com o objeto do payload para abstração dos dados.

Exemplo

{
    "responsible": "dmansupimpa3",
    "deliveryEntity": 1,
    "messageCode": 1,
    "messageText": "Atenção as Condições Obrigatórias Para Fornecimento anexo a este pedido de compra. O prazo de pagamento deve ser contado a partir do dia seguinte a data de emissão da NF. P/ a entrega de item(ns) com validade inferior a 120dd, informar o comprador responsável antes do faturamento/entrega. Obrigatório informar o nº Pedido na NF.",
    "comments": null,
    "collectionSite": "1",
    "orderDate": "2023-10-09",
    "freightPaymentType": 1,
    "vendorId": 1,
    "siteCode": "1",
    "paymentTermId": 0,
    "carrierCode": 7,
    "orderType": 1,
    "userCode": "dmansupimpa3",
    "package": 0,
    "processSequence": 1,
    "suggestionSequence": 2,
    "purchaseOrderLinesDiscarded": [],
    "specificPaymentTerms": [
        {
            "sequence": 1,
            "date"messageText": "2023-11-08T03:00:00.000Z",
            "percentage": 8.333,
            "comments": ""
        },
        {
            "sequence": 2,
            "date": "2023-12-09T03:00:00.000ZAtenção as Condições Obrigatórias Para Fornecimento anexo a este pedido de compra. O prazo de pagamento deve ser contado a partir do dia seguinte a data de emissão da NF. P/ a entrega de item(ns) com validade inferior a 120dd, informar o comprador responsável antes do faturamento/entrega. Obrigatório informar o nº Pedido na NF.",
         "comments": null,
    "percentagecollectionSite": 8.333"1",
         "orderDate": "2023-10-09",
    "commentsfreightPaymentType": ""1,
        }"vendorId": 1,
        {"siteCode": "1",
         "paymentTermId": 0,
    "sequencecarrierCode": 37,
         "orderType": 1,
    "dateuserCode": "2024-01-08T03:00:00.000Zdmansupimpa3",
         "package": 0,
    "percentageprocessSequence": 8.3331,
         "suggestionSequence": 2,
    "commentspurchaseOrderLinesDiscarded": [],
    "specificPaymentTerms": [
        }
{
          ]
}

ttSummaryPurchRequisition

Temp-table

OUTPUT

Retorna a temp-table carregada com as ordens de compra vinculadas a sugestão de pedido (sugest-ped-comp-ordem).

Retorno

Retorna uma temp-table com as ordens de compra ou erros gerados durante o processamento.

  "sequence": 1,
            "date": "2023-11-08T03:00:00.000Z",
            "percentage": 8.333,
            "comments": ""
        },
        {
            "sequence": 2,
            "date": "2023-12-09T03:00:00.000Z",
            "percentage": 8.333,
            "comments": ""
        },
        {
            "sequence": 3,
            "date": "2024-01-08T03:00:00.000Z",
            "percentage": 8.333,
            "comments": ""
        }
    ]
}

ttSummaryPurchRequisition

Temp-table

OUTPUT

Retorna a temp-table carregada com as ordens de compra vinculadas a sugestão de pedido (sugest-ped-comp-ordem).

Retorno

Retorna uma temp-table com as ordens de compra ou erros gerados durante o processamento.

Parâmetro com o objeto do payload para abstração dos dados.

pi-create-purchase-order

Requisito

Nenhum.

Sintaxe

RUN pi-create-purchase-order in h-handle ( INPUT oPayload,

INPUT TABLE ttSummaryPurchRequisition,

OUTPUT TABLE ttSummaryPurchaseOrder).

Descrição

Retorna a temp-table com os valores necessários para geração do pedido de compra.

Parâmetros

Tipo

Input/Output

Descrição

oPayload

JsonObject

INPUT

Parâmetro com o objeto do payload para abstração dos dados.

Exemplo

{
  "responsible": "dmansupimpa3",
  "deliveryEntity": 1,
  "messageCode": 1,
  "messageText": "Atenção as Condições Obrigatórias Para Fornecimento anexo a este pedido de compra. O prazo de pagamento deve ser contado a partir do dia seguinte a data de emissão da NF. P/ a entrega de item(ns) com validade inferior a 120dd, informar o comprador responsável antes do faturamento/entrega. Obrigatório informar o nº Pedido na NF.",
  "comments": null,
  "collectionSite": "1",
  "orderDate": "2023-10-09",
  "freightPaymentType

pi-create-purchase-order

Requisito

Nenhum.

Descrição

Retorna a temp-table com os valores necessários para geração do pedido de compra.

Parâmetros

Tipo

Input/Output

Descrição

oPayload

JsonObject

INPUT

Exemplo

{
  "responsible": "dmansupimpa3",
  "deliveryEntity": 1,
  "messageCode": 1,
  "messageText": "Atenção as Condições Obrigatórias Para Fornecimento anexo a este pedido de compra. O prazo de pagamento deve ser contado a partir do dia seguinte a data de emissão da NF. P/ a entrega de item(ns) com validade inferior a 120dd, informar o comprador responsável antes do faturamento/entrega. Obrigatório informar o nº Pedido na NF.",
  "comments": null,
  "collectionSite": "1",
  "orderDate": "2023-10-09",
  "freightPaymentType": 1,
  "vendorId": 1,
  "siteCode": "1",
  "paymentTermId": 0,
  "carrierCode": 7,
  "orderType": 1,
  "userCode": "dmansupimpa3",
  "package": 0,
  "processSequence": 1,
  "suggestionSequence": 2,
  "purchaseOrderLinesDiscarded": [],
  "specificPaymentTerms": [
      {
          "sequence": 1,
          "date": "2023-11-08T03:00:00.000Z",
          "percentage": 8.333,
          "comments": ""
      },
      {
          "sequence": 2,
          "date": "2023-12-09T03:00:00.000Z",
          "percentage": 8.333,
          "comments": ""
      },
      {
          "sequence": 3,
          "date": "2024-01-08T03:00:00.000Z",
          "percentage": 8.333,
          "comments": ""
      }
    ]
}

ttSummaryPurchRequisition

Temp-table

INPUT

Temp-table com as ordens de compra do pedido de compra.

ttSummaryPurchaseOrder

Temp-table

OUTPUT

Retorna a temp-table carregada com as informações necessárias para a geração do pedido de compra.

Retorno

Retorna uma temp-table com as informações do pedido de compra ou erros gerados durante o processamento.

pi-create-payment-terms

Requisito

Condição de pagamento do pedido precisa ser específica ( 0 ).

Descrição

Cria a temp-table ttPaymentTerms se o cálculo percentual das parcelas geradas for igual a 100.

Retorna a temp-table com as informações das parcelas geradas.

Parâmetros

Tipo

Input/Output

Descrição

oPayload

JsonObject

INPUT

Parâmetro com o objeto do payload para abstração dos dados.

{
"responsible": "dmansupimpa3",
"deliveryEntitymessageCode messageText"Atenção as Condições Obrigatórias Para Fornecimento anexo a este pedido de compra. O prazo de pagamento deve ser contado a partir do dia seguinte a data de emissão da NF. P/ a entrega de item(ns) com validade inferior a 120dd, informar o comprador responsável antes do faturamento/entrega. Obrigatório informar o nº Pedido na NF.",
"comments": null,
"collectionSite": "1",
"orderDate": "2023-10-09",
"freightPaymentType": 1,
"vendorId": 1,
"siteCode": "1",
"paymentTermId": 0,
"carrierCode": 7,
"orderType": 1,
"userCode": "dmansupimpa3",
"package": 0,
"processSequence": 1,
"suggestionSequence": 2,
"purchaseOrderLinesDiscarded": [],
"specificPaymentTerms": [
1202311 , {
"sequence": 2,
"date": "2023-12-09T03:00:00.000Z",
"percentage": 8.333,
"comments": ""
},
{
"sequence": 3,
"date": "2024-01-08T03:00:00.000Z",
"percentage": 8.333,
"comments": ""
}
]
}

Exemplo
": 1, "
vendorId": 1,
"
siteCode":
"1", "paymentTermId": 0, "carrierCode": 7, "orderType": 1, "userCode": "dmansupimpa3", "package": 0, "processSequence": 1, "suggestionSequence": 2, "purchaseOrderLinesDiscarded": [], "specificPaymentTerms": [ { "sequence": 1, "date": "2023-11-08T03:00:00.000Z", "percentage": 8.333, "comments": "" }, { "sequence": 2, "date": "2023-12-09T03:00:00.000Z", "percentage": 8.333, "comments": "" }, { "sequence":
3, "date": "
2024-
01-08T03:00:00.000Z", "percentage": 8.333, "comments": ""
}

ttSummaryPurchaseOrder

Temp-table

INPUT

Temp-table com as informações do pedido de compra.

ttPaymentTerms

Temp-table

OUTPUT

Retorna a temp-table carregada com as parcelas de condição específica.

]
}

ttSummaryPurchRequisition

Temp-table

INPUT

Temp-table com as ordens de compra do pedido de compra.

ttSummaryPurchaseOrder

Temp-table

OUTPUT

Retorna a temp-table carregada com as informações necessárias para a geração do pedido de compra.

Retorno

Retorna uma temp-table com as informações do pedido de compra ou erros gerados durante o processamento.

pi-create-payment-terms

Requisito

Condição de pagamento do pedido precisa ser específica ( 0 ).

Sintaxe

RUN pi-create-payment-terms in h-handle ( INPUT oPayload,

INPUT TABLE ttSummaryPurchaseOrder,

OUTPUT TABLE ttPaymentTerms,

OUTPUT TABLE RowErrors).

Descrição

Cria a temp-table ttPaymentTerms se o cálculo percentual das parcelas geradas for igual a 100.

Retorna a temp-table com as informações das parcelas geradas.

Parâmetros

Tipo

Input/Output

Descrição

oPayload

JsonObject

INPUT

Parâmetro com o objeto do payload para abstração dos dados.

Exemplo

{
  "responsible": "dmansupimpa3",
  "deliveryEntity": 1,
  "messageCode": 1,
  "messageText": "Atenção as Condições Obrigatórias Para Fornecimento anexo a este pedido de compra. O prazo de pagamento deve ser contado a partir do dia seguinte a data de emissão da NF. P/ a entrega de item(ns) com validade inferior a 120dd, informar o comprador responsável antes do faturamento/entrega. Obrigatório informar o nº Pedido na NF.",
  "comments": null,
  "collectionSite": "1",
  "orderDate": "2023-10-09",
  "freightPaymentType": 1,
  "vendorId": 1,
  "siteCode": "1",
  "paymentTermId": 0,
  "carrierCode": 7,
  "orderType": 1,
  "userCode": "dmansupimpa3",
  "package": 0,
  "processSequence": 1,
  "suggestionSequence": 2,
  "purchaseOrderLinesDiscarded": [],
  "specificPaymentTerms": [
      {
          "sequence": 1,
          "date": "2023-11-08T03:00:00.000Z",
          "percentage": 8.333,
          "comments": ""
      },
      {
          "sequence": 2,
          "date": "2023-12-09T03:00:00.000Z",
          "percentage": 8.333,
          "comments": ""
      },
      {
          "sequence": 3,
          "date": "2024-01-08T03:00:00.000Z",
          "percentage": 8.333,
          "comments": ""
      }
    ]
}

ttSummaryPurchaseOrder

Temp-table

INPUT

Temp-table com as informações do pedido de compra.

ttPaymentTerms

Temp-table

OUTPUT

Retorna a temp-table carregada com as parcelas de condição específica.

RowErrors

Temp-table

OUTPUT

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

Retorno

Retorna uma temp-table com as parcelas de condição específica ou erros gerados durante o processamento.

pi-validate-order-requisition
Requisito	Nenhum.
Sintaxe	RUN pi-validate-order-requisiton in h-handle ( INPUT TABLE ttSummaryPurchRequisition, INPUT TABLE ttSummaryPurchaseOrder, OUTPUT TABLE RowErrors).
Descrição	Valida as informações das ordens de compra vinculadas a sugestão em questão.
	Parâmetros	Tipo	Input/Output	Descrição
	ttSummaryPurchRequisition	Temp-table	INPUT	Temp-table com as ordens de compra do pedido de compra.
	ttSummaryPurchaseOrder	Temp-table	INPUT	Temp-table com as informações do pedido de compra.
	RowErrors	Temp-table	OUTPUT	Informações sobre os erros ocorridos durante o processo de busca dos dados.
Retorno	Retorna erros gerados durante o processamento das validações.

Temp-table com as ordens de compra do pedido de compra.

pi-generate-order-v1

Requisito

Nenhum.

Sintaxe

RUN pi-generate-order-v1 in h-handle ( INPUT oInput,

OUTPUT oOutput,

OUTPUT TABLE RowErrors).

Descrição

Recebe o payload vindo da API de comunicação (ccp/api/v1/purchaseOrder) chamado pelo método pi-generate-order,
com as informações necessárias para geração do pedido.

Após carregar as temp-tables (ttSummaryPurchRequisition, ttSummaryPurchaseOrder, ttPaymentTerms), as mesmas serão enviadas
por parâmetro para a api (fch/fchmat/fchmatcreatepurchaseorder.p) realizar a validação e geração do pedido.

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

Retorna as informações do pedido de compra gerado.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetro com o objeto do payload para abstração dos dados e geração do pedido.

Exemplo

{
  "responsible": "dmansupimpa3",
  "deliveryEntity": 1,
  "messageCode": 1,
  "messageText": "Atenção as Condições Obrigatórias Para Fornecimento anexo a este pedido de compra. O prazo de pagamento deve ser contado a partir do dia seguinte a data de emissão da NF. P/ a entrega de item(ns) com validade inferior a 120dd, informar o comprador responsável antes do faturamento/entrega. Obrigatório informar o nº Pedido na NF.",
  "comments": null,
  "collectionSite": "1",
  "orderDate": "2023-10-09",
  "freightPaymentType": 1,
  "vendorId": 1,
  "siteCode": "1",
  "paymentTermId": 0,
  "carrierCode": 7,
  "orderType": 1,
  "userCode

RowErrors

Temp-table

OUTPUT

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

Retorno

Retorna uma temp-table com as parcelas de condição específica ou erros gerados durante o processamento.

pi-validate-order-requisition

Requisito

Nenhum.

Descrição

Valida as informações das ordens de compra vinculadas a sugestão em questão.

Parâmetros

Tipo

Input/Output

Descrição

ttSummaryPurchRequisition

Temp-table

INPUT

ttSummaryPurchaseOrder

Temp-table

INPUT

Temp-table com as informações do pedido de compra.

RowErrors

Temp-table

OUTPUT

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

Retorno

Retorna erros gerados durante o processamento das validações.

pi-generate-order-v1

Requisito

Nenhum.

Descrição

Recebe o payload vindo da API de comunicação (ccp/api/v1/purchaseOrder) chamado pelo método pi-generate-order,
com as informações necessárias para geração do pedido.

Após carregar as temp-tables (ttSummaryPurchRequisition, ttSummaryPurchaseOrder, ttPaymentTerms), as mesmas serão enviadas
por parâmetro para a api (fch/fchmat/fchmatcreatepurchaseorder.p) realizar a validação e geração do pedido.

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

Retorna as informações do pedido de compra gerado.

Parâmetros

Tipo

Input/Output

Descrição

oInput

JsonObject

INPUT

Parâmetro com o objeto do payload para abstração dos dados e geração do pedido.

Exemplo

{
  "responsible": "dmansupimpa3",
  "deliveryEntity"package": 0,
  "processSequence": 1,
  "messageCodesuggestionSequence": 12,
   "messageTextpurchaseOrderLinesDiscarded": [],
 "Atenção as Condições Obrigatórias Para Fornecimento anexo a este pedido de compra. O prazo de pagamento deve ser contado a partir do dia seguinte a data de emissão da NF. P/ a entrega de item(ns) com validade inferior a 120dd, informar o comprador responsável antes do faturamento/entrega. Obrigatório informar o nº Pedido na NF.",
  "comments": null,
  "collectionSite": "1",
  "orderDate": "2023-10-09",
  "freightPaymentType": 1,
  "vendorId": 1,
  "siteCode": "1",
  "paymentTermId": 0,
  "carrierCode": 7,
  "orderType": 1,
  "userCode": "dmansupimpa3",
  "package": 0,
  "processSequence": 1,
  "suggestionSequence": 2,
  "purchaseOrderLinesDiscarded": [],
  "specificPaymentTerms": [
      {
          "sequence": 1,
          "date": "2023-11-08T03:00:00.000Z",
          "percentage": 8.333,
          "comments": ""
      },
      {
   "specificPaymentTerms": [
      {
          "sequence": 1,
          "date": "2023-11-08T03:00:00.000Z",
          "percentage": 8.333,
          "comments": ""
      },
      {
          "sequence": 2,
          "date": "2023-12-09T03:00:00.000Z",
          "percentage": 8.333,
          "comments": ""
      },
      {
          "sequence": 3,
          "date": "2024-01-08T03:00:00.000Z",
          "percentage": 8.333,
          "comments": ""
      }
    ]
}

oOutput

JsonObject

OUTPUT

Retorna o número do pedido de compra gerado e se está pendente de aprovação.

Exemplo
{ "purchaseOrderNumber": 123345 "isPendingApproval": false }

RowErrors

Temp-table

OUTPUT

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

Retorno

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

JsonObjectRowErrors

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

Retorna uma lista com os aprovadores encontrados.

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": [ "sequenceapprovers": 2, "date": "2023-12-09T03:00:00.000Z", 123456" ] }

aOutput

JsonArray

OUTPUT

Retorna uma lista com os aprovadores encontrados.

Exemplo

{
    "percentagetotal": 8.3331,
          "commentshasNext": ""
      }false,
      {
  "items": [
        "sequence": 3,
 {
            "datecode": "2024-01-08T03:00:00.000Zfaborges",
            "percentagename": 8.333"Felipe Augusto Borges",
            "commentsemail": ".@totvs.com.br"
        }
     ]
}

oOutput

lHasNext

Logical

OUTPUT

Retorna se haverá mais registros a serem apresentados.

o número do pedido de compra gerado e se está pendente de aprovação.

Exemplo

{
    "purchaseOrderNumber": 123345
    "isPendingApproval": false
}

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.

pi-get-approvers-v1

Requisito

Nenhum.

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

Exemplo

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

aOutput

JsonArray

OUTPUT

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:

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
ErrorDescription	CHARACTER	Descrição do erro	Não	Não se aplica
ErrorParameters	CHARACTER	Parâmetros da mensagem de erro	Não	Não se aplica
ErrorType	CHARACTER	Tipo do erro	Não	Não se aplica
ErrorHelp	CHARACTER	Texto de ajuda da mensagem de erro	Não	Não se aplica
ErrorSubType	CHARACTER	Subtipo do erro	Não	Não se aplica

RowErrors

PurchaseOrder

Entrada/Saída
Temp-table com dados

dos erros ocorridos durante o processo

do(s) pedido(s) de compra.					Saída
Atributo	Nome do objeto	Tipo	Descrição	Obrigatório	Evolução

ErrorSequence

num-pedido

purchaseOrder

INTEGER

Número

da sequência

do

erro

pedido de compra	Sim	Não se aplica
cod-emitente

ErrorNumber

vendorCode

INTEGER

Código do

erro

Sim

Não se aplica

ErrorDescriptionCHARACTER Descrição do erro NãoNão se aplicaErrorParametersCHARACTER Parâmetros da mensagem de erro

emitente

Sim

Não

Não se aplica

ErrorType

nome-abrev-emit

shortName

CHARACTER

Tipo

Descrição do

erro

emitente	Não	Não se aplica
cod-estabel

ErrorHelp

siteCode

CHARACTER

Texto de ajuda da mensagem de erro

Código do estabelecimento

Sim

Não

	Não se aplica
cnpj

ErrorSubType

documentNumber

CHARACTER

Subtipo

CNPJ do

erro

estabelecimento

Não

Nã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 compraSim

data-pedido	orderDate	DATE	Data do pedido de compra	Sim	Não se aplica
contr-forn	supplyContract	LOGICAL	Contrato fornecedor	Não	Não se aplica

cod-emitente

natureza

vendorCode

nature

INTEGER

Código

Natureza do

emitente

pedido

Sim

Não se aplica

nome

natureza-

abrev-emit

txt

shortName

natureTxt

CHARACTER

Descrição

do emitente

da natureza

Não

Não se aplica

cod-estabel

situacao

siteCode

situation

CHARACTER

INTEGER

Código

Situação do

estabelecimento

pedido

Sim

Nã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

Natureza do pedidonaturezatxtnatureTxtNãosituacaosituationINTEGERSim

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
cnpj	documentNumber	CHARACTER	CNPJ do estabelecimento	Não	Não se aplica
data-pedido	orderDate	DATE	Data do pedido de compra	Sim	Não se aplica
contr-forn	supplyContract	LOGICAL	Contrato fornecedor	Não	Não se aplica
natureza	nature	INTEGER
	Sim	Não se aplica
nome-
usuar
name
CHARACTER	Descrição da natureza
CHARACTER	Nome do usuário aprovador	Sim
	Não se aplica
e-mail
email
CHARACTER
Situação do pedido
E-mail do usuário aprovador	Não
	Não se aplica

Árvore de páginas

Histórico da Página

Versões comparadas

Versão antiga 7

Nova versão 8

Chave

Documento de API

Produto:

Ocorrência:

Nome físico:

Objetivo

Funcionamento

Métodos Negócio

pi-get-v1

Requisito

Sintaxe

Descrição

Repassa o número do pedido para a busca de um registro.

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

Retorna um registro de pedido de compra.

Parâmetros

Tipo

Input/Output

Descrição

Retorno

pi-query-v1

Requisito

Descrição

Retorna informações de mais de um pedido de compra.

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

Retorna uma lista de pedidos de compra.

Parâmetros

Tipo

Input/Output

Descrição

Sintaxe

Descrição

Retorna informações de mais de um pedido de compra.

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

Retorna uma lista de pedidos de compra.

Parâmetros

Tipo

Input/Output

Descrição

Retorno

Retorno

pi-create-purch-requisition

Requisito

Sintaxe

Descrição

Cria a temp-table com as ordens de compra vinculadas a sugestão do pedido para a geração do pedido de compra.

Retorna a temp-table com as ordens de compra.

Parâmetros

Tipo

Input/Output

Descrição

pi-create-purch-requisition

Requisito

Descrição

Cria a temp-table com as ordens de compra vinculadas a sugestão do pedido para a geração do pedido de compra.

Retorna a temp-table com as ordens de compra.

Parâmetros

Tipo

Input/Output

Descrição

Retorno

Retorno

pi-create-purchase-order

Requisito

Sintaxe

Descrição

Retorna a temp-table com os valores necessários para geração do pedido de compra.

Parâmetros

Tipo

Input/Output

Descrição

pi-create-purchase-order

Requisito

Descrição

Retorna a temp-table com os valores necessários para geração do pedido de compra.

Recebe o payload vindo da API de comunicação (ccp/api/v1/purchaseOrder) chamado pelo método pi-generate-order,
com as informações necessárias para geração do pedido.

Após carregar as temp-tables (ttSummaryPurchRequisition, ttSummaryPurchaseOrder, ttPaymentTerms), as mesmas serão enviadas
por parâmetro para a api (fch/fchmat/fchmatcreatepurchaseorder.p) realizar a validação e geração do pedido.

Recebe o payload vindo da API de comunicação (ccp/api/v1/purchaseOrder) chamado pelo método pi-generate-order,
com as informações necessárias para geração do pedido.

Após carregar as temp-tables (ttSummaryPurchRequisition, ttSummaryPurchaseOrder, ttPaymentTerms), as mesmas serão enviadas
por parâmetro para a api (fch/fchmat/fchmatcreatepurchaseorder.p) realizar a validação e geração do pedido.