Árvore de páginas

Versões comparadas

Chave

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

...

02. SITUAÇÃO/REQUISITO

Criação de API REST com método métodos POST(criação) e DELETE(exclusão) de pagamentos pendentes a fim de substituir a integração EAI. A integração a ser substituída éAs integrações a serem substituídas foram: adapters\xml\fi5\axrfi010.p e adapters\xml\fi5\axrfi009.p.

03. SOLUÇÃO


Totvs custom tabs box
tabsPOST,DELETE
idsPOST,DELETE
Totvs custom tabs box items
defaultyes
referenciaPOST

POST - Geração de pagamentos pendentes. Deve ser enviada requisição POST na ROTA https://{servidor}/api/fin/v1/tradingProcess passando o JSON com as informações do pagamento pendente.

Se o registro for criado com sucesso, irá retornar status 200, caso ocorrer erros, será retornado o JSON com as mensagens de erro.

Image Modified

Totvs custom tabs box items
defaultno
referenciaDELETE

DELETE - Exclusão de pagamentos pendente. Deve ser enviada requisição DELETE na ROTA https://{servidor}/api/fin/v1/tradingProcess  passando no corpo da requisição um array dos dados de pagamento pendente que serão excluídos.

Se os registros forem excluídos com sucesso, irá retornar status 200, caso ocorrer erros, será retornado o JSON com as mensagens de erro.

Image Added

04. DEMAIS INFORMAÇÕES

JSON Pagamentos Pendente (POST):

{
    "CashierNumber": 1,
    "CustomerCode": 1,
    "PaymentDate": "2024-11-07",
    "PaymentDescription": "descrição",
    "Reference": "ref5",
    "PaymentValue": 10
}

JSON Pagamentos Pendente (DELETE):

{
    "PendingPaymentInformation": [
        {
            "CashierNumber": 1,
            "CustomerCode": 1,
            "PaymentDate": "2024-11-07",
            "PaymentDescription": "",
            "Reference": "ref",
            "PaymentValue": 10
        }
    ]
}

JSON Retorno de Erros:

{
    "detailedMessage": "Deve ser informado algum valor para Cliente.",
    "code": "20731",
    "message": "Cliente inválido !",
    "type": "error"
}

...