Table of Contents
Company Info
Overview
Settings API v2 endpoints provides you with more information about your book, including the Company information. You can retrieve the Books settings as well as update the selected settings.
Allows you to read the company information and update the Physical and/Legal address of the book you have requested API data from.
Reckon One Module | Endpoint | Additional Parameter(s) | HTTP Method | Request URL | API Portal | Countries |
Core | Company Info |
| GET | https://api.reckon.com/R1/{cashbookid}/companyinfo | AU/NZ/UK | |
Core | Company Info |
| PUT | https://api.reckon.com/R1/{cashbookid}/companyinfo | AU/NZ/UK | |
Core | Company Info | /address | PUT | https://api.reckon.com/R1/{cashbookid}/companyinfo | AU/NZ/UK |
(GET) Company info Sample Response
Endpoint: https://api.reckon.com/R1/{cashbookid}/companyinfo
Method: GET
Authorization: Bearer {token},
Content-Type: application/json,
{
"BranchNumber": "003",
"CashbookId": "e673d490-4571-4a45-895m-8e0cbf11r8799",
"CompanyId": "4adef29c-7531-4bcd-8cf5-8677d000z9853",
"CompanyName": "Wyee Point Marina",
"CompanyReference": null,
"ContactEmail": "admin@wyeeppointmarina.com.au",
"ContactName": "Peter Peters",
"FaxCode": "01",
"FaxNumber": "43591802",
"LegalAddress": {
"AddressId": "33678678-d09c-4370-a540-2a8694c9d1d3",
"Line1": "PO Box 695",
"Line2": null,
"Line3": null,
"Town": null,
"Suburb": "BELMONT",
"State": "NSW",
"Postcode": "2280",
"Country": null,
"AddressType": null,
"IsInternational": null
},
"LegalName": "PP & MJ Peters T/As",
"MobileCode": null,
"MobileNumber": null,
"PhoneCode": "01",
"PhoneNumber": "43591800",
"PhysicalAddress": {
"AddressId": "cbbd0138-44d5-4286-ad73-7f5aa0866c83",
"Line1": "Unit 17",
"Line2": "77 Rutleys Rd",
"Line3": null,
"Town": null,
"Suburb": "WYEE POINT",
"State": "NSW",
"Postcode": "2259",
"Country": null,
"AddressType": null,
"IsInternational": null
},
"TaxNumber": "17569956631",
"Website": "www.wyeepointmarina.com.au"
}
(PUT) Update Company Info
Endpoint: https://api.reckon.com/R1/{cashbookid}/companyinfo
Method: PUT
Authorization: Bearer {token},
Content-Type: application/json,
{
"BranchNumber": "001",
"CompanyName": "My Company",
"CompanyReference": null,
"ContactEmail": "myemail@address.com",
"ContactName": "Ifti Chowdhury",
"FaxCode": "02",
"FaxNumber": "95123456",
"LegalAddress": {
"Line1": "100 Pacific Highway",
"Line2": null,
"Line3": null,
"Town": null,
"Suburb": "North Sydney",
"State": "NSW",
"Postcode": "2060",
"Country": null,
"AddressType": null,
"IsInternational": false
},
"LegalName": "Ifti Pty Ltd",
"MobileCode": null,
"MobileNumber": null,
"PhoneCode": "02",
"PhoneNumber": "95123456",
"PhysicalAddress": {
"Line1": "100 Pacific Highway",
"Line2": null,
"Line3": null,
"Town": null,
"Suburb": "North Sydney",
"State": "NSW",
"Postcode": "2060",
"Country": "",
"AddressType": null,
"IsInternational": false
},
"TaxNumber": "99 999 999 999",
"Website": "www.reckon.com"
}
If the API call is successful, you will receive a 200 OK response.
If you don't send the value of an object via the PUT method, the data of that object then becomes blank (NULL) in the Book, even though the object wasn't mandatory.
For example: If your Book had a Company name and you don't pass any value for CompanyName in your PUT request, then the Company name in the book will become blank.
Details of each object
Data Field | Description | Data Type | Comments |
BranchNumber | The Branch number of the Book | Alphanumeric |
|
CompanyName | The Company name of the tax group | Alphanumeric |
|
CompanyReference | Not in use at the moment. You can pass the value as null or ignore this object |
|
|
ContactEmail | Contact person's Email address from the Contact details tab | Alphanumeric |
|
ContactName | Contact person's Contact name from the Contact details tab | Alphanumeric |
|
FaxCode | Fax Code | Number |
|
FaxNumber | Fax Number | Number |
|
LegalAddress | Legal Address section |
|
|
Line1 | Line 1 of the Legal address | Alphanumeric |
|
Line2 | Line 2 of the Legal address | Alphanumeric |
|
Line3 | Not in use |
|
|
Town | Town/City of the Legal address (not used for AU addresses) | Alphanumeric |
|
Suburb | Suburb of the Legal address | Alphanumeric |
|
State | State of the Legal address | Alphanumeric |
|
Postcode | Postcode of the Legal address |
|
|
Country | Country of the Legal address | Alphanumeric |
|
AddressType | Not in use at the moment. You can pass the value as null or ignore this object |
|
|
IsInternational | Boolean that defines whether the Legal address is National or International | Boolean (True/False) | It's a mandatory object |
LegalName | Legal name of the Book from General details tab | Alphanumeric |
|
MobileCode | Mobile code from Contact details tab | Number |
|
MobileNumber | Mobile number from Contact details tab | Number |
|
PhoneCode | Phone code from Contact details tab |
|
|
PhoneNumber | Phone number from Contact details tab |
|
|
PhysicalAddress | Physical Address section |
|
|
Line1 | Line 1 of the Physical address | Alphanumeric |
|
Line2 | Line 2 of the Physical address | Alphanumeric |
|
Line3 | Not in use |
|
|
Town | Town/City of the Physical address (not used for AU addresses) | Alphanumeric |
|
Suburb | Suburb of the Physical address | Alphanumeric |
|
State | State of the Physical address | Alphanumeric |
|
Postcode | Postcode of the Physical address |
|
|
Country | Country of the Physical address | Alphanumeric |
|
AddressType | Not in use at the moment. You can pass the value as null or ignore this object |
|
|
IsInternational | Boolean that defines whether the Legal address is National or International | Boolean (True/False) | It's a mandatory object |
TaxNumber | Business number of the Book from General details tab | Alphanumeric |
|
Website | Website from Contact details tab | Alphanumeric |
|
(PUT) Update Company's Legal and/Physical Address ONLY
Endpoint: https://api.reckon.com/R1/{cashbookid}/companyinfo/address
Method: PUT
Authorization: Bearer {token}
Content-Type: application/json
{
"LegalAddress":{
"Line1": "100 Pacific Highway",
"Line2": "",
"Line3": null,
"Town": "North Sydney",
"Suburb": "North Sydney",
"State": "New South Wales",
"Postcode": "2060",
"Country": "Australia",
"IsInternational": false
},
"PhysicalAddress":{
"Line1":"1 Sydney Way",
"Line2":"",
"Line3":"",
"Town":"Sydney",
"Suburb":"Sydney",
"State":"New South Wales",
"Postcode":"2000",
"Country":"",
"IsInternational":false
},
"PhysicalSameAsLegal": false
}If the API call is successful, you will receive a 200 OK response.
