Sage One - Accounts - v3 ES

Documentation of the Sage Business Cloud Accounting API.

Updates a Contact Opening Balance

Endpoint Availability

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

Access Control Restrictions

Requires the authenticated user to have any of the following roles in the areas Settings, Sales, and Purchases: Full Access

Try it

Request URL

Request parameters

string

The Contact Opening Balance Key.

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

{
  "contact_opening_balance": {
    "contact_opening_balance_type_id": "string",
    "date": "string",
    "contact_id": "string",
    "reference": "string",
    "total_amount": 0.0,
    "transaction_type_id": "string",
    "details": "string",
    "net_amount": 0.0,
    "tax_rate_id": "string",
    "tax_amount": 0.0,
    "currency_id": "string",
    "exchange_rate": 0.0,
    "base_currency_net_amount": 0.0,
    "base_currency_tax_amount": 0.0,
    "base_currency_total_amount": 0.0
  }
}
{
  "type": "object",
  "properties": {
    "contact_opening_balance": {
      "type": "object",
      "properties": {
        "contact_opening_balance_type_id": {
          "type": "string",
          "description": "The type of contact opening balance e.g. invoice or credit note"
        },
        "date": {
          "type": "string",
          "format": "date",
          "description": "The date of the opening balance"
        },
        "contact_id": {
          "type": "string",
          "description": "The contact the opening balance relates to"
        },
        "reference": {
          "type": "string",
          "description": "The reference for the opening balance"
        },
        "total_amount": {
          "type": "number",
          "format": "double",
          "description": "The total amount of the opening balance"
        },
        "transaction_type_id": {
          "type": "string",
          "description": "The ID of the Transaction Type."
        },
        "details": {
          "type": "string",
          "description": "A description of the opening balance"
        },
        "net_amount": {
          "type": "number",
          "format": "double",
          "description": "The net amount of the opening balance"
        },
        "tax_rate_id": {
          "type": "string",
          "description": "The ID of the Tax Rate."
        },
        "tax_amount": {
          "type": "number",
          "format": "double",
          "description": "The tax amount of the opening balance"
        },
        "currency_id": {
          "type": "string",
          "description": "The ID of the Currency."
        },
        "exchange_rate": {
          "type": "number",
          "format": "double",
          "description": "The exchange rate for the opening balance"
        },
        "base_currency_net_amount": {
          "type": "number",
          "format": "double",
          "description": "The net amount of the opening balance in base currency"
        },
        "base_currency_tax_amount": {
          "type": "number",
          "format": "double",
          "description": "The tax amount of the opening balance in base currency"
        },
        "base_currency_total_amount": {
          "type": "number",
          "format": "double",
          "description": "The total amount of the opening balance in base currency"
        }
      }
    }
  },
  "required": [
    "contact_opening_balance"
  ],
  "description": "Updates a Contact Opening Balance"
}

Response 200

Updates a Contact Opening Balance

{
  "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",
  "contact_opening_balance_type": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "contact": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "date": "string",
  "reference": "string",
  "details": "string",
  "net_amount": 0.0,
  "tax_rate": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "tax_amount": 0.0,
  "tax_breakdown": [
    {
      "tax_rate": {
        "legacy_id": 0,
        "id": "string",
        "displayed_as": "string",
        "$path": "string"
      },
      "percentage": 0.0,
      "amount": 0.0
    }
  ],
  "total_amount": 0.0,
  "currency": {
    "legacy_id": 0,
    "id": "string",
    "displayed_as": "string",
    "$path": "string"
  },
  "exchange_rate": 0.0,
  "base_currency_net_amount": 0.0,
  "base_currency_tax_amount": 0.0,
  "base_currency_tax_breakdown": [
    {
      "tax_rate": {
        "legacy_id": 0,
        "id": "string",
        "displayed_as": "string",
        "$path": "string"
      },
      "percentage": 0.0,
      "amount": 0.0
    }
  ],
  "base_currency_total_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 contact opening balance",
      "x-sage-menusection": "Settings"
    },
    "deleted_at": {
      "type": "string",
      "format": "date-time",
      "description": "The datetime when the item was deleted"
    },
    "contact_opening_balance_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 type of contact opening balance e.g. invoice or credit note",
      "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 the opening balance relates to",
      "x-sage-menusection": "Settings"
    },
    "date": {
      "type": "string",
      "format": "date",
      "description": "The date of the opening balance"
    },
    "reference": {
      "type": "string",
      "maxLength": 25,
      "description": "The reference for the opening balance"
    },
    "details": {
      "type": "string",
      "maxLength": 255,
      "description": "A description of the opening balance"
    },
    "net_amount": {
      "type": "number",
      "format": "double",
      "description": "The net amount of the opening balance"
    },
    "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 for the opening balance",
      "x-sage-menusection": "Settings"
    },
    "tax_amount": {
      "type": "number",
      "format": "double",
      "description": "The tax amount of the opening balance"
    },
    "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 opening balance"
    },
    "total_amount": {
      "type": "number",
      "format": "double",
      "description": "The total amount of the opening balance"
    },
    "currency": {
      "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 currency for the opening balance",
      "x-sage-menusection": "Settings"
    },
    "exchange_rate": {
      "type": "number",
      "format": "double",
      "description": "The exchange rate for the opening balance"
    },
    "base_currency_net_amount": {
      "type": "number",
      "format": "double",
      "description": "The net amount of the opening balance in base currency"
    },
    "base_currency_tax_amount": {
      "type": "number",
      "format": "double",
      "description": "The tax amount of the opening balance in base currency"
    },
    "base_currency_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 opening balance in base currency"
    },
    "base_currency_total_amount": {
      "type": "number",
      "format": "double",
      "description": "The total amount of the opening balance in base currency"
    }
  },
  "description": "### Endpoint Availability\n\n* Accounting Plus: 🇨🇦, 🇩🇪, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸\n* Accounting Standard: 🇬🇧, 🇮🇪\n\n### Access Control Restrictions\n\nRequires the authenticated user to have any of the following roles in the areas `Settings`, `Sales`, and `Purchases`: Full Access",
  "x-sage-menusection": "Settings"
}

Code samples

@ECHO OFF

curl -v -X PUT "https://api.columbus.sage.com/es/sageone/accounts/v3/contact_opening_balances/{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/es/sageone/accounts/v3/contact_opening_balances/{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/es/sageone/accounts/v3/contact_opening_balances/{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/es/sageone/accounts/v3/contact_opening_balances/{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/es/sageone/accounts/v3/contact_opening_balances/{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/es/sageone/accounts/v3/contact_opening_balances/{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", "/es/sageone/accounts/v3/contact_opening_balances/{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", "/es/sageone/accounts/v3/contact_opening_balances/{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/es/sageone/accounts/v3/contact_opening_balances/{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