Skip to main content

Informações Financeiras do Cliente

Descrição

O endpoint GetCustomerFinancialInfo obtém um resumo financeiro do cliente no sistema MIMS.


Request HTTP GET

Tipo da RequisiçãoURL Exemplo
POST{{url_base}}/GetCustomerFinancialInfo
Exemplohttp://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetCustomerFinancialInfo"

Parâmetros de Entrada

ParâmetroTipoObrigatórioDescrição
CustomerNoString(25)SimCódigo Externo do Cliente

Retorno

ParâmetroTipoObrigatórioDescrição
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

O objeto GetCustomerFinancialInfoData representa um resumo financeiro do cliente no sistema MIMS.

Parâmetros de retorno

ParâmetroTipoObrigatórioDescrição
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
}
}