Sage One - Accounts - v3 UKI
Documentation of the Sage Business Cloud Accounting API.
Updates a Other Payment
Endpoint Availability
- Accounting Plus: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸
- Accounting Standard: 🇬🇧, 🇮🇪
- Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸
Access Control Restrictions
Requires the authenticated user to have any of the following roles in the area Bank: Restricted Access, Full Access
Request URL
Request parameters
string
The Other Payment Key.
Request headers
(optional)
string
Media type of the body sent to the API.
Request body
{
"other_payment": {
"transaction_type_id": "string",
"date": "string",
"total_amount": 0.0,
"base_currency_total_itc_amount": 0.0,
"total_itc_amount": 0.0,
"base_currency_total_itr_amount": 0.0,
"total_itr_amount": 0.0,
"part_recoverable": true,
"payment_method_id": "string",
"contact_id": "string",
"bank_account_id": "string",
"tax_address_region_id": "string",
"net_amount": 0.0,
"tax_amount": 0.0,
"reference": "string",
"withholding_tax_rate": 0.0,
"withholding_tax_amount": 0.0,
"payment_lines": [
{
"ledger_account_id": "string",
"total_amount": 0.0,
"details": "string",
"tax_rate_id": "string",
"net_amount": 0.0,
"tax_amount": 0.0,
"is_purchase_for_resale": true,
"trade_of_asset": true,
"gst_amount": 0.0,
"pst_amount": 0.0,
"tax_recoverable": true
}
]
}
}{
"type": "object",
"properties": {
"other_payment": {
"type": "object",
"properties": {
"transaction_type_id": {
"type": "string",
"description": "The transaction type of the payment"
},
"date": {
"type": "string",
"format": "date",
"description": "The date of the payment"
},
"total_amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment"
},
"base_currency_total_itc_amount": {
"type": "number",
"format": "double",
"description": "The total amount of input tax credit in base currency for the\n Other Payment (Canada only)"
},
"total_itc_amount": {
"type": "number",
"format": "double",
"description": "The total amount of input tax credit for the Other Payment (Canada only)"
},
"base_currency_total_itr_amount": {
"type": "number",
"format": "double",
"description": "The total amount of input tax refund in base currency for the\n Other Payment (Canada only)"
},
"total_itr_amount": {
"type": "number",
"format": "double",
"description": "The total amount of input tax refund for the Other Payment (Canada only)"
},
"part_recoverable": {
"type": "boolean",
"description": "Indicates if the Other Payment is part recoverable or not (Canada only)"
},
"payment_method_id": {
"type": "string",
"description": "The ID of the Payment Method."
},
"contact_id": {
"type": "string",
"description": "The ID of the Contact."
},
"bank_account_id": {
"type": "string",
"description": "The ID of the Bank Account."
},
"tax_address_region_id": {
"type": "string",
"description": "The ID of the Tax Address Region. (Canada only)"
},
"net_amount": {
"type": "number",
"format": "double",
"description": "The net amount of the payment"
},
"tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount of the payment"
},
"reference": {
"type": "string",
"description": "A reference of the payment"
},
"withholding_tax_rate": {
"type": "number",
"format": "double",
"description": "IRPF withheld tax rate"
},
"withholding_tax_amount": {
"type": "number",
"format": "double",
"description": "IRPF withheld tax amount"
},
"payment_lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ledger_account_id": {
"type": "string",
"description": "The ID of the Ledger Account."
},
"total_amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment line"
},
"details": {
"type": "string",
"description": "The details of the payment line"
},
"tax_rate_id": {
"type": "string",
"description": "The ID of the Tax Rate."
},
"net_amount": {
"type": "number",
"format": "double",
"description": "The net amount of the payment line"
},
"tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount of the payment line"
},
"is_purchase_for_resale": {
"type": "boolean",
"description": "Identifies whether the line item is for resale. (Ireland only)"
},
"trade_of_asset": {
"type": "boolean",
"description": "Whether the line item is marked as trade of asset."
},
"gst_amount": {
"type": "number",
"format": "double",
"description": "The gst or hst tax amount for the other payment"
},
"pst_amount": {
"type": "number",
"format": "double",
"description": "The pst or qst tax amount for the other payment"
},
"tax_recoverable": {
"type": "boolean",
"description": "Indicates if the other payment is tax recoverable or not"
}
}
}
}
}
}
},
"required": [
"other_payment"
],
"description": "Updates a Other Payment"
}Response 200
Updates a Other Payment
{
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string",
"created_at": "string",
"updated_at": "string",
"transaction": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"transaction_type": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"deleted_at": "string",
"base_currency_total_itc_amount": 0.0,
"total_itc_amount": 0.0,
"base_currency_total_itr_amount": 0.0,
"total_itr_amount": 0.0,
"part_recoverable": true,
"payment_method": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"contact": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"bank_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"tax_address_region": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"date": "string",
"net_amount": 0.0,
"tax_amount": 0.0,
"total_amount": 0.0,
"reference": "string",
"payment_lines": [
{
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"ledger_account": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"details": "string",
"tax_rate": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"net_amount": 0.0,
"tax_amount": 0.0,
"total_amount": 0.0,
"tax_breakdown": [
{
"tax_rate": {
"legacy_id": 0,
"id": "string",
"displayed_as": "string",
"$path": "string"
},
"percentage": 0.0,
"amount": 0.0
}
],
"is_purchase_for_resale": true,
"trade_of_asset": true,
"gst_amount": 0.0,
"pst_amount": 0.0,
"tax_recoverable": true
}
],
"editable": true,
"deletable": true,
"withholding_tax_rate": 0.0,
"withholding_tax_amount": 0.0
}{
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was created"
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was last updated"
},
"transaction": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The transaction for the item",
"x-sage-menusection": "Settings"
},
"transaction_type": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The transaction type of the payment",
"x-sage-menusection": "Settings"
},
"deleted_at": {
"type": "string",
"format": "date-time",
"description": "The datetime when the item was deleted"
},
"base_currency_total_itc_amount": {
"type": "number",
"format": "double",
"description": "The total amount of input tax credit in base currency for the\n Other Payment (Canada only)"
},
"total_itc_amount": {
"type": "number",
"format": "double",
"description": "The total amount of input tax credit for the Other Payment (Canada only)"
},
"base_currency_total_itr_amount": {
"type": "number",
"format": "double",
"description": "The total amount of input tax refund in base currency for the\n Other Payment (Canada only)"
},
"total_itr_amount": {
"type": "number",
"format": "double",
"description": "The total amount of input tax refund for the Other Payment (Canada only)"
},
"part_recoverable": {
"type": "boolean",
"description": "Indicates if the Other Payment is part recoverable or not (Canada only)"
},
"payment_method": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The payment method of the payment",
"x-sage-menusection": "Settings"
},
"contact": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The contact of the payment",
"x-sage-menusection": "Settings"
},
"bank_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The bank account of the payment",
"x-sage-menusection": "Settings"
},
"tax_address_region": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The address region for tax purposes (Canada only)",
"x-sage-menusection": "Settings"
},
"date": {
"type": "string",
"format": "date",
"description": "The date of the payment"
},
"net_amount": {
"type": "number",
"format": "double",
"description": "The net amount of the payment"
},
"tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount of the payment"
},
"total_amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment"
},
"reference": {
"type": "string",
"maxLength": 25,
"description": "A reference of the payment\nNote: An upper length limit of 25 or 40 characters is imposed conditionally and may not apply in every request. A hard upper limit of 255 characters is imposed by the storage layer, though."
},
"payment_lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"ledger_account": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The ledger account of the payment line",
"x-sage-menusection": "Settings"
},
"details": {
"type": "string",
"description": "The details of the payment line"
},
"tax_rate": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The tax rate of the payment line",
"x-sage-menusection": "Settings"
},
"net_amount": {
"type": "number",
"format": "double",
"description": "The net amount of the payment line"
},
"tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount of the payment line"
},
"total_amount": {
"type": "number",
"format": "double",
"description": "The total amount of the payment line"
},
"tax_breakdown": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tax_rate": {
"type": "object",
"properties": {
"legacy_id": {
"type": "integer",
"format": "int32",
"description": "The legacy ID for the item"
},
"id": {
"type": "string",
"description": "The unique identifier for the item"
},
"displayed_as": {
"type": "string",
"description": "The name of the resource"
},
"$path": {
"type": "string",
"description": "The API path for the resource"
}
},
"description": "The tax rate",
"x-sage-menusection": "Settings"
},
"percentage": {
"type": "number",
"format": "double",
"description": "The tax rate percentage"
},
"amount": {
"type": "number",
"format": "double",
"description": "The tax amount for the given tax rate"
}
}
},
"description": "The tax breakdown for the payment line"
},
"is_purchase_for_resale": {
"type": "boolean",
"description": "Identifies whether the line item is for resale. (Ireland only)"
},
"trade_of_asset": {
"type": "boolean",
"description": "Whether the line item is marked as trade of asset."
},
"gst_amount": {
"type": "number",
"format": "double",
"description": "The gst or hst tax amount for the other payment"
},
"pst_amount": {
"type": "number",
"format": "double",
"description": "The pst or qst tax amount for the other payment"
},
"tax_recoverable": {
"type": "boolean",
"description": "Indicates if the other payment is tax recoverable or not"
}
}
},
"description": "The payment lines of the payment"
},
"editable": {
"type": "boolean",
"description": "Indicates whether or not the payment can be edited"
},
"deletable": {
"type": "boolean",
"description": "Indicates whether or not the payment can be deleted"
},
"withholding_tax_rate": {
"type": "number",
"format": "double",
"description": "IRPF withheld tax rate"
},
"withholding_tax_amount": {
"type": "number",
"format": "double",
"description": "IRPF withheld tax amount"
}
},
"description": "### Endpoint Availability\n\n* Accounting Plus: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸\n* Accounting Standard: 🇬🇧, 🇮🇪\n* Accounting Start: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the area `Bank`: Restricted Access, Full Access",
"x-sage-menusection": "Bank, Payments & Receipts"
}Code samples
@ECHO OFF
curl -v -X PUT "https://api.columbus.sage.com/uki/sageone/accounts/v3/other_payments/{key}"
-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.columbus.sage.com/uki/sageone/accounts/v3/other_payments/{key}?" + 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.columbus.sage.com/uki/sageone/accounts/v3/other_payments/{key}");
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.columbus.sage.com/uki/sageone/accounts/v3/other_payments/{key}?" + $.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.columbus.sage.com/uki/sageone/accounts/v3/other_payments/{key}";
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.columbus.sage.com/uki/sageone/accounts/v3/other_payments/{key}');
$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.columbus.sage.com')
conn.request("PUT", "/uki/sageone/accounts/v3/other_payments/{key}?%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.columbus.sage.com')
conn.request("PUT", "/uki/sageone/accounts/v3/other_payments/{key}?%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.columbus.sage.com/uki/sageone/accounts/v3/other_payments/{key}')
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