AddressesPaymentsCalendar
This method returns the number of the due documents along with the due amount in the local currency. The results are grouped by address of the document, document type and payment due date.
BODY - RAW
{
"Method": "AddressesPaymentsCalendar",
"Parameters": [
<nDueTo>,
[<nDueFrom>]
]
}
PARAMETERS
| Parameters | Description |
|---|---|
| nDueTo |
Mandatory The documents with a due date between today and today + nDueTo will be insluded in the results. If documents with multiple due dates exist, each due date is taken into consideration separately. |
| nDueFrom |
Optional The documents with a due date greater than today + nDueFrom will be included in the results. |
EXAMPLE
*/ Return all the payments due in the next 30 days
{
"Method": "AddressesPaymentsCalendar",
"Parameters": [
30
]
}
*/ Return all the payments due in more than 30 days
{
"Method": "AddressesPaymentsCalendar",
"Parameters": [
0,
30
]
}
*/ Return all the payments due between 31 and 60 days
{
"Method": "AddressesPaymentsCalendar",
"Parameters": [
60,
31
]
}
CLASS RETURNED
| Property | Description |
|---|---|
| DocumentType |
Type of the document. The type can be : |
| AddressId |
Id of the address |
| Address |
Company name, last name, first name, zip code and city of the address. |
| Term |
Days up to the due date |
| OpenDocuments | Count of the open documents for each AddressId, DocumentType and Delay |
| LocalOpenAmount | Sum of the open amounts for each AddressId, DocumentType and Delay |