Connect to a databook subscription
There are various SDKs and APIs available to programmatically work with databook. The samples below are shown in C# code and use the databook .NET SDK. The equivalent JSON is also shown if you are using the API direct or via Javascript.
Create the client using code like the following example.
C#
private static string endpointUrl = "[endpoint url]";
private static string authorizationUserId = "[your user id]";
private static string authorizationKey = "[your key]";
//Create a new instance of the DatabookClient
var client = new DatabookClient(new Uri(endpointUrl), authorizationUserId, authorizationKey);
Recording an Invoice
A simple double entry example. This example assumes the Library, Book and Accounts have been predefined already.
A Library represents a logical section in your application i.e. tenant or a sub-system
C#
private const string LibraryId = "F895D43A-AC1C-44CA-95FF-74E55FB309F4";
private const string BookId = "SalesLedger";
private const string ReceivablesAccountId = "4000";
private const string SalesAccountId = "5000";
public PostInvoice(string invoiceId, decimal amount)
{
var posting = new Activity()
{
name = "Invoice",
date = DateTime.Now,
ref = invoiceId
};
posting.AddLine(SalesAccountId, credit: amount );
posting.AddLine(ReceivablesAccountId, debit: amount);
client.Submit(LibraryId, BookId, posting);
}
JSON
{
"name": "Invoice",
"date": "2014/8/31 12:34:52",
"ref": "IN0001212"
"lines": [
{
"accountId": "4000",
"mode": "1",
"base": "67.40"
},
{
"accountId": "5000",
"mode": "-1",
"base": "67.40"
}
]
}
Tracking Workflow with Clearance
The first function starts a particular task. The second function looks for the activity line in the InProgress account so the Finish step can clear this line to indicate the task has transitioned between states.
If clearance was not used the Task would exist in both accounts.
C#
private const string LibraryId = "A3F9FD95-8FC1-4525-A5C4-8C4DE3ADF729";
private const string BookId = "Workflow";
private const string InProgressAccountId = "InProgress";
private const string FinishedAccountId = "Finish";
//
public StartTask(string taskId, DateTime startTime)
{
var stateChange = new Activity()
{
name = "Start Task",
date = startTime,
ref = taskId
};
stateChange.AddLine(InProgressAccountId, 1)
client.Submit(LibraryId, BookId, stateChange);
}
//
public FinishTask(string taskId, DateTime finishTime)
{
// Find the open line matching this task in the InProgress account
var openLineId = client.FindOpenItem(taskId, InProgressAccountId)
var stateChange = new Activity()
{
name = "Finish Task",
date = finishTime
};
var line = stateChange.AddLine(LibraryId, BookId, FinishedAccountId)
line.AddClearance(openLineId);
client.Submit(LibraryId, BookId, stateChange);
}
JSON
/* Start */
{
"name": "Start Task",
"date": "2014/8/31 12:34:52",
"ref": "TASK0001"
"lines": [
{
"accountId": "InProgress",
"mode": "1",
"base": "1"
}
]
}
/* Open Line Query */
{
"lineId": "TASK0001-1",
"activityId": "TASK0001",
"base": 1
}
/* Finish */
{
"name": "Finish Task",
"date": "2014/9/14 11:01:36",
"ref": "TASK0001"
"lines": [
{
"accountId": "Finish",
"mode": "1",
"base": "1"
"clearance":[
{
"clearanceId": "TASK0001-1"
}
]
}
]
}
