PendingPayments
This method returns the number of the open (unpaid) documents along with the open (unpaid) amount in the local currency. The results grouped by document type and payment delay. Up to three different delays can be passed as a parameter.
BODY - RAW
{
"Method": "PendingPayments",
"Parameters": [
<dFirstIntervalLimit>,
[<nSecondIntervalLimit>,
<nThirdIntervalLimit>]
]
}
Parameters
| Parameters | Description |
|---|---|
| nFirstIntervalLimit |
Mandatory This parameter allows to specify a first group of late payments. The method will return the documents for which the payments are late, up to the number of days specified in the parameter. The delay is calculated from the due date. If documents with multiple due dates exist, each due date is taken into consideration. |
| nSecondIntervalLimit |
Optional This parameter allows to specify a first group of late payments. The interval taken into consideration is the one between nFirstIntervalLimit+1 and the number of days passed as parameter here. |
| nThirdIntervalLimit |
Optional Third limit to set up the delay intervals. The method returns all open documents with a delay between the second and third interval limit, and all open documents with a delay greater than this interval limit. |
Remark: The method will also always return the payments that have a delay bigger than the bigger delay specified in the parameters.
EXAMPLE
*/ Return all pending payments for the intervals [0-30 days] - > 30 days
{
"Method": "PendingPayments",
"Parameters": [
30
]
}
*/ Return all pending payments for the intervals [0-30 days] - [31-60 days] - > 60 days
{
"Method": "PendingPayments",
"Parameters": [
30,
60
]
}
*/ Return all pending payments for the intervals [0-30 days] - [31-60 days] - [61-90 days] - > 90 days
{
"Method": "PendingPayments",
"Parameters": [
30,
60,
90
]
}
CLASS RETURNED
| Property | Description |
|---|---|
| DocumentType |
Type of the document. The type can be : |
| Delay |
Interval of the delay |
| OpenDocuments | Count of open documents for each DocumentType and Delay |
| LocalOpenAmount | Sum of the open amounts for each DocumentType and Delay |