| FINANCIAL_DEBTOR_SEARCH | FINANCIAL Endpoint | |
| /rpc/financial/?method=FINANCIAL_DEBTOR_SEARCH | ||
| Get a list of debtors. Note: This is not an advanced search. |
| PARAMETERS | TYPE | ||
| Area | Numeric | Id of the Linked Area | |
| AreaType | Numeric | 1=Based On Contact Record,2=Based on Financial Record | |
| ContactBusiness | Numeric | ||
| ContactPerson | Numeric | ||
| CustomerRating | Numeric | There are standard values, plus you can define your own. eg. 1=A,2=B,3=C,4=AA | |
| EndDate | date | As at date, ie only include Invoices etc on or before this date | |
| RelationshipManager | Numeric | A contact person | |
| ReportBy | Numeric | 1=Total [Default],3=Total Detailed,4=Aged,5=Total Unallocated | |
| SortDirection | Text | Ascending (or Asc) [default],Descending (or Desc) | |
| SortField | Text | DebtorName (or Name) [default],Total | |
| View | Numeric | 1=Traditional,2=Based on Due Date |
| RETURN - All ReportBy | ||
| DebtorName | Will be either the contact business tradename, or contact person surname / firstname | |
| DebtorType | Either 'B' for business, 'P' for person | |
| Id |
| RETURN - 1=Total | ||
| LastReceiptDate | ||
| Total |
| RETURN - 3=Total Detailed | ||
| LastReceiptAmount | ||
| LastReceiptDate | ||
| Total | ||
| TotalCreditNotes | ||
| TotalInvoiced | ||
| TotalReceipted |
| RETURN - 4=Aged | ||
| Note: | In addition to the 31-60 columns, suggested captions for each of these values are provided in the header, eg 31-60Description | |
| 31-60 | ||
| 61-90 | ||
| 91 | Only returned for View=1 | |
| Current | ||
| LastReceiptAmount | ||
| LastReceiptDate | ||
| NotYetDue | Only returned for View=2 | |
| Total |
| RETURN - 5=Total Unallocated | ||
| LastReceiptAmount | ||
| LastReceiptDate | ||
| Total | ||
| UnallocatedReceipts |
| RETURN - Totals | ||
| [As above] | Each totallable column is also returned in the Totals section |