Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Updates an existing supplier.

Update an existing supplier.

PUT /e7e3ba02-05e2-4bea-9348-85876c9952ba/suppliers/2a8cd401-5e6d-47d4-b5f0-011ff387dd59

Try it

Request

Request URL

Request parameters

  • string

    Format - guid. The book's id.

  • string

    Format - guid. The suppliers's id.

  • (optional)
    string

    The external resource's id.

  • (optional)
    string

    Format - guid. The external client application's id.

  • (optional)
    string

    The external book/file/tenancy/etc's id.

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Details of the updated supplier.

{
  "name": "John Doe",
  "organisationName": "null",
  "branch": "null",
  "notes": "null",
  "businessNumber1": "null",
  "businessNumber2": "null",
  "businessNumber": "null",
  "status": "Active",
  "addresses": "null",
  "phoneNumbers": "null",
  "electronicAddresses": "null",
  "entityTypes": {
    "IsCustomer": false,
    "IsSupplier": true,
    "IsEmployee": false,
    "IsSuperfund": false
  },
  "isTpar": true,
  "bankDetails": "null"
}
{
  "required": [
    "name"
  ],
  "type": "object",
  "properties": {
    "name": {
      "maxLength": 100,
      "minLength": 1,
      "type": "string",
      "description": "The organisation's display name.",
      "example": "John Doe"
    },
    "organisationName": {
      "maxLength": 100,
      "type": "string",
      "description": "The organisation's name.",
      "default": "null",
      "nullable": true,
      "example": "Reckon Co."
    },
    "branch": {
      "maxLength": 100,
      "type": "string",
      "description": "The organisation's branch.",
      "default": "null",
      "nullable": true,
      "example": "1234"
    },
    "notes": {
      "maxLength": 1000,
      "type": "string",
      "description": "Notes for the organisation.",
      "default": "null",
      "nullable": true,
      "example": "The person to call."
    },
    "businessNumber1": {
      "maxLength": 20,
      "type": "string",
      "description": "The organisation's business number 1.",
      "default": "null",
      "nullable": true,
      "example": "0218001234"
    },
    "businessNumber2": {
      "maxLength": 20,
      "type": "string",
      "description": "The organisation's business number 2.",
      "default": "null",
      "nullable": true,
      "example": "0218001234"
    },
    "businessNumber": {
      "maxLength": 20,
      "type": "string",
      "description": "This applies to NZBN number.",
      "default": "null",
      "nullable": true,
      "example": "0218001234123"
    },
    "status": {
      "oneOf": [
        {
          "enum": [
            "Active",
            "Inactive"
          ],
          "type": "string",
          "description": "The status of an organisation.",
          "x-enumNames": [
            "Active",
            "Inactive"
          ]
        }
      ],
      "description": "The status of the organisation. (Active/Inactive)",
      "default": "Active",
      "nullable": true,
      "example": "Active"
    },
    "addresses": {
      "type": "array",
      "items": {
        "required": [
          "type"
        ],
        "type": "object",
        "properties": {
          "line1": {
            "maxLength": 80,
            "type": "string",
            "description": "Line 1 of the address.",
            "default": "null",
            "nullable": true,
            "example": "Level 2"
          },
          "line2": {
            "maxLength": 80,
            "type": "string",
            "description": "Line 2 of the address.",
            "default": "null",
            "nullable": true,
            "example": "100 Pacific Highway"
          },
          "line3": {
            "maxLength": 80,
            "type": "string",
            "description": "Line 3 of the address.",
            "default": "null",
            "nullable": true,
            "example": "Line 3"
          },
          "suburb": {
            "maxLength": 80,
            "type": "string",
            "description": "The suburb.",
            "default": "null",
            "nullable": true,
            "example": "North Sydney"
          },
          "town": {
            "maxLength": 80,
            "type": "string",
            "description": "The town.",
            "default": "null",
            "nullable": true,
            "example": "Sydney"
          },
          "state": {
            "maxLength": 80,
            "type": "string",
            "description": "The state.",
            "default": "null",
            "nullable": true,
            "example": "NSW"
          },
          "postcode": {
            "maxLength": 30,
            "type": "string",
            "description": "The post code.",
            "default": "null",
            "nullable": true,
            "example": "2060"
          },
          "country": {
            "maxLength": 30,
            "type": "string",
            "description": "The country.",
            "default": "null",
            "nullable": true,
            "example": "Australia"
          },
          "type": {
            "minLength": 1,
            "type": "string",
            "description": "The id or name of the address type.",
            "example": "Billing"
          }
        },
        "additionalProperties": false,
        "description": "Details of an address to create or update."
      },
      "description": "List of addresses.",
      "default": "null",
      "nullable": true
    },
    "phoneNumbers": {
      "type": "array",
      "items": {
        "required": [
          "type"
        ],
        "type": "object",
        "properties": {
          "countryCode": {
            "maxLength": 10,
            "type": "string",
            "description": "The country code.",
            "default": "null",
            "nullable": true,
            "example": "61"
          },
          "areaCode": {
            "maxLength": 10,
            "type": "string",
            "description": "The area code.",
            "default": "null",
            "nullable": true,
            "example": "02"
          },
          "number": {
            "maxLength": 30,
            "type": "string",
            "description": "The number.",
            "default": "null",
            "nullable": true,
            "example": "90101234"
          },
          "extension": {
            "maxLength": 10,
            "type": "string",
            "description": "The extension.",
            "default": "null",
            "nullable": true,
            "example": "4321"
          },
          "type": {
            "minLength": 1,
            "type": "string",
            "description": "The id or name of the phone number type.",
            "example": "Work"
          }
        },
        "additionalProperties": false,
        "description": "Details of a phone number to create or update."
      },
      "description": "List of phone numbers.",
      "default": "null",
      "nullable": true
    },
    "electronicAddresses": {
      "type": "array",
      "items": {
        "required": [
          "type"
        ],
        "type": "object",
        "properties": {
          "type": {
            "minLength": 1,
            "type": "string",
            "description": "The id or name of the electronic address type.",
            "example": "Email"
          },
          "address": {
            "maxLength": 100,
            "type": "string",
            "description": "The electronic address.",
            "default": "null",
            "nullable": true,
            "example": "x@y.com"
          }
        },
        "additionalProperties": false,
        "description": "Details of an electronic address to create or update."
      },
      "description": "List of electronic addresses.",
      "default": "null",
      "nullable": true
    },
    "entityTypes": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "isCustomer": {
              "type": "boolean",
              "description": "Is the entity a customer.",
              "default": false,
              "nullable": true,
              "example": false
            },
            "isSupplier": {
              "type": "boolean",
              "description": "Is the entity a suppleir.",
              "default": false,
              "nullable": true,
              "example": false
            },
            "isEmployee": {
              "type": "boolean",
              "description": "Is the entity an employee.",
              "default": false,
              "nullable": true,
              "example": false
            },
            "isSuperfund": {
              "type": "boolean",
              "description": "Is the entity a superfund.",
              "default": false,
              "nullable": true,
              "example": false
            }
          },
          "additionalProperties": false,
          "description": "Contact's entity types."
        }
      ],
      "description": "The organisation's entity types.",
      "nullable": true,
      "example": {
        "IsCustomer": false,
        "IsSupplier": true,
        "IsEmployee": false,
        "IsSuperfund": false
      }
    },
    "isTpar": {
      "type": "boolean",
      "description": "If the supplier is Tpar.",
      "example": true
    },
    "bankDetails": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "name": {
              "maxLength": 50,
              "type": "string",
              "description": "The bank account's name.",
              "default": "null",
              "nullable": true,
              "example": "My bank account"
            },
            "bankBranchNumber": {
              "maxLength": 10,
              "pattern": "^[0-9]*$",
              "type": "string",
              "description": "The bank account's branch number.",
              "default": "null",
              "nullable": true,
              "example": "123456"
            },
            "bankAccountNumber": {
              "maxLength": 50,
              "pattern": "^[0-9]*$",
              "type": "string",
              "description": "The bank account's number.",
              "default": "null",
              "nullable": true,
              "example": "444555"
            }
          },
          "additionalProperties": false,
          "description": "Details of a supplier's bank account to create or update."
        }
      ],
      "description": "The supplier's bank account details.",
      "default": "null",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Details of a supplier to create or update."
}

Responses

204 No Content

The result of the update.

400 Bad Request

The supplier could not be updated as the request contains invalid data.

Representations

{
  "message": "Something went wrong.",
  "code": 400,
  "errorCode": "General.NotFound",
  "errors": [
    {
      "location": "password",
      "message": "The value entered is not a valid password.",
      "errorCode": "General.DuplicateValue"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "The description of the error.",
      "nullable": true,
      "example": "Something went wrong."
    },
    "code": {
      "type": "integer",
      "description": "The HTTP status code of the error.",
      "format": "int32",
      "example": 400
    },
    "errorCode": {
      "type": "string",
      "description": "The error code.",
      "nullable": true,
      "example": "General.NotFound"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "location": {
            "type": "string",
            "description": "The location/path of the source of the error.",
            "nullable": true,
            "example": "password"
          },
          "message": {
            "type": "string",
            "description": "The description of what was wrong at this location.",
            "nullable": true,
            "example": "The value entered is not a valid password."
          },
          "errorCode": {
            "type": "string",
            "description": "The error code.",
            "nullable": true,
            "example": "General.DuplicateValue"
          }
        },
        "additionalProperties": false,
        "description": "Details of a specific error."
      },
      "description": "An array of specific errors where relevant.",
      "nullable": true
    }
  },
  "additionalProperties": false,
  "description": "Response sent when an error occurs."
}

401 Unauthorized

The authentication token is missing, expired or invalid.

Representations

{
  "message": "Authorization has been denied for this request.",
  "code": 401
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "The description of the error.",
      "nullable": true,
      "example": "Authorization has been denied for this request."
    },
    "code": {
      "type": "integer",
      "description": "The HTTP status code of the error.",
      "format": "int32",
      "example": 401
    }
  },
  "additionalProperties": false,
  "description": "Response sent when a 401 Unauthorized error occurs."
}

403 Forbidden

The user does not have permission to update the supplier.

Representations

{
  "message": "User does not have permission to access this resource.",
  "code": 403
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "The description of the error.",
      "nullable": true,
      "example": "User does not have permission to access this resource."
    },
    "code": {
      "type": "integer",
      "description": "The HTTP status code of the error.",
      "format": "int32",
      "example": 403
    }
  },
  "additionalProperties": false,
  "description": "Response sent when a 403 Forbidden error occurs."
}

404 Not Found

The specified book or supplier does not exist.

Representations

{
  "message": "Resource not found.",
  "code": 404
}
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "The description of the error.",
      "nullable": true,
      "example": "Resource not found."
    },
    "code": {
      "type": "integer",
      "description": "The HTTP status code of the error.",
      "format": "int32",
      "example": 404
    }
  },
  "additionalProperties": false,
  "description": "Response sent when a 404 Forbidden error occurs."
}

Code samples

@ECHO OFF

curl -v -X PUT "https://api.reckon.com/r1/v2/{bookId}/suppliers/{supplierId}?ExternalResourceId={string}&ExternalClientId={string}&ExternalTenancyId={string}"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["ExternalResourceId"] = "{string}";
            queryString["ExternalClientId"] = "{string}";
            queryString["ExternalTenancyId"] = "{string}";
            var uri = "https://api.reckon.com/r1/v2/{bookId}/suppliers/{supplierId}?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
                content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
                response = await client.PutAsync(uri, content);
            }
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.reckon.com/r1/v2/{bookId}/suppliers/{supplierId}");

            builder.setParameter("ExternalResourceId", "{string}");
            builder.setParameter("ExternalClientId", "{string}");
            builder.setParameter("ExternalTenancyId", "{string}");

            URI uri = builder.build();
            HttpPut request = new HttpPut(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "ExternalResourceId": "{string}",
            "ExternalClientId": "{string}",
            "ExternalTenancyId": "{string}",
        };
      
        $.ajax({
            url: "https://api.reckon.com/r1/v2/{bookId}/suppliers/{supplierId}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.reckon.com/r1/v2/{bookId}/suppliers/{supplierId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"ExternalResourceId={string}",
                         @"ExternalClientId={string}",
                         @"ExternalTenancyId={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PUT"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.reckon.com/r1/v2/{bookId}/suppliers/{supplierId}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'ExternalResourceId' => '{string}',
    'ExternalClientId' => '{string}',
    'ExternalTenancyId' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_PUT);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'ExternalResourceId': '{string}',
    'ExternalClientId': '{string}',
    'ExternalTenancyId': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.reckon.com')
    conn.request("PUT", "/r1/v2/{bookId}/suppliers/{supplierId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'ExternalResourceId': '{string}',
    'ExternalClientId': '{string}',
    'ExternalTenancyId': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.reckon.com')
    conn.request("PUT", "/r1/v2/{bookId}/suppliers/{supplierId}?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.reckon.com/r1/v2/{bookId}/suppliers/{supplierId}')

query = URI.encode_www_form({
    # Request parameters
    'ExternalResourceId' => '{string}',
    'ExternalClientId' => '{string}',
    'ExternalTenancyId' => '{string}'
})

if uri.query && uri.query.length > 0
    uri.query += '&' + query
else
    uri.query = query
end

request = Net::HTTP::Put.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body