URL https://app.fundraiserone.net/api/v1/ContactImport/
Lookups URL https://app.fundraiserone.net/api/v1/Customer/Lookups
Methods Supported POST
Request
HEADER
ContentType : application/json
SecretKey : [Your API Key]
Parameters:
BatchID Numeric - Identifies the batch transactions will be applied. System also creates an automatic batch as required when blank.
ProductID Numeric - Sets the default ProductID for transactions.
OperaionID Numeric - Sets the Operation for transactions.
EmailTemplateID Numeric - Sets an email template merges and sends it. Optional
PrintTemplateID Numeric - When used together with the EmailTemplateID it receipts the Transaction and sends the receipt. Optional
Contact Import Body Definitions:
Fundraiser ID | 21234345 | FundraiserOne's ID - Used to to match with existing records. Optional |
Title | Title of the donor to be imported. | |
FirstName | Victoria | First name of the donor to be imported. |
Lastname | Smith | Surname of the donor to be imported. |
Date of Birth | 15/05/1985 | Date of Birth of the donor to be imported. Must be formatted dd/MM/yyyy. |
Gender | Female | Gender of the donor to be imported. |
Address | 40 Somewhere Road | Address of the donor to be imported. |
Suburb | Miramar | Suburb of the donor to be imported. |
City | Wellington | City of the donor to be imported. |
Country | New Zealand | Country of the donor to be imported. |
Postcode | 6022 | |
Home Phone | ||
Work Phone | ||
Mobile Phone | ||
The API will set Receipt Method to email if an email address exists here by default. Can be changed using New Receipt Method. | ||
Amount | 10.00 | Amount of once off or regular gift. Leave Blank if there is no gift. |
Frequency | Once Off | Leave blank if there is no gift. |
Payment Method | Credit Card | |
Card Type | ||
Card Token | 12323456 | Card Tokens used for recharging credit cards. |
PlanID | Stored to Bank Statement Account. | |
Bank | ANZ | |
Account Name | J Smith | Account name to Bank Statement Name and Account Name. |
Account Number | 0334344863674800 | |
Start Date | 20/06/2023 | The Regular Payment start date must be formatted dd/MM/yyyy. Can not be back date from import date. |
Lead Source | Contact Source | Import will add the contact source if it doesn't exist. |
Sign Up Date | 20/06/2023 | |
Opt-In (Phone) | Yes or No | Opt-in Phone communications yes or no can used here. |
Opt-In (Email) | Yes or No | Opt-in Email communications yes or no can used here. |
Opt-In (SMS) | Yes or No | Opt-in SMS communications yes or no can used here. |
Opt-In (Post) | Yes or No | Opt-in Post communications yes or no can used here. |
Notes | Will add this note into the notes section of the contact. | |
Card Name | ||
Card Number | ||
Card Expiry | 12/2028 | |
Region | Import will add the region if it doesn't exist. | |
Organisation | Name of the organisation. | |
Contact Type | Name of the Type. Defaults to Individual when blank. | |
Contact Group | Adds and assigns a contact group. | |
Anonymous | Yes or No | Assigns the transactions to the system selected anonymous contact. |
Code Example:
Body{{ "BatchId": 12, "ProductId": 1, "OperationId": 10, "EmailTemplateID": 66, "PrintTemplateID": 85, "ContactImport": [ { "CustomerID": "12323", "Title": "Mr", "FirstName": "John", "LastName": "Smith", "DateOfBirth": "25/05/1987", "Gender": "Male", "AddressStreet": "12 Broadway", "AddressSuburb": "Miramar", "AddressCity": "Wellington", "AddressCountry": "New Zealand", "AddressPostcode": "6002", "HomePhone": "+64555 6567", "WorkPhone": "", "MobilePhone": "+64 215 5678", "Email": "jsmith@example.com", "Amount": "10.00", "Frequency": "Monthly", "PaymentMethod": "Credit Card", "CardType": "Visa", "CardToken": "232345", "PlanID": "", "Bank": "", "AccountName": "", "AccountNumber": "", "StartDate": "30/11/2028", "LeadSource": "ABC", "SignUpDate": "20/11/2028", "OptinPhone": "Yes", "OptinEmail": "No", "OptinSMS": "Yes", "OptinPost": "No", "Notes": "", "CardName": "J Smith", "CardNumber": "0000 00.. .... 0000", "CardExpiry": "07/27", "Region": "", "Organisation": "", "ContactType": "Board Member", "ContactGroup": "Golf", "Anonymous": "Yes" } }Response{ "Successful": true, "Message": "1 record(s) added"}