Saltar al contenido principal

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çãoURL Exemplo
GET{{url_base}}/GetCustomerFinancialInfo
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/GetCustomerFinancialInfo

Parâmetros de Entrada

NomeTipoObrigatórioComentários
CustomerNoString(25)SimCódigo Externo do Cliente

Retorno

NomeTipoObrigatórioComentários
WebServiceReturnWebServiceReturnSimInformações padrão de resposta do WebService na execução do método
CustomerFinancialInfoDataGetCustomerFinancialInfoDataSimObjeto contendo as informações financeiras do cliente

Objeto: GetCustomerFinancialInfoData

Descrição: Representa um resumo financeiro do cliente no sistema MIMS.

Propriedades

NomeTipoObrigatórioComentários
CreditTotalFloatSimValor do crédito total
CreditUsageFloatSimValor do crédito usado
CreditSpecialUsageFloatSimValor do crédito especial usado
CreditDisposableQtyFloatSimValor de crédito disponível
OverdueDocumentsQtyIntegerSimQuantidade de títulos em atraso
LastDocumentPaymentDateDataHoraSimData do último título pago
NextDocumentPaymentDateDataHoraSimData do próximo título a pagar
LastDocumentPaymentNoString(25)SimNúmero do último título pago
NextDocumentPaymentNoString(25)SimNúmero do próximo título a pagar
IsBlockedBooleanSimFlag 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 CustomerNo seja válido e existente no sistema MIMS.
  • Os campos de data, como LastDocumentPaymentDate e NextDocumentPaymentDate, são retornados no formato ISO 8601 (ex.: 2025-02-15T12:00:00Z).
  • O campo IsBlocked é um valor booleano (true ou false) indicando se o cliente está bloqueado financeiramente.