AddressesPendingPayments
This method returns the number of the open (unpaid) documents along with the open (unpaid) amount in the local currency. The results are grouped by address of the document, document type and payment delay.
BODY - RAW
{
"Method": "AddressesPendingPayments",
"Parameters": [
<nDelayTo>,
[<nDelayFrom>]
]
}
Parameters
| Parameters | Description |
|---|---|
| nDelayTo | Mandatory This parameter allows to specify the maximal delay of the payments included in the results. The delay is calculated from the due date. If documents with multiple due dates exist, each due date is taken into consideration. |
| nDelayFrom | Optional This parameter allows to specify the minimal delay of the payments included in the results. If the parameter is omitted, all the documents with a delay smaller than the one specified in nDelayTo will be included. |
EXAMPLE
*/ Return all pending payments for the intervals [0-30 days]
{
"Method": "AddressesPendingPayments",
"Parameters": [
30
]
}
*/ Return all pending payments for the interval > 30 days
{
"Method": "AddressesPendingPayments",
"Parameters": [
0,
30
]
}
*/ Return all pending payments for the interval [31-60 days]
{
"Method": "AddressesPendingPayments",
"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. |
| Delay | Interval of te delay |
| OpenDocuments | Count of the open documents for each AddressId, DocumentType and Delay |
| LocalOpenAmount | Sum of the open amounts for each AddressId, DocumentType and Delay |