Sage Evolution SDK | Documentation Portal - User contributions [en]

Getting Started

2015-11-04T07:28:18Z

196.36.226.1: /* Getting Started */

== Getting Started ==

*[[Evolution | Requirements, Initialise A Connection and Licensing]]
*[[Trouble_Shooting_Connection_Problems | Troubleshooting Connection Problems]]

== C# SDK Transactions ==

*[[AccountsPayable | Accounts Payable]]

*[[Accounts_Receivable | Accounts Receivable]]

*[[General_Ledger | General Ledger]]

*[[Inventory]]

*[[Order_Entry | Order Entry]]

*[[Contact_Management_Incidents | Contact Management Incidents]]

*[[Job_Costing | Job Costing]]

*[[Additional_Functionality | Additional Functionality]]

== Other Languages ==
*[[Delphi_Sales_Orders|Delphi Sales Orders]]

*[[Python]]

*[[PHP_Sales_Orders|PHP Sales Orders]]

*[[VB6_Customer_Account|VB 6 Transaction]]

SDK Delphi

2015-10-26T06:49:42Z

196.36.226.1:

If you are using Delphi.NET, the API can be used by referencing the DLL (a .NET assembly) directly.

However, the Pastel Evolution SDK can also be used from Delphi for Win32 by importing the COM type library distributed with the API as a .tlb file.

Follow these steps to get started:

# Refer to the [[Evolution|COM procedure]] for registering the DLL for COM.
# Import the type library. View the [[SDK Delphi Import | procedure here]].
# Add '''Pastel_Evolution_TLB''' to your unit's ''uses'' declaration.
# Add the files '''mscorlib_TLB.pas''' and '''System_TLB.pas''' to your project. You can either generate them yourself, or download them [[SDK Downloads | here]].
# Refer to the below example procedure for jump-starting your integration tasks.

<syntaxhighlight lang="delphi">
procedure TForm1.Button1Click(Sender: TObject);
var
stkItem : _InventoryItem;
customer : _Customer;
helper : _ComHelper;
orderDetail : _OrderDetail;
salesOrder : _SalesOrder;
reference, itemCode, customerCode : string;
recordID : integer;
begin
try
itemCode := 'ABC001';
customerCode := 'CASH33';
Log('Connecting...');
helper := CoComHelper.Create();
helper.CreateCommonDBConnection('server=.;initial catalog=EvolutionCommon;integrated security=SSPI');
helper.SetLicense('DEMO', '47481667230473');
helper.CreateConnection('server=.;initial catalog=50127;integrated security=SSPI');
helper.BeginTran;
Log('...connected');
Log('Expected DB version', helper.CompatibleEvolutionDatabaseVersion);
Log('Current DB version: ', helper.CurrentEvolutionDatabaseVersion);
if helper.CompatibleEvolutionDatabaseVersion <> helper.CurrentEvolutionDatabaseVersion then
Log('WARNING', 'The current database version differs from version expected by the API.');
recordID := helper.FindARAccountByCode(customerCode);
if recordID = -1 then
begin
// account does not exist, so create it
customer := CoCustomer.Create();
customer.Code := customerCode;
customer.Description := 'Demo Account';
customer.Save;
Log('Account created', customer.ID);
end
else
begin
// account exists, so simply load it
customer := helper.GetARAccount(customerCode);
end;
Log('Creating order...');
salesOrder := CoSalesOrder.Create();
salesOrder.Customer := customer;
Log('Creating detail...');
orderDetail := CoOrderDetail.Create;
// find inventory item
recordID := helper.FindStockItemByCode(itemCode);
if recordID = -1 then
begin
// item does not exist, so create it
stkItem := CoInventoryItem.Create();
stkItem.Code := itemCode;
stkItem.IsServiceItem := True;
stkItem.Description := 'Demo Item';
stkItem.Save;
Log('Item created', stkItem.ID)
end
else
begin
// item exists, so simply load it
stkItem := helper.GetStockItem(itemCode);
end;
orderDetail.InventoryItem := stkItem;
// if this is a new item, it gets created as a service item (above),
// and the quantity on hand will be irrelevant
Log('Stock on hand', stkItem.QtyOnHand);
orderDetail.Quantity := 5;
orderDetail.UnitSellingPrice := 100;
orderDetail.Discount := 100;
Log('Line total (excl.)', orderDetail.TotalExcl);
Log('Adding detail...');
Log('...done');
salesOrder.Detail.Add_2(orderDetail);
Log('Order Total (excl)', salesOrder.TotalExcl);
reference := salesOrder.Complete;
Log('Invoice No', reference);
helper.CommitTran;
except
on E : Exception do
begin
helper.RollbackTran;
ShowMessage(E.Message);
end;
end;
end;
</syntaxhighlight>

CSupplierAccountTransaction

2015-10-26T06:29:35Z

196.36.226.1:

'''The supplier class is used to create Supplier Accounts which can be used on supplier related processes.

The following code displays how a new supplier is created with the basic necessary properties like Code and description specified.'''

<syntaxhighlight lang="csharp">
//Assign variable S to Supplier class
Supplier S = new Supplier();
//Specify Supplier properties
S.Code = "SupplierSDK1";
S.Description = "supplierSDK1";
//Use the save method to Save the Supplier
S.Save();
</syntaxhighlight>

'''The same supplier can be edited and saved again with updated information like addresses and telephone number.'''

<syntaxhighlight lang="csharp">
Supplier S = new Supplier("SupplierSDK1");
//Set new properties
S.Telephone = "113456";
S.EmailAddress = "Supplier@SDK";
//Set Postal or physical address
S.PostalAddress = new Address("Postal Address 1", "Post 2", "Post 3", "Post 4", "Post 5", "PC");
S.PhysicalAddress = new Address()
{
Line1 = "Physical1",
Line2 = "Physical2",
Line3 = "Physical3",
Line4 = "Physical4",
Line5 = "Physical5",
PostalCode = "2000",
};
//Use the save method to Save the Supplier
S.Save();
</syntaxhighlight>

SDK Delphi

2015-10-26T06:29:00Z

196.36.226.1: Created page with "If you are using Delphi.NET, the API can be used by referencing the DLL (a .NET assembly) directly. However, the Pastel Evolution SDK can also be used from Delphi for Win32 b..."

If you are using Delphi.NET, the API can be used by referencing the DLL (a .NET assembly) directly.

However, the Pastel Evolution SDK can also be used from Delphi for Win32 by importing the COM type library distributed with the API as a .tlb file.

Follow these steps to get started:

# Refer to the [[Initialisation#COM|COM procedure]] for registering the DLL for COM.
# Import the type library. View the [[SDK Delphi Import | procedure here]].
# Add '''Pastel_Evolution_TLB''' to your unit's ''uses'' declaration.
# Add the files '''mscorlib_TLB.pas''' and '''System_TLB.pas''' to your project. You can either generate them yourself, or download them [[SDK Downloads | here]].
# Refer to the below example procedure for jump-starting your integration tasks.

<syntaxhighlight lang="delphi">
procedure TForm1.Button1Click(Sender: TObject);
var
stkItem : _InventoryItem;
customer : _Customer;
helper : _ComHelper;
orderDetail : _OrderDetail;
salesOrder : _SalesOrder;
reference, itemCode, customerCode : string;
recordID : integer;
begin
try
itemCode := 'ABC001';
customerCode := 'CASH33';
Log('Connecting...');
helper := CoComHelper.Create();
helper.CreateCommonDBConnection('server=.;initial catalog=EvolutionCommon;integrated security=SSPI');
helper.SetLicense('DEMO', '47481667230473');
helper.CreateConnection('server=.;initial catalog=50127;integrated security=SSPI');
helper.BeginTran;
Log('...connected');
Log('Expected DB version', helper.CompatibleEvolutionDatabaseVersion);
Log('Current DB version: ', helper.CurrentEvolutionDatabaseVersion);
if helper.CompatibleEvolutionDatabaseVersion <> helper.CurrentEvolutionDatabaseVersion then
Log('WARNING', 'The current database version differs from version expected by the API.');
recordID := helper.FindARAccountByCode(customerCode);
if recordID = -1 then
begin
// account does not exist, so create it
customer := CoCustomer.Create();
customer.Code := customerCode;
customer.Description := 'Demo Account';
customer.Save;
Log('Account created', customer.ID);
end
else
begin
// account exists, so simply load it
customer := helper.GetARAccount(customerCode);
end;
Log('Creating order...');
salesOrder := CoSalesOrder.Create();
salesOrder.Customer := customer;
Log('Creating detail...');
orderDetail := CoOrderDetail.Create;
// find inventory item
recordID := helper.FindStockItemByCode(itemCode);
if recordID = -1 then
begin
// item does not exist, so create it
stkItem := CoInventoryItem.Create();
stkItem.Code := itemCode;
stkItem.IsServiceItem := True;
stkItem.Description := 'Demo Item';
stkItem.Save;
Log('Item created', stkItem.ID)
end
else
begin
// item exists, so simply load it
stkItem := helper.GetStockItem(itemCode);
end;
orderDetail.InventoryItem := stkItem;
// if this is a new item, it gets created as a service item (above),
// and the quantity on hand will be irrelevant
Log('Stock on hand', stkItem.QtyOnHand);
orderDetail.Quantity := 5;
orderDetail.UnitSellingPrice := 100;
orderDetail.Discount := 100;
Log('Line total (excl.)', orderDetail.TotalExcl);
Log('Adding detail...');
Log('...done');
salesOrder.Detail.Add_2(orderDetail);
Log('Order Total (excl)', salesOrder.TotalExcl);
reference := salesOrder.Complete;
Log('Invoice No', reference);
helper.CommitTran;
except
on E : Exception do
begin
helper.RollbackTran;
ShowMessage(E.Message);
end;
end;
end;
</syntaxhighlight>