GET
/
v1
/
Business
/
PaymentSummary
/
Monthly
Returns the Payment Summary for the Business
curl --request GET \
  --url https://api.creditriskmonitor.com/v1/Business/PaymentSummary/Monthly \
  --header 'Authorization: Bearer <token>'
{
  "Success": true,
  "Data": [
    {
      "CategoryName": "<string>",
      "CategoryCode": "<string>",
      "MonthReported": "<string>",
      "Accounts": 123,
      "DBTIndex": 123,
      "AverageDBTIndex": 123,
      "TotalDue": 123,
      "CurrentAmount": 123,
      "PastDue30Days": 123,
      "PastDue60Days": 123,
      "PastDue90Days": 123,
      "PastDueOver90Days": 123,
      "OtherAmount": 123,
      "CreditBalance": 123,
      "CurrentAmountPercent": 123,
      "PastDue30DaysPercent": 123,
      "PastDue60DaysPercent": 123,
      "PastDue90DaysPercent": 123,
      "PastDueOver90DaysPercent": 123,
      "OtherAmountPercent": 123
    }
  ],
  "ErrorCode": "<string>"
}
Use the Login endpoint to retrieve the SessionKey, then include it in the Authorization field for authentication.

Authorizations

​
Authorization
string
header
required

Enter the Session Key with the Bearer prefix, e.g. "Bearer abcde12345".

Query Parameters

​
id
integer

ID of the Business to get the Payment Summary for.

​
CustomerId
string

If you are a Trade Provider you can use your CustomerId to idenfity a Business with the CustomerId parameter.

​
SupplierId
string

If you have a Supplier List you can use your SupplierId to identify a Business with the SupplierId parameter.

Response

200
application/json

OK