Informações Financeiras do Cliente

O endpoint GetCustomerFinancialInfo retorna as informações do resumo financeiro do cliente no sistema MIMS.

---

Como buscar informações do resumo financeiro do cliente

Request HTTP GET

Tipo da Requisição	URL Exemplo
POST	{{url_base}}/GetCustomerFinancialInfo
Exemplo	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetCustomerFinancialInfo"

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

---

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
CustomerFinancialInfoData	GetCustomerFinancialInfoData	Sim	Objeto contendo as informações do financeiro do cliente

📝 Objeto GetCustomerFinancialInfoData

O objeto GetCustomerFinancialInfoData representa as informações do resumo financeiro do cliente.

Parâmetros de Retorno

Parâmetro	Tipo	Obrigatório	Descrição
CreditTotal	Float	Sim	Valor do crédito total
CreditUsage	Float	Sim	Valor do crédito usado
CreditEspecial	Float	Sim	Valor do crédito especial
CreditEspecialUsage	Float	Sim	Valor do crédito especial usado
CreditDisponible	Float	Sim	Valor do crédito disponível
OpenDocumentsQty	Integer	Sim	Quantidade de títulos em aberto
OverdueDocumentsQty	Integer	Sim	Quantidade de títulos em atraso
LastDocumentPaymentDate	DataHora	Sim	Data do último título pago
LastDocumentPaymentNo	String(25)	Sim	Número do último título pago
NextDocumentPaymentDate	DataHora	Sim	Data do próximo título a pagar
NextDocumentPaymentNo	String(25)	Sim	Número do próximo título a pagar
IsBlocked	Boolean	Sim	Flag que indica que o cliente está bloqueado

---

Exemplo de Request

curl --location 'http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetCustomerFinancialInfo"' \
--header 'Content-Type: application/json' \
--data '
{
    "CustomerNo": "118771"
}'

---

Exemplo de Response

{
  "WebServiceReturn": {
      "Status": "wrsSuccess",
      "ErrorCode": "",
      "Message": "",
      "Actor": "",
      "ReturnQuestion": null
  },
  "CustomerFinancialInfoData": {
      "CreditTotal": 0.0,
      "CreditUsage": 0.0,
      "CreditEspecial": 0.0,
      "CreditEspecialUsage": 0.0,
      "CreditDisponible": 0.0,
      "OpenDocumentsQty": 0,
      "OverdueDocumentsQty": 0,
      "LastDocumentPaymentDate": null,
      "LastDocumentPaymentNo": "",
      "NextDocumentPaymentDate": null,
      "NextDocumentPaymentNo": "",
      "IsBlocked": false
  }
}

---

🐞 Possíveis Erros

Código	Mensagem
CFR‑001	Registros financeiros do cliente não encontrados!

---