AddressPaymentsCalendar
This method returns the detail of all open documents for a given address for due date that is comprised in a given range of days.
BODY - RAW
{
"Method": "AddressPaymentsCalendar",
"Parameters": [
<nAddressId>,
<nFirstDueRange>,
[<nSecondDueRange>
]
}
PARAMETERS
| Parameters | Description |
|---|---|
| nAddressId | Id of the address. |
| nFirstDueRange | First limit to set up the due date range. The method returns all open documents with due date up to today + nFirstDueRange. |
| nSecondDueRange | (Optional) Second limit to set up the due date range. The method returns all open documents with a due date greater than today + nSecondDueRange. |
EXAMPLE
*/ Return all the payments due up to 30 days
{
"Method": "AddressPaymentsCalendar",
"Parameters": [
1234,
30
]
}
*/ Return all the payments due in more than 30 days
{
"Method": "AddressPaymentsCalendar",
"Parameters": [
1234,
0,
30
]
}
*/ Return all pending payments due in between 30 and 60 days
{
"Method": "AddressPaymentsCalendar",
"Parameters": [
1234,
60,
30
]
}
CLASS RETURNED
| Property | Description |
|---|---|
| DocumentType | Type of the document. The type can be : - 17 : Debtor starting balance - 20 : Debtor invoice - 22 : Credit note - 43 : Creditor starting balance - 44 : Creditor invoice - 47 : Creditor credit note |
| DocumentId | Id of the document |
| DocumentNumber | Number of the document. |
| DocumentDate | Date of the document |
| AddressId | Id of the address |
| Address | Company name, last name, first name, zip code and city of the address |
| LocalOpenAmount | Open amount in local currency |
| LocalPaidAmount | Paid amount in local currency |
| LocalTotalAmount | Total amount in local currency |
| ForeignOpenAmount | Open amount in foreign currency |
| ForeignPaidAmount | Paid amount in foreign currency |
| ForeignTotalAmount | Total amount in foreign currency |
| DueDate | DueDate |
| Term | Days up to the due date |
| DocumentCategory | Id of the document category |