Atualização de Crédito de Cliente
O endpoint PostUpdateCustomerCredit é responsável por atualizar o crédito de um cliente no sistema MIMS.
Como atualizar o crédito de um cliente
Request HTTP Post
| Tipo da Requisição | URL Exemplo |
|---|---|
| POST | {{url_base}}/PostUpdateCustomerCredit |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostUpdateCustomerCredit" |
Parâmetros de Entrada
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| CustomerNo | String(25) | Sim | Código externo do cliente |
| CustomerAuxiliaryNo | String(25) | Não | Código externo auxiliar do cliente |
| PaymentTotal | Float | Sim | Valor total do pagamento (deve ser diferente de zero) |
| PaymentDate | DataHora | Sim | Data do pagamento |
| PaymentNo | String(40) | Não | Número do pagamento |
Observação
- Quando
PaymentTotalfor maior que zero, o crédito do cliente será liberado (aumentado). - Quando
PaymentTotalfor menor que zero, o crédito do cliente será utilizado (diminuído).
Retorno
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sim | Informações padrão de resposta do WebService na execução do método |
Exemplo de Request
curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"PostUpdateCustomerCredit"' \
--header 'Content-Type: application/json' \
--data '{
"CustomerNo": "CUST001",
"CustomerAuxiliaryNo": "",
"PaymentTotal": 1000.00,
"PaymentDate": "2024-01-15T10:30:00",
"PaymentNo": "PAG001"
}'
Exemplo de Response
{
"WebServiceReturn": {
"Status": "wrsSuccess",
"ErrorCode": "",
"Message": "",
"Actor": "",
"ReturnQuestion": null
}
}
🐞 Possíveis Erros
| Código | Mensagem |
|---|---|
| DSO‑005 | Mensagem de erro retornada pelo sistema de ajuste de crédito do cliente |