Reckon One API v2

API change history

This is version 2 of the Reckon One API.

Updates an existing invoice.

Update an existing invoice.

POST /5af6572c-9771-4b86-995d-3374d3bc683c/invoices/e6abf51e-2052-43c7-be02-4146cbfe9d00

Try it

Request

Request URL

Request parameters

  • string

    Format - guid. The book's id.

  • string

    Format - guid. The invoice'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 invoice.

{
  "customer": "Company Ltd",
  "invoiceDate": "2020-02-06T12:00:00Z",
  "dueDate": "null",
  "invoiceDiscountAmount": "null",
  "invoiceDiscountPercent": "null",
  "amountTaxStatus": "Inclusive",
  "paymentTerms": "The customer's default payment terms",
  "reference": "null",
  "accountsReceivableLedgerAccount": "The default Accounts Receivable account",
  "classification": "null",
  "template": "null",
  "lineItems": [
    {
      "lineNumber": 2,
      "serviceDate": "null",
      "project": "null",
      "itemDetails": "null",
      "accountDetails": "null",
      "description": "null",
      "taxAmount": "null",
      "taxRate": "null",
      "taxIsModified": "null"
    }
  ],
  "notes": "null",
  "paymentDetails": "null"
}
{
  "required": [
    "customer",
    "invoiceDate",
    "amountTaxStatus",
    "lineItems",
    "template"
  ],
  "type": "object",
  "properties": {
    "customer": {
      "minLength": 1,
      "type": "string",
      "description": "The customer that is being invoiced.",
      "example": "Company Ltd"
    },
    "invoiceDate": {
      "minLength": 1,
      "type": "string",
      "description": "The date of the invoice.",
      "format": "date-time",
      "example": "2020-02-06T12:00:00Z"
    },
    "dueDate": {
      "type": "string",
      "description": "The date payment is due by.",
      "format": "date-time",
      "default": "null",
      "nullable": true,
      "example": "2020-03-06T12:00:00Z"
    },
    "invoiceDiscountAmount": {
      "type": "number",
      "description": "The invoice discount amount.",
      "format": "decimal",
      "default": "null",
      "nullable": true,
      "example": 10.0
    },
    "invoiceDiscountPercent": {
      "type": "number",
      "description": "The invoice discount percentage.",
      "format": "decimal",
      "default": "null",
      "nullable": true,
      "example": 7.5
    },
    "amountTaxStatus": {
      "oneOf": [
        {
          "enum": [
            "NonTaxed",
            "Inclusive",
            "Exclusive"
          ],
          "type": "string",
          "description": "The tax status of an amount.",
          "x-enumNames": [
            "NonTaxed",
            "Inclusive",
            "Exclusive"
          ]
        }
      ],
      "description": "The amount tax status of the amounts in the invoice.",
      "example": "Inclusive"
    },
    "paymentTerms": {
      "type": "string",
      "description": "Payment terms.",
      "default": "The customer's default payment terms",
      "nullable": true,
      "example": "30 days net"
    },
    "reference": {
      "type": "string",
      "description": "The invoice reference.",
      "default": "null",
      "nullable": true,
      "example": "My reference"
    },
    "accountsReceivableLedgerAccount": {
      "type": "string",
      "description": "The accounts receivable ledger account.\n_Note:_ It is not currently possible to create multiple Accounts Receivable accounts so this field is read-only and will be ignored.",
      "default": "The default Accounts Receivable account",
      "nullable": true,
      "readOnly": true,
      "example": "Accounts Receivable"
    },
    "classification": {
      "type": "string",
      "description": "The classification.",
      "default": "null",
      "nullable": true,
      "example": "My classification"
    },
    "template": {
      "minLength": 1,
      "type": "string",
      "description": "The template used to print or email the invoice.",
      "default": "null",
      "example": "Professional invoice"
    },
    "lineItems": {
      "type": "array",
      "items": {
        "required": [
          "lineNumber"
        ],
        "type": "object",
        "properties": {
          "lineNumber": {
            "type": "integer",
            "description": "The line number.",
            "format": "int32",
            "example": 2
          },
          "serviceDate": {
            "type": "string",
            "description": "The date when the service was provided.",
            "format": "date-time",
            "default": "null",
            "nullable": true,
            "example": "2020-01-01T12:00:00Z"
          },
          "project": {
            "type": "string",
            "description": "The id or full name of the project that the line item relates to.\nNote that the full name includes the name(s) of any parent project(s) separated by colons.",
            "default": "null",
            "nullable": true,
            "example": "Project A:Project B:Project C"
          },
          "itemDetails": {
            "oneOf": [
              {
                "required": [
                  "item"
                ],
                "type": "object",
                "properties": {
                  "item": {
                    "minLength": 1,
                    "type": "string",
                    "description": "The id or full name of the item that the line relates to.\nNote that the full name includes the name(s) of any parent item(s) separated by colons.",
                    "example": "Parent item:Child item"
                  },
                  "price": {
                    "type": "number",
                    "description": "The price of each item including or excluding tax (depending on the `amountTaxStatus`).",
                    "format": "decimal",
                    "default": "null",
                    "nullable": true,
                    "example": 5.5
                  },
                  "quantity": {
                    "type": "number",
                    "description": "The quantity purchased.",
                    "format": "decimal",
                    "default": "nulll",
                    "nullable": true,
                    "example": 1.0
                  },
                  "discountAmount": {
                    "type": "number",
                    "description": "The total discount for the line item.",
                    "format": "decimal",
                    "default": "null",
                    "nullable": true,
                    "example": 10.0
                  },
                  "discountPercent": {
                    "type": "number",
                    "description": "The discount percentage for the line item.",
                    "format": "decimal",
                    "default": "null",
                    "nullable": true,
                    "example": 25.0
                  },
                  "billableId": {
                    "type": "string",
                    "description": "The id related to a billable line item.",
                    "format": "guid",
                    "nullable": true,
                    "example": "511650E7-A0C6-46ED-A2EE-EEAE711E167C"
                  }
                },
                "additionalProperties": false,
                "description": "Details of an item used on an invoice line item."
              }
            ],
            "description": "Details of an item used on an invoice line item.\nThis must be omitted if `accountDetails` have been provided.",
            "default": "null",
            "nullable": true
          },
          "accountDetails": {
            "oneOf": [
              {
                "required": [
                  "ledgerAccount"
                ],
                "type": "object",
                "properties": {
                  "ledgerAccount": {
                    "minLength": 1,
                    "type": "string",
                    "description": "The id or full name of the ledger account that the line relates to.\nNote that the full name includes the name(s) of any parent account(s) separated by colons.",
                    "example": "Income:Sub income"
                  },
                  "quantity": {
                    "type": "number",
                    "description": "The quantity purchased.",
                    "format": "decimal",
                    "default": "nulll",
                    "nullable": true,
                    "example": 1.0
                  },
                  "amount": {
                    "type": "number",
                    "description": "The amount including or excluding tax (depending on the `amountTaxStatus`).",
                    "format": "decimal",
                    "default": 0.0,
                    "nullable": true,
                    "example": 110.0
                  }
                },
                "additionalProperties": false,
                "description": "Details of an account used on an invoice line item."
              }
            ],
            "description": "Details of an account used on an invoice line item.\nThis must be omitted if `itemDetails` have been provided.",
            "default": "null",
            "nullable": true
          },
          "description": {
            "type": "string",
            "description": "The description of the line.",
            "default": "null",
            "nullable": true,
            "example": "This is my new line"
          },
          "taxAmount": {
            "type": "number",
            "description": "The tax amount.",
            "format": "decimal",
            "default": "null",
            "nullable": true,
            "example": 10.0
          },
          "taxRate": {
            "type": "string",
            "description": "The tax rate.",
            "default": "null",
            "nullable": true,
            "example": "GST"
          },
          "taxIsModified": {
            "type": "boolean",
            "description": "Whether the tax amount has been modified.",
            "default": "null",
            "nullable": true,
            "readOnly": true,
            "example": false
          }
        },
        "additionalProperties": false,
        "description": "Details of an invoice line item to create or update."
      },
      "description": "The individual items that make up the invoice.\nNote that the maximum items is 200."
    },
    "notes": {
      "type": "string",
      "description": "Notes related to the invoice.",
      "default": "null",
      "nullable": true,
      "example": "This is a note."
    },
    "paymentDetails": {
      "type": "string",
      "description": "Details of how to pay the invoice.",
      "default": "null",
      "nullable": true,
      "example": "BSB 134-456, Account 987654"
    }
  },
  "additionalProperties": false,
  "description": "Details of an invoice to update."
}

Responses

204 No Content

The result of the update.

400 Bad Request

The invoice 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 edit invoices.

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 invoice 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}/invoices/{invoiceId}"
-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}");

            var uri = "https://api.reckon.com/r1/v2/{bookId}/invoices/{invoiceId}?" + 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}/invoices/{invoiceId}");


            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
        };
      
        $.ajax({
            url: "https://api.reckon.com/r1/v2/{bookId}/invoices/{invoiceId}?" + $.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}/invoices/{invoiceId}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    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}/invoices/{invoiceId}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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({
})

try:
    conn = httplib.HTTPSConnection('api.reckon.com')
    conn.request("PUT", "/r1/v2/{bookId}/invoices/{invoiceId}?%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({
})

try:
    conn = http.client.HTTPSConnection('api.reckon.com')
    conn.request("PUT", "/r1/v2/{bookId}/invoices/{invoiceId}?%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}/invoices/{invoiceId}')

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