Linha Datasul

Árvore de páginas

01. DADOS GERAIS

Produto:

TOTVS Backoffice

Linha de Produto:

Linha Datasul

Segmento:

Backoffice

Módulo:

TOTVS Backoffice (Linha Datasul) - Contas a Receber (ACR)

Função:Pagamento Pendente
País:Brasil
Ticket:
Requisito/Story/Issue (informe o requisito relacionado) :DMANACRTES1-15826

02. SITUAÇÃO/REQUISITO

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

03. SOLUÇÃO


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.

DELETE - Exclusão de pagamento pendente. Deve ser enviada requisição DELETE na ROTA https://{servidor}/api/fin/v1/tradingProcess/{SequenciaPagamento}  passando na URL o número da sequência de pagamento.

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

GET- Consulta de pagamento pendente. Deve ser enviada requisição GET na ROTA https://{servidor}/api/fin/v1/tradingProcess/referenceCustomer/{Referência;CodigoCliente}  passando na URL a referência e o código do cliente, separados por ponto e vírgula (;).


04. DEMAIS INFORMAÇÕES

JSON Pagamentos Pendente (POST):

{
    "CashierNumber": 1,
    "CustomerCode": 1,
    "PaymentDate": "2024-12-09",
    "PaymentDescription": "descrição",
    "Reference": "ref5",
    "PaymentValue": 10,
    "ProcessType": "Pagamento"
}

JSON Retorno de Erros:

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


05. ASSUNTOS RELACIONADOS

    Documentação em formato JSON para consulta em ferramentas como Swagger ou similares disponível em finapi/apipublicfin.json.