Customer Financial Information

The GetCustomerFinancialInfo endpoint returns customer financial summary information in the MIMS system.

---

How to get customer financial summary information

HTTP GET Request

Request Type	Example URL
POST	{{url_base}}/GetCustomerFinancialInfo
Example	http://seuIPePorta/datasnap/rest/RESTWebServiceMethods/"GetCustomerFinancialInfo"

Input Parameters

Parameter	Type	Required	Description
CustomerNo	String(25)	Yes	External code of the customer
CustomerAuxiliaryNo	String(25)	No	Auxiliary external code of the customer

---

Return

Parameter	Type	Required	Description
WebServiceReturn	WebServiceReturn	Yes	Standard WebService response information in method execution
CustomerFinancialInfoData	GetCustomerFinancialInfoData	Yes	Object containing customer financial information

📝 GetCustomerFinancialInfoData Object

The GetCustomerFinancialInfoData object represents customer financial summary information.

Return Parameters

Parameter	Type	Required	Description
CreditTotal	Float	Yes	Total credit value
CreditUsage	Float	Yes	Used credit value
CreditEspecial	Float	Yes	Special credit value
CreditEspecialUsage	Float	Yes	Used special credit value
CreditDisponible	Float	Yes	Available credit value
OpenDocumentsQty	Integer	Yes	Quantity of open documents
OverdueDocumentsQty	Integer	Yes	Quantity of overdue documents
LastDocumentPaymentDate	DataHora	Yes	Last paid document date
LastDocumentPaymentNo	String(25)	Yes	Last paid document number
NextDocumentPaymentDate	DataHora	Yes	Next document payment date
NextDocumentPaymentNo	String(25)	Yes	Next document payment number
IsBlocked	Boolean	Yes	Flag indicating that the customer is blocked

---

Request Example

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

---

Response Example

{
  "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
  }
}

---

🐞 Possible Errors

Code	Message
CFR‑001	Customer financial records not found!

---