Atoka API User Reference

Companies package "Payment Indicators"

API tokens are configured to access only the packages each user needs; this means you might not have access to the content of this package. Ask your sales contact!

Available fields
Description
Data
Used by filters
Facet
Match
Stats
amountCollected

Amount collected by the Payline participant

 - -
amountCollected.q1

Amount collected in the 1st quarter (relative to referenceTimePeriod)

 float -
amountCollected.q2

Amount collected in the 2nd quarter (relative to referenceTimePeriod)

 float -
amountCollected.q3

Amount collected in the 3rd quarter (relative to referenceTimePeriod)

 float -
amountCollected.q4

Amount collected in the 4th quarter (relative to referenceTimePeriod)

 float -
amountOverdue

Total amount of payments yet to be paid by the customers, with an overdue of more than 0 days (a copy of openItems > amount > overdueTotal)

 float -
avgDaysOverdue

Average customers payment delay; when a value is missing, no payments were recorded in the given period of time.

 - -
avgDaysOverdue.over12Months

Average customers payment delay calculated over the 12-month observation period

 int -
avgDaysOverdue.q1

Average customers payment delay in the 1st quarter (relative to referenceTimePeriod)

 int -
avgDaysOverdue.q2

Average customers payment delay in the 2nd quarter (relative to referenceTimePeriod)

 int -
avgDaysOverdue.q3

Average customers payment delay in the 3rd quarter (relative to referenceTimePeriod)

 int -
avgDaysOverdue.q4

Average customers payment delay in the 4th quarter (relative to referenceTimePeriod)

 int -
avgDaysPaymentTerms

Agreed average payment time

 - -
avgDaysPaymentTerms.q1

Agreed average payment time 1st quarter (relative to referenceTimePeriod)

 int -
avgDaysPaymentTerms.q2

Agreed average payment time 2nd quarter (relative to referenceTimePeriod)

 int -
avgDaysPaymentTerms.q3

Agreed average payment time 3rd quarter (relative to referenceTimePeriod)

 int -
avgDaysPaymentTerms.q4

Agreed average payment time 4th quarter (relative to referenceTimePeriod)

 int -
avgDaysTakenToPay

Average of actual payment days, weighed on to the amount collected

 - -
avgDaysTakenToPay.q1

Average of actual payment, weighed on to the amount collected, in the 1st quarter (relative to referenceTimePeriod)

 int -
avgDaysTakenToPay.q2

Average of actual payment, weighed on to the amount collected, in the 2nd quarter (relative to referenceTimePeriod)

 int -
avgDaysTakenToPay.q3

Average of actual payment, weighed on to the amount collected, in the 3rd quarter (relative to referenceTimePeriod)

 int -
avgDaysTakenToPay.q4

Average of actual payment, weighed on to the amount collected, in the 4th quarter (relative to referenceTimePeriod)

 int -
balance

Total amount of payments yet to be paid by the customers (a copy of openItems > amount > total)

 float -
closedItems

Payments paid by the customers

 - -
closedItems.amount.from1To30Days

Amount of payments paid by the customers, with an overdue of <= 30 days

 float -
closedItems.amount.from31To60Days

Amount of payments paid by the customers, with an overdue of <= 60 days

 float -
closedItems.amount.from61To90Days

Amount of payments paid by the customers, with an overdue of <= 90 days

 float -
closedItems.amount.notOverdue

Amount of payments paid by the customers, with no overdue

 float -
closedItems.amount.over90Days

Amount of payments paid by the customers, with an overdue of more than 90 days

 float -
closedItems.amount.total

Total amount of payments paid by the customers

 float -
closedItems.count.from1To30Days

Number of payments paid by the customers, with an overdue of <= 30 days

 int -
closedItems.count.from31To60Days

Number of payments paid by the customers, with an overdue of <= 30 days

 int -
closedItems.count.from61To90Days

Number of payments paid by the customers, with an overdue of <= 30 days

 int -
closedItems.count.notOverdue

Number of payments paid by the customers, with no overdue

 int -
closedItems.count.over90Days

Number of payments paid by the customers, with an overdue of more than 90 days

 int -
openItems

Payments yet to be paid by the customers

 - -
openItems.amount.from1To30Days

Amount of payments yet to be paid by the customers, with an overdue of <= 30 days

 float -
openItems.amount.from31To60Days

Amount of payments yet to be paid by the customers, with an overdue of <= 60 days

 float -
openItems.amount.from61To90Days

Amount of payments yet to be paid by the customers, with an overdue of <= 90 days

 float -
openItems.amount.notOverdue

Amount of payments yet to be paid by the customers, with no overdue

 float -
openItems.amount.over90Days

Amount of payments yet to be paid by the customers, with an overdue of more than 90 days

 float -
openItems.amount.overdueTotal

Total amount of payments yet to be paid by the customers, with an overdue of more than 0 days

 float -
openItems.amount.total

Total amount of payments yet to be paid by the customers

 float -
openItems.count.from1To30Days

Number of payments yet to be paid by the customers, with an overdue of <= 30 days

 int -
openItems.count.from31To60Days

Number of payments yet to be paid by the customers, with an overdue of <= 60 days

 int -
openItems.count.from61To90Days

Number of payments yet to be paid by the customers, with an overdue of <= 90 days

 int -
openItems.count.notOverdue

Number of payments yet to be paid by the customers, with no overdue

 int -
openItems.count.over90Days

Number of payments yet to be paid by the customers, with an overdue of more than 90 days

 int -
paymentRecords

Record of payments paid or yet to be paid

 - -
paymentRecords.countExpired

Total number of payments yet to be paid by the customers

 int -
paymentRecords.countNotExpired

Total number of payments paid by the customers

 int -
paymentRecords.expiredIncidence

Percentage of yet to be paid over total

 float -
referenceDate

First day of the last month of the 12 months considered by the indicators

 date -
referenceTimePeriod.endDate

Last day of the last month of the 12 months considered by the indicators

 date -
referenceTimePeriod.startDate

First day of the first month of the 12 months considered by the indicators

 date -
revenue.max

The maximum amount of a single payment over the 12 months of closed or open partite contabili

 float -
revenue.min

The minimum amount of a single payment over the 12 months of closed or open partite contabili

 float -
revenue.value

Revenue (open + closed) items

 float -
totalItems

Total amount of payments

 int -
trend

Trend related to payments

 - -
trend.class

Trend class, ranging from -2 to 2

 "-2", "-1", "0", "1", "2" -
trend.label

Trend class label

 "Peggioramento consistente", "Peggioramento leggero", "Stazionario", "Miglioramento leggero", ... -
Example JSON fragment for package
{
"referenceTimePeriod": {
"startDate": "2015-12-24",
"endDate": "2015-12-24"
},
"referenceDate": "2015-12-24",
"amountCollected": {
"q1": 0.42,
"q2": 0.42,
"q3": 0.42,
"q4": 0.42
},
"amountOverdue": 0.42,
"balance": 0.42,
"avgDaysPaymentTerms": {
"q1": 42,
"q2": 42,
"q3": 42,
"q4": 42
},
"avgDaysOverdue": {
"q1": 42,
"q2": 42,
"q3": 42,
"q4": 42,
"over12Months": 42
},
"avgDaysTakenToPay": {
"q1": 42,
"q2": 42,
"q3": 42,
"q4": 42
},
"closedItems": {
"amount": {
"total": 0.42,
"notOverdue": 0.42,
"from1To30Days": 0.42,
"from31To60Days": 0.42,
"from61To90Days": 0.42,
"over90Days": 0.42
},
"count": {
"notOverdue": 42,
"from1To30Days": 42,
"from31To60Days": 42,
"from61To90Days": 42,
"over90Days": 42
}
},
"openItems": {
"amount": {
"total": 0.42,
"notOverdue": 0.42,
"from1To30Days": 0.42,
"from31To60Days": 0.42,
"from61To90Days": 0.42,
"over90Days": 0.42,
"overdueTotal": 0.42
},
"count": {
"notOverdue": 42,
"from1To30Days": 42,
"from31To60Days": 42,
"from61To90Days": 42,
"over90Days": 42
}
},
"paymentRecords": {
"countExpired": 42,
"countNotExpired": 42,
"expiredIncidence": 0.42
},
"revenue": {
"min": 0.42,
"max": 0.42,
"value": 0.42
},
"totalItems": 42,
"trend": {
"class": "-2",
"label": "Peggioramento consistente"
}
}