Table of Contents
Contacts API v1
Overview
Customers API v2 endpoints provides you with more information about your Customers.
Suppliers API v2 endpoints provides you with more information about your Suppliers.
Superfunds API v2 endpoints provides you with more information about your Superfunds.
Contacts API v2 endpoints provides you with more information about your Contacts.
Employees API v2 endpoints provides you with more information about your Employees.
The contacts Id endpoint can be found at: https://api.reckon.com/R1/{BOOKId}/contacts/{ContactId}
Methods supported: GET, POST, PUT, DELETE
The Book Id represents the unique GUID of the Book the user wants to write data to. For example c1b3da90-e9df-4d57-8cfb-71a1d7bfe401
Reckon One Module | Endpoint | Additional Parameter(s) | HTTP Method | Request URL | Description | API Portal | Countries |
Core | /contactId | GET | Retrieve information about a contact. Note a contact in Reckon One can be a customer, supplier, employee or super fund | AU/NZ/UK | |||
Core | /contactId /activate | POST | Activate a contact | AU/NZ/UK | |||
Core | Contacts | /contactId /deactivate | POST | Deactivate a contact | AU/NZ/UK | ||
Core | Contacts |
| GET | Retrieve contacts list | AU/NZ/UK | ||
Core | Contacts |
| PUT | Update a contact | AU/NZ/UK | ||
Core | Contacts |
| POST | Create a contact | AU/NZ/UK | ||
Core | Contacts | /contactId | DELETE | Delete a contact | AU/NZ/UK |
Sample
Sample response
{
"ContactId":"01344311-de36-41af-98c9-4e70ab6f19e0",
"CashbookId":"c1b3da90-e9df-4d57-8cfb-71a1d7bfe401",
"PaymentTermId":null,
"CustomerCreditLimit":null,
"Description":"Brendon Green",
"FirstNameBranchName":"Brendo",
"SurnameBusinessName":"Gree",
"IsCustomer":true,
"IsSupplier":true,
"IsActive":false,
"IsPerson":true,
"Email":"test@test.com",
"Website":"http://www.google.com",
"BusinessNumber1":"123456789",
"Notes":"test",
"AreaCode":null,
"PhoneNumber":null,
"FaxCode":null,
"FaxNumber":"123456789",
"IsBusinessAddressDifferent":false,
"IsEmployee":false,
"Addresses":
[{"AddressId":"f01d1e4d-34c5-4e0c-90a5-44ce8999d4a8",
"Line1":"7 The Glen123",
"Line2":null,
"Town":null,
"Suburb":"Bordrton123",
"State":"ACT",
"Postcode":"1234",
"Country":null,
"AddressType":"Business",
"IsInternational":false},
{
"AddressId":"8f82e484-7583-40cd-a93d-22de5f23e1ac",
"Line1":"7 The Glen",
"Line2":null,
"Line3":"",
"Town":null,
"Suburb":"Borderton",
"State":"SA",
"Postcode":null,
"Country":null,
"AddressType":"Postal",
"IsInternational":true
}],
"LastModifiedDate": "2018-09-25T11:11:16.913"
}
Sample post
{
"CashbookId":"c1b3da90-e9df-4d57-8cfb-71a1d7bfe401",
"PaymentTermId":null,
"CustomerCreditLimit":null,
"Description":"Brendon Green",
"FirstNameBranchName":"Brendo",
"SurnameBusinessName":"Gree",
"IsCustomer":true,
"IsSupplier":true,
"IsActive":false,
"IsPerson":true,
"IsTpar":true,
"Email":"test@test.com",
"Website":"http://www.google.com",
"BusinessNumber1":"123456789",
"Notes":"test",
"AreaCode":null,
"PhoneNumber":null,
"FaxCode":null,
"FaxNumber":"123456789",
"IsBusinessAddressDifferent":false,
"IsEmployee":false,
"Addresses":
[{"AddressId":"f01d1e4d-34c5-4e0c-90a5-44ce8999d4a8",
"Line1":"7 The Glen 123",
"Line2":null,
"Line3":"",
"Town":null,
"Suburb":"Bordrton123",
"State":"ACT",
"Postcode":"1234",
"Country":null,
"AddressType":"Business",
"IsInternational":false},
{"AddressId":"8f82e484-7583-40cd-a93d-22de5f23e1ac",
"Line1":"7 The Glen",
"Line2":null,
"Town":null,
"Suburb":"Borderton",
"State":"SA",
"Postcode":null,
"Country":null,
"AddressType":"Postal",
"IsInternational":true}]
}
Sample Minimum payload
The below payload will create a customer with minimum information:
{
"Description":"Officeworks",
"FirstNameBranchName":"Scott",
"SurnameBusinessName":"Anderson",
"IsCustomer":true
}
Details of each object
Data Field | Description | Data Type | Mandatory? |
ContactId | Unique Id for Contact in the Reckon One Database ** | GUID | Required for PUT not POST |
CashBookId | Unique Id for the Book (File) in the Reckon One Database | GUID | No |
PaymentTermId | Unique Id for the Payment Term that is set against the contact in the Reckon One Book. | GUID | No |
CustomerCreditLimit | Credit Limit set against the contact in the Reckon One Book | Numeric | No |
Description | Description for the contact the user has entered into the Reckon One Book | Alphanumeric | Yes |
FirstNameBranchName | If personal :First name of the contact If business: Branch name/number of the business | Alphanumeric | No |
SurnameBusinessName | If personal: Last name of the contact If business: Business name | Alphanumeric | Yes |
IsCustomer | Whether the contact is set to a customer type | Boolean (True/False) | Required if the contact type is Customer |
IsSupplier | Whether the contact is set to a supplier type | Boolean (True/False) | Required if the contact type is Supplier |
IsEmployee | Type of contact is Employee. The contact must be set as "IsPerson = true" as it requires first and last name. Only available for Type = IsPerson (Individual). | Boolean (True/False) | Required if the contact type is Employee |
isActive | Whether the contact is set to active in the book | Boolean (True/False) | No. If you don't pass it, the contact is set as Inactive by default |
IsPerson | Whether the contact is set as a personal (Individual in the UI) or business contact. True indicates Personal, False indicates Business | Boolean (True/False) | No. if you don't pass it, the contact is set as Business by default |
IsTpar | Whether the contact will appear on the Taxable Payments Annual Report | Boolean (True/False) | No |
Email address for the contact | Alphanumeric | No | |
Website | Website of the contact | Alphanumeric | No |
Businessnumber1 | Tax registration number of the business. AU = ABN, NZ = IRD, UK = VAT | Numeric (with UI validation) | No |
Notes | Notes against the contact | Alphanumeric | No |
Areacode | Area code for the phone number | Numeric | No |
PhoneNumber | Phone number of the contact | Numeric | No. Required if passed AreaCode |
MobileCode | The prefix of the mobile number for the region. In Australia this is typically 04 and in New Zealand 021 | Numeric | No |
MobileNumber | The Number of the Mobile phone minus the prefix | Numeric | No. Required if passed MobileCode |
FaxCode | Area code of the fax number for the contact | Numeric | No. |
FaxNumber | Fax number for the contact | Numeric | No. Required if passed FaxCode |
IsBusinessAddressDifferent | Indicates whether there is multiple addresses set for the contact | Boolean (True/False) | No |
Address Array | Each address is contained in an array | N/A | No |
AddressId | Unique id stored in the Reckon One book to identify the address. | GUID | No |
Line1 | Line1 of the address in the contact | Alphanumeric | No |
Line2 | Line2 of the address in the contact | Alphanumeric | No |
Line3 | Not currently available in AU, NZ, UK books | Alphanumeric | No |
Town | Town/City of the address in the contact (not used for AU addresses) | Alphanumeric | No |
Suburb | Suburb of the address in the contact (required for AU Addresses) | Alphanumeric | No |
State | State of the address in the contact (County in UK eg Cambridgeshire) | Alphanumeric | No |
Postcode | Postcode of the address in the contact | Numeric | No |
Country | Country of the address in the contact | Alphanumeric | No |
AddressType | Type of the address set in the contact | Boolean (Postal/Business) | Required only if you pass Address Array |
IsInternational | Whether the address is a international address or not. | Boolean (True/False) | Required only if you pass Address Array |
Contact List
Methods supported: GET
The Book Id represents the unique GUID of the Book the user wants to write data to. For example c1b3da90-e9df-4d57-8cfb-71a1d7bfe401
Sample response
{"ContactId":"01344311-de36-41af-98c9-4e70ab6f19e0",
"CashbookId":"c1b3da90-e9df-4d57-8cfb-71a1d7bfe401",
"PaymentTermId":null,
"CustomerCreditLimit":null,
“IsTpar":true,
"Description":"Brendon Green",
"FirstNameBranchName":"Brendo",
"SurnameBusinessName":"Green",
"IsCustomer":true,
"IsSupplier":true,
"IsActive":false,
"IsPerson":true,
"Email":"test@test.com",
"Website":"http://www.google.com",
"BusinessNumber1":"123456789",
"Notes":"test",
"AreaCode":null,
"PhoneNumber":null,
"FaxCode":null,
"FaxNumber":"123456789",
"IsBusinessAddressDifferent":false,
"IsEmployee":false,
"Addresses":
[{"AddressId":"f01d1e4d-34c5-4e0c-90a5-44ce8999d4a8",
"Line1":"7 The Glen 123",
"Line2":null,
"Town":null,
"Suburb":"Bordrton123",
"State":"ACT",
"Postcode":"1234",
"Country":null,
"AddressType":"Business",
"IsInternational":false},
{"AddressId":"8f82e484-7583-40cd-a93d-22de5f23e1ac",
"Line1":"7 The Glen",
"Line2":null,
"Line3":"",
"Town":null,
"Suburb":"Borderton",
"State":"SA",
"Postcode":null,
"Country":null,
"AddressType":"Postal",
"IsInternational":true}],
"LastModifiedDate": "2018-09-25T11:11:16.913"}Details of each object
Data Field | Description | Data Type |
ContactId | Unique Id for Contact in the Reckon One Database ** Required for PUT not POST | GUID |
CashBookId | Unique Id for the Book (File) in the Reckon One Database | GUID |
PaymentTermId | Unique Id for the Payment Term that is set against the contact in the Reckon One Book. | GUID |
CustomerCreditLimit | Credit Limit set against the contact in the Reckon One Book | Numeric |
IsTpar | Whether the contact is to be included in the Taxable Payments Annual Report | Boolean (True/False) |
Description | Description for the contact the user has entered into the Reckon One Book | Alphanumeric |
FirstNameBranchName | If personal :First name of the contact If business: Branch name/number of the business | Alphanumeric |
SurnameBusinessName | If personal: Last name of the contact If business: Business name | Alphanumeric |
IsCustomer | Whether the contact is set to a customer type | Boolean (True/False) |
IsSupplier | Whether the contact is set to a supplier type | Boolean (True/False) |
IsEmployee | Type of contact is Employee. The contact must be set as "IsPerson = true" as it requires first and last name. Only available for Type = IsPerson (Individual). | Boolean (True/False) |
isActive | Whether the contact is set to active in the book | Boolean (True/False) |
IsPerson | Whether the contact is set as a personal (individual in the UI) or business contact. True indicates Personal, False indicates Business | Boolean (True/False) |
Email address for the contact | Alphanumeric | |
Website | Website of the contact | Alphanumeric |
Businessnumber1 | Tax registration number of the business. AU = ABN, NZ = IRD, UK = VAT | Numeric |
Notes | Notes against the contact | Alphanumeric |
Area code | Area code for the phone number | Numeric |
PhoneNumber | Phone number of the contact | Numeric |
MobileCode | The prefix of the mobile number for the region. In Australia this is typically 04 and in New Zealand 021 | Numeric |
MobileNumber | The Number of the Mobile phone minus the prefix | Numeric |
FaxCode | Area code of the fax number for the contact | Numeric |
FaxNumber | Fax number for the contact | Numeric |
IsBusinessAddressDifferent | Indicates whether there is multiple addresses set for the contact
| Boolean (True/False) |
Address Array | Each address is contained in an array | N/A |
AddressId | Unique id stored in the Reckon One book to identify the address | GUID |
Line1 | Line1 of the address in the contact | Alphanumeric |
Line2 | Line2 of the address in the contact | Alphanumeric |
Line3 | Not currently available in AU, NZ, UK books | Alphanumeric |
Town | Town/City of the address in the contact (not used for AU addresses) | Alphanumeric |
Suburb | Suburb of the address in the contact (required for AU Addresses) | Alphanumeric |
State | State of the address in the contact (County in UK eg Cambridgeshire) | Alphanumeric |
Postcode | Postcode of the address in the contact | Numeric |
Country | Country of the address in the contact | Alphanumeric |
AddressType | Type of the address set in the contact | Boolean (Personal/Business) |
IsInternational | Whether the address is a international address or not. | Boolean (True/False) |
LastModifiedDate | NEW - Last modified date and time of the Contact record | UTC |
