Informações Financeiras do Cliente
Descrição
Este endpoint obtém um resumo financeiro do cliente no sistema MIMS. Ele retorna informações como crédito total, crédito usado, títulos a pagar, datas de vencimento e status de bloqueio do cliente.
Request HTTP GET
| Tipo da Requisição | URL Exemplo |
|---|---|
| GET | {{url_base}}/GetCustomerFinancialInfo |
| Exemplo | http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/GetCustomerFinancialInfo |
Parâmetros de Entrada
| Nome | Tipo | Obrigatório | Comentários |
|---|---|---|---|
| CustomerNo | String(25) | Sim | Código Externo do Cliente |
Retorno
| Nome | Tipo | Obrigatório | Comentários |
|---|---|---|---|
| WebServiceReturn | WebServiceReturn | Sim | Informações padrão de resposta do WebService na execução do método |
| CustomerFinancialInfoData | GetCustomerFinancialInfoData | Sim | Objeto contendo as informações financeiras do cliente |
Objeto: GetCustomerFinancialInfoData
Descrição: Representa um resumo financeiro do cliente no sistema MIMS.
Propriedades
| Nome | Tipo | Obrigatório | Comentários |
|---|---|---|---|
| CreditTotal | Float | Sim | Valor do crédito total |
| CreditUsage | Float | Sim | Valor do crédito usado |
| CreditSpecialUsage | Float | Sim | Valor do crédito especial usado |
| CreditDisposableQty | Float | Sim | Valor de crédito disponível |
| OverdueDocumentsQty | Integer | Sim | Quantidade de títulos em atraso |
| LastDocumentPaymentDate | DataHora | Sim | Data do último título pago |
| NextDocumentPaymentDate | DataHora | Sim | Data do próximo título a pagar |
| LastDocumentPaymentNo | String(25) | Sim | Número do último título pago |
| NextDocumentPaymentNo | String(25) | Sim | Número do próximo título a pagar |
| IsBlocked | Boolean | Sim | Flag que indica se o cliente está bloqueado |
Exemplo de Request
GET http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/GetCustomerFinancialInfo
Content-Type: application/json
{
"CustomerNo": "CUST001"
}
Exemplo de Response
{
"WebServiceReturn": {
"Success": true,
"Message": "Informações financeiras do cliente obtidas com sucesso."
},
"CustomerFinancialInfoData": {
"CreditTotal": 10000.00,
"CreditUsage": 2500.00,
"CreditSpecialUsage": 500.00,
"CreditDisposableQty": 7000.00,
"OverdueDocumentsQty": 2,
"LastDocumentPaymentDate": "2025-02-15T12:00:00Z",
"NextDocumentPaymentDate": "2025-02-25T12:00:00Z",
"LastDocumentPaymentNo": "TIT123",
"NextDocumentPaymentNo": "TIT124",
"IsBlocked": false
}
}
Notas de Dev
- Certifique-se de que
CustomerNoseja válido e existente no sistema MIMS. - Os campos de data, como
LastDocumentPaymentDateeNextDocumentPaymentDate, são retornados no formato ISO 8601 (ex.:2025-02-15T12:00:00Z). - O campo
IsBlockedé um valor booleano (trueoufalse) indicando se o cliente está bloqueado financeiramente.