Sage One - Accounts - v3 CA
Documentation of the Sage Business Cloud Accounting API.
Updates a Sales Credit Note
Endpoint Availability
- Accounting Plus: 🇨🇦, 🇩🇪, 🇫🇷, 🇮🇪, 🇬🇧, 🇺🇸
Access Control Restrictions
Requires the authenticated user to have any of the following roles in the area Sales: Full Access, Restricted Access
Request URL
Request parameters
string
The Sales Credit Note Key.
Request headers
(optional)
string
Media type of the body sent to the API.
Request body
{
"sales_credit_note": {
"contact_id": "string",
"date": "string",
"vat_reverse_charge": true,
"destination_consignment": true,
"cis_applicable_amount": 0.0,
"base_currency_cis_applicable_amount": 0.0,
"total_after_cis_deduction": 0.0,
"base_currency_total_after_cis_deduction": 0.0,
"credit_note_number_prefix": "string",
"credit_note_number": "string",
"contact_name": "string",
"contact_reference": "string",
"original_invoice_date": "string",
"reference": "string",
"notes": "string",
"terms_and_conditions": "string",
"shipping_net_amount": 0.0,
"shipping_tax_rate_id": "string",
"shipping_tax_amount": 0.0,
"total_quantity": 0.0,
"shipping_total_amount": 0.0,
"net_amount": 0.0,
"tax_amount": 0.0,
"total_amount": 0.0,
"currency_id": "string",
"exchange_rate": 0.0,
"inverse_exchange_rate": 0.0,
"base_currency_shipping_net_amount": 0.0,
"base_currency_shipping_tax_amount": 0.0,
"base_currency_shipping_total_amount": 0.0,
"total_discount_amount": 0.0,
"base_currency_total_discount_amount": 0.0,
"base_currency_net_amount": 0.0,
"base_currency_tax_amount": 0.0,
"base_currency_total_amount": 0.0,
"status_id": "string",
"sent": true,
"tax_address_region_id": "string",
"withholding_tax_rate": 0.0,
"withholding_tax_amount": 0.0,
"base_currency_withholding_tax_amount": 0.0,
"main_address": {
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"postal_code": "string",
"country_id": "string",
"address_type_id": "string",
"region": "string",
"country_group_id": "string"
},
"delivery_address": {
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"postal_code": "string",
"country_id": "string",
"address_type_id": "string",
"region": "string",
"country_group_id": "string"
},
"credit_note_lines": [
{
"description": "string",
"ledger_account_id": "string",
"unit_price": 0.0,
"product_id": "string",
"service_id": "string",
"trade_of_asset": true,
"quantity": 0.0,
"net_amount": 0.0,
"tax_rate_id": "string",
"tax_amount": 0.0,
"total_amount": 0.0,
"base_currency_unit_price": 0.0,
"unit_price_includes_tax": true,
"base_currency_net_amount": 0.0,
"base_currency_tax_amount": 0.0,
"base_currency_total_amount": 0.0,
"eu_goods_services_type_id": "string",
"discount_amount": 0.0,
"base_currency_discount_amount": 0.0,
"discount_percentage": 0.0,
"eu_sales_description_id": "string"
}
],
"tax_analysis": [
{
"tax_rate_id": "string",
"net_amount": 0.0,
"tax_amount": 0.0,
"total_amount": 0.0,
"goods_amount": 0.0,
"service_amount": 0.0
}
]
}
}{
"type": "object",
"properties": {
"sales_credit_note": {
"type": "object",
"properties": {
"contact_id": {
"type": "string",
"description": "The contact the sales credit note relates to"
},
"date": {
"type": "string",
"format": "date",
"description": "The date of the credit note"
},
"vat_reverse_charge": {
"type": "boolean",
"description": "Indicates whether Domestic Reverser Charge is applied to the artefact. Only used for a UK business."
},
"destination_consignment": {
"type": "boolean",
"description": "Indicates whether consignment checkbox for destination VAT is checked on the artefact. Only used for an UK business, where destination VAT was enabled in the settings."
},
"cis_applicable_amount": {
"type": "number",
"format": "double",
"description": "The total amount of CIS deductible labour - only applicable in UK"
},
"base_currency_cis_applicable_amount": {
"type": "number",
"format": "double",
"description": "The total amount of CIS deductible labour in the base currency - only applicable in UK"
},
"total_after_cis_deduction": {
"type": "number",
"format": "double",
"description": "The total of the artefact with the total of CIS deducted - only applicable in UK"
},
"base_currency_total_after_cis_deduction": {
"type": "number",
"format": "double",
"description": "The total of the artefact with the total of CIS deducted in the base currency - only applicable in UK"
},
"credit_note_number_prefix": {
"type": "string",
"description": "The credit note number prefix"
},
"credit_note_number": {
"type": "string",
"description": "The generated credit note number"
},
"contact_name": {
"type": "string",
"description": "The name of the contact when the credit note was created"
},
"contact_reference": {
"type": "string",
"description": "The reference of the contact when the credit note was created"
},
"original_invoice_date": {
"type": "string",
"format": "date",
"description": "The date of the original invoice"
},
"reference": {
"type": "string",
"description": "The reference for the credit note"
},
"notes": {
"type": "string",
"description": "credit note notes"
},
"terms_and_conditions": {
"type": "string",
"description": "Credit note terms and conditions"
},
"shipping_net_amount": {
"type": "number",
"format": "double",
"description": "The net shipping amount"
},
"shipping_tax_rate_id": {
"type": "string",
"description": "The ID of the Shipping Tax Rate."
},
"shipping_tax_amount": {
"type": "number",
"format": "double",
"description": "The tax shipping amount. NOTE: This is not required for POST/PUT requests as the shipping tax is calculated based on the shipping_net_amount and the shipping_tax_rate."
},
"total_quantity": {
"type": "number",
"format": "double",
"description": "The total quantity of the credit note"
},
"shipping_total_amount": {
"type": "number",
"format": "double",
"description": "The total shipping amount"
},
"net_amount": {
"type": "number",
"format": "double",
"description": "The net amount of the credit note"
},
"tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount of the credit note"
},
"total_amount": {
"type": "number",
"format": "double",
"description": "The total amount of the credit note"
},
"currency_id": {
"type": "string",
"description": "The ID of the Currency."
},
"exchange_rate": {
"type": "number",
"format": "double",
"description": "The exchange rate for the credit note"
},
"inverse_exchange_rate": {
"type": "number",
"format": "double",
"description": "The inverse exchange rate for the credit note"
},
"base_currency_shipping_net_amount": {
"type": "number",
"format": "double",
"description": "The net shipping amount in base currency"
},
"base_currency_shipping_tax_amount": {
"type": "number",
"format": "double",
"description": "The tax shipping amount in base currency"
},
"base_currency_shipping_total_amount": {
"type": "number",
"format": "double",
"description": "The total shipping amount in base currency"
},
"total_discount_amount": {
"type": "number",
"format": "double",
"description": "The discount amount on the credit note"
},
"base_currency_total_discount_amount": {
"type": "number",
"format": "double",
"description": "The discount amount on the credit note in base currency"
},
"base_currency_net_amount": {
"type": "number",
"format": "double",
"description": "The net amount of the credit note in base currency"
},
"base_currency_tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount of the credit note in base currency"
},
"base_currency_total_amount": {
"type": "number",
"format": "double",
"description": "The total amount of the credit note in base currency"
},
"status_id": {
"type": "string",
"description": "The ID of the Status."
},
"sent": {
"type": "boolean",
"description": "Indicates whether the credit note has been sent"
},
"tax_address_region_id": {
"type": "string",
"description": "The ID of the Tax Address Region. (Canada only)"
},
"withholding_tax_rate": {
"type": "number",
"format": "double",
"description": "The withheld Tax Rate - only applicable in UK (CIS subcontractor tax rate)"
},
"withholding_tax_amount": {
"type": "number",
"format": "double",
"description": "The withheld Tax Amount - only applicable in UK (CIS subcontractor tax)"
},
"base_currency_withholding_tax_amount": {
"type": "number",
"format": "double",
"description": "The withheld Tax Amount in the base currency - only applicable in UK (CIS subcontractor tax)"
},
"main_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "The first line of the address"
},
"address_line_2": {
"type": "string",
"description": "The second line of the address"
},
"city": {
"type": "string",
"description": "The address town/city"
},
"postal_code": {
"type": "string",
"description": "The address postal code/zipcode"
},
"country_id": {
"type": "string",
"description": "The ID of the Country."
},
"address_type_id": {
"type": "string",
"description": "The ID of the Address Type."
},
"region": {
"type": "string",
"description": "The address state/province/region"
},
"country_group_id": {
"type": "string",
"description": "The ID of the Country Group."
}
}
},
"delivery_address": {
"type": "object",
"properties": {
"address_line_1": {
"type": "string",
"description": "The first line of the address"
},
"address_line_2": {
"type": "string",
"description": "The second line of the address"
},
"city": {
"type": "string",
"description": "The address town/city"
},
"postal_code": {
"type": "string",
"description": "The address postal code/zipcode"
},
"country_id": {
"type": "string",
"description": "The ID of the Country."
},
"address_type_id": {
"type": "string",
"description": "The ID of the Address Type."
},
"region": {
"type": "string",
"description": "The address state/province/region"
},
"country_group_id": {
"type": "string",
"description": "The ID of the Country Group."
}
}
},
"credit_note_lines": {
"type": "array",
"items": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "The description for the invoice line"
},
"ledger_account_id": {
"type": "string",
"description": "The ID of the Ledger Account."
},
"unit_price": {
"type": "number",
"format": "double",
"description": "The unit price for the invoice line"
},
"product_id": {
"type": "string",
"description": "The ID of the Product."
},
"service_id": {
"type": "string",
"description": "The ID of the Service."
},
"trade_of_asset": {
"type": "boolean",
"description": "Whether the line item is marked as trade of asset."
},
"quantity": {
"type": "number",
"format": "double",
"description": "The quantity for the invoice line"
},
"net_amount": {
"type": "number",
"format": "double",
"description": "The net amount for the invoice line"
},
"tax_rate_id": {
"type": "string",
"description": "The ID of the Tax Rate."
},
"tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount for the invoice line\". This attribute is required in v3.1, unless the tax rate is of a \"zero\", \"exempt\" or \"no_tax\" type. Then the tax_amount is infered as 0.0. In v3, this attribute is optional, but you should still set, as it defaults to 0.0 in any case. This is not what you want for tax rates with a percentage > 0.0."
},
"total_amount": {
"type": "number",
"format": "double",
"description": "The total amount for the invoice line"
},
"base_currency_unit_price": {
"type": "number",
"format": "double",
"description": "The unit price for the invoice line in base currency"
},
"unit_price_includes_tax": {
"type": "boolean",
"description": "Defines whether the unit price includes tax"
},
"base_currency_net_amount": {
"type": "number",
"format": "double",
"description": "The net amount for the invoice line in base currency"
},
"base_currency_tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount for the invoice line in base currency"
},
"base_currency_total_amount": {
"type": "number",
"format": "double",
"description": "The total amount for the invoice line in base currency"
},
"eu_goods_services_type_id": {
"type": "string",
"description": "The ID of the EU Goods Services Type."
},
"discount_amount": {
"type": "number",
"format": "double",
"description": "The discount amount for the invoice line"
},
"base_currency_discount_amount": {
"type": "number",
"format": "double",
"description": "The discount amount for the invoice line in base currency"
},
"discount_percentage": {
"type": "number",
"format": "double",
"description": "The discount percentage for the invoice line"
},
"eu_sales_description_id": {
"type": "string",
"description": "The ID of the EU Sales Description."
}
}
}
},
"tax_analysis": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tax_rate_id": {
"type": "string",
"description": "The ID of the Tax Rate."
},
"net_amount": {
"type": "number",
"format": "double",
"description": "The net amount for the tax rate"
},
"tax_amount": {
"type": "number",
"format": "double",
"description": "The tax amount for the tax rate"
},
"total_amount": {
"type": "number",
"format": "double",
"description": "The total amount for the tax rate"
},
"goods_amount": {
"type": "number",
"format": "double",
"description": "The total amount for the tax rate relating to goods"
},
"service_amount": {
"type": "number",
"format": "double",
"description": "The total amount for the tax rate relating to services"
}
}
}
}
}
}
},
"required": [
"sales_credit_note"
],
"description": "Updates a Sales Credit Note"
}Response 200
Updates a Sales Credit Note
Code samples
@ECHO OFF
curl -v -X PUT "https://api.columbus.sage.com/ca/sageone/accounts/v3/sales_credit_notes/{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/ca/sageone/accounts/v3/sales_credit_notes/{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/ca/sageone/accounts/v3/sales_credit_notes/{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/ca/sageone/accounts/v3/sales_credit_notes/{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/ca/sageone/accounts/v3/sales_credit_notes/{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/ca/sageone/accounts/v3/sales_credit_notes/{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", "/ca/sageone/accounts/v3/sales_credit_notes/{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", "/ca/sageone/accounts/v3/sales_credit_notes/{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/ca/sageone/accounts/v3/sales_credit_notes/{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