FINANCIAL_RECEIPT_SEARCH | FINANCIAL Endpoint | |
/rpc/financial/?method=FINANCIAL_RECEIPT_SEARCH | ||
For information on how to use Advanced Searches, click here |
DETAILS | |||
Prefix | Receipt |
SUB SEARCHES | |||
ContactBusinessReceivedFrom | CONTACT_BUSINESS_SEARCH | ||
ContactPersonReceivedFrom | CONTACT_PERSON_SEARCH | ||
LineItem | FINANCIAL_ITEM_SEARCH | ||
SourceBankTransaction | FINANCIAL_BANK_ACCOUNT_TRANSACTION_SEARCH |
PARAMETERS | TYPE | NOTES | |
Amount | Numeric | ||
Area | Numeric | Linked area | |
AreaText | Text | ||
Balanced | Numeric | 1 / 0. See FINANCIAL_DEBTORSCREDITORS_PROCESSING_MANAGE | |
BankAccount | Numeric | ID of the Bank Account the Receipt was deposited into | |
BankAccountText | Text | See above | |
ContactBusinessReceivedFrom | Numeric | ID of the business contact that received from. | |
ContactBusinessReceivedFromText | Text | ||
ContactPersonReceivedFrom | Numeric | ID of the person contact that received from. | |
ContactPersonReceivedFromText | Text | ||
Id | Numeric | ||
Notes | Text | ||
Object | Numeric | ||
ObjectContext | Numeric | ||
ObjectText | Text | ||
OutstandingAmount | Numeric | Receipt Amount - Amount allocated to invoices | |
PaymentMethod | Numeric | You can define your own, or use the defaults eg. 1=Cheque,2=Visa or Mastercard,3=Direct Debit | |
PaymentMethodText | Text | See above | |
PaymentReferenceName | Text | Customer Payment Details - Customer Account Name / Credit Card Name / Drawer | |
PaymentReferenceNumber | Text | Customer Payment Details - Customer Account No / Credit Card No / Bank | |
PaymentReferenceOther | Text | Customer Payment Details - Customer BSB / Expiry Date / Branch | |
PaymentReferenceTransactionReference | Text | Customer Payment Details - Transaction Reference / Cheque Number | |
Project | Numeric | Linked Project | |
ProjectText | Text | See above | |
ReceivedDate | Date | ||
ReceivedDateTimeZone | Numeric | ||
ReceivedDateTimeZoneText | Text (50) | ||
Reconciliation | Numeric | ID of the associated bank reconciliation for the receipt. | |
ReconciliationText | Text | ||
Reference | Text | ||
SourceBankTransaction | Numeric | Can be set via FINANCIAL_RECONCILIATION_ITEM_MANAGE | |
SourceBankTransactionText | Text | ||
Tax | Numeric | ||
Standard System Parameters | Click here for more information |
EXAMPLE | |
1. Get the Reference, Receipt Amount, and Line Item Amount for all Receipts | |
var oAdvancedSearch = new AdvancedSearch(); oAdvancedSearch.endPoint = 'financial'; oAdvancedSearch.method = 'RECEIPT_SEARCH'; oAdvancedSearch.addField('receipt.reference,receipt.amount,receipt.lineitem.amount'); oAdvancedSearch.sort('reference', 'desc'); oAdvancedSearch.getResults(function(asData) { SearchComplete(asData);}); |