Sage 200 - Accounts
A powerful API providing easy, secure, scalable integration into the core Sage 200 product which enables third-party developers to rapidly create apps and rich extensions. Accounts API exposes resources of Sage 200 related to accounting process such as customers, suppliers, ledger accounts, payment methods, journals, journal entries, analytics. Typical integrations use cases are financial reporting, expenses management, or invoice accounting.
Get customers
Get all the resources of type 'Customer', optionally paged, ordered and filtered.
Try itRequest URL
Request parameters
(optional)
integer
Format - int32. startIndex indicates an absolute “offset” in the complete list of the requested resources. The default value is 1. In case of missing this parameter, then the default value will be 1 which refers to the first object.
(optional)
integer
Format - int32. itemsPerPage enables you to limit the maximum number of objects returned in a request. The default value and the maximum value allowed is 50. In case of specify a value greater than 50, then only 50 objects will be returned.
(optional)
string
Format - date-time (as date-time in RFC3339). updatedOrCreatedSince enables you to return a collection of objects which has been created or updated from the specified date
(optional)
string
Format - date-time (as date-time in RFC3339). deletedSince enables you to return a collection of objects which has been deleted from the specified date
(optional)
string
orderby enables you to return the result in ascending or descending order. The order is based on the field name you specify and the key words asc for ascending and desc for descending. If you want to sort by more than one data filed, then they will be separated by comma (,).
(optional)
string
where enables you to filter the objects that are returned using expressions which includes the following operators: eq (equals), nq (distinct), lt (less than), le (less or equal than), gt (greater than), ge (greater or equal than), in (inside of), like (similarity pattern). Currently only is possible to apply filtering using one of the data fields that has been marked with the flag “where”.
(optional)
boolean
compact enables you to include all the child objects that are linked to the parent object within your results. The default value is true.
Request headers
string
Tenant unique identifier.
string
Company unique identifier.
string
Sage ID Access Token prefixed with the word 'Bearer'.
string
Subscription key which provides access to this API.
Request body
Response 200
OK.
{
"$totalResults": 0,
"$startIndex": 0,
"$itemsPerPage": 0,
"$resources": [
{
"id": "string",
"company_id": "string",
"application_id": "string",
"active": true,
"identity_type": "1",
"identity": "string",
"account_code": "string",
"account_id": "string",
"customer_type": "1",
"name": "string",
"email": "string",
"telephone": "string",
"mobile": "string",
"fax": "string",
"notes": "string",
"financial_limit": 0.0,
"tax_type": "1",
"main_contact_id": "string",
"price_type_id": "string",
"discount_type_id": "string",
"payment_method_id": "string",
"discount_percent": 0.0,
"discount_amount_rappel_percent": 0.0,
"discount_payment_method_percent": 0.0,
"zone_id": "string",
"sales_person_id": "string",
"commission_percent": 0.0,
"status_published": true,
"identity_of_legal_representative": "string",
"name_of_legal_representative": "string",
"cost_centers": [
"string"
],
"extended_properties": [
{
"name": "string",
"value": "string"
}
],
"addresses": [
{
"id": "string",
"application_id": "string",
"type": "1",
"full_address": "string",
"type_street": "0",
"street": "string",
"number": "string",
"letter": "string",
"stair": "string",
"floor": "string",
"door": "string",
"country": "string",
"region": "string",
"post_code": "string",
"locality": "string",
"email": "string",
"telephone": "string",
"mobile": "string",
"fax": "string"
}
],
"bank_accounts": [
{
"id": "string",
"application_id": "string",
"bank_id": "string",
"name": "string",
"iban": "string",
"addresses": [
{
"id": "string",
"application_id": "string",
"type": "1",
"full_address": "string",
"type_street": "0",
"street": "string",
"number": "string",
"letter": "string",
"stair": "string",
"floor": "string",
"door": "string",
"country": "string",
"region": "string",
"post_code": "string",
"locality": "string",
"email": "string",
"telephone": "string",
"mobile": "string",
"fax": "string"
}
]
}
],
"timestamp": "string"
}
]
}{
"type": "object",
"properties": {
"$totalResults": {
"type": "integer",
"format": "int32",
"description": "Indicates the number of objects returned in a request",
"readOnly": false
},
"$startIndex": {
"type": "integer",
"format": "int32",
"description": "startIndex indicates an absolute “offset” in the complete list of the requested resources. The default value is 1.\r\nIn case of missing this parameter, then the default value will be 1 which refers to the first object.",
"readOnly": false
},
"$itemsPerPage": {
"type": "integer",
"format": "int32",
"description": "itemsPerPage enables you to limit the maximum number of objects returned in a request. The default value and the maximum value allowed is 50. In case of specify a value greater than 50, then only 50 objects will be returned.",
"readOnly": false
},
"$resources": {
"type": "array",
"items": {
"type": "object",
"description": "List of the customers. <br /><br /><span style=\"font-style:italic\">This entity supports change control</span>",
"x-sage-menusection": "Contacts",
"x-sage-relatedopeations": [
"companies",
"ledger_accounts",
"customers",
"payment_methods",
"zones",
"cost_centers",
"suppliers"
],
"required": [
"company_id",
"name"
],
"properties": {
"id": {
"type": "string",
"description": "Identifier for the Customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"company_id": {
"type": "string",
"description": "Company ID of the Customer",
"x-sage-entitylink": "companies",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"description": "Application ID of the Customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"active": {
"type": "boolean",
"description": "Active of the customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"identity_type": {
"type": "string",
"description": "Type of tax document of the Customer. See <a href=\"/docs#/spain/s200/accounts/v1/identitytype\">identitytype</a>",
"readOnly": false,
"x-sage-enumlink": "identitytype",
"enum": [
"1",
"2",
"3",
"4",
"5",
"6"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"identity": {
"type": "string",
"description": "VAT number / Tax ID Number of the Customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"account_code": {
"type": "string",
"description": "Account code of the customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"account_id": {
"type": "string",
"description": "Accountant ledger account associated",
"x-sage-entitylink": "ledger_accounts",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": false
},
"customer_type": {
"type": "string",
"description": "Type of customer. See <a href=\"/docs#/spain/s200/accounts/v1/customertype\">customertype</a>",
"readOnly": false,
"x-sage-enumlink": "customertype",
"enum": [
"1",
"2",
"3"
],
"x-sage-queryable": true,
"x-sage-orderable": false
},
"name": {
"type": "string",
"description": "Name of the Customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"email": {
"type": "string",
"description": "Email of the Customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"telephone": {
"type": "string",
"description": "Telephone of the Customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"mobile": {
"type": "string",
"description": "Mobile of the Customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"fax": {
"type": "string",
"description": "Fax of the Customer",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"notes": {
"type": "string",
"description": "Notes of the Customer",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"financial_limit": {
"type": "number",
"description": "Financial limit",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"tax_type": {
"type": "string",
"description": "Tax reference of the Customer. See <a href=\"/docs#/spain/s200/accounts/v1/taxtype\">taxtype</a>",
"readOnly": false,
"x-sage-enumlink": "taxtype",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"main_contact_id": {
"type": "string",
"description": "Main person of contact of the Customer",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"price_type_id": {
"type": "string",
"description": "Type of price of the Customer",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_type_id": {
"type": "string",
"description": "Type of discounts of the customer",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"payment_method_id": {
"type": "string",
"description": "ID Payment Method of the Customer",
"x-sage-entitylink": "payment_methods",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_percent": {
"type": "number",
"description": "Default discount percent of the customer",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_amount_rappel_percent": {
"type": "number",
"description": "Default discount percent of the customer by rappel",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"discount_payment_method_percent": {
"type": "number",
"description": "Default discount of the customer",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"zone_id": {
"type": "string",
"description": "Zone of the customer",
"x-sage-entitylink": "zones",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"sales_person_id": {
"type": "string",
"description": "Main sales person of the customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"commission_percent": {
"type": "number",
"description": "Default Percent Commission of the customer",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"status_published": {
"type": "boolean",
"description": "Status published of the customer",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"identity_of_legal_representative": {
"type": "string",
"description": "VAT number / Tax ID Number of the legal representative of the customers",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"name_of_legal_representative": {
"type": "string",
"description": "name of legal representative of the customer",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"cost_centers": {
"type": "array",
"description": "Cost centers associated",
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "string"
}
},
"extended_properties": {
"type": "array",
"description": "List of free properties",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "name of the free property",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"value": {
"type": "string",
"description": "value of the free property",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"addresses": {
"type": "array",
"description": "List of Address of the Customer",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identifier for the address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"description": "Application id",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"type": {
"type": "string",
"description": "Type of address. See <a href=\"/docs#/spain/s200/accounts/v1/addresstype\">addresstype</a>",
"readOnly": false,
"x-sage-enumlink": "addresstype",
"enum": [
"1",
"2",
"3",
"4"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"full_address": {
"type": "string",
"description": "Text with the full address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"type_street": {
"type": "string",
"description": "Type street address. See <a href=\"/docs#/spain/s200/accounts/v1/streettype\">streettype</a>",
"readOnly": false,
"x-sage-enumlink": "streettype",
"enum": [
"0",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"1"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"street": {
"type": "string",
"description": "Street of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"number": {
"type": "string",
"description": "Number of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"letter": {
"type": "string",
"description": "Letter of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"stair": {
"type": "string",
"description": "Stair of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"floor": {
"type": "string",
"description": "Floor of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"door": {
"type": "string",
"description": "Door of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"country": {
"type": "string",
"description": "Country name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"region": {
"type": "string",
"description": "Region name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"post_code": {
"type": "string",
"description": "Zip postal",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"locality": {
"type": "string",
"description": "Locality name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"email": {
"type": "string",
"description": "address email",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"telephone": {
"type": "string",
"description": "address telephone",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"mobile": {
"type": "string",
"description": "address mobile",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"fax": {
"type": "string",
"description": "address fax",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
},
"bank_accounts": {
"type": "array",
"description": "List of Banks Accounts of the Customer",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"description": "Application code",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"bank_id": {
"type": "string",
"description": "Associated bank",
"x-sage-entitylink": "banks",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"name": {
"type": "string",
"description": "Name of bank account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"iban": {
"type": "string",
"description": "IBAN of bank account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"addresses": {
"type": "array",
"description": "List of address of the bank account",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false,
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Identifier for the address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"application_id": {
"type": "string",
"description": "Application id",
"readOnly": false,
"x-sage-queryable": true,
"x-sage-orderable": true
},
"type": {
"type": "string",
"description": "Type of address. See <a href=\"/docs#/spain/s200/accounts/v1/addresstype\">addresstype</a>",
"readOnly": false,
"x-sage-enumlink": "addresstype",
"enum": [
"1",
"2",
"3",
"4"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"full_address": {
"type": "string",
"description": "Text with the full address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"type_street": {
"type": "string",
"description": "Type street address. See <a href=\"/docs#/spain/s200/accounts/v1/streettype\">streettype</a>",
"readOnly": false,
"x-sage-enumlink": "streettype",
"enum": [
"0",
"2",
"3",
"4",
"5",
"6",
"7",
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22",
"23",
"24",
"25",
"26",
"27",
"28",
"29",
"30",
"1"
],
"x-sage-queryable": false,
"x-sage-orderable": false
},
"street": {
"type": "string",
"description": "Street of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"number": {
"type": "string",
"description": "Number of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"letter": {
"type": "string",
"description": "Letter of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"stair": {
"type": "string",
"description": "Stair of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"floor": {
"type": "string",
"description": "Floor of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"door": {
"type": "string",
"description": "Door of address",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"country": {
"type": "string",
"description": "Country name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"region": {
"type": "string",
"description": "Region name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"post_code": {
"type": "string",
"description": "Zip postal",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"locality": {
"type": "string",
"description": "Locality name",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"email": {
"type": "string",
"description": "address email",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"telephone": {
"type": "string",
"description": "address telephone",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"mobile": {
"type": "string",
"description": "address mobile",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
},
"fax": {
"type": "string",
"description": "address fax",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
}
}
}
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "timestamp of de Customers",
"readOnly": false,
"x-sage-queryable": false,
"x-sage-orderable": false
}
}
}
}
}
}Code samples
@ECHO OFF
curl -v -X GET "https://api.columbus.sage.com/es/s200/accounts/v1/customers?startIndex={integer}&itemsPerPage={integer}&updatedOrCreatedSince={string}&deletedSince={string}&orderBy={string}&where={string}&compact={boolean}"
-H "X-Site: "
-H "X-Company: "
-H "Authorization: "
-H "Ocp-Apim-Subscription-Key: "
-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("X-Site", "");
client.DefaultRequestHeaders.Add("X-Company", "");
client.DefaultRequestHeaders.Add("Authorization", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["startIndex"] = "{integer}";
queryString["itemsPerPage"] = "{integer}";
queryString["updatedOrCreatedSince"] = "{string}";
queryString["deletedSince"] = "{string}";
queryString["orderBy"] = "{string}";
queryString["where"] = "{string}";
queryString["compact"] = "{boolean}";
var uri = "https://api.columbus.sage.com/es/s200/accounts/v1/customers?" + queryString;
var response = await client.GetAsync(uri);
}
}
} // // 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/es/s200/accounts/v1/customers");
builder.setParameter("startIndex", "{integer}");
builder.setParameter("itemsPerPage", "{integer}");
builder.setParameter("updatedOrCreatedSince", "{string}");
builder.setParameter("deletedSince", "{string}");
builder.setParameter("orderBy", "{string}");
builder.setParameter("where", "{string}");
builder.setParameter("compact", "{boolean}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("X-Site", "");
request.setHeader("X-Company", "");
request.setHeader("Authorization", "");
request.setHeader("Ocp-Apim-Subscription-Key", "");
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
"startIndex": "{integer}",
"itemsPerPage": "{integer}",
"updatedOrCreatedSince": "{string}",
"deletedSince": "{string}",
"orderBy": "{string}",
"where": "{string}",
"compact": "{boolean}",
};
$.ajax({
url: "https://api.columbus.sage.com/es/s200/accounts/v1/customers?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("X-Site","");
xhrObj.setRequestHeader("X-Company","");
xhrObj.setRequestHeader("Authorization","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// 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/es/s200/accounts/v1/customers";
NSArray* array = @[
// Request parameters
@"entities=true",
@"startIndex={integer}",
@"itemsPerPage={integer}",
@"updatedOrCreatedSince={string}",
@"deletedSince={string}",
@"orderBy={string}",
@"where={string}",
@"compact={boolean}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"X-Site"];
[_request setValue:@"" forHTTPHeaderField:@"X-Company"];
[_request setValue:@"" forHTTPHeaderField:@"Authorization"];
[_request setValue:@"" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
[_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/es/s200/accounts/v1/customers');
$url = $request->getUrl();
$headers = array(
// Request headers
'X-Site' => '',
'X-Company' => '',
'Authorization' => '',
'Ocp-Apim-Subscription-Key' => '',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'startIndex' => '{integer}',
'itemsPerPage' => '{integer}',
'updatedOrCreatedSince' => '{string}',
'deletedSince' => '{string}',
'orderBy' => '{string}',
'where' => '{string}',
'compact' => '{boolean}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// 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
'X-Site': '',
'X-Company': '',
'Authorization': '',
'Ocp-Apim-Subscription-Key': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'startIndex': '{integer}',
'itemsPerPage': '{integer}',
'updatedOrCreatedSince': '{string}',
'deletedSince': '{string}',
'orderBy': '{string}',
'where': '{string}',
'compact': '{boolean}',
})
try:
conn = httplib.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/es/s200/accounts/v1/customers?%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
'X-Site': '',
'X-Company': '',
'Authorization': '',
'Ocp-Apim-Subscription-Key': '',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'startIndex': '{integer}',
'itemsPerPage': '{integer}',
'updatedOrCreatedSince': '{string}',
'deletedSince': '{string}',
'orderBy': '{string}',
'where': '{string}',
'compact': '{boolean}',
})
try:
conn = http.client.HTTPSConnection('api.columbus.sage.com')
conn.request("GET", "/es/s200/accounts/v1/customers?%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/es/s200/accounts/v1/customers')
query = URI.encode_www_form({
# Request parameters
'startIndex' => '{integer}',
'itemsPerPage' => '{integer}',
'updatedOrCreatedSince' => '{string}',
'deletedSince' => '{string}',
'orderBy' => '{string}',
'where' => '{string}',
'compact' => '{boolean}'
})
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['X-Site'] = ''
# Request headers
request['X-Company'] = ''
# Request headers
request['Authorization'] = ''
# Request headers
request['Ocp-Apim-Subscription-Key'] = ''
# 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