PaymentsCalendar
This method returns the number of the due documents along with due amount in the local currency. The results grouped by document type and payment due date. Up to three different ranges can be passed as a parameter to filter the documents.
BODY - RAW
{
"Method": "PaymentsCalendar",
"Parameters": [
<dFirstDueRange>,
[<nSecondDueRange>,
<nThirdDueRange>]
]
}
PARAMETERS
| Parameters | Description |
|---|---|
| nFirstDueRange |
Mandatory This parameter allows to specify a first range to filter on the due date. The method will return the documents for which the payments are due in the days between today and today + nFrstDueRange. If documents with multiple due dates exist, each due date is taken into consideration separetely. |
| nSecondDueRange |
Optional This parameter allows to specify a second range to filter on the due date. The range taken into consideration is the one between nFirstDueTerm+1 and the number of days passed as parameter here. All the documents with a due date comprised in that range will be grouped together. |
| nThirdDueRange |
Optional Third range of to filter on the due date. The method returns all the due documents with a due date between the second and third due range, and all the open documents with a due date greater than today + nThirdDue Range. |
Remark: The method will also always return the payments that have a due date bigger than the bigger due term specified in the parameters.
EXAMPLE
*/ Return all the payments due in the next 30 days, and the payments due in more than 30 days
{
"Method": "PaymentsCalendar",
"Parameters": [
30
]
}
*/ Return all the payments due in the next 30 days, all the payments due between 31 and 60 days from today, and all the payments due in more than 60 days from now.
{
"Method": "PaymentsCalendar",
"Parameters": [
30,
60
]
}
*/ Return all the payments due in the next 30 days, all the payments due between 31 and 60 days from today, all the payments due bewtween 61 and 90 days from now and all the payments due in more than 90 days from now.
{
"Method": "PaymentsCalendar",
"Parameters": [
30,
60,
90
]
}
CLASS RETURNED
| Property | Description |
|---|---|
| DocumentType |
Type of the document. The type can be : |
| Term |
Days up to the due date. |
| OpenDocuments |
Count of open documents for each DocumentType and Term. |
| LocalOpenAmount |
Sum of the open amounts for each DocumentType and Term |