Sage One - Accounts - v3 CA

Documentation of the Sage Business Cloud Accounting API.

Creates a Purchase Credit Note

Endpoint Availability

  • Accounting Plus: 🇨🇦, 🇩🇪, 🇫🇷, 🇮🇪, 🇬🇧, 🇺🇸

Access Control Restrictions

Requires the authenticated user to have any of the following roles in the area Purchases: Full Access, Restricted Access

Try it

Request URL

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

{
  "purchase_credit_note": {
    "contact_id": "string",
    "date": "string",
    "vat_reverse_charge": true,
    "postponed_accounting": true,
    "vat_exempt_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,
    "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,
    "contact_name": "string",
    "contact_reference": "string",
    "original_invoice_date": "string",
    "reference": "string",
    "vendor_reference": "string",
    "notes": "string",
    "total_quantity": 0.0,
    "net_amount": 0.0,
    "tax_amount": 0.0,
    "total_amount": 0.0,
    "currency_id": "string",
    "exchange_rate": 0.0,
    "inverse_exchange_rate": "string",
    "base_currency_net_amount": 0.0,
    "base_currency_tax_amount": 0.0,
    "base_currency_total_amount": 0.0,
    "status_id": "string",
    "tax_address_region_id": "string",
    "withholding_tax_rate": 0.0,
    "withholding_tax_amount": 0.0,
    "base_currency_withholding_tax_amount": 0.0,
    "credit_note_lines": [
      {
        "description": "string",
        "ledger_account_id": "string",
        "quantity": 0.0,
        "unit_price": 0.0,
        "is_purchase_for_resale": true,
        "product_id": "string",
        "service_id": "string",
        "trade_of_asset": true,
        "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",
        "gst_amount": 0.0,
        "pst_amount": 0.0,
        "tax_recoverable": true
      }
    ],
    "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": {
    "purchase_credit_note": {
      "type": "object",
      "properties": {
        "contact_id": {
          "type": "string",
          "description": "The contact the purchase 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."
        },
        "postponed_accounting": {
          "type": "boolean",
          "description": "Indicates whether postponed accounting rules are applied to the artefact. Only used for UK and IE accounting businesses, where the vendor is flagged as importer"
        },
        "vat_exempt_consignment": {
          "type": "boolean",
          "description": "Indicates whether vat exempt import is applied to the artefact. Only used for a UK business, where the artefact has the consignment checkbox selected."
        },
        "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"
        },
        "base_currency_total_itc_amount": {
          "type": "number",
          "format": "double",
          "description": "The total amount of input tax credit in base currency for the\n                     purchase credit note (Canada only)"
        },
        "total_itc_amount": {
          "type": "number",
          "format": "double",
          "description": "The total amount of input tax credit for the purchase credit note (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                     purchase credit note (Canada only)"
        },
        "total_itr_amount": {
          "type": "number",
          "format": "double",
          "description": "The total amount of input tax refund for the purchase credit note (Canada only)"
        },
        "part_recoverable": {
          "type": "boolean",
          "description": "Indicates if the purchase credit note is part recoverable or not (Canada only)"
        },
        "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"
        },
        "vendor_reference": {
          "type": "string",
          "description": "The vendor reference for the credit note"
        },
        "notes": {
          "type": "string",
          "description": "credit note notes"
        },
        "total_quantity": {
          "type": "number",
          "format": "double",
          "description": "The total quantity of the credit note"
        },
        "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": "string",
          "description": "The inverse exchange rate for the credit note"
        },
        "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."
        },
        "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)"
        },
        "credit_note_lines": {
          "type": "array",
          "description": "The credit note lines of the credit note",
          "items": {
            "type": "object",
            "properties": {
              "description": {
                "type": "string",
                "description": "The description for the credit note line"
              },
              "ledger_account_id": {
                "type": "string",
                "description": "The ID of the Ledger Account."
              },
              "quantity": {
                "type": "number",
                "format": "double",
                "description": "The quantity for the credit note line"
              },
              "unit_price": {
                "type": "number",
                "format": "double",
                "description": "The unit price for the credit note line"
              },
              "is_purchase_for_resale": {
                "type": "boolean",
                "description": "Identifies whether the line item is for resale. (Ireland Only)"
              },
              "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."
              },
              "net_amount": {
                "type": "number",
                "format": "double",
                "description": "The net amount for the credit note 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 credit note 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 credit note line"
              },
              "base_currency_unit_price": {
                "type": "number",
                "format": "double",
                "description": "The unit price for the credit note 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 credit note line in base currency"
              },
              "base_currency_tax_amount": {
                "type": "number",
                "format": "double",
                "description": "The tax amount for the credit note line in base currency"
              },
              "base_currency_total_amount": {
                "type": "number",
                "format": "double",
                "description": "The total amount for the credit note line in base currency"
              },
              "eu_goods_services_type_id": {
                "type": "string",
                "description": "The ID of the EU Goods Services Type."
              },
              "gst_amount": {
                "type": "number",
                "format": "double",
                "description": "The gst or hst tax amount for the credit note line"
              },
              "pst_amount": {
                "type": "number",
                "format": "double",
                "description": "The pst or qst tax amount for the credit note line"
              },
              "tax_recoverable": {
                "type": "boolean",
                "description": "Indicates if the credit note line is tax recoverable or not"
              }
            },
            "required": [
              "description",
              "ledger_account_id",
              "quantity",
              "unit_price"
            ]
          }
        },
        "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": [
        "contact_id",
        "date",
        "credit_note_lines"
      ]
    }
  },
  "required": [
    "purchase_credit_note"
  ],
  "description": "Creates a Purchase Credit Note"
}

Response 201

Creates a Purchase Credit Note

Code samples

@ECHO OFF

curl -v -X POST "https://api.columbus.sage.com/ca/sageone/accounts/v3/purchase_credit_notes"
-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/purchase_credit_notes?" + 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.PostAsync(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/purchase_credit_notes");


            URI uri = builder.build();
            HttpPost request = new HttpPost(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/purchase_credit_notes?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // 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/purchase_credit_notes";
    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:@"POST"];
    // 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/purchase_credit_notes');
$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_POST);

// 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("POST", "/ca/sageone/accounts/v3/purchase_credit_notes?%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("POST", "/ca/sageone/accounts/v3/purchase_credit_notes?%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/purchase_credit_notes')

request = Net::HTTP::Post.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