CData Cloud offers access to Sage 200 across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Sage 200 through CData Cloud.
CData Cloud allows you to standardize and configure connections to Sage 200 as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to Sage 200 in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Sage 200 and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Sage 200 through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Sage 200 by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
To connect to Sage 200, specify the following connection properties:
To connect via OAuth from all authentication flows, you must set AuthScheme to OAuth.
The following subsections describe how to authenticate to Sage 200 from the available oauth flows. For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application. For a complete list of connection string properties available in Sage 200, see Connection.
When the access token expires, the Cloud refreshes it automatically.
However, you must create a custom OAuth application to connect to Sage 200 via the Web. And since custom OAuth applications seamlessly support all three commonly-used auth flows, you might want to create custom OAuth applications (use your own OAuth Application Credentials) for those auth flows anyway. Custom OAuth applications are useful if you want to:
When you are ready to begin the process:
Sage creates the desired custom OAuth application and responds with values for the OAuthClientId (Client Id), the OAuthClientSecret (Client Secret), and the Scope.
If you need further assistance from Sage, see https://developer.columbus.sage.com/contactus.
By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
This section shows the available API objects and provides more information on executing SQL to Sage 200 APIs.
Sage200 StandardUK Data Model describes the schemas available to connect to Sage 200 Standard UK accounts. You can use tables to work with live Sage 200 data. You can use stored procedures provided by CData Cloud to automate working with Sage 200 data.
Sage200 ProfessionalUK Data Model describes the schemas available to connect to Sage 200 Professional UK accounts. You can use tables to work with live Sage 200 data. You can use stored procedures provided by CData Cloud to automate working with Sage 200 data.
Views describes the available views. Views are statically defined to model Banks, Customers, Products, and more.
Stored Procedures are function-like interfaces to Sage 200. Stored procedures allow you to execute operations to Sage 200, such as retrieving the OAuth Access Token.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| BankPostedTransactions | Bank posted transactions are created when transactions such as receipts or payments are posted against the Cash Book. |
| Banks | Bank accounts can be created in Sage 200 for any type of account that money is paid in/out of, for example, cash, credit cards or, business current account. Bank accounts can be in any currency and all balances are recorded in the currency specific to that bank account. |
| CompanyDetails | Every instance of Sage 200 is configured for the company using it. A company is identified in Sage 200 by its name. Sage 200 stores separate company details for each company that is created. The information stored within company details is typical company information such as VAT registration number and company contact details. |
| CostCentres | Cost centres are typically used to aid collating related costs and reporting on a specific segment of an organisation i.e. a company division such as sales or production. |
| Currencies | Sage 200 works in multiple currencies and each company can configure up to 99 currencies to use, and all can be configured to use a single exchange rate, period exchange rates, or both. One currency must be configured as the base currency and this cannot be changed once transactions have been entered. If a currency is configured as amendable, the exchange rate can be modified when entering transactions. |
| CustomerContacts | Information can be stored for multiple contacts against each customer account. Each contact can have its own details such as telephone numbers, fax numbers, email address and website. |
| CustomerDeliveryAddresses | A customer can have multiple delivery addresses stored for their account which can be used when creating an invoice or sales order. |
| Customers | Customers are one of the most important entities within Sage 200 as they are associated with many important resources within the application and underpin most of the main features (e.g. sales orders, payment receipts, etc). When making larger requests for customer information, the Customer Views resource can be a faster alternative to this resource. |
| CustomerSalesOrderInvoiceCreditLine | The default sort (orderby) fields are by 'sop_invoice_credit_id' and 'sop_invoice_credit_line_id' descending. |
| Departments | Departments are a subdivision of cost centres and are used where specific costs or revenue need to be collated and reported on separately. For example, a cost centre could be a sales area such as North East or South West and different departments could be Administration and Training. |
| FinancialReportLayouts | Financial statement layouts are designed to provide a clear representation of your accounts. This resource returns the details of all financial statement layouts. The default sort (orderby) field are by 'financial_report_layout_id' and 'financial_report_row_report_row' ascending. |
| FinancialYearPeriods | This resource returns the details of all accounting periods for all financial years held for the company. A company always has five future financial years and can have unlimited previous years, depending on how long the company has been operating. The default sort (orderby) field are by 'financial_year_start_date' and 'period_number' ascending. |
| NominalCodes | Nominal accounts are fundamental to the successful management of company finances. The value of every transaction entered into Sage 200 is posted to a nominal account and, is where the revenue and expenditure of the business is recorded. Nominal accounts include a code, and cost centre and a department. |
| NominalReportCategories | Nominal report categories are used in financial statements (PL, Balance Sheet) to group nominal codes under headings and to determine whether the nominal code value is reported on the layout for the Balance Sheet (Asset and Liability) or Profit and Loss (Income and Expense). |
| NominalTransactionAnalysisCodes | Nominal transaction analysis codes are used to group nominal analysis items on various transaction types |
| PendingEmails | When working with Microsoft Flow, it is useful to be able to access pending emails to send as notifications to the user from Sage 200. |
| PriceBands | A price band is simply a price list. They're used to offer different prices to different customers. Product prices are set in the each price band. The price a customer receives for a product depends on the price band their account is linked to. |
| ProductGroups | Product groups are used to group stock items together with similar characteristics or requirements. Product Groups provide several default settings for stock items and, have their own unique code and description. |
| ProductPrices | This returns the selling prices of your products. A price is returned for each price band associated with a product. A price band is simply a price list. The price a customer receives for a product depends on the price band their account is linked to. The 'Standard' price band is the default. The prices returned here do not include any customer specific discounts. The default sort (orderby) field is by 'product_code' ascending. |
| Products | Products are used to track stock within Sage 200. This is not just for physical items, but also for items that are ordered direct from suppliers, services, and time or labour that can be included on customer invoices. |
| ProductTransactions | A product transaction is created each time a product is moved in, or out of stock. Product transactions are created from various sources such as purchase orders, sales orders, transfers between warehouses etc.. This resource returns the details of product transactions. The default sort (orderby) field is by 'id' descending. |
| PurchaseOrderLines | When making larger requests for purchase order information, the Purchase Order Line Views resource is a faster alternative to the 'Purchase Orders' resource. |
| PurchaseOrders | Purchase orders are used to represent the purchase of goods or services from a supplier. They are central to a business and define the terms (price, quantity and times) by which the products or services will be received. |
| PurchasePostedTransactions | Purchase posted transactions are created when transactions, such as purchases made, refunds or credit notes, are posted against the Purchase Ledger. It is not possible to use this API resource to create posted transactions. |
| SalesHistoricalTransactions | Sales historical transactions are created when transactions are archived from the Sales Ledger. It is not possible to use this API resource to create historical transactions. |
| SalesOrderAdditionalCharges | Additional charges can be added to sales orders to account for items such as carriage and insurance. Within the Sage 200 application, users can setup and maintain the list of additional charges that can be referenced when creating a sales order. This API resource can be used to determine what each additional charge is for. |
| SalesOrderLines | When making larger requests for sales order information, the Sales Order Line Views resource is a faster alternative to the 'Sales Orders' resource. The Sales Order Line Views resource returns more information than the 'Sales Orders' resource, and therefore reduces the number of API requests required to return the same information from multiple resources. This resource returns a view of sales orders, sales order lines, customers, products, warehouses, tax codes and currencies that can be queried on any field. The default sort (orderby) field are by 'sop_order_id' and 'sop_order_line_id' descending. |
| SalesOrderProformaLines | This resource returns a view of sales pro formas, sales pro forma lines, customers, products, warehouses, tax codes and currencies that can be queried on any field. The default sort (orderby) field are by 'sop_proforma_id' and 'sop_proforma_line_id' descending. |
| SalesOrderQuoteLines | This resource returns a view of sales quotes, sales quote lines, customers, products, warehouses, tax codes and currencies that can be queried on any field. The default sort (orderby) field are by 'sop_quote_id' and 'sop_quote_line_id' descending. |
| SalesOrders | Sales orders are used to represent the sale of goods or services to a customer. They are central to a business and define the terms (price, quantity and times) by which the products or services will be delivered. Note: Adding traceable items to sales orders. If you're using traceable stock items and an item is set to be sold from a single batch, then the order quantity must be less than or equal to quantity in the batch. If you try to order more than the quantity in the batch, the order cannot be posted via the API. |
| SalesPostedTransactions | Sales posted transactions are created when transactions, such as orders invoiced, receipts, refunds or credit notes, are posted against the Sales Ledger. It is not possible to use this API resource to create posted transactions. To post a transaction, the necessary API resource must be invoked. When making larger requests for customer information, the Sales Transactions Views resource can be a faster alternative to this resource. |
| SalesTradingPeriods | This resource returns the details of all sales trading periods for all financial years held for the company. A company can have the trading periods set to be the same as the accounting periods or as different periods. (Sage 200c Professional and Sage 200 Extra Online Only, Sage 200c Standard defaults to financial year periods) |
| SalesTransactions | When making larger API requests for transaction information from the Sales ledger, the Sales Transaction Views resource can be a faster alternative to the 'Sales Posted Transactions' resource. The Sales Transaction Views resource also returns a wider breadth of information than the Sales Posted Transactions. |
| StockSettings | These settings to define how to process and manage your stock. |
| SupplierContacts | Information can be stored for multiple contacts against each Supplier account. Each contact can have its own details such as telephone numbers, fax numbers, email address and website. |
| Suppliers | Suppliers are one of the most important entities within Sage 200 as they are associated with many important resources within the application and underpin most of the main features (e.g. purchase orders, purchase receipts, etc). |
| TaxCodes | Tax codes are normally used for UK business VAT Rates. They are accessed by Sage 200 modules in order to: - Analyse the rates to Nominal Ledger accounts. - Analyse the rates to the VAT Return. - Read percentages for calculations in transactions. |
| WarehouseHoldings | All stock within Sage 200 regardless of type (Stock, Service/labour, or Miscellaneous), require a holding location. The location indicates where an item is stored and the stock level settings for each product in the warehouse i.e. the re-order level, the minimum and maximum stock levels. Items with a type of 'Stock' have levels recorded for each warehouse location and the levels are used when allocating, issuing and receiving stock. If the stock setting UseMultipleLocations is true, a product can be linked to multiple warehouse holdings. You cannot delete the last warehouse holding associated with a product. |
| Warehouses | All stock within Sage 200, regardless of type (Stock, Service/labour, or Miscellaneous), requires a holding location. By default, the HOME warehouse is created within Sage 200, you can then create your own warehouses. |
Bank posted transactions are created when transactions such as receipts or payments are posted against the Cash Book.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: NominalAnalysisItems,TaxAnalysisItems,TradeItems columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM BankPostedTransactions WHERE Id = 29448 SELECT * FROM BankPostedTransactions WHERE BankId = 29401 SELECT * FROM BankPostedTransactions WHERE BankTransactionType = 'Payment' SELECT * FROM BankPostedTransactions WHERE EntryDescription = 'Opening Balance' SELECT * FROM BankPostedTransactions WHERE Reference = 'O/Bal' SELECT * FROM BankPostedTransactions WHERE SecondReference = 'abc' SELECT * FROM BankPostedTransactions WHERE TransactionDate = '2017-12-31T01:00:00.000+01:00' SELECT * FROM BankPostedTransactions WHERE PostedDate = '2017-09-13T02:00:00.000+02:00' SELECT * FROM BankPostedTransactions WHERE ChequeValue = -6511.96 SELECT * FROM BankPostedTransactions WHERE ChequeDiscountValue = 0 SELECT * FROM BankPostedTransactions WHERE ChequeToAccountCurrencyRate = 1 SELECT * FROM BankPostedTransactions WHERE BankChequeToBaseCurrencyRate = 1 SELECT * FROM BankPostedTransactions WHERE ChequeCurrencyId = 2103 SELECT * FROM BankPostedTransactions WHERE Urn = 24 SELECT * FROM BankPostedTransactions WHERE UserName = 'Migration' SELECT * FROM BankPostedTransactions WHERE DateTimeUpdated = '2018-02-28T15:23:46.467+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Id. | |
| BankId | Long |
Banks.Id | Bank Id. See banks |
| BankTransactionType | String | Transaction type. See bank_transaction_types | |
| EntryDescription | String | Transaction description. | |
| Reference | String | Transaction reference. | |
| SecondReference | String | Second reference. | |
| TransactionDate | Date | Transaction date. | |
| PostedDate | Date | Posted date. | |
| ChequeValue | Decimal | Value of the entry. | |
| ChequeDiscountValue | Decimal | Entry discount value. | |
| ChequeToAccountCurrencyRate | Decimal | Exchange rate between the bank account currency and the cheque currency. | |
| BankChequeToBaseCurrencyRate | Decimal | Exchange rate between the bank account and the company base currency. | |
| ChequeCurrencyId | Long | Currency Id. See currencies | |
| Urn | Long | Unique reference number. | |
| UserName | String | User who entered the transaction. | |
| NominalAnalysisItems | String | Nominal analysis items. See bank_posted_transactions_nominal_analysis_items | |
| TaxAnalysisItems | String | Tax analysis items. See bank_posted_transactions_tax_analysis_items | |
| TradeItems | String | Trade items. See bank_posted_transactions_trade_items | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Bank accounts can be created in Sage 200 for any type of account that money is paid in/out of, for example, cash, credit cards or, business current account. Bank accounts can be in any currency and all balances are recorded in the currency specific to that bank account.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: BankAddressId,BankAddressContact,BankAddressCountry,BankAddressCity,BankAddressPostcode,BankAddress_1,BankAddress_2,BankAddress_3,BankAddress_4,BankContacts columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Banks WHERE Id = 29401 SELECT * FROM Banks WHERE Code = '1200' SELECT * FROM Banks WHERE Description = 'Bank Current Account' SELECT * FROM Banks WHERE SortCode = '233434' SELECT * FROM Banks WHERE AccountNo = '003234234' SELECT * FROM Banks WHERE BankName = 'Lloyds Bank PLC' SELECT * FROM Banks WHERE AccountType = 'BankAccountTypeCurrent' SELECT * FROM Banks WHERE AccountStatusType = 'AccountStatusActive' SELECT * FROM Banks WHERE Balance = -9941.57 SELECT * FROM Banks WHERE BalanceInBase = -9941.57 SELECT * FROM Banks WHERE OverdraftLimit = 0 SELECT * FROM Banks WHERE AccountName = 'Stationery & Computer Mart UK Ltd' SELECT * FROM Banks WHERE Iban = 'abc' SELECT * FROM Banks WHERE Bic = 'abc' SELECT * FROM Banks WHERE StatementBalance = 0 SELECT * FROM Banks WHERE StatementDate = '2019-10-02T11:46:53Z' SELECT * FROM Banks WHERE AccountCurrencyId = 2103 SELECT * FROM Banks WHERE DateTimeUpdated = '2018-02-28T15:23:46.070+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Bank account record Id. | |
| Code | String | Bank account code. | |
| Description | String | Bank description. | |
| SortCode | String | Bank sort code. | |
| AccountNo | String | Bank account number. | |
| BankName | String | Bank name. | |
| AccountType | String | Bank account type. See bank_account_types | |
| AccountStatusType | String | The status of the bank account (Sage 200c Standard and versions of Professional released after February 2018). For example, this can either be 'Active' or 'Hidden'. See account_status_types | |
| Balance | Decimal | Bank balance. | |
| BalanceInBase | Decimal | Bank balance in base currency. | |
| OverdraftLimit | Decimal | Bank overdraft limit. | |
| AccountName | String | Account name. | |
| Iban | String | International bank account number. | |
| Bic | String | Bank identifier code. | |
| StatementBalance | Decimal | Last statement balance. | |
| StatementDate | Date | Last statement date. | |
| AccountCurrencyId | Long |
Currencies.Id | Currency record Id. See currencies |
| BankAddressId | Long | Bank address. Bank address record id. | |
| BankAddressContact | String | Bank address. Address Contact name. | |
| BankAddressCountry | String | Bank address. Country. | |
| BankAddressCity | String | Bank address. City. | |
| BankAddressPostcode | String | Bank address. Postcode. | |
| BankAddress_1 | String | Bank address. Address line 1. | |
| BankAddress_2 | String | Bank address. Address line 2. | |
| BankAddress_3 | String | Bank address. Address line 3. | |
| BankAddress_4 | String | Bank address. Address line 4. | |
| BankContacts | String | Collection of bank contact values. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Every instance of Sage 200 is configured for the company using it. A company is identified in Sage 200 by its name. Sage 200 stores separate company details for each company that is created. The information stored within company details is typical company information such as VAT registration number and company contact details.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: CountryCode,CountryCodeName,CountryCodeEUMember,AddressCountry,Address_1,Address_2,Address_3,Address_4,AddressCity,AddressCounty,AddressPostcode columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM CompanyDetails WHERE Name = 'Stationery & Computer Mart UK' SELECT * FROM CompanyDetails WHERE Telephone = '0191 955 3000' SELECT * FROM CompanyDetails WHERE Fax = '0191 955 3001' SELECT * FROM CompanyDetails WHERE Email = '[email protected]' SELECT * FROM CompanyDetails WHERE Website = 'http://www.stationerycomputermartuk.co.uk' SELECT * FROM CompanyDetails WHERE TaxRegistrationNumber = '376 6823 94' SELECT * FROM CompanyDetails WHERE CountryCodeId = 13 SELECT * FROM CompanyDetails WHERE YearsAccountsHeldFor = 2 SELECT * FROM CompanyDetails WHERE EoriNumber = 'abc' SELECT * FROM CompanyDetails WHERE DateTimeUpdated = '2018-02-28T15:23:46.040+01:00'
| Name | Type | References | Description |
| Name [KEY] | String | Company name. | |
| Telephone | String | Telephone number. | |
| Fax | String | Fax number. | |
| String | Email address. | ||
| Website | String | Company website address. | |
| TaxRegistrationNumber | String | Tax registration number. | |
| CountryCodeId | Long | Country code record Id. See country_codes | |
| CountryCode | String | Country code record Id. See country_codes | |
| CountryCodeName | String | Country code record Id. See country_codes | |
| CountryCodeEUMember | Boolean | Country code record Id. See country_codes | |
| YearsAccountsHeldFor | Int | Number of years that periods with nominal data exist for up to a maximum of six years. | |
| AddressCountry | String | The company's address Id. | |
| Address_1 | String | The company's address. Address line 1. | |
| Address_2 | String | The company's address. Address line 2. | |
| Address_3 | String | The company's address. Address line 3. | |
| Address_4 | String | The company's address. Address line 4. | |
| AddressCity | String | The company's address. City | |
| AddressCounty | String | The company's address. County | |
| AddressPostcode | String | The company's address. Postcode | |
| EoriNumber | String | The company's EORI number. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Cost centres are typically used to aid collating related costs and reporting on a specific segment of an organisation i.e. a company division such as sales or production.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM CostCentres WHERE Id = 1015 SELECT * FROM CostCentres WHERE Code = 'abc' SELECT * FROM CostCentres WHERE Name = 'abc' SELECT * FROM CostCentres WHERE DateTimeUpdated = '2018-02-28T15:23:46.230+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Cost centre record Id. | |
| Code | String | Cost centre code. | |
| Name | String | Cost centre name. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Sage 200 works in multiple currencies and each company can configure up to 99 currencies to use, and all can be configured to use a single exchange rate, period exchange rates, or both. One currency must be configured as the base currency and this cannot be changed once transactions have been entered. If a currency is configured as amendable, the exchange rate can be modified when entering transactions.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: CurrencyIsoCode,CurrencyIsoCodeName columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Currencies WHERE Id = 2103 SELECT * FROM Currencies WHERE Symbol = '£' SELECT * FROM Currencies WHERE Name = 'Pound Sterling' SELECT * FROM Currencies WHERE CoreCurrencyRate = 1 SELECT * FROM Currencies WHERE EuroCurrencyRate = 0.714285 SELECT * FROM Currencies WHERE CurrencyIsoCodeId = 49 SELECT * FROM Currencies WHERE IsBaseCurrency = true SELECT * FROM Currencies WHERE IsEuroCurrency = false SELECT * FROM Currencies WHERE DateTimeUpdated = '2018-02-28T15:23:46.243+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Currency record Id. | |
| Symbol | String | Currency symbol. | |
| Name | String | Currency name. | |
| CoreCurrencyRate | Decimal | Currency rate in use against base. | |
| EuroCurrencyRate | Decimal | Euro rate. | |
| CurrencyIsoCodeId | Long | ISO Currency Code Record Id. See currency_iso_codes | |
| CurrencyIsoCode | String | ISO Currency Code Record Id. See currency_iso_codes | |
| CurrencyIsoCodeName | String | ISO Currency Code Record Id. See currency_iso_codes | |
| IsBaseCurrency | Bool | Flag to indicate if the currency is the base currency. | |
| IsEuroCurrency | Bool | Flag to indicate if the currency is Euro. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Information can be stored for multiple contacts against each customer account. Each contact can have its own details such as telephone numbers, fax numbers, email address and website.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM CustomerContacts WHERE Id = 42101 SELECT * FROM CustomerContacts WHERE CustomerId = '0000000001' SELECT * FROM CustomerContacts WHERE Name = 'Sample'
| Name | Type | References | Description |
| Id [KEY] | Long | Customer contact record Id. | |
| CustomerId | Long | Customer record Id. | |
| Name | String | Contact Name - Concatenated first_name, middle_name and last_name. | |
| FirstName | String | Contact first name. | |
| MiddleName | String | Contact middle name. | |
| LastName | String | Contact surname. | |
| IsDefault | Bool | Is this the default contact for the parent customer. See customer | |
| DefaultTelephone | String | Default telephone number. | |
| DefaultEmail | String | Default email address. | |
| SalutationId | Long | Contact salutation id. | |
| SalutationIsDefault | Boolean | Contact salutation. | |
| SalutationCode | String | Contact salutation code. | |
| SalutationDescription | String | Contact salutation description. | |
| Emails | String | Customer emails. See customer_emails | |
| Telephones | String | Customer telephones. See customer_telephones | |
| Mobiles | String | Customer mobiles. See customer_mobiles | |
| Faxes | String | Customer faxes. See customer_faxes | |
| Websites | String | Customer websites. See customer_websites | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
A customer can have multiple delivery addresses stored for their account which can be used when creating an invoice or sales order.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM CustomerDeliveryAddresses WHERE Id = 27927 SELECT * FROM CustomerDeliveryAddresses WHERE Contact = 'Lee Dalkin' SELECT * FROM CustomerDeliveryAddresses WHERE Country = 'abc' SELECT * FROM CustomerDeliveryAddresses WHERE CustomerId = 27825 SELECT * FROM CustomerDeliveryAddresses WHERE Description = 'Registered address' SELECT * FROM CustomerDeliveryAddresses WHERE Email = '[email protected]' SELECT * FROM CustomerDeliveryAddresses WHERE Fax = '01742 876 236' SELECT * FROM CustomerDeliveryAddresses WHERE IsDefault = false SELECT * FROM CustomerDeliveryAddresses WHERE PostalName = 'A1 Design Services' SELECT * FROM CustomerDeliveryAddresses WHERE TaxCodeId = 1729 SELECT * FROM CustomerDeliveryAddresses WHERE TaxNumber = 'GB238 3839 38' SELECT * FROM CustomerDeliveryAddresses WHERE Telephone = '01742 876 234' SELECT * FROM CustomerDeliveryAddresses WHERE Address1 = '67a Station Road' SELECT * FROM CustomerDeliveryAddresses WHERE Address2 = 'abc' SELECT * FROM CustomerDeliveryAddresses WHERE Address3 = 'Blackpool' SELECT * FROM CustomerDeliveryAddresses WHERE Address4 = 'Lancashire' SELECT * FROM CustomerDeliveryAddresses WHERE City = 'abc' SELECT * FROM CustomerDeliveryAddresses WHERE County = 'abc' SELECT * FROM CustomerDeliveryAddresses WHERE Postcode = 'BP12 7HT' SELECT * FROM CustomerDeliveryAddresses WHERE AddressCountryCodeId = 0 SELECT * FROM CustomerDeliveryAddresses WHERE DateTimeUpdated = '2018-02-28T15:23:46.867+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | The unique id of the customer delivery address. | |
| Contact | String | The contact associated with the customer delivery address. | |
| Country | String | Country (if using segmented addresses in Sage 200c Professional or Sage 200 Extra Online). | |
| CustomerId | Long | Unique Id of the customer account the customer delivery address is associated with. See customers | |
| Description | String | The description of the customer delivery address. | |
| String | The email address associated with the customer delivery address. | ||
| Fax | String | The fax number associated with the customer delivery address. | |
| IsDefault | Bool | Flag to indicate if this is the default customer delivery address for the parent customer. See customer | |
| PostalName | String | Postal name is the name of the person or company who the invoice or sales order is addressed to. | |
| TaxCodeId | Long | The tax code record Id. See tax_codes | |
| TaxNumber | String | The tax number. | |
| Telephone | String | The telephone number associated with the customer delivery address. | |
| Address1 | String | Address line 1. | |
| Address2 | String | Address line 2. | |
| Address3 | String | Address line 3. | |
| Address4 | String | Address line 4. | |
| City | String | City (if using segmented addresses in Sage 200c Professional or Sage 200 Extra Online). | |
| County | String | County (if using segmented addresses in Sage 200c Professional or Sage 200 Extra Online). | |
| Postcode | String | Postcode. | |
| AddressCountryCodeId | Long | Country code Id. See country_codes | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Customers are one of the most important entities within Sage 200 as they are associated with many important resources within the application and underpin most of the main features (e.g. sales orders, payment receipts, etc). When making larger requests for customer information, the Customer Views resource can be a faster alternative to this resource.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: CountryCode,CountryCodeName,CountryCodeEuMember,MainAddress_1,MainAddress_2,MainAddress_3,MainAddress_4,MainAddressCity,MainAddressCounty,MainAddressPostcode,Contacts columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Customers WHERE Id = 27825 SELECT * FROM Customers WHERE Reference = 'A1D001' SELECT * FROM Customers WHERE Name = 'A1 Design Services' SELECT * FROM Customers WHERE ShortName = 'A1 Desig' SELECT * FROM Customers WHERE Balance = 1120.92 SELECT * FROM Customers WHERE OnHold = false SELECT * FROM Customers WHERE AccountStatusType = 'AccountStatusActive' SELECT * FROM Customers WHERE CurrencyId = 2103 SELECT * FROM Customers WHERE ExchangeRateType = 'ExchangeRateSingle' SELECT * FROM Customers WHERE TelephoneCountryCode = '44' SELECT * FROM Customers WHERE TelephoneAreaCode = '01742' SELECT * FROM Customers WHERE TelephoneSubscriberNumber = '876234' SELECT * FROM Customers WHERE FaxCountryCode = '44' SELECT * FROM Customers WHERE FaxAreaCode = '01742' SELECT * FROM Customers WHERE FaxSubscriberNumber = '876236' SELECT * FROM Customers WHERE Website = 'www.sage.co.uk' SELECT * FROM Customers WHERE CreditLimit = 0 SELECT * FROM Customers WHERE DefaultTaxCodeId = 1729 SELECT * FROM Customers WHERE VatNumber = 'GB238 3839 38' SELECT * FROM Customers WHERE DunsCode = 'abc' SELECT * FROM Customers WHERE AnalysisCode1 = 'Trade' SELECT * FROM Customers WHERE AnalysisCode2 = 'George' SELECT * FROM Customers WHERE AnalysisCode3 = 'Lancashire' SELECT * FROM Customers WHERE AnalysisCode4 = 'abc' SELECT * FROM Customers WHERE AnalysisCode5 = 'abc' SELECT * FROM Customers WHERE AverageTimeToPay = 0 SELECT * FROM Customers WHERE ValueOfCurrentOrdersInSop = 340.38 SELECT * FROM Customers WHERE CountryCodeId = 13 SELECT * FROM Customers WHERE DateTimeUpdated = '2018-03-05T11:19:18.317+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Customer unique Id. | |
| Reference | String | Customer account reference. NOTE: Not required if customer reference is set to | |
| Name | String | Customer name. | |
| ShortName | String | Customer short name. | |
| Balance | Decimal | Customer account balance. | |
| OnHold | Bool | True if customer account is on hold, else False. | |
| AccountStatusType | String | The status of the customer account (Sage 200c Standard and versions of Extra/Professional released after July 2017). For example, this can either be 'Active' or 'Hidden'. See account_status_types | |
| CurrencyId | Long |
Currencies.Id | Currency record Id. See currencies |
| ExchangeRateType | String | The type of exchange rate used on the customer account. See exchange_rate_types | |
| TelephoneCountryCode | String | Telephone country code (Sage 200c Professional and Sage 200 Extra Online Only). | |
| TelephoneAreaCode | String | Telephone area code (Sage 200c Professional and Sage 200 Extra Online Only). | |
| TelephoneSubscriberNumber | String | Telephone subscriber number (Sage 200c Professional and Sage 200 Extra Online Only). | |
| FaxCountryCode | String | Fax country code. | |
| FaxAreaCode | String | Fax area code. | |
| FaxSubscriberNumber | String | Fax subscriber number. | |
| Website | String | Website address. | |
| CreditLimit | Decimal | Credit limit for the customer. | |
| DefaultTaxCodeId | Long |
TaxCodes.Id | Default tax code record Id. See tax_codes |
| VatNumber | String | VAT registration number. | |
| DunsCode | String | DUNS number. | |
| AnalysisCode1 | String | Analysis code 1. | |
| AnalysisCode2 | String | Analysis code 2. | |
| AnalysisCode3 | String | Analysis code 3. | |
| AnalysisCode4 | String | Analysis code 4. | |
| AnalysisCode5 | String | Analysis code 5. | |
| AverageTimeToPay | Int | The customer average time to pay. | |
| ValueOfCurrentOrdersInSop | Decimal | Value of current sales orders for this customer. | |
| CountryCodeId | Long | Country code record Id. | |
| CountryCode | String | The customers country code. | |
| CountryCodeName | String | The customers country code name. | |
| CountryCodeEuMember | Boolean | Shows if the customer is Eu Member. | |
| MainAddress_1 | String | The customers main address line 1. | |
| MainAddress_2 | String | The customers main address line 2. | |
| MainAddress_3 | String | The customers main address line 3. | |
| MainAddress_4 | String | The customers main address line 4. | |
| MainAddressCity | String | The customers main address city. | |
| MainAddressCounty | String | The customers main address county. | |
| MainAddressPostcode | String | The customers main address postcode. | |
| Contacts | String | Customer contacts. See customer_contacts | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
The default sort (orderby) fields are by 'sop_invoice_credit_id' and 'sop_invoice_credit_line_id' descending.
| Name | Type | References | Description |
| CustomerId | Long | The associated customer record Id. See customers. | |
| CustomerName | String | The associated customer name. | |
| CustomerReference | String | The associated customer account reference. | |
| InvoiceCreditId | Long | Sales invoice credit Id. | |
| InvoiceCreditType | String | Sales invoice credit type. | |
| InvoiceCreditDocumentNo | String | Sales invoice credit document number. | |
| InvoiceCreditDocumentDate | Datetime | Sales invoice document date time (UTC). | |
| InvoiceCreditDocumentStatus | String | Sales invoice document status. | |
| InvoiceCreditExchangeRate | Decimal | Exchange rate for the sales invoice credit. | |
| InvoiceCreditDateTimeUpdated | Datetime | The date and time the sales invoice credit was last updated (UTC). | |
| InvoiceCreditLineId | Long | The associated sales invoice credit line Id. | |
| InvoiceCreditLineDate | Datetime | The invoice credit line date time (UTC). | |
| InvoiceCreditLineTotalValue | Decimal | The total value of the sop invoice credit line. | |
| InvoiceCreditLineTaxValue | Decimal | The tax value of the sop invoice credit line. | |
| InvoiceCreditLineDateTimeUpdated | Datetime | The date and time the sop invoice credit line was last updated (UTC). | |
| InvoiceLineProfitAnalysisId | Long | The associated sales invoice credit line profit analysis Id. | |
| InvoiceLineProfitAnalysisLineQuantity | Decimal | The quantity of the associated sop invoice credit line. | |
| InvoiceLineProfitAnalysisRealisedCostValue | Decimal | The realised cost value. | |
| InvoiceLineProfitAnalysisRealisedProfitValue | Decimal | The realised profit value. | |
| InvoiceLineProfitAnalysisDateTimeUpdated | Datetime | The date and time the sop invoice credit line profit analysis was last updated (UTC). | |
| ProductId | Long | The associated product record Id. See products. | |
| ProductCode | String | The code of the product ordered. | |
| ProductName | String | The name of the product ordered. | |
| ProductDescription | String | The associated product description. | |
| ProductDateTimeUpdated | Datetime | The date and time the product was last updated (UTC). | |
| ProductGroupId | Long | The associated product group record Id. | |
| ProductGroupCode | String | The associated product group code. | |
| ProductGroupDescription | String | The associated product group description. | |
| ProductGroupDateTimeUpdated | Datetime | The date and time the product group was last updated (UTC). |
Departments are a subdivision of cost centres and are used where specific costs or revenue need to be collated and reported on separately. For example, a cost centre could be a sales area such as North East or South West and different departments could be Administration and Training.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Departments WHERE Id = 1016 SELECT * FROM Departments WHERE Code = 'abc' SELECT * FROM Departments WHERE Name = 'abc' SELECT * FROM Departments WHERE DateTimeUpdated = '2018-02-28T15:23:46.277+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Department record Id. | |
| Code | String | Department code. | |
| Name | String | Department name. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Financial statement layouts are designed to provide a clear representation of your accounts. This resource returns the details of all financial statement layouts. The default sort (orderby) field are by 'financial_report_layout_id' and 'financial_report_row_report_row' ascending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM FinancialReportLayoutViews WHERE LayoutId = 46151 SELECT * FROM FinancialReportLayoutViews WHERE LayoutAccountReportType = 'ProfitLoss' SELECT * FROM FinancialReportLayoutViews WHERE LayoutName = 'Sample Profit and Loss Layout' SELECT * FROM FinancialReportLayoutViews WHERE RowId = 47221 SELECT * FROM FinancialReportLayoutViews WHERE RowLineType = 'Text' SELECT * FROM FinancialReportLayoutViews WHERE RowLayoutPositionType = 'Unknown' SELECT * FROM FinancialReportLayoutViews WHERE RowLayoutDebitOrCreditType = 'Unknown' SELECT * FROM FinancialReportLayoutViews WHERE RowReportRow = 1 SELECT * FROM FinancialReportLayoutViews WHERE RowTitle = 'Sales' SELECT * FROM FinancialReportLayoutViews WHERE RowSubtotalGroup = 1 SELECT * FROM FinancialReportLayoutViews WHERE RowGroupBreak1 = 0 SELECT * FROM FinancialReportLayoutViews WHERE RowGroupBreak2 = 0 SELECT * FROM FinancialReportLayoutViews WHERE RowGroupBreak3 = 0 SELECT * FROM FinancialReportLayoutViews WHERE RowGroupBreak4 = 0 SELECT * FROM FinancialReportLayoutViews WHERE RowGroupBreak5 = 0 SELECT * FROM FinancialReportLayoutViews WHERE RowGroupBreak6 = 0 SELECT * FROM FinancialReportLayoutViews WHERE RowGroupBreak7 = 0 SELECT * FROM FinancialReportLayoutViews WHERE RowGroupBreak8 = 0 SELECT * FROM FinancialReportLayoutViews WHERE RowGroupBreak9 = 0 SELECT * FROM FinancialReportLayoutViews WHERE NominalAccountReportCategoryId = 123 SELECT * FROM FinancialReportLayoutViews WHERE NominalAccountReportCategoryCode = 'abc' SELECT * FROM FinancialReportLayoutViews WHERE NominalAccountReportCategoryDescription = 'abc'
| Name | Type | References | Description |
| LayoutId [KEY] | Long | Financial report layout record Id. | |
| LayoutAccountReportType | String | The type of the financial layout. See financial_report_layout_types | |
| LayoutName | String | financial report layout name. | |
| RowId | Long | An asscoiated financial report row Id. | |
| RowLineType | String | The type of the financial layout. See financial_report_row_line_types | |
| RowLayoutPositionType | String | The type of the financial report row layout position. See financial_report_row_layout_position_types | |
| RowLayoutDebitOrCreditType | String | The type of the financial layout. See financial_report_row_layout_debit_or_credit_types | |
| RowReportRow | Int | Value to show the line number of the report row in the layout. | |
| RowTitle | String | The row title. | |
| RowSubtotalGroup | Int | Value to represent the sub total group. | |
| RowGroupBreak1 | Int | Value to represent the report row group break 1. | |
| RowGroupBreak2 | Int | Value to represent the report row group break 2. | |
| RowGroupBreak3 | Int | Value to represent the report row group break 3. | |
| RowGroupBreak4 | Int | Value to represent the report row group break 4. | |
| RowGroupBreak5 | Int | Value to represent the report row group break 5. | |
| RowGroupBreak6 | Int | Value to represent the report row group break 6. | |
| RowGroupBreak7 | Int | Value to represent the report row group break 7. | |
| RowGroupBreak8 | Int | Value to represent the report row group break 8. | |
| RowGroupBreak9 | Int | Value to represent the report row group break 9. | |
| NominalAccountReportCategoryId | Long | An Id specific to each nominal account report category. See nominal_report_category_types | |
| NominalAccountReportCategoryCode | String | The nominal account report category code. | |
| NominalAccountReportCategoryDescription | String | The nominal account report category description. |
This resource returns the details of all accounting periods for all financial years held for the company. A company always has five future financial years and can have unlimited previous years, depending on how long the company has been operating. The default sort (orderby) field are by 'financial_year_start_date' and 'period_number' ascending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM FinancialYearPeriodViews WHERE FinancialYearId = 1 SELECT * FROM FinancialYearPeriodViews WHERE FinancialYearStartDate = '2018-01-01T01:00:00.000+01:00' SELECT * FROM FinancialYearPeriodViews WHERE FinancialYearEndDate = '2018-12-31T01:00:00.000+01:00' SELECT * FROM FinancialYearPeriodViews WHERE YearRelativeToCurrentYear = 0 SELECT * FROM FinancialYearPeriodViews WHERE NumberOfPeriodsInYear = 12 SELECT * FROM FinancialYearPeriodViews WHERE AccountingPeriodId = 1 SELECT * FROM FinancialYearPeriodViews WHERE PeriodNumber = 1 SELECT * FROM FinancialYearPeriodViews WHERE PeriodStartDate = '2018-01-01T01:00:00.000+01:00' SELECT * FROM FinancialYearPeriodViews WHERE PeriodEndDate = '2018-01-31T01:00:00.000+01:00'
| Name | Type | References | Description |
| FinancialYearId [KEY] | Long | An Id specific to each financial year. | |
| FinancialYearStartDate | Date | Date the financial year starts. The returned string includes the time but this will always be 00:00:00. | |
| FinancialYearEndDate | Date | Date the financial year ends. The returned string includes the time but this will always be 00:00:00. | |
| YearRelativeToCurrentYear | Int | Value to represent the year relative to the current financial year. The current financial year is 0. The first previous year is -1. The first future year is 1. | |
| NumberOfPeriodsInYear | Int | The number of periods in the financial year. | |
| AccountingPeriodId | Long | An Id specific to each accounting period. | |
| PeriodNumber | Int | Value to show the period in relation to the associated year. For example, for a year that starts in January, January will be period 1, February period 2 etc. | |
| PeriodStartDate | Date | Date the period starts. The returned string includes the time but this will always be 00:00:00. | |
| PeriodEndDate | Date | Date the period finished. The returned string includes the time but this will always be 00:00:00. |
Nominal accounts are fundamental to the successful management of company finances. The value of every transaction entered into Sage 200 is posted to a nominal account and, is where the revenue and expenditure of the business is recorded. Nominal accounts include a code, and cost centre and a department.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM NominalCodes WHERE Id = 2317 SELECT * FROM NominalCodes WHERE Name = 'Freehold Property' SELECT * FROM NominalCodes WHERE Reference = '0010' SELECT * FROM NominalCodes WHERE CostCentreId = 1015 SELECT * FROM NominalCodes WHERE CostCentreCode = 'abc' SELECT * FROM NominalCodes WHERE DepartmentId = 1016 SELECT * FROM NominalCodes WHERE DepartmentCode = 'abc' SELECT * FROM NominalCodes WHERE NominalAccountType = 'NominalAccountTypePosting' SELECT * FROM NominalCodes WHERE AccountStatusType = 'AccountStatusActive' SELECT * FROM NominalCodes WHERE ReportCategoryId = 2289 SELECT * FROM NominalCodes WHERE DisplayBalancesInSelectionList = false SELECT * FROM NominalCodes WHERE BalanceYearToDate = 123.3 SELECT * FROM NominalCodes WHERE DateTimeUpdated = '2018-02-28T15:23:46.717+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Nominal code record Id. | |
| Name | String | Nominal code name. | |
| Reference | String | Nominal code reference. | |
| CostCentreId | Long |
CostCentres.Id | Nominal code cost centre record Id. See cost_centres |
| CostCentreCode | String | Cost centre code. | |
| DepartmentId | Long |
Departments.Id | Nominal code department record Id. See departments |
| DepartmentCode | String | Department code. | |
| NominalAccountType | String | The type of the nominal code. See nominal_account_types | |
| AccountStatusType | String | The status of the nominal code (Sage 200c Standard and versions of Professional released after February 2018). For example, this can either be 'Active' or 'Hidden'. See account_status_types | |
| ReportCategoryId | Long | Financial report category record Id. See nominal_report_categories | |
| DisplayBalancesInSelectionList | Bool | Whether balances for the nominal code can be shown in selection lists. | |
| BalanceYearToDate | Decimal | The nominal account balance, if balances can be shown for the nominal account. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Nominal report categories are used in financial statements (PL, Balance Sheet) to group nominal codes under headings and to determine whether the nominal code value is reported on the layout for the Balance Sheet (Asset and Liability) or Profit and Loss (Income and Expense).
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM NominalReportCategories WHERE Id = 2258 SELECT * FROM NominalReportCategories WHERE AccountReportType = 'ProfitLoss' SELECT * FROM NominalReportCategories WHERE Code = '1' SELECT * FROM NominalReportCategories WHERE Description = 'Sales' SELECT * FROM NominalReportCategories WHERE AccountReportCategoryType = 'NominalReportingCategoryTypeIncome' SELECT * FROM NominalReportCategories WHERE DateTimeUpdated = '2018-02-28T15:23:45.960+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Nominal report category record Id. | |
| AccountReportType | String | The type of the report.. See financial_report_layout_types | |
| Code | String | Nominal report category code. | |
| Description | String | Nominal report category description. | |
| AccountReportCategoryType | String | The type of the report category. See nominal_report_category_types | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Nominal transaction analysis codes are used to group nominal analysis items on various transaction types
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM NominalTransactionAnalysisCodes WHERE Code = 'Promo0715' SELECT * FROM NominalTransactionAnalysisCodes WHERE Description = 'Promotion July 2015' SELECT * FROM NominalTransactionAnalysisCodes WHERE Active = true SELECT * FROM NominalTransactionAnalysisCodes WHERE DateTimeUpdated = '2018-02-28T15:23:46.413+01:00'
| Name | Type | References | Description |
| Code [KEY] | String | Nominal transaction analysis code. | |
| Description | String | Nominal transaction analysis code description. | |
| Active | Bool | Boolean indicating whether the transaction analysis code is active. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
When working with Microsoft Flow, it is useful to be able to access pending emails to send as notifications to the user from Sage 200.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM PendingEmails WHERE Id = 123 SELECT * FROM PendingEmails WHERE EmailType = 'abc' SELECT * FROM PendingEmails WHERE EmailAddress = 'abc' SELECT * FROM PendingEmails WHERE EmailSubject = 'abc' SELECT * FROM PendingEmails WHERE EmailBody = 'abc' SELECT * FROM PendingEmails WHERE UserNumber = 123 SELECT * FROM PendingEmails WHERE UserName = 'abc' SELECT * FROM PendingEmails WHERE DateTimeUpdated = '2019-10-02T11:46:53Z'
| Name | Type | References | Description |
| Id [KEY] | Long | The unique id of the Sage 200 pending email identifier. | |
| EmailType | String | The type of pending email (which provides the intended purpose). | |
| EmailAddress | String | The email address of the email recipient. | |
| EmailSubject | String | The text to use for the subject of the email. | |
| EmailBody | String | The text to use for the body of the email. | |
| UserNumber | Long | The user id of the email recipient. | |
| UserName | String | The user name of the email recipient. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
A price band is simply a price list. They're used to offer different prices to different customers. Product prices are set in the each price band. The price a customer receives for a product depends on the price band their account is linked to.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM PriceBands WHERE Id = 1064 SELECT * FROM PriceBands WHERE Name = 'Standard' SELECT * FROM PriceBands WHERE Description = 'Standard' SELECT * FROM PriceBands WHERE IsStandardBand = true SELECT * FROM PriceBands WHERE CurrencyId = 2103 SELECT * FROM PriceBands WHERE PriceBandTypeId = 0 SELECT * FROM PriceBands WHERE IsActive = true SELECT * FROM PriceBands WHERE IsTimeBased = false SELECT * FROM PriceBands WHERE ActiveDateTimeFrom = '2019-10-02T11:46:53Z' SELECT * FROM PriceBands WHERE ActiveDateTimeTo = '2019-10-02T11:46:53Z' SELECT * FROM PriceBands WHERE DateTimeUpdated = '2018-02-28T15:23:46.183+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Price band record Id. | |
| Name | String | Price band name. | |
| Description | String | Price band description. | |
| IsStandardBand | Bool | Is this the Standard price band. | |
| CurrencyId | Long | Currency record Id. See currencies | |
| PriceBandTypeId | Long | Price band type record Id; this will be 0 for Universal price bands and 1 for Limited price bands. | |
| IsActive | Bool | Is this price band active. | |
| IsTimeBased | Bool | Is this price band time based. | |
| ActiveDateTimeFrom | Datetime | The date and time this price band is active from. | |
| ActiveDateTimeTo | Datetime | The date and time this price band is active to. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Product groups are used to group stock items together with similar characteristics or requirements. Product Groups provide several default settings for stock items and, have their own unique code and description.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM ProductGroups WHERE Id = 34632 SELECT * FROM ProductGroups WHERE Code = 'NONS' SELECT * FROM ProductGroups WHERE Description = 'Non Stock Item' SELECT * FROM ProductGroups WHERE ProductType = 'EnumStockItemTypeMisc' SELECT * FROM ProductGroups WHERE CanLevelsGoNegative = false SELECT * FROM ProductGroups WHERE DateTimeUpdated = '2018-02-28T15:23:46.310+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Product group Id. | |
| Code | String | Product group code. | |
| Description | String | Product group description. | |
| ProductType | String | Product group type. See product_types | |
| CanLevelsGoNegative | Bool | Can stock levels go negative. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
This returns the selling prices of your products. A price is returned for each price band associated with a product. A price band is simply a price list. The price a customer receives for a product depends on the price band their account is linked to. The 'Standard' price band is the default. The prices returned here do not include any customer specific discounts. The default sort (orderby) field is by 'product_code' ascending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM ProductPriceViews WHERE ProductPriceId = 34760 SELECT * FROM ProductPriceViews WHERE ProductId = 34751 SELECT * FROM ProductPriceViews WHERE ProductCode = 'BOARD001' SELECT * FROM ProductPriceViews WHERE ProductName = 'Whiteboard - Drywipe (900 x 1200)' SELECT * FROM ProductPriceViews WHERE ProductStockUnitName = 'Each' SELECT * FROM ProductPriceViews WHERE PriceBandId = 1064 SELECT * FROM ProductPriceViews WHERE PriceBandName = 'Standard' SELECT * FROM ProductPriceViews WHERE ProductPriceUseStandard = true SELECT * FROM ProductPriceViews WHERE ProductPricePrice = 20 SELECT * FROM ProductPriceViews WHERE CurrencyId = 2103 SELECT * FROM ProductPriceViews WHERE CurrencyName = 'Pound Sterling' SELECT * FROM ProductPriceViews WHERE CurrencySymbol = '£' SELECT * FROM ProductPriceViews WHERE DateTimeUpdated = '2018-02-28T15:23:46.787+01:00'
| Name | Type | References | Description |
| ProductPriceId [KEY] | Long | Product price record Id. | |
| ProductId [KEY] | Long | Product record Id. See products | |
| ProductCode | String | Product code. | |
| ProductName | String | Product name. | |
| ProductStockUnitName | String | The name of the unit the product is sold in. For example box, crate, bottle. The default unit is each. | |
| PriceBandId | Long | Price band record Id. | |
| PriceBandName | String | The name of the price band. | |
| ProductPriceUseStandard | Bool | 'True' if uses the price from the standard price band is used otherwise 'False' The price of a product can be linked to the price set in the standard price band. This is used when only some product prices are different to the standard price. | |
| ProductPricePrice | Decimal | The selling price for the shown product and price band. | |
| CurrencyId | Long | Currency record Id. See currencies | |
| CurrencyName | String | The name of the currency used for the price. | |
| CurrencySymbol | String | The symbol of the currency used for the price. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Products are used to track stock within Sage 200. This is not just for physical items, but also for items that are ordered direct from suppliers, services, and time or labour that can be included on customer invoices.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: WarehouseHoldings columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Products WHERE Id = 34737 SELECT * FROM Products WHERE Code = 'M' SELECT * FROM Products WHERE Name = 'M' SELECT * FROM Products WHERE Description = 'abc' SELECT * FROM Products WHERE Barcode = 'abc' SELECT * FROM Products WHERE AllowSalesOrder = true SELECT * FROM Products WHERE ProductGroupId = 34633 SELECT * FROM Products WHERE TaxCodeId = 1731 SELECT * FROM Products WHERE DateTimeUpdated = '2019-08-01T18:00:33.140+02:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Product record Id. | |
| Code | String | Product code. | |
| Name | String | Product name. | |
| Description | String | Product description. | |
| Barcode | String | Product barcode. | |
| AllowSalesOrder | Bool | Allowed on a sales order. | |
| ProductGroupId | Long | Product group record Id. See product_groups | |
| TaxCodeId | Long | Tax code record Id. See tax_codes | |
| WarehouseHoldings | String | If stock setting UseMultipleLocations is true, you must specify warehouse holding(s) when creating products. If stock setting UseMultipleLocations is false, then new product will be automatically linked to the default (home) warehouse. See warehouse_holdings | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
A product transaction is created each time a product is moved in, or out of stock. Product transactions are created from various sources such as purchase orders, sales orders, transfers between warehouses etc.. This resource returns the details of product transactions. The default sort (orderby) field is by 'id' descending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM ProductTransactionViews WHERE Id = 36511 SELECT * FROM ProductTransactionViews WHERE ProductId = 34751 SELECT * FROM ProductTransactionViews WHERE ProductCode = 'BOARD001' SELECT * FROM ProductTransactionViews WHERE ProductGroupId = 34640 SELECT * FROM ProductTransactionViews WHERE ProductGroupCode = '0006' SELECT * FROM ProductTransactionViews WHERE TransactionType = 'EnumSecondaryActivityTypeStockTakeAdjustmentIn' SELECT * FROM ProductTransactionViews WHERE TransactionDate = '2015-12-31T01:00:00.000+01:00' SELECT * FROM ProductTransactionViews WHERE SourceAreaReference = 'abc' SELECT * FROM ProductTransactionViews WHERE SourceAreaName = 'Internal' SELECT * FROM ProductTransactionViews WHERE Reference = 'abc' SELECT * FROM ProductTransactionViews WHERE SecondReference = 'STK TAKE' SELECT * FROM ProductTransactionViews WHERE WarehouseName = 'Warehouse' SELECT * FROM ProductTransactionViews WHERE BinName = 'Unspecified' SELECT * FROM ProductTransactionViews WHERE Quantity = 2 SELECT * FROM ProductTransactionViews WHERE UnitCostPrice = 15 SELECT * FROM ProductTransactionViews WHERE UnitIssuePrice = 0 SELECT * FROM ProductTransactionViews WHERE UnitDiscountValue = 0 SELECT * FROM ProductTransactionViews WHERE TotalOrderDiscount = 0 SELECT * FROM ProductTransactionViews WHERE CostValue = 30 SELECT * FROM ProductTransactionViews WHERE IssueValue = 0 SELECT * FROM ProductTransactionViews WHERE Memo = 'abc' SELECT * FROM ProductTransactionViews WHERE UserName = 'Migration' SELECT * FROM ProductTransactionViews WHERE AnalysisCode1 = 'abc' SELECT * FROM ProductTransactionViews WHERE AnalysisCode2 = 'abc' SELECT * FROM ProductTransactionViews WHERE AnalysisCode3 = 'abc' SELECT * FROM ProductTransactionViews WHERE AnalysisCode4 = 'abc' SELECT * FROM ProductTransactionViews WHERE AnalysisCode5 = 'abc' SELECT * FROM ProductTransactionViews WHERE DateTimeUpdated = '2018-02-28T15:23:46.123+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Product transaction Id. | |
| ProductId | Long | Product record Id. See products | |
| ProductCode | String | Product code. | |
| ProductGroupId | Long | Product group record Id. See product_groups | |
| ProductGroupCode | String | Product group code. See product_groups | |
| TransactionType | String | Enum value that describes the transaction that created the product movement. See product_transaction_types | |
| TransactionDate | Date | The date of the transaction. | |
| SourceAreaReference | String | The code of the source of the transaction. | |
| SourceAreaName | String | The name of the source of the transaction. | |
| Reference | String | This can be an optional reference added to the transaction by the user, or an automatically generated reference such as the order number. | |
| SecondReference | String | This can be an additional optional reference added to the transaction by the user, or an automatically generated reference such as the despatch note number. | |
| WarehouseName | String | The warehouse the product was moved from or to. See warehouses | |
| BinName | String | The name of the bin to which the transaction relates to. | |
| Quantity | Decimal | The quantity on the transaction. | |
| UnitCostPrice | Decimal | The cost price per unit for this transaction. | |
| UnitIssuePrice | Decimal | The price used when products are moved out of stock. | |
| UnitDiscountValue | Decimal | The discount amount per unit used for this transaction. | |
| TotalOrderDiscount | Decimal | The total discount value of the transaction. | |
| CostValue | Decimal | The total cost value. | |
| IssueValue | Decimal | The total issue or sales price of the transaction. | |
| Memo | String | Any memo note that was applied to the product transaction. | |
| UserName | String | The name of the Sage 200 user that created the transaction. | |
| AnalysisCode1 | String | Analysis Code 1. | |
| AnalysisCode2 | String | Analysis Code 2. | |
| AnalysisCode3 | String | Analysis Code 3. | |
| AnalysisCode4 | String | Analysis Code 4. | |
| AnalysisCode5 | String | Analysis Code 5. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
When making larger requests for purchase order information, the Purchase Order Line Views resource is a faster alternative to the 'Purchase Orders' resource.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM PurchaseOrderLines WHERE PurchaseOrderId = 42101 SELECT * FROM PurchaseOrderLines WHERE CurrencyId = '0000000001'
| Name | Type | References | Description |
| PurchaseOrderId [KEY] | Long | Unique ID of the purchase order. See _orders | |
| SupplierDocumentNo | String | Supplier purchase order document number. | |
| CurrencyId | Long | The Id for the currency used for the purchase order. See currencies | |
| CurrencyName | String | The name for the currency used for the purchase order. | |
| CurrencySymbol | String | The symbol of the currency used for the purchase order. | |
| SubtotalValue | Decimal | The subtotal value for the order. | |
| SubtotalDiscountValue | Decimal | The subtotal discount value for the order. | |
| SubtotalLandedCostsValue | Decimal | The subtotal landed costs value for the order. | |
| LineId | Long | Associated purchase order line Id. See _order_lines | |
| LineNumber | Short | Purchase order line number. | |
| LineType | String | Purchase order line type. See order_return_line_types | |
| LineProductCode | String | Purchase order line product code. | |
| LineProductDescription | String | Purchase order line product description. This could be stock item description, free text, additional charge or comment. | |
| LineQuantity | Decimal | The quantity ordered. | |
| LineUnitPrice | Decimal | The buying price per item. | |
| LineUnitDiscountPercent | Decimal | The percentage discount per item. | |
| LineUnitDiscountValue | Decimal | The discount value per item. | |
| LineTotalValue | Decimal | The total value of the line. | |
| LineDiscountedUnitPrice | Decimal | The discounted unit price of the line. This is calculated by subtracting the _order_line_unit_discount_value from the _order_line_unit_price. | |
| LineLandedCostsValue | Decimal | The value of landed costs for the order. | |
| LineAnalysisCode1 | String | Analysis code 1. | |
| LineAnalysisCode2 | String | Analysis code 2. | |
| LineAnalysisCode3 | String | Analysis code 3. | |
| LineAnalysisCode4 | String | Analysis code 4. | |
| LineAnalysisCode5 | String | Analysis code 5. | |
| LineDateTimeUpdated | Datetime | The date and time the order line was last updated (UTC). | |
| LineForDirectDelivery | Bool | Indicates if line is marked for direct delivery | |
| LineShowOnSupplierDocs | Bool | Indicates if line will show on supplier documents. | |
| DeliveryAddrPostalName | String | delivery address name. | |
| DeliveryAddrDescription | String | delivery address description. | |
| DeliveryAddrAddress1 | String | delivery address line 1. | |
| DeliveryAddrAddress2 | String | delivery address line 2. | |
| DeliveryAddrAddress3 | String | delivery address line 3. | |
| DeliveryAddrAddress4 | String | delivery address line 4. | |
| DeliveryAddrCity | String | delivery address city. | |
| DeliveryAddrCounty | String | delivery address county. | |
| DeliveryAddrPostCode | String | delivery address post code | |
| DeliveryAddrCountry | String | delivery address country. | |
| DeliveryAddrContact | String | delivery address contact | |
| DeliveryAddrTelephone | String | delivery address telephone number | |
| DeliveryAddrFax | String | delivery address line fax number... | |
| DeliveryAddrEmail | String | delivery address line email. | |
| SupplierId | Long | The associated supplier record Id. See suppliers | |
| SupplierReference | String | The associated supplier account reference. | |
| SupplierName | String | The associated supplier name. | |
| ProductId | Long | The associated product record Id. Only returned where _order_line_type = EnumLineTypeStandard. See products | |
| ProductCode | String | The code of the product ordered. Only returned where _order_line_type = EnumLineTypeStandard | |
| ProductName | String | The name of the product ordered. Only returned where _order_line_type = EnumLineTypeStandard | |
| ProductDescription | String | The associated product description. Only returned where _order_line_type = EnumLineTypeStandard | |
| WarehouseId | Long | The id of the warehouse the product is stored in. Only returned where _order_line_type = EnumLineTypeStandard. See warehouses | |
| WarehouseName | String | The name of the warehouse. Only returned where _order_line_type = EnumLineTypeStandard | |
| TaxCodeId | Long | The id of the tax code set on the line. See tax_codes | |
| TaxCodeCode | Short | The associated tax code. | |
| TaxCodeName | String | The associated tax code name. | |
| TaxCodeRate | Decimal | The associated tax rate. |
Purchase orders are used to represent the purchase of goods or services from a supplier. They are central to a business and define the terms (price, quantity and times) by which the products or services will be received.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM PurchaseOrders WHERE Id = 42101 SELECT * FROM PurchaseOrders WHERE DocumentNo = '0000000001' SELECT * FROM PurchaseOrders WHERE ExchangeRate = 'Sample'
| Name | Type | References | Description |
| Id [KEY] | Long | Purchase order record Id. | |
| DocumentNo | String | Purchase order document number. Note: If the POP setting in Sage 200c Professional, then this property MUST be set. | |
| DocumentDate | Date | Purchase order document date. | |
| DocumentStatus | String | Document status. See pop_document_status_types | |
| AuthorisationStatus | String | Authorisation status. See pop_authorisation_status_types | |
| SupplierId | Long |
Suppliers.Id | Supplier record Id. See suppliers |
| ExchangeRate | Decimal | Exchange rate. | |
| SubtotalGoodsValue | Decimal | Goods value (sum of stock items and free text). | |
| SubtotalChargesNetValue | Decimal | Charges net value. | |
| SubtotalDiscountValue | Decimal | Discount value. | |
| SubtotalLandedCostsValue | Decimal | Landed costs value. | |
| TotalNetValue | Decimal | Net value (sum of all line types). | |
| TotalTaxValue | Decimal | Tax value. | |
| TotalGrossValue | Decimal | Gross value. | |
| SupplierDocumentNo | String | Supplier document number. | |
| SettlementDiscountDays | Short | Settlement discount days. | |
| SettlementDiscountPercent | Decimal | Settlement discount percent. | |
| DocumentDiscountPercent | Decimal | Document discount percent. | |
| DocumentOriginatorId | Long | Document originator id. See users | |
| DocumentOriginatorName | String | Document originator name. | |
| DocumentCreatedById | Long | Document created by id. See users | |
| DocumentCreatedBy | String | Document created by. | |
| RequestedDeliveryDate | Date | Requested delivery date. | |
| AnalysisCode1 | String | Analysis code 1. | |
| AnalysisCode2 | String | Analysis code 2. | |
| AnalysisCode3 | String | Analysis code 3. | |
| AnalysisCode4 | String | Analysis code 4. | |
| AnalysisCode5 | String | Analysis code 5. | |
| Lines | String | The purchase order lines collection. See pop_order_lines | |
| DeliveryAddress_1 | String | The delivery address line 1. | |
| DeliveryAddress_2 | String | The delivery address line 2. | |
| DeliveryAddress_3 | String | The delivery address line 3. | |
| DeliveryAddress_4 | String | The delivery address line 4. | |
| DeliveryAddressCity | String | The delivery address city. | |
| DeliveryAddressCounty | String | The delivery address county. | |
| DeliveryAddressPostcode | String | The delivery address postcode. | |
| DeliveryAddressContact | String | The delivery address contact. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Purchase posted transactions are created when transactions, such as purchases made, refunds or credit notes, are posted against the Purchase Ledger. It is not possible to use this API resource to create posted transactions.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: NominalAnalysisItems,TaxAnalysisItems,BankItems,AllocationSessionItems,AllocationHistoryItems columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM PurchasePostedTransactions WHERE Id = 33018 SELECT * FROM PurchasePostedTransactions WHERE SupplierId = 28936 SELECT * FROM PurchasePostedTransactions WHERE TraderTransactionType = 'TradingAccountEntryTypeInvoice' SELECT * FROM PurchasePostedTransactions WHERE Reference = 'O/BAL' SELECT * FROM PurchasePostedTransactions WHERE SecondReference = 'Opening Balance' SELECT * FROM PurchasePostedTransactions WHERE Queried = 'abc' SELECT * FROM PurchasePostedTransactions WHERE TransactionDate = '2017-12-31T01:00:00.000+01:00' SELECT * FROM PurchasePostedTransactions WHERE PostedDate = '2018-09-13T02:00:00.000+02:00' SELECT * FROM PurchasePostedTransactions WHERE DueDate = '2024-01-30T01:00:00.000+01:00' SELECT * FROM PurchasePostedTransactions WHERE DocumentGoodsValue = 55 SELECT * FROM PurchasePostedTransactions WHERE DocumentGrossValue = 55 SELECT * FROM PurchasePostedTransactions WHERE DocumentTaxValue = 0 SELECT * FROM PurchasePostedTransactions WHERE DocumentDiscountValue = 0 SELECT * FROM PurchasePostedTransactions WHERE DiscountPercent = 0 SELECT * FROM PurchasePostedTransactions WHERE DocumentTaxDiscountValue = 0 SELECT * FROM PurchasePostedTransactions WHERE DocumentAllocatedValue = 55 SELECT * FROM PurchasePostedTransactions WHERE DocumentOutstandingValue = 0 SELECT * FROM PurchasePostedTransactions WHERE BaseGoodsValue = 55 SELECT * FROM PurchasePostedTransactions WHERE BaseGrossValue = 55 SELECT * FROM PurchasePostedTransactions WHERE BaseTaxValue = 0 SELECT * FROM PurchasePostedTransactions WHERE BaseDiscountValue = 0 SELECT * FROM PurchasePostedTransactions WHERE BaseTaxDiscountValue = 0 SELECT * FROM PurchasePostedTransactions WHERE BaseAllocatedValue = 55 SELECT * FROM PurchasePostedTransactions WHERE ControlValueInBaseCurrency = 0 SELECT * FROM PurchasePostedTransactions WHERE ExchangeRate = 1 SELECT * FROM PurchasePostedTransactions WHERE SettledImmediately = false SELECT * FROM PurchasePostedTransactions WHERE VatAdjustmentDocExpected = false SELECT * FROM PurchasePostedTransactions WHERE DiscountDays = 0 SELECT * FROM PurchasePostedTransactions WHERE Urn = 11 SELECT * FROM PurchasePostedTransactions WHERE UserName = 'Migration' SELECT * FROM PurchasePostedTransactions WHERE DateTimeUpdated = '2018-02-28T15:23:46.137+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Id. | |
| SupplierId | Long | Supplier Id. See customers | |
| TraderTransactionType | String | Transaction type. See trader_transaction_types | |
| Reference | String | Transaction reference. | |
| SecondReference | String | Second reference. | |
| Queried | String | Query flag. | |
| TransactionDate | Date | Transaction date. | |
| PostedDate | Date | Posted date. | |
| DueDate | Date | Due date. | |
| DocumentGoodsValue | Decimal | Value of the goods. | |
| DocumentGrossValue | Decimal | Gross value. | |
| DocumentTaxValue | Decimal | Tax value. | |
| DocumentDiscountValue | Decimal | Tax discount value. | |
| DiscountPercent | Decimal | Percentage discount. | |
| DocumentTaxDiscountValue | Decimal | Tax discount value. | |
| DocumentAllocatedValue | Decimal | Allocated value. | |
| DocumentOutstandingValue | Decimal | Outstanding value. | |
| BaseGoodsValue | Decimal | Value of the goods in base currency. | |
| BaseGrossValue | Decimal | Gross value in base currency. | |
| BaseTaxValue | Decimal | Tax value in base currency. | |
| BaseDiscountValue | Decimal | Discount value in base currency. | |
| BaseTaxDiscountValue | Decimal | Tax discount value in base currency. | |
| BaseAllocatedValue | Decimal | Allocated value in base currency. | |
| ControlValueInBaseCurrency | Decimal | Control value in base currency. | |
| ExchangeRate | Decimal | Exchange rate used for transaction. | |
| SettledImmediately | Bool | Immediately settled | |
| VatAdjustmentDocExpected | Bool | Whether a VAT adjustment is expected. | |
| DiscountDays | Short | Number of days discount valid. | |
| Urn | Long | Unique reference number. | |
| UserName | String | User who entered the transaction. | |
| NominalAnalysisItems | String | Nominal analysis items. See purchase_posted_transactions_nominal_analysis_items | |
| TaxAnalysisItems | String | Tax analysis items. See purchase_posted_transactions_tax_analysis_items | |
| BankItems | String | Bank items. See purchase_posted_transactions_bank_items | |
| AllocationSessionItems | String | Allocation session items. See purchase_posted_transactions_allocation_session_items | |
| AllocationHistoryItems | String | Allocation history items. See purchase_posted_transactions_allocation_history_items | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Sales historical transactions are created when transactions are archived from the Sales Ledger. It is not possible to use this API resource to create historical transactions.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: NominalAnalysisItems,TaxAnalysisItems,BankItems columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesHistoricalTransactions WHERE Id = 123 SELECT * FROM SalesHistoricalTransactions WHERE CustomerId = 123 SELECT * FROM SalesHistoricalTransactions WHERE TraderTransactionType = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE Reference = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE SecondReference = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE Queried = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE TransactionDate = '2019-10-02T11:46:53Z' SELECT * FROM SalesHistoricalTransactions WHERE PostedDate = '2019-10-02T11:46:53Z' SELECT * FROM SalesHistoricalTransactions WHERE DueDate = '2019-10-02T11:46:53Z' SELECT * FROM SalesHistoricalTransactions WHERE FullSettlementDate = '2019-10-02T11:46:53Z' SELECT * FROM SalesHistoricalTransactions WHERE DocumentGoodsValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DocumentGrossValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DocumentTaxValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DocumentDiscountValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DiscountPercent = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DocumentTaxDiscountValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DocumentAllocatedValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DocumentOutstandingValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE BaseGoodsValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE BaseGrossValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE BaseTaxValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE BaseDiscountValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE BaseTaxDiscountValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE BaseAllocatedValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE ControlValueInBaseCurrency = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE ExchangeRate = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE SettledImmediately = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE DiscountDays = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE Urn = 123 SELECT * FROM SalesHistoricalTransactions WHERE UserName = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE DateTimeUpdated = '2019-10-02T11:46:53Z'
| Name | Type | References | Description |
| Id [KEY] | Long | Id. | |
| CustomerId | Long | Customer Id. See customers | |
| TraderTransactionType | String | Transaction type. See trader_transaction_types | |
| Reference | String | Transaction reference. | |
| SecondReference | String | Second reference. | |
| Queried | String | Query flag. | |
| TransactionDate | Date | Transaction date. | |
| PostedDate | Date | Posted date. | |
| DueDate | Date | Due date. | |
| FullSettlementDate | Date | Full settlement date. | |
| DocumentGoodsValue | Decimal | Value of the goods. | |
| DocumentGrossValue | Decimal | Gross value. | |
| DocumentTaxValue | Decimal | Tax value. | |
| DocumentDiscountValue | Decimal | Document discount value. | |
| DiscountPercent | Decimal | Percentage discount. | |
| DocumentTaxDiscountValue | Decimal | Tax discount value. | |
| DocumentAllocatedValue | Decimal | Allocated value. | |
| DocumentOutstandingValue | Decimal | Outstanding value. | |
| BaseGoodsValue | Decimal | Value of the goods in base currency. | |
| BaseGrossValue | Decimal | Gross value in base currency. | |
| BaseTaxValue | Decimal | Tax value in base currency. | |
| BaseDiscountValue | Decimal | Discount value in base currency. | |
| BaseTaxDiscountValue | Decimal | Tax discount value in base currency. | |
| BaseAllocatedValue | Decimal | Allocated value in base currency. | |
| ControlValueInBaseCurrency | Decimal | Control value in base currency. | |
| ExchangeRate | Decimal | Exchange rate used for transaction. | |
| SettledImmediately | Bool | Immediately settled. | |
| DiscountDays | Short | Number of days discount valid. | |
| Urn | Long | Unique reference number. | |
| UserName | String | User who entered the transaction. | |
| NominalAnalysisItems | String | Nominal analysis items. See sales_historical_transactions_nominal_analysis_items | |
| TaxAnalysisItems | String | Tax analysis items. See sales_historical_transactions_tax_analysis_items | |
| BankItems | String | Bank items. See sales_historical_transactions_bank_items | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Additional charges can be added to sales orders to account for items such as carriage and insurance. Within the Sage 200 application, users can setup and maintain the list of additional charges that can be referenced when creating a sales order. This API resource can be used to determine what each additional charge is for.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesOrderAdditionalCharges WHERE Id = 42101 SELECT * FROM SalesOrderAdditionalCharges WHERE Code = '0000000001' SELECT * FROM SalesOrderAdditionalCharges WHERE Name = 'Sample'
| Name | Type | References | Description |
| Id [KEY] | Long | Sop additional charge record Id. | |
| Code | String | Sop additional charge code. | |
| Name | String | Sop additional charge name. | |
| ChargeValue | Decimal | Sop additional charge value. | |
| NotionalCostValue | Decimal | Sop additional charge notional cost value. | |
| NominalCodeId | Long |
NominalCodes.Id | Nominal code record Id. See nominal_codes |
| TaxCodeId | Long |
TaxCodes.Id | Tax code record Id. See tax_codes |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
When making larger requests for sales order information, the Sales Order Line Views resource is a faster alternative to the 'Sales Orders' resource. The Sales Order Line Views resource returns more information than the 'Sales Orders' resource, and therefore reduces the number of API requests required to return the same information from multiple resources. This resource returns a view of sales orders, sales order lines, customers, products, warehouses, tax codes and currencies that can be queried on any field. The default sort (orderby) field are by 'sop_order_id' and 'sop_order_line_id' descending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesOrderLines WHERE SalesOrderId = 42101 SELECT * FROM SalesOrderLines WHERE CurrencyId = 2343234543 SELECT * FROM SalesOrderLines WHERE CurrencyName = 'Sample'
| Name | Type | References | Description |
| SalesOrderId [KEY] | Long | Unique Id of the sales order. See sop_orders | |
| LineId [KEY] | Long | Associated sales order line Id. See sop_order_lines | |
| CustomerDocumentNo | String | Customer sales order document number. | |
| CurrencyId | Long | The Id for the currency used for the sales order. See currencies | |
| CurrencyName | String | The name for the currency used for the sales order. | |
| CurrencySymbol | String | The symbol of the currency used for the sales order. | |
| DocumentDiscountPercent | Decimal | Document discount percent value, between -99.99 and 99.99. A negative value is treated as a surcharge (e.g. -10 is a 10% surcharge), and a positive value is treated as a discount. | |
| DocumentCreatedBy | String | The person who created the SOP Order | |
| RequestedDeliveryDate | Date | Requested delivery date. | |
| PromisedDeliveryDate | Date | Promised delivery date. | |
| LineNumber | Short | Sales order line number. | |
| LineType | String | Sales order line type. See order_return_line_types | |
| LineProductCode | String | Sales order line product code. | |
| LineProductDescription | String | Sales order line product description. This could be stock item description, free text, additional charge or comment. | |
| LineQuantity | Decimal | The quantity ordered. | |
| LineAllocatedQuantity | Decimal | The quantity allocated. | |
| LineDespatchReceiptQuantity | Decimal | The quantity despatched. | |
| LineInvoiceCreditQuantity | Decimal | The quantity invoiced. | |
| LineSellingUnitDescription | String | The selling unit description. | |
| LineSellingUnitPrice | Decimal | The selling price per item. | |
| LineUnitDiscountPercent | Decimal | The percentage discount per item. | |
| LineUnitDiscountValue | Decimal | The discount value per item. | |
| LineCostPrice | Decimal | The cost price. | |
| LineTotalValue | Decimal | The total value of the line. | |
| LineLineTaxValue | Decimal | The tax value of the line. | |
| LineDiscountedUnitPrice | Decimal | The discounted unit price of the line. This is calculated by subtracting the sop_order_line_unit_discount_value from the sop_order_line_selling_unit_price. | |
| LineRequestedDeliveryDate | Date | Requested delivery date. | |
| LinePromisedDeliveryDate | Date | Promised delivery date. | |
| LineAnalysisCode1 | String | Analysis code 1. | |
| LineAnalysisCode2 | String | Analysis code 2. | |
| LineAnalysisCode3 | String | Analysis code 3. | |
| LineAnalysisCode4 | String | Analysis code 4. | |
| LineAnalysisCode5 | String | Analysis code 5. | |
| LineDateTimeUpdated | Datetime | The date and time the sop order line was last updated (UTC). | |
| DeliveryAddrAddress1 | String | SOP delivery address line 1. | |
| DeliveryAddrAddress2 | String | SOP delivery address line 2. | |
| DeliveryAddrAddress3 | String | SOP delivery address line 3. | |
| DeliveryAddrAddress4 | String | SOP delivery address line 4. | |
| DeliveryAddrCity | String | SOP delivery address city. | |
| DeliveryAddrCounty | String | SOP delivery address county. | |
| DeliveryAddrPostCode | String | SOP delivery address post code | |
| DeliveryAddrCountry | String | SOP delivery address country. | |
| DeliveryAddrContact | String | SOP delivery address contact | |
| DeliveryAddrTelephone | String | SOP delivery address telephone number | |
| DeliveryAddrFax | String | SOP delivery address line fax number... | |
| DeliveryAddrEmail | String | SOP delivery address line email. | |
| CustomerId | Long | The associated customer record Id. See customers | |
| CustomerReference | String | The associated customer account reference. | |
| CustomerName | String | The associated customer name. | |
| ProductId | Long | The associated product record Id. Only returned where sop_order_line_type = EnumLineTypeStandard. See products | |
| ProductCode | String | The code of the product ordered. Only returned where sop_order_line_type = EnumLineTypeStandard | |
| ProductName | String | The name of the product ordered. Only returned where sop_order_line_type = EnumLineTypeStandard | |
| ProductDescription | String | The associated product description. Only returned where sop_order_line_type = EnumLineTypeStandard | |
| WarehouseId | Long | The id of the warehouse the product is stored in. Only returned where sop_order_line_type = EnumLineTypeStandard. See warehouses | |
| WarehouseName | String | The name of the warehouse. Only returned where sop_order_line_type = EnumLineTypeStandard | |
| TaxCodeId | Long | The id of the tax code set on the line. See tax_codes | |
| TaxCodeCode | Short | The associated tax code. | |
| TaxCodeName | String | The associated tax code name. | |
| TaxCodeRate | Decimal | The associated tax rate. |
This resource returns a view of sales pro formas, sales pro forma lines, customers, products, warehouses, tax codes and currencies that can be queried on any field. The default sort (orderby) field are by 'sop_proforma_id' and 'sop_proforma_line_id' descending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesOrderProformaLines WHERE SalesOrderProformaId = 346345654564565 SELECT * FROM SalesOrderProformaLines WHERE SalesOrderProformaDocumentStatus = 'Sample'
| Name | Type | References | Description |
| ProformaId [KEY] | Long | Unique Id of the sales pro forma | |
| ProformaDocumentNo | String | Sales pro forma document number. | |
| ProformaDocumentDate | Date | Sales pro forma date. | |
| ProformaDocumentStatus | String | Sales pro forma status. See sop_document_status_types | |
| ProformaCustomerDocumentNo | String | Customer sales pro forma document number. | |
| ProformaCurrencyId | Long | The Id for the currency used for the sales pro forma. See currencies | |
| ProformaCurrencyName | String | The name for the currency used for the sales pro forma. | |
| ProformaCurrencySymbol | String | The symbol of the currency used for the sales pro forma. | |
| ProformaExchangeRate | Decimal | Exchange rate for the sales pro forma. | |
| ProformaRequestedDeliveryDate | Date | Requested delivery date. | |
| ProformaPromisedDeliveryDate | Date | Promised delivery date. | |
| ProformaAnalysisCode1 | String | Analysis code 1. | |
| ProformaAnalysisCode2 | String | Analysis code 2. | |
| ProformaAnalysisCode3 | String | Analysis code 3. | |
| ProformaAnalysisCode4 | String | Analysis code 4. | |
| ProformaAnalysisCode5 | String | Analysis code 5. | |
| ProformaDateTimeUpdated | Datetime | The date and time the sales pro forma was last updated (UTC). | |
| ProformaLineId | Long | Associated sales pro forma line Id | |
| ProformaLineNumber | Short | Sales pro forma line number. | |
| ProformaLineType | String | Sales pro forma line type. See order_return_line_types | |
| ProformaLineProductCode | String | Sales pro forma line product code. | |
| ProformaLineProductDescription | String | Sales pro forma line product description. This could be stock item description, free text, additional charge or comment. | |
| ProformaLineQuantity | Decimal | The line quantity. | |
| ProformaLineSellingUnitDescription | String | The selling unit description. | |
| ProformaLineSellingUnitPrice | Decimal | The selling price per item. | |
| ProformaLineUnitDiscountPercent | Decimal | The percentage discount per item. | |
| ProformaLineUnitDiscountValue | Decimal | The discount value per item. | |
| ProformaLineCostPrice | Decimal | The cost price. | |
| ProformaLineTotalValue | Decimal | The total value of the line. | |
| ProformaLineLineTaxValue | Decimal | The tax value of the line. | |
| ProformaLineDiscountedUnitPrice | Decimal | The discounted unit price of the line. This is calculated by subtracting the sop_proforma_line_unit_discount_value from the sop_proforma_line_selling_unit_price. | |
| ProformaLineRequestedDeliveryDate | Date | Requested delivery date. | |
| ProformaLinePromisedDeliveryDate | Date | Promised delivery date. | |
| ProformaLineAnalysisCode1 | String | Analysis code 1. | |
| ProformaLineAnalysisCode2 | String | Analysis code 2. | |
| ProformaLineAnalysisCode3 | String | Analysis code 3. | |
| ProformaLineAnalysisCode4 | String | Analysis code 4. | |
| ProformaLineAnalysisCode5 | String | Analysis code 5. | |
| ProformaLineDateTimeUpdated | Datetime | The date and time the sop pro forma line was last updated (UTC). | |
| CustomerId | Long | The associated customer record Id. See customers | |
| CustomerReference | String | The associated customer account reference. | |
| CustomerName | String | The associated customer name. | |
| ProductId | Long | The associated product record Id. Only returned where sop_proforma_line_type = EnumLineTypeStandard. See products | |
| ProductCode | String | The code of the product ordered. Only returned where sop_proforma_line_type = EnumLineTypeStandard | |
| ProductName | String | The name of the product ordered. Only returned where sop_proforma_line_type = EnumLineTypeStandard | |
| ProductDescription | String | The associated product description. Only returned where sop_proforma_line_type = EnumLineTypeStandard | |
| WarehouseId | Long | The id of the warehouse the product is stored in. Only returned where sop_proforma_line_type = EnumLineTypeStandard. See warehouses | |
| WarehouseName | String | The name of the warehouse. Only returned where sop_proforma_line_type = EnumLineTypeStandard | |
| TaxCodeId | Long | The id of the tax code set on the line. See tax_codes | |
| TaxCodeCode | Short | The associated tax code. | |
| TaxCodeName | String | The associated tax code name. | |
| TaxCodeRate | Decimal | The associated tax rate. |
This resource returns a view of sales quotes, sales quote lines, customers, products, warehouses, tax codes and currencies that can be queried on any field. The default sort (orderby) field are by 'sop_quote_id' and 'sop_quote_line_id' descending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesOrderQuoteLines WHERE SalesOrderQuoteId = 3424324324324 SELECT * FROM SalesOrderQuoteLines WHERE SalesOrderQuoteDocumentNo = 'Sample' SELECT * FROM SalesOrderQuoteLines WHERE SalesOrderQuoteCustomerDocumentNo = 'Sample'
| Name | Type | References | Description |
| QuoteId [KEY] | Long | Unique Id of the sales quote | |
| QuoteDocumentNo | String | Sales quote document number. | |
| QuoteDocumentDate | Date | Sales quote date. | |
| QuoteDocumentStatus | String | Sales quote status. See sop_document_status_types | |
| QuoteCustomerDocumentNo | String | Customer sales quote document number. | |
| QuoteCurrencyId | Long | The Id for the currency used for the sales quote. See currencies | |
| QuoteCurrencyName | String | The name for the currency used for the sales quote. | |
| QuoteCurrencySymbol | String | The symbol of the currency used for the sales quote. | |
| QuoteExchangeRate | Decimal | Exchange rate for the sales quote. | |
| QuoteRequestedDeliveryDate | Date | Requested delivery date. | |
| QuotePromisedDeliveryDate | Date | Promised delivery date. | |
| QuoteAnalysisCode1 | String | Analysis code 1. | |
| QuoteAnalysisCode2 | String | Analysis code 2. | |
| QuoteAnalysisCode3 | String | Analysis code 3. | |
| QuoteAnalysisCode4 | String | Analysis code 4. | |
| QuoteAnalysisCode5 | String | Analysis code 5. | |
| QuoteDateTimeUpdated | Datetime | The date and time the sales quote was last updated (UTC). | |
| QuoteLineId | Long | Associated sales quote line Id | |
| QuoteLineNumber | Short | Sales quote line number. | |
| QuoteLineType | String | Sales quote line type. See order_return_line_types | |
| QuoteLineProductCode | String | Sales quote line product code. | |
| QuoteLineProductDescription | String | Sales quote line product description. This could be stock item description, free text, additional charge or comment. | |
| QuoteLineQuantity | Decimal | The line quantity. | |
| QuoteLineSellingUnitDescription | String | The selling unit description. | |
| QuoteLineSellingUnitPrice | Decimal | The selling price per item. | |
| QuoteLineUnitDiscountPercent | Decimal | The percentage discount per item. | |
| QuoteLineUnitDiscountValue | Decimal | The discount value per item. | |
| QuoteLineCostPrice | Decimal | The cost price. | |
| QuoteLineTotalValue | Decimal | The total value of the line. | |
| QuoteLineLineTaxValue | Decimal | The tax value of the line. | |
| QuoteLineDiscountedUnitPrice | Decimal | The discounted unit price of the line. This is calculated by subtracting the sop_quote_line_unit_discount_value from the sop_quote_line_selling_unit_price. | |
| QuoteLineRequestedDeliveryDate | Date | Requested delivery date. | |
| QuoteLinePromisedDeliveryDate | Date | Promised delivery date. | |
| QuoteLineAnalysisCode1 | String | Analysis code 1. | |
| QuoteLineAnalysisCode2 | String | Analysis code 2. | |
| QuoteLineAnalysisCode3 | String | Analysis code 3. | |
| QuoteLineAnalysisCode4 | String | Analysis code 4. | |
| QuoteLineAnalysisCode5 | String | Analysis code 5. | |
| QuoteLineDateTimeUpdated | Datetime | The date and time the sop quote line was last updated (UTC). | |
| CustomerId | Long | The associated customer record Id. See customers | |
| CustomerReference | String | The associated customer account reference. | |
| CustomerName | String | The associated customer name. | |
| ProductId | Long | The associated product record Id. Only returned where sop_quote_line_type = EnumLineTypeStandard. See products | |
| ProductCode | String | The code of the product ordered. Only returned where sop_quote_line_type = EnumLineTypeStandard | |
| ProductName | String | The name of the product ordered. Only returned where sop_quote_line_type = EnumLineTypeStandard | |
| ProductDescription | String | The associated product description. Only returned where sop_quote_line_type = EnumLineTypeStandard | |
| WarehouseId | Long | The id of the warehouse the product is stored in. Only returned where sop_quote_line_type = EnumLineTypeStandard. See warehouses | |
| WarehouseName | String | The name of the warehouse. Only returned where sop_quote_line_type = EnumLineTypeStandard | |
| TaxCodeId | Long | The id of the tax code set on the line. See tax_codes | |
| TaxCodeCode | Short | The associated tax code. | |
| TaxCodeName | String | The associated tax code name. | |
| TaxCodeRate | Decimal | The associated tax rate. |
Sales orders are used to represent the sale of goods or services to a customer. They are central to a business and define the terms (price, quantity and times) by which the products or services will be delivered. Note: Adding traceable items to sales orders. If you're using traceable stock items and an item is set to be sold from a single batch, then the order quantity must be less than or equal to quantity in the batch. If you try to order more than the quantity in the batch, the order cannot be posted via the API.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesOrders WHERE Id = 42101 SELECT * FROM SalesOrders WHERE DocumentNo = '0000000001' SELECT * FROM SalesOrders WHERE CustomerDocumentNo = 'Sample'
| Name | Type | References | Description |
| Id [KEY] | Long | Sales order record Id. | |
| DocumentNo | String | Sales order document number. Note: If the SOP setting in Sage 200c Professional or Sage 200 Extra Online is to NOT automatically generate numbers, then this property MUST be set. If the SOP setting in Sage 200 Extra is to automatically generate numbers, or you are using Sage 200c Standard (which doesn't allow you to set this option), then setting this on POST will be ignored. | |
| DocumentDate | Date | Sales order document date. | |
| DocumentStatus | String | Document status. See sop_document_status_types | |
| CustomerId | Long |
Customers.Id | Customer record Id. See customers |
| ExchangeRate | Decimal | Exchange rate. | |
| SubtotalGoodsValue | Decimal | Goods value (sum of stock items and free text). | |
| SubtotalChargeNetValue | Decimal | Charge net value. | |
| SubtotalChargeTaxValue | Decimal | Charge tax value. | |
| SubtotalDiscountValue | Decimal | Discount value | |
| TotalNetValue | Decimal | Net value (sum of all line types). | |
| TotalTaxValue | Decimal | Tax value. | |
| TotalGrossValue | Decimal | Gross value. | |
| CustomerDocumentNo | String | Customer document number. | |
| UseInvoiceAddress | Bool | True if this order uses the customer invoice address, else False. | |
| SettlementDiscountDays | Short | Settlement discount days. | |
| SettlementDiscountPercent | Decimal | Settlement discount percent. | |
| DocumentDiscountPercent | Decimal | Document discount percent value, between -99.99 and 99.99. A negative value is treated as a surcharge (e.g. -10 is a 10% surcharge), and a positive value is treated as a discount. | |
| DocumentCreatedBy | String | The person who created the SOP Order | |
| RequestedDeliveryDate | Date | Requested delivery date. | |
| PromisedDeliveryDate | Date | Promised delivery date. | |
| AnalysisCode1 | String | Analysis code 1. | |
| AnalysisCode2 | String | Analysis code 2. | |
| AnalysisCode3 | String | Analysis code 3. | |
| AnalysisCode4 | String | Analysis code 4. | |
| AnalysisCode5 | String | Analysis code 5. | |
| AnalysisCode6 | String | Analysis code 6. | |
| AnalysisCode7 | String | Analysis code 7. | |
| AnalysisCode8 | String | Analysis code 8. | |
| AnalysisCode9 | String | Analysis code 9. | |
| AnalysisCode10 | String | Analysis code 10. | |
| AnalysisCode11 | String | Analysis code 11. | |
| AnalysisCode12 | String | Analysis code 12. | |
| AnalysisCode13 | String | Analysis code 13. | |
| AnalysisCode14 | String | Analysis code 14. | |
| AnalysisCode15 | String | Analysis code 15. | |
| AnalysisCode16 | String | Analysis code 16. | |
| AnalysisCode17 | String | Analysis code 17. | |
| AnalysisCode18 | String | Analysis code 18. | |
| AnalysisCode19 | String | Analysis code 19. | |
| AnalysisCode20 | String | Analysis code 20. | |
| Lines | String | The sales order lines collection. See sop_order_lines | |
| DeliveryAddressId | Long | The delivery address contact. | |
| DeliveryAddress_1 | String | The delivery address line 1. | |
| DeliveryAddress_2 | String | The delivery address line 2. | |
| DeliveryAddress_3 | String | The delivery address line 3. | |
| DeliveryAddress_4 | String | The delivery address line 4. | |
| DeliveryAddressCity | String | The delivery address city. | |
| DeliveryAddressCounty | String | The delivery address county. | |
| DeliveryAddressPostcode | String | The delivery address postcode. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Sales posted transactions are created when transactions, such as orders invoiced, receipts, refunds or credit notes, are posted against the Sales Ledger. It is not possible to use this API resource to create posted transactions. To post a transaction, the necessary API resource must be invoked. When making larger requests for customer information, the Sales Transactions Views resource can be a faster alternative to this resource.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: NominalAnalysisItems,TaxAnalysisItems,BankItems,AllocationSessionItems,AllocationHistoryItems columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesPostedTransactions WHERE Id = 29674 SELECT * FROM SalesPostedTransactions WHERE CustomerId = 27849 SELECT * FROM SalesPostedTransactions WHERE TraderTransactionType = 'TradingAccountEntryTypeInvoice' SELECT * FROM SalesPostedTransactions WHERE Reference = 'O/BAL' SELECT * FROM SalesPostedTransactions WHERE SecondReference = 'Opening Balance' SELECT * FROM SalesPostedTransactions WHERE Queried = 'abc' SELECT * FROM SalesPostedTransactions WHERE TransactionDate = '2017-12-31T01:00:00.000+01:00' SELECT * FROM SalesPostedTransactions WHERE PostedDate = '2018-09-13T02:00:00.000+02:00' SELECT * FROM SalesPostedTransactions WHERE DueDate = '2018-02-14T01:00:00.000+01:00' SELECT * FROM SalesPostedTransactions WHERE FullSettlementDate = '2019-04-15T02:00:00.000+02:00' SELECT * FROM SalesPostedTransactions WHERE DocumentGoodsValue = 150 SELECT * FROM SalesPostedTransactions WHERE DocumentGrossValue = 150 SELECT * FROM SalesPostedTransactions WHERE DocumentTaxValue = 0 SELECT * FROM SalesPostedTransactions WHERE DocumentDiscountValue = 0 SELECT * FROM SalesPostedTransactions WHERE DiscountPercent = 0 SELECT * FROM SalesPostedTransactions WHERE DocumentTaxDiscountValue = 0 SELECT * FROM SalesPostedTransactions WHERE DocumentAllocatedValue = 150 SELECT * FROM SalesPostedTransactions WHERE DocumentOutstandingValue = 0 SELECT * FROM SalesPostedTransactions WHERE BaseGoodsValue = 150 SELECT * FROM SalesPostedTransactions WHERE BaseGrossValue = 150 SELECT * FROM SalesPostedTransactions WHERE BaseTaxValue = 0 SELECT * FROM SalesPostedTransactions WHERE BaseDiscountValue = 0 SELECT * FROM SalesPostedTransactions WHERE BaseTaxDiscountValue = 0 SELECT * FROM SalesPostedTransactions WHERE BaseAllocatedValue = 150 SELECT * FROM SalesPostedTransactions WHERE ControlValueInBaseCurrency = 0 SELECT * FROM SalesPostedTransactions WHERE ExchangeRate = 1 SELECT * FROM SalesPostedTransactions WHERE SettledImmediately = false SELECT * FROM SalesPostedTransactions WHERE DiscountDays = 0 SELECT * FROM SalesPostedTransactions WHERE Urn = 1 SELECT * FROM SalesPostedTransactions WHERE UserName = 'Migration' SELECT * FROM SalesPostedTransactions WHERE DateTimeUpdated = '2018-02-28T15:23:46.330+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Id. | |
| CustomerId | Long | Customer Id. See customers | |
| TraderTransactionType | String | Transaction type. See trader_transaction_types | |
| Reference | String | Transaction reference. | |
| SecondReference | String | Second reference. | |
| Queried | String | Query flag. | |
| TransactionDate | Date | Transaction date. | |
| PostedDate | Date | Posted date. | |
| DueDate | Date | Due date. | |
| FullSettlementDate | Date | Full settlement date. | |
| DocumentGoodsValue | Decimal | Value of the goods. | |
| DocumentGrossValue | Decimal | Gross value. | |
| DocumentTaxValue | Decimal | Tax value. | |
| DocumentDiscountValue | Decimal | Document discount value. | |
| DiscountPercent | Decimal | Percentage discount. | |
| DocumentTaxDiscountValue | Decimal | Tax discount value. | |
| DocumentAllocatedValue | Decimal | Allocated value. | |
| DocumentOutstandingValue | Decimal | Outstanding value. | |
| BaseGoodsValue | Decimal | Value of the goods in base currency. | |
| BaseGrossValue | Decimal | Gross value in base currency. | |
| BaseTaxValue | Decimal | Tax value in base currency. | |
| BaseDiscountValue | Decimal | Discount value in base currency. | |
| BaseTaxDiscountValue | Decimal | Tax discount value in base currency. | |
| BaseAllocatedValue | Decimal | Allocated value in base currency. | |
| ControlValueInBaseCurrency | Decimal | Control value in base currency. | |
| ExchangeRate | Decimal | Exchange rate used for transaction. | |
| SettledImmediately | Bool | Immediately settled. | |
| DiscountDays | Short | Number of days discount valid. | |
| Urn | Long | Unique reference number. | |
| UserName | String | User who entered the transaction. | |
| NominalAnalysisItems | String | Nominal analysis items. See sales_posted_transactions_nominal_analysis_items | |
| TaxAnalysisItems | String | Tax analysis items. See sales_posted_transactions_tax_analysis_items | |
| BankItems | String | Bank items. See sales_posted_transactions_bank_items | |
| AllocationSessionItems | String | Allocation session items. See sales_posted_transactions_allocation_session_items | |
| AllocationHistoryItems | String | Allocation history items. See sales_posted_transactions_allocation_history_items | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
This resource returns the details of all sales trading periods for all financial years held for the company. A company can have the trading periods set to be the same as the accounting periods or as different periods. (Sage 200c Professional and Sage 200 Extra Online Only, Sage 200c Standard defaults to financial year periods)
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesTradingPeriods WHERE Id = 1 SELECT * FROM SalesTradingPeriods WHERE PeriodNumber = '1' SELECT * FROM SalesTradingPeriods WHERE StartDate = '2018-01-01T01:00:00.000+01:00' SELECT * FROM SalesTradingPeriods WHERE EndDate = '2018-01-31T01:00:00.000+01:00' SELECT * FROM SalesTradingPeriods WHERE DateTimeUpdated = '2018-02-28T15:23:45.667+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | An unique Id specific to each sales trading period. | |
| PeriodNumber | String | The period number. | |
| StartDate | Date | Date the trading period starts. The returned string includes the time but this will always be 00:00:00. | |
| EndDate | Date | Date the trading period ends. The returned string includes the time but this will always be 00:00:00. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
When making larger API requests for transaction information from the Sales ledger, the Sales Transaction Views resource can be a faster alternative to the 'Sales Posted Transactions' resource. The Sales Transaction Views resource also returns a wider breadth of information than the Sales Posted Transactions.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesTransactionViews WHERE PostedCustomerTransactionId = 29674 SELECT * FROM SalesTransactionViews WHERE TransactionType = 'TradingAccountEntryTypeInvoice' SELECT * FROM SalesTransactionViews WHERE TransactionDate = '2017-12-31T01:00:00.000+01:00' SELECT * FROM SalesTransactionViews WHERE PostedDate = '2018-09-13T02:00:00.000+02:00' SELECT * FROM SalesTransactionViews WHERE DueDate = '2018-02-14T01:00:00.000+01:00' SELECT * FROM SalesTransactionViews WHERE DiscountDays = 0 SELECT * FROM SalesTransactionViews WHERE Reference = 'O/BAL' SELECT * FROM SalesTransactionViews WHERE SecondReference = 'Opening Balance' SELECT * FROM SalesTransactionViews WHERE Query = ' ' SELECT * FROM SalesTransactionViews WHERE Status = 'Full' SELECT * FROM SalesTransactionViews WHERE UserName = 'Migration' SELECT * FROM SalesTransactionViews WHERE LedgerType = 'LedgerSales' SELECT * FROM SalesTransactionViews WHERE Urn = 1 SELECT * FROM SalesTransactionViews WHERE ExchangeRate = 1 SELECT * FROM SalesTransactionViews WHERE SettledImmediately = false SELECT * FROM SalesTransactionViews WHERE BaseGoodsValue = 150 SELECT * FROM SalesTransactionViews WHERE BaseGrossValue = 150 SELECT * FROM SalesTransactionViews WHERE BaseDiscountValue = 0 SELECT * FROM SalesTransactionViews WHERE BaseTaxValue = 0 SELECT * FROM SalesTransactionViews WHERE BaseTaxDiscountValue = 0 SELECT * FROM SalesTransactionViews WHERE BaseAllocatedValue = 150 SELECT * FROM SalesTransactionViews WHERE BaseOutstandingValue = 0 SELECT * FROM SalesTransactionViews WHERE DocumentGoodsValue = 150 SELECT * FROM SalesTransactionViews WHERE DocumentGrossValue = 150 SELECT * FROM SalesTransactionViews WHERE DocumentDiscountValue = 0 SELECT * FROM SalesTransactionViews WHERE DocumentTaxValue = 0 SELECT * FROM SalesTransactionViews WHERE DocumentTaxDiscountValue = 0 SELECT * FROM SalesTransactionViews WHERE DocumentAllocatedValue = 150 SELECT * FROM SalesTransactionViews WHERE DocumentOutstandingValue = 0 SELECT * FROM SalesTransactionViews WHERE CustomerId = 27849 SELECT * FROM SalesTransactionViews WHERE CustomerReference = 'COM001' SELECT * FROM SalesTransactionViews WHERE CustomerName = 'Compton Packaging' SELECT * FROM SalesTransactionViews WHERE CurrencyName = 'Pound Sterling' SELECT * FROM SalesTransactionViews WHERE CurrencySymbol = '£'
| Name | Type | References | Description |
| PostedCustomerTransactionId [KEY] | Long | Id of the transaction. | |
| TransactionType | String | Transaction type. See trader_transaction_types | |
| TransactionDate | Date | The date of the transaction. | |
| PostedDate | Date | The date the transaction was posted. | |
| DueDate | Date | The due date of the transaction. | |
| DiscountDays | Short | Days discount valid. | |
| Reference | String | The reference of the transaction. | |
| SecondReference | String | The second reference of the transaction. | |
| Query | String | Query. | |
| Status | String | Status. | |
| UserName | String | User that posted the transaction. | |
| LedgerType | String | Ledger type. See ledger_types | |
| Urn | Long | Unique reference number. | |
| ExchangeRate | Decimal | Exchange Rate. | |
| SettledImmediately | Bool | Immediately settled. | |
| BaseGoodsValue | Decimal | Goods value in base currency. | |
| BaseGrossValue | Decimal | Gross value in base currency. | |
| BaseDiscountValue | Decimal | Discount value in base currency. | |
| BaseTaxValue | Decimal | Tax value in base currency. | |
| BaseTaxDiscountValue | Decimal | Tax discount value in base currency. | |
| BaseAllocatedValue | Decimal | Allocated value in base currency. | |
| BaseOutstandingValue | Decimal | Outstanding value in base currency. | |
| DocumentGoodsValue | Decimal | Goods value. | |
| DocumentGrossValue | Decimal | Gross value. | |
| DocumentDiscountValue | Decimal | Discount value. | |
| DocumentTaxValue | Decimal | Tax value. | |
| DocumentTaxDiscountValue | Decimal | Tax discount value. | |
| DocumentAllocatedValue | Decimal | Allocated value. | |
| DocumentOutstandingValue | Decimal | Outstanding value. | |
| CustomerId | Long | Customer Id. | |
| CustomerReference | String | Customer account code. | |
| CustomerName | String | Customer account name. | |
| CurrencyName | String | Currency. | |
| CurrencySymbol | String | Currency symbol. |
These settings to define how to process and manage your stock.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM StockSettings WHERE Id = 1 SELECT * FROM StockSettings WHERE UseMultipleLocations = true SELECT * FROM StockSettings WHERE ProfitPercentOfRevenue = true SELECT * FROM StockSettings WHERE DateTimeUpdated = '2018-02-28T15:23:45.543+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Stock setting unique Id. | |
| UseMultipleLocations | Bool | When true this setting allows Sage 200 to track stock at different locations. This can be across several warehouses, or a single warehouse split into separate areas (bins). (Sage 200c Standard value is true and cannot be changed). | |
| ProfitPercentOfRevenue | Bool | Profit can be calculated as a percentage of revenue (true), or as a percentage of cost (false). | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Information can be stored for multiple contacts against each Supplier account. Each contact can have its own details such as telephone numbers, fax numbers, email address and website.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SupplierContacts WHERE Id = 42101 SELECT * FROM SupplierContacts WHERE SupplierId = 325434364565 SELECT * FROM SupplierContacts WHERE FirstName = 'Sample'
| Name | Type | References | Description |
| Id [KEY] | Long | Supplier contact record Id. | |
| SupplierId | Long | Supplier record Id. | |
| Name | String | Contact Name - Concatenated first_name, middle_name and last_name. | |
| FirstName | String | Contact first name. | |
| MiddleName | String | Contact middle name. | |
| LastName | String | Contact surname. | |
| IsDefault | Bool | Is this the default contact for the parent Supplier. See Supplier | |
| DefaultTelephone | String | Default telephone number. | |
| DefaultEmail | String | Default email address. | |
| SalutationId | Long | Contact salutation id. | |
| SalutationIsDefault | Boolean | Contact salutation. | |
| SalutationCode | String | Contact salutation code. | |
| SalutationDescription | String | Contact salutation description. | |
| Emails | String | Supplier emails. See Supplier_emails | |
| Telephones | String | Supplier telephones. See Supplier_telephones | |
| Mobiles | String | Supplier mobiles. See Supplier_mobiles | |
| Faxes | String | Supplier faxes. See Supplier_faxes | |
| Websites | String | Supplier websites. See Supplier_websites | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Suppliers are one of the most important entities within Sage 200 as they are associated with many important resources within the application and underpin most of the main features (e.g. purchase orders, purchase receipts, etc).
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: CountryCode,CountryCodeName,CountryCodeEuMember,BankId,BankAccountNumber,BankAccountName,BankIBAN,BankBIC,MainAddress_1,MainAddress_2,MainAddress_3,MainAddress_4,MainAddressCity,MainAddressCounty,MainAddressPostcode,Contacts columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Suppliers WHERE Id = 28846 SELECT * FROM Suppliers WHERE Reference = 'CON001' SELECT * FROM Suppliers WHERE Name = 'Concept Stationery Supplies' SELECT * FROM Suppliers WHERE ShortName = 'Concept' SELECT * FROM Suppliers WHERE Balance = 4346.16 SELECT * FROM Suppliers WHERE OnHold = false SELECT * FROM Suppliers WHERE AccountStatusType = 'AccountStatusActive' SELECT * FROM Suppliers WHERE CurrencyId = 2103 SELECT * FROM Suppliers WHERE ExchangeRateType = 'ExchangeRateSingle' SELECT * FROM Suppliers WHERE TelephoneCountryCode = '44' SELECT * FROM Suppliers WHERE TelephoneAreaCode = '0191' SELECT * FROM Suppliers WHERE TelephoneSubscriberNumber = '643 4343' SELECT * FROM Suppliers WHERE FaxCountryCode = '44' SELECT * FROM Suppliers WHERE FaxAreaCode = '0191' SELECT * FROM Suppliers WHERE FaxSubscriberNumber = '643 4345' SELECT * FROM Suppliers WHERE Website = 'www.sage.co.uk' SELECT * FROM Suppliers WHERE CreditLimit = 17000 SELECT * FROM Suppliers WHERE CountryCodeId = 13 SELECT * FROM Suppliers WHERE DefaultTaxCodeId = 1729 SELECT * FROM Suppliers WHERE VatNumber = 'GB988 3453 23' SELECT * FROM Suppliers WHERE AnalysisCode1 = 'North East' SELECT * FROM Suppliers WHERE AnalysisCode2 = 'Stationery' SELECT * FROM Suppliers WHERE AnalysisCode3 = 'abc' SELECT * FROM Suppliers WHERE AnalysisCode4 = 'abc' SELECT * FROM Suppliers WHERE AnalysisCode5 = 'abc' SELECT * FROM Suppliers WHERE DateTimeUpdated = '2018-02-28T15:23:46.253+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Supplier unique Id. | |
| Reference | String | Supplier account reference. NOTE: Not required if supplier reference is set to | |
| Name | String | Supplier name. | |
| ShortName | String | Supplier short name. | |
| Balance | Decimal | Supplier account balance. | |
| OnHold | Bool | True if supplier account is on hold, else False. | |
| AccountStatusType | String | The status of the supplier account (Sage 200c Standard and versions of Extra/Professional released after July 2017). For example, this can either be 'Active' or 'Hidden'. See account_status_types | |
| CurrencyId | Long |
Currencies.Id | Currency record Id. See currencies |
| ExchangeRateType | String | The type of exchange rate used on the supplier account. See exchange_rate_types | |
| TelephoneCountryCode | String | Telephone country code (Sage 200c Professional and Sage 200 Extra Online Only). | |
| TelephoneAreaCode | String | Telephone area code (Sage 200c Professional and Sage 200 Extra Online Only). | |
| TelephoneSubscriberNumber | String | Telephone subscriber number (Sage 200c Professional and Sage 200 Extra Online Only). | |
| FaxCountryCode | String | Fax country code. | |
| FaxAreaCode | String | Fax area code. | |
| FaxSubscriberNumber | String | Fax subscriber number. | |
| Website | String | Website address. | |
| CreditLimit | Decimal | Credit limit for the supplier. | |
| CountryCodeId | Long | Country code record Id. | |
| CountryCode | String | The customers country code. | |
| CountryCodeName | String | The customers country code name. | |
| CountryCodeEuMember | Boolean | Shows if the customer is Eu Member. | |
| DefaultTaxCodeId | Long |
TaxCodes.Id | Default tax code record Id. See tax_codes |
| VatNumber | String | VAT registration number. | |
| AnalysisCode1 | String | Analysis code 1. | |
| AnalysisCode2 | String | Analysis code 2. | |
| AnalysisCode3 | String | Analysis code 3. | |
| AnalysisCode4 | String | Analysis code 4. | |
| AnalysisCode5 | String | Analysis code 5. | |
| BankId | String | Supplier bank account id. | |
| BankAccountNumber | String | Supplier bank account number. | |
| BankAccountName | String | Supplier bank account name. | |
| BankIBAN | String | Supplier bank account iban number. | |
| BankBIC | String | Supplier bank account BIC number. | |
| MainAddress_1 | String | The customers main address line 1. | |
| MainAddress_2 | String | The customers main address line 2. | |
| MainAddress_3 | String | The customers main address line 3. | |
| MainAddress_4 | String | The customers main address line 4. | |
| MainAddressCity | String | The customers main address city. | |
| MainAddressCounty | String | The customers main address county. | |
| MainAddressPostcode | String | The customers main address postcode. | |
| Contacts | String | Supplier contacts. See supplier_contacts | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Tax codes are normally used for UK business VAT Rates. They are accessed by Sage 200 modules in order to: - Analyse the rates to Nominal Ledger accounts. - Analyse the rates to the VAT Return. - Read percentages for calculations in transactions.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM TaxCodes WHERE Id = 1728 SELECT * FROM TaxCodes WHERE Code = 0 SELECT * FROM TaxCodes WHERE Name = 'Zero rated' SELECT * FROM TaxCodes WHERE TaxRate = 0 SELECT * FROM TaxCodes WHERE Terms = 'EcTermsNotApplicable' SELECT * FROM TaxCodes WHERE TermsDescription = 'Not Applicable' SELECT * FROM TaxCodes WHERE DateTimeUpdated = '2018-02-28T15:23:46.133+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Tax code record Id. | |
| Code | Short | Tax code. | |
| Name | String | Name of the tax code. | |
| TaxRate | Decimal | Tax rate. | |
| Terms | String | Name of the terms. | |
| TermsDescription | String | Description of the terms. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
All stock within Sage 200 regardless of type (Stock, Service/labour, or Miscellaneous), require a holding location. The location indicates where an item is stored and the stock level settings for each product in the warehouse i.e. the re-order level, the minimum and maximum stock levels. Items with a type of 'Stock' have levels recorded for each warehouse location and the levels are used when allocating, issuing and receiving stock. If the stock setting UseMultipleLocations is true, a product can be linked to multiple warehouse holdings. You cannot delete the last warehouse holding associated with a product.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM WarehouseHoldings WHERE Id = 34738 SELECT * FROM WarehouseHoldings WHERE WarehouseId = 34629 SELECT * FROM WarehouseHoldings WHERE ProductId = 34737 SELECT * FROM WarehouseHoldings WHERE ReorderLevel = 0 SELECT * FROM WarehouseHoldings WHERE MinimumLevel = 0 SELECT * FROM WarehouseHoldings WHERE MaximumLevel = 0 SELECT * FROM WarehouseHoldings WHERE ConfirmedQtyInStock = 0 SELECT * FROM WarehouseHoldings WHERE UnconfirmedQtyInStock = 0 SELECT * FROM WarehouseHoldings WHERE QuantityInStock = 0 SELECT * FROM WarehouseHoldings WHERE QuantityAllocatedStock = 0 SELECT * FROM WarehouseHoldings WHERE QuantityAllocatedSop = 0 SELECT * FROM WarehouseHoldings WHERE QuantityAllocatedBom = 0 SELECT * FROM WarehouseHoldings WHERE QuantityAllocated = 0 SELECT * FROM WarehouseHoldings WHERE DateTimeUpdated = '2019-08-01T18:00:33.140+02:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Warehouse holding record Id. | |
| WarehouseId | Long |
Warehouses.Id | Warehouse record Id. See warehouses |
| ProductId | Long |
Products.Id | Product record Id. See products |
| ReorderLevel | Decimal | Reorder stock level. | |
| MinimumLevel | Decimal | Minimum stock quantity level. | |
| MaximumLevel | Decimal | Maximum stock quantity level. | |
| ConfirmedQtyInStock | Decimal | Confirmed stock quantity. | |
| UnconfirmedQtyInStock | Decimal | Unconfirmed stock quantity. | |
| QuantityInStock | Decimal | Total confirmed and unconfirmed stock quantity. | |
| QuantityAllocatedStock | Decimal | Allocated stock quantity. | |
| QuantityAllocatedSop | Decimal | Allocated sales order quantity. | |
| QuantityAllocatedBom | Decimal | Allocated bill of materials quantity. | |
| QuantityAllocated | Decimal | Total Allocated stock, sop and bom quantity. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
All stock within Sage 200, regardless of type (Stock, Service/labour, or Miscellaneous), requires a holding location. By default, the HOME warehouse is created within Sage 200, you can then create your own warehouses.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Warehouses WHERE Id = 34626 SELECT * FROM Warehouses WHERE Name = 'Supplied Direct' SELECT * FROM Warehouses WHERE DateTimeUpdated = '2018-02-28T15:23:46.190+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Warehouse record Id. | |
| Name | String | Warehouse name. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with Sage 200.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Sage 200, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
Views describes the available views. Views are statically defined to model Banks, Customers, Products, and more.
Stored Procedures are function-like interfaces to Sage 200. Stored procedures allow you to execute operations to Sage 200, such as retrieving the OAuth Access Token.
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| BankPostedTransactions | Bank posted transactions are created when transactions such as receipts or payments are posted against the Cash Book. |
| Banks | Bank accounts can be created in Sage 200 for any type of account that money is paid in/out of, for example, cash, credit cards or, business current account. Bank accounts can be in any currency and all balances are recorded in the currency specific to that bank account. |
| CompanyDetails | Every instance of Sage 200 is configured for the company using it. A company is identified in Sage 200 by its name. Sage 200 stores separate company details for each company that is created. The information stored within company details is typical company information such as VAT registration number and company contact details. |
| CostCentres | Cost centres are typically used to aid collating related costs and reporting on a specific segment of an organisation i.e. a company division such as sales or production. |
| Currencies | Sage 200 works in multiple currencies and each company can configure up to 99 currencies to use, and all can be configured to use a single exchange rate, period exchange rates, or both. One currency must be configured as the base currency and this cannot be changed once transactions have been entered. If a currency is configured as amendable, the exchange rate can be modified when entering transactions. |
| CustomerContacts | Information can be stored for multiple contacts against each customer account. Each contact can have its own details such as telephone numbers, fax numbers, email address and website. |
| CustomerDeliveryAddresses | A customer can have multiple delivery addresses stored for their account which can be used when creating an invoice or sales order. |
| Customers | Customers are one of the most important entities within Sage 200 as they are associated with many important resources within the application and underpin most of the main features (e.g. sales orders, payment receipts, etc). When making larger requests for customer information, the Customer Views resource can be a faster alternative to this resource. |
| CustomerSalesOrderInvoiceCreditLine | This resource returns a view of related customers, sales invoice credits, sales invoice credit lines, invoice line profit analysis, products, and product groups that can be queried on any field. The default sort (orderby) fields are by 'sop_invoice_credit_id' and 'sop_invoice_credit_line_id' descending. |
| Departments | Departments are a subdivision of cost centres and are used where specific costs or revenue need to be collated and reported on separately. For example, a cost centre could be a sales area such as North East or South West and different departments could be Administration and Training. |
| FinancialReportLayouts | Financial statement layouts are designed to provide a clear representation of your accounts. This resource returns the details of all financial statement layouts. The default sort (orderby) field are by 'financial_report_layout_id' and 'financial_report_row_report_row' ascending. |
| FinancialYearPeriods | This resource returns the details of all accounting periods for all financial years held for the company. A company always has five future financial years and can have unlimited previous years, depending on how long the company has been operating. The default sort (orderby) field are by 'financial_year_start_date' and 'period_number' ascending. |
| NominalCodes | Nominal accounts are fundamental to the successful management of company finances. The value of every transaction entered into Sage 200 is posted to a nominal account and, is where the revenue and expenditure of the business is recorded. Nominal accounts include a code, and cost centre and a department. |
| NominalReportCategories | Nominal report categories are used in financial statements (PL, Balance Sheet) to group nominal codes under headings and to determine whether the nominal code value is reported on the layout for the Balance Sheet (Asset and Liability) or Profit and Loss (Income and Expense). |
| NominalTransactionAnalysisCodes | Nominal transaction analysis codes are used to group nominal analysis items on various transaction types |
| PendingEmails | When working with Microsoft Flow, it is useful to be able to access pending emails to send as notifications to the user from Sage 200. |
| PriceBands | A price band is simply a price list. They're used to offer different prices to different customers. Product prices are set in the each price band. The price a customer receives for a product depends on the price band their account is linked to. |
| ProductGroups | Product groups are used to group stock items together with similar characteristics or requirements. Product Groups provide several default settings for stock items and, have their own unique code and description. |
| ProductPrices | This returns the selling prices of your products. A price is returned for each price band associated with a product. A price band is simply a price list. The price a customer receives for a product depends on the price band their account is linked to. The 'Standard' price band is the default. The prices returned here do not include any customer specific discounts. The default sort (orderby) field is by 'product_code' ascending. |
| Products | Products are used to track stock within Sage 200. This is not just for physical items, but also for items that are ordered direct from suppliers, services, and time or labour that can be included on customer invoices. |
| ProductTransactions | A product transaction is created each time a product is moved in, or out of stock. Product transactions are created from various sources such as purchase orders, sales orders, transfers between warehouses etc.. This resource returns the details of product transactions. The default sort (orderby) field is by 'id' descending. |
| PurchaseOrderLines | When making larger requests for purchase order information, the Purchase Order Line Views resource is a faster alternative to the 'Purchase Orders' resource. |
| PurchaseOrders | Purchase orders are used to represent the purchase of goods or services from a supplier. They are central to a business and define the terms (price, quantity and times) by which the products or services will be received. |
| PurchasePostedTransactions | Purchase posted transactions are created when transactions, such as purchases made, refunds or credit notes, are posted against the Purchase Ledger. It is not possible to use this API resource to create posted transactions. |
| SalesHistoricalTransactions | Sales historical transactions are created when transactions are archived from the Sales Ledger. It is not possible to use this API resource to create historical transactions. |
| SalesOrderAdditionalCharges | Additional charges can be added to sales orders to account for items such as carriage and insurance. Within the Sage 200 application, users can setup and maintain the list of additional charges that can be referenced when creating a sales order. This API resource can be used to determine what each additional charge is for. |
| SalesOrderLines | When making larger requests for sales order information, the Sales Order Line Views resource is a faster alternative to the 'Sales Orders' resource. The Sales Order Line Views resource returns more information than the 'Sales Orders' resource, and therefore reduces the number of API requests required to return the same information from multiple resources. This resource returns a view of sales orders, sales order lines, customers, products, warehouses, tax codes and currencies that can be queried on any field. The default sort (orderby) field are by 'sop_order_id' and 'sop_order_line_id' descending. |
| SalesOrderProformaLines | This resource returns a view of sales pro formas, sales pro forma lines, customers, products, warehouses, tax codes and currencies that can be queried on any field. The default sort (orderby) field are by 'sop_proforma_id' and 'sop_proforma_line_id' descending. |
| SalesOrderQuoteLines | This resource returns a view of sales quotes, sales quote lines, customers, products, warehouses, tax codes and currencies that can be queried on any field. The default sort (orderby) field are by 'sop_quote_id' and 'sop_quote_line_id' descending. |
| SalesOrders | Sales orders are used to represent the sale of goods or services to a customer. They are central to a business and define the terms (price, quantity and times) by which the products or services will be delivered. Note: Adding traceable items to sales orders. If you're using traceable stock items and an item is set to be sold from a single batch, then the order quantity must be less than or equal to quantity in the batch. If you try to order more than the quantity in the batch, the order cannot be posted via the API. |
| SalesPostedTransactions | Sales posted transactions are created when transactions, such as orders invoiced, receipts, refunds or credit notes, are posted against the Sales Ledger. It is not possible to use this API resource to create posted transactions. To post a transaction, the necessary API resource must be invoked. When making larger requests for customer information, the Sales Transactions Views resource can be a faster alternative to this resource. |
| SalesTradingPeriods | This resource returns the details of all sales trading periods for all financial years held for the company. A company can have the trading periods set to be the same as the accounting periods or as different periods. (Sage 200c Professional and Sage 200 Extra Online Only, Sage 200c Standard defaults to financial year periods) |
| SalesTransactions | When making larger API requests for transaction information from the Sales ledger, the Sales Transaction Views resource can be a faster alternative to the 'Sales Posted Transactions' resource. The Sales Transaction Views resource also returns a wider breadth of information than the Sales Posted Transactions. |
| StockSettings | These settings to define how to process and manage your stock. |
| SupplierContacts | Information can be stored for multiple contacts against each Supplier account. Each contact can have its own details such as telephone numbers, fax numbers, email address and website. |
| Suppliers | Suppliers are one of the most important entities within Sage 200 as they are associated with many important resources within the application and underpin most of the main features (e.g. purchase orders, purchase receipts, etc). |
| TaxCodes | Tax codes are normally used for UK business VAT Rates. They are accessed by Sage 200 modules in order to: - Analyse the rates to Nominal Ledger accounts. - Analyse the rates to the VAT Return. - Read percentages for calculations in transactions. |
| WarehouseHoldings | All stock within Sage 200 regardless of type (Stock, Service/labour, or Miscellaneous), require a holding location. The location indicates where an item is stored and the stock level settings for each product in the warehouse i.e. the re-order level, the minimum and maximum stock levels. Items with a type of 'Stock' have levels recorded for each warehouse location and the levels are used when allocating, issuing and receiving stock. If the stock setting UseMultipleLocations is true, a product can be linked to multiple warehouse holdings. You cannot delete the last warehouse holding associated with a product. |
| Warehouses | All stock within Sage 200, regardless of type (Stock, Service/labour, or Miscellaneous), requires a holding location. By default, the HOME warehouse is created within Sage 200, you can then create your own warehouses. |
Bank posted transactions are created when transactions such as receipts or payments are posted against the Cash Book.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: NominalAnalysisItems,TaxAnalysisItems,TradeItems columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM BankPostedTransactions WHERE Id = 29448 SELECT * FROM BankPostedTransactions WHERE BankId = 29401 SELECT * FROM BankPostedTransactions WHERE BankTransactionType = 'Payment' SELECT * FROM BankPostedTransactions WHERE EntryDescription = 'Opening Balance' SELECT * FROM BankPostedTransactions WHERE Reference = 'O/Bal' SELECT * FROM BankPostedTransactions WHERE SecondReference = 'abc' SELECT * FROM BankPostedTransactions WHERE TransactionDate = '2017-12-31T01:00:00.000+01:00' SELECT * FROM BankPostedTransactions WHERE PostedDate = '2017-09-13T02:00:00.000+02:00' SELECT * FROM BankPostedTransactions WHERE ChequeValue = -6511.96 SELECT * FROM BankPostedTransactions WHERE ChequeDiscountValue = 0 SELECT * FROM BankPostedTransactions WHERE ChequeToAccountCurrencyRate = 1 SELECT * FROM BankPostedTransactions WHERE BankChequeToBaseCurrencyRate = 1 SELECT * FROM BankPostedTransactions WHERE ChequeCurrencyId = 2103 SELECT * FROM BankPostedTransactions WHERE Urn = 24 SELECT * FROM BankPostedTransactions WHERE UserName = 'Migration' SELECT * FROM BankPostedTransactions WHERE DateTimeUpdated = '2018-02-28T15:23:46.467+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Id. | |
| BankId | Long |
Banks.Id | Bank Id. See banks |
| BankTransactionType | String | Transaction type. See bank_transaction_types | |
| EntryDescription | String | Transaction description. | |
| Reference | String | Transaction reference. | |
| SecondReference | String | Second reference. | |
| TransactionDate | Date | Transaction date. | |
| PostedDate | Date | Posted date. | |
| ChequeValue | Decimal | Value of the entry. | |
| ChequeDiscountValue | Decimal | Entry discount value. | |
| ChequeToAccountCurrencyRate | Decimal | Exchange rate between the bank account currency and the cheque currency. | |
| BankChequeToBaseCurrencyRate | Decimal | Exchange rate between the bank account and the company base currency. | |
| ChequeCurrencyId | Long | Currency Id. See currencies | |
| Urn | Long | Unique reference number. | |
| UserName | String | User who entered the transaction. | |
| NominalAnalysisItems | String | Nominal analysis items. See bank_posted_transactions_nominal_analysis_items | |
| TaxAnalysisItems | String | Tax analysis items. See bank_posted_transactions_tax_analysis_items | |
| TradeItems | String | Trade items. See bank_posted_transactions_trade_items | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Bank accounts can be created in Sage 200 for any type of account that money is paid in/out of, for example, cash, credit cards or, business current account. Bank accounts can be in any currency and all balances are recorded in the currency specific to that bank account.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: BankAddressId,BankAddressContact,BankAddressCountry,BankAddressCity,BankAddressPostcode,BankAddress_1,BankAddress_2,BankAddress_3,BankAddress_4,BankContacts columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Banks WHERE Id = 29401 SELECT * FROM Banks WHERE Code = '1200' SELECT * FROM Banks WHERE Description = 'Bank Current Account' SELECT * FROM Banks WHERE SortCode = '233434' SELECT * FROM Banks WHERE AccountNo = '003234234' SELECT * FROM Banks WHERE BankName = 'Lloyds Bank PLC' SELECT * FROM Banks WHERE AccountType = 'BankAccountTypeCurrent' SELECT * FROM Banks WHERE AccountStatusType = 'AccountStatusActive' SELECT * FROM Banks WHERE Balance = -9941.57 SELECT * FROM Banks WHERE BalanceInBase = -9941.57 SELECT * FROM Banks WHERE OverdraftLimit = 0 SELECT * FROM Banks WHERE AccountName = 'Stationery & Computer Mart UK Ltd' SELECT * FROM Banks WHERE Iban = 'abc' SELECT * FROM Banks WHERE Bic = 'abc' SELECT * FROM Banks WHERE StatementBalance = 0 SELECT * FROM Banks WHERE StatementDate = '2019-10-02T11:46:53Z' SELECT * FROM Banks WHERE AccountCurrencyId = 2103 SELECT * FROM Banks WHERE DateTimeUpdated = '2018-02-28T15:23:46.070+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Bank account record Id. | |
| Code | String | Bank account code. | |
| Description | String | Bank description. | |
| SortCode | String | Bank sort code. | |
| AccountNo | String | Bank account number. | |
| BankName | String | Bank name. | |
| AccountType | String | Bank account type. See bank_account_types | |
| AccountStatusType | String | The status of the bank account (Sage 200c Standard and versions of Professional released after February 2018). For example, this can either be 'Active' or 'Hidden'. See account_status_types | |
| Balance | Decimal | Bank balance. | |
| BalanceInBase | Decimal | Bank balance in base currency. | |
| OverdraftLimit | Decimal | Bank overdraft limit. | |
| AccountName | String | Account name. | |
| Iban | String | International bank account number. | |
| Bic | String | Bank identifier code. | |
| StatementBalance | Decimal | Last statement balance. | |
| StatementDate | Date | Last statement date. | |
| AccountCurrencyId | Long |
Currencies.Id | Currency record Id. See currencies |
| BankAddressId | Long | Bank address. Bank address record id. | |
| BankAddressContact | String | Bank address. Address Contact name. | |
| BankAddressCountry | String | Bank address. Country. | |
| BankAddressCity | String | Bank address. City. | |
| BankAddressPostcode | String | Bank address. Postcode. | |
| BankAddress_1 | String | Bank address. Address line 1. | |
| BankAddress_2 | String | Bank address. Address line 2. | |
| BankAddress_3 | String | Bank address. Address line 3. | |
| BankAddress_4 | String | Bank address. Address line 4. | |
| BankContacts | String | Collection of bank contact values. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Every instance of Sage 200 is configured for the company using it. A company is identified in Sage 200 by its name. Sage 200 stores separate company details for each company that is created. The information stored within company details is typical company information such as VAT registration number and company contact details.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: CountryCode,CountryCodeName,CountryCodeEUMember,AddressCountry,Address_1,Address_2,Address_3,Address_4,AddressCity,AddressCounty,AddressPostcode columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM CompanyDetails WHERE Name = 'Stationery & Computer Mart UK' SELECT * FROM CompanyDetails WHERE Telephone = '0191 955 3000' SELECT * FROM CompanyDetails WHERE Fax = '0191 955 3001' SELECT * FROM CompanyDetails WHERE Email = '[email protected]' SELECT * FROM CompanyDetails WHERE Website = 'http://www.stationerycomputermartuk.co.uk' SELECT * FROM CompanyDetails WHERE TaxRegistrationNumber = '376 6823 94' SELECT * FROM CompanyDetails WHERE CountryCodeId = 13 SELECT * FROM CompanyDetails WHERE YearsAccountsHeldFor = 2 SELECT * FROM CompanyDetails WHERE EoriNumber = 'abc' SELECT * FROM CompanyDetails WHERE DateTimeUpdated = '2018-02-28T15:23:46.040+01:00'
| Name | Type | References | Description |
| Name [KEY] | String | Company name. | |
| Telephone | String | Telephone number. | |
| Fax | String | Fax number. | |
| String | Email address. | ||
| Website | String | Company website address. | |
| TaxRegistrationNumber | String | Tax registration number. | |
| CountryCodeId | Long | Country code record Id. See country_codes | |
| CountryCode | String | Country code record Id. See country_codes | |
| CountryCodeName | String | Country code record Id. See country_codes | |
| CountryCodeEUMember | Boolean | Country code record Id. See country_codes | |
| YearsAccountsHeldFor | Int | Number of years that periods with nominal data exist for up to a maximum of six years. | |
| AddressCountry | String | The company's address Id. | |
| Address_1 | String | The company's address. Address line 1. | |
| Address_2 | String | The company's address. Address line 2. | |
| Address_3 | String | The company's address. Address line 3. | |
| Address_4 | String | The company's address. Address line 4. | |
| AddressCity | String | The company's address. City | |
| AddressCounty | String | The company's address. County | |
| AddressPostcode | String | The company's address. Postcode | |
| EoriNumber | String | The company's EORI number. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Cost centres are typically used to aid collating related costs and reporting on a specific segment of an organisation i.e. a company division such as sales or production.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM CostCentres WHERE Id = 1015 SELECT * FROM CostCentres WHERE Code = 'abc' SELECT * FROM CostCentres WHERE Name = 'abc' SELECT * FROM CostCentres WHERE DateTimeUpdated = '2018-02-28T15:23:46.230+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Cost centre record Id. | |
| Code | String | Cost centre code. | |
| Name | String | Cost centre name. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Sage 200 works in multiple currencies and each company can configure up to 99 currencies to use, and all can be configured to use a single exchange rate, period exchange rates, or both. One currency must be configured as the base currency and this cannot be changed once transactions have been entered. If a currency is configured as amendable, the exchange rate can be modified when entering transactions.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: CurrencyIsoCode,CurrencyIsoCodeName columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Currencies WHERE Id = 2103 SELECT * FROM Currencies WHERE Symbol = '£' SELECT * FROM Currencies WHERE Name = 'Pound Sterling' SELECT * FROM Currencies WHERE CoreCurrencyRate = 1 SELECT * FROM Currencies WHERE EuroCurrencyRate = 0.714285 SELECT * FROM Currencies WHERE CurrencyIsoCodeId = 49 SELECT * FROM Currencies WHERE IsBaseCurrency = true SELECT * FROM Currencies WHERE IsEuroCurrency = false SELECT * FROM Currencies WHERE DateTimeUpdated = '2018-02-28T15:23:46.243+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Currency record Id. | |
| Symbol | String | Currency symbol. | |
| Name | String | Currency name. | |
| CoreCurrencyRate | Decimal | Currency rate in use against base. | |
| EuroCurrencyRate | Decimal | Euro rate. | |
| CurrencyIsoCodeId | Long | ISO Currency Code Record Id. See currency_iso_codes | |
| CurrencyIsoCode | String | ISO Currency Code Record Id. See currency_iso_codes | |
| CurrencyIsoCodeName | String | ISO Currency Code Record Id. See currency_iso_codes | |
| IsBaseCurrency | Bool | Flag to indicate if the currency is the base currency. | |
| IsEuroCurrency | Bool | Flag to indicate if the currency is Euro. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Information can be stored for multiple contacts against each customer account. Each contact can have its own details such as telephone numbers, fax numbers, email address and website.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM CustomerContacts WHERE Id = 42101 SELECT * FROM CustomerContacts WHERE CustomerId = '0000000001' SELECT * FROM CustomerContacts WHERE Name = 'Sample'
| Name | Type | References | Description |
| Id [KEY] | Long | Customer contact record Id. | |
| CustomerId | Long | Customer record Id. | |
| Name | String | Contact Name - Concatenated first_name, middle_name and last_name. | |
| FirstName | String | Contact first name. | |
| MiddleName | String | Contact middle name. | |
| LastName | String | Contact surname. | |
| IsDefault | Bool | Is this the default contact for the parent customer. See customer | |
| DefaultTelephone | String | Default telephone number. | |
| DefaultEmail | String | Default email address. | |
| SalutationId | Long | Contact salutation id. | |
| SalutationIsDefault | Boolean | Contact salutation. | |
| SalutationCode | String | Contact salutation code. | |
| SalutationDescription | String | Contact salutation description. | |
| Emails | String | Customer emails. See customer_emails | |
| Telephones | String | Customer telephones. See customer_telephones | |
| Mobiles | String | Customer mobiles. See customer_mobiles | |
| Faxes | String | Customer faxes. See customer_faxes | |
| Websites | String | Customer websites. See customer_websites | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
A customer can have multiple delivery addresses stored for their account which can be used when creating an invoice or sales order.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM CustomerDeliveryAddresses WHERE Id = 27927 SELECT * FROM CustomerDeliveryAddresses WHERE Contact = 'Lee Dalkin' SELECT * FROM CustomerDeliveryAddresses WHERE Country = 'abc' SELECT * FROM CustomerDeliveryAddresses WHERE CustomerId = 27825 SELECT * FROM CustomerDeliveryAddresses WHERE Description = 'Registered address' SELECT * FROM CustomerDeliveryAddresses WHERE Email = '[email protected]' SELECT * FROM CustomerDeliveryAddresses WHERE Fax = '01742 876 236' SELECT * FROM CustomerDeliveryAddresses WHERE IsDefault = false SELECT * FROM CustomerDeliveryAddresses WHERE PostalName = 'A1 Design Services' SELECT * FROM CustomerDeliveryAddresses WHERE TaxCodeId = 1729 SELECT * FROM CustomerDeliveryAddresses WHERE TaxNumber = 'GB238 3839 38' SELECT * FROM CustomerDeliveryAddresses WHERE Telephone = '01742 876 234' SELECT * FROM CustomerDeliveryAddresses WHERE Address1 = '67a Station Road' SELECT * FROM CustomerDeliveryAddresses WHERE Address2 = 'abc' SELECT * FROM CustomerDeliveryAddresses WHERE Address3 = 'Blackpool' SELECT * FROM CustomerDeliveryAddresses WHERE Address4 = 'Lancashire' SELECT * FROM CustomerDeliveryAddresses WHERE City = 'abc' SELECT * FROM CustomerDeliveryAddresses WHERE County = 'abc' SELECT * FROM CustomerDeliveryAddresses WHERE Postcode = 'BP12 7HT' SELECT * FROM CustomerDeliveryAddresses WHERE AddressCountryCodeId = 0 SELECT * FROM CustomerDeliveryAddresses WHERE DateTimeUpdated = '2018-02-28T15:23:46.867+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | The unique id of the customer delivery address. | |
| Contact | String | The contact associated with the customer delivery address. | |
| Country | String | Country (if using segmented addresses in Sage 200c Professional or Sage 200 Extra Online). | |
| CustomerId | Long | Unique Id of the customer account the customer delivery address is associated with. See customers | |
| Description | String | The description of the customer delivery address. | |
| String | The email address associated with the customer delivery address. | ||
| Fax | String | The fax number associated with the customer delivery address. | |
| IsDefault | Bool | Flag to indicate if this is the default customer delivery address for the parent customer. See customer | |
| PostalName | String | Postal name is the name of the person or company who the invoice or sales order is addressed to. | |
| TaxCodeId | Long | The tax code record Id. See tax_codes | |
| TaxNumber | String | The tax number. | |
| Telephone | String | The telephone number associated with the customer delivery address. | |
| Address1 | String | Address line 1. | |
| Address2 | String | Address line 2. | |
| Address3 | String | Address line 3. | |
| Address4 | String | Address line 4. | |
| City | String | City (if using segmented addresses in Sage 200c Professional or Sage 200 Extra Online). | |
| County | String | County (if using segmented addresses in Sage 200c Professional or Sage 200 Extra Online). | |
| Postcode | String | Postcode. | |
| AddressCountryCodeId | Long | Country code Id. See country_codes | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Customers are one of the most important entities within Sage 200 as they are associated with many important resources within the application and underpin most of the main features (e.g. sales orders, payment receipts, etc). When making larger requests for customer information, the Customer Views resource can be a faster alternative to this resource.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: CountryCode,CountryCodeName,CountryCodeEuMember,MainAddress_1,MainAddress_2,MainAddress_3,MainAddress_4,MainAddressCity,MainAddressCounty,MainAddressPostcode,Contacts columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Customers WHERE Id = 27825 SELECT * FROM Customers WHERE Reference = 'A1D001' SELECT * FROM Customers WHERE Name = 'A1 Design Services' SELECT * FROM Customers WHERE ShortName = 'A1 Desig' SELECT * FROM Customers WHERE Balance = 1120.92 SELECT * FROM Customers WHERE OnHold = false SELECT * FROM Customers WHERE AccountStatusType = 'AccountStatusActive' SELECT * FROM Customers WHERE CurrencyId = 2103 SELECT * FROM Customers WHERE ExchangeRateType = 'ExchangeRateSingle' SELECT * FROM Customers WHERE TelephoneCountryCode = '44' SELECT * FROM Customers WHERE TelephoneAreaCode = '01742' SELECT * FROM Customers WHERE TelephoneSubscriberNumber = '876234' SELECT * FROM Customers WHERE FaxCountryCode = '44' SELECT * FROM Customers WHERE FaxAreaCode = '01742' SELECT * FROM Customers WHERE FaxSubscriberNumber = '876236' SELECT * FROM Customers WHERE Website = 'www.sage.co.uk' SELECT * FROM Customers WHERE CreditLimit = 0 SELECT * FROM Customers WHERE DefaultTaxCodeId = 1729 SELECT * FROM Customers WHERE VatNumber = 'GB238 3839 38' SELECT * FROM Customers WHERE DunsCode = 'abc' SELECT * FROM Customers WHERE AnalysisCode1 = 'Trade' SELECT * FROM Customers WHERE AnalysisCode2 = 'George' SELECT * FROM Customers WHERE AnalysisCode3 = 'Lancashire' SELECT * FROM Customers WHERE AnalysisCode4 = 'abc' SELECT * FROM Customers WHERE AnalysisCode5 = 'abc' SELECT * FROM Customers WHERE AverageTimeToPay = 0 SELECT * FROM Customers WHERE ValueOfCurrentOrdersInSop = 340.38 SELECT * FROM Customers WHERE CountryCodeId = 13 SELECT * FROM Customers WHERE DateTimeUpdated = '2018-03-05T11:19:18.317+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Customer unique Id. | |
| Reference | String | Customer account reference. NOTE: Not required if customer reference is set to | |
| Name | String | Customer name. | |
| ShortName | String | Customer short name. | |
| Balance | Decimal | Customer account balance. | |
| OnHold | Bool | True if customer account is on hold, else False. | |
| AccountStatusType | String | The status of the customer account (Sage 200c Standard and versions of Extra/Professional released after July 2017). For example, this can either be 'Active' or 'Hidden'. See account_status_types | |
| CurrencyId | Long |
Currencies.Id | Currency record Id. See currencies |
| ExchangeRateType | String | The type of exchange rate used on the customer account. See exchange_rate_types | |
| TelephoneCountryCode | String | Telephone country code (Sage 200c Professional and Sage 200 Extra Online Only). | |
| TelephoneAreaCode | String | Telephone area code (Sage 200c Professional and Sage 200 Extra Online Only). | |
| TelephoneSubscriberNumber | String | Telephone subscriber number (Sage 200c Professional and Sage 200 Extra Online Only). | |
| FaxCountryCode | String | Fax country code. | |
| FaxAreaCode | String | Fax area code. | |
| FaxSubscriberNumber | String | Fax subscriber number. | |
| Website | String | Website address. | |
| CreditLimit | Decimal | Credit limit for the customer. | |
| DefaultTaxCodeId | Long |
TaxCodes.Id | Default tax code record Id. See tax_codes |
| VatNumber | String | VAT registration number. | |
| DunsCode | String | DUNS number. | |
| AnalysisCode1 | String | Analysis code 1. | |
| AnalysisCode2 | String | Analysis code 2. | |
| AnalysisCode3 | String | Analysis code 3. | |
| AnalysisCode4 | String | Analysis code 4. | |
| AnalysisCode5 | String | Analysis code 5. | |
| AnalysisCode6 | String | Analysis code 6. | |
| AnalysisCode7 | String | Analysis code 7. | |
| AnalysisCode8 | String | Analysis code 8. | |
| AnalysisCode9 | String | Analysis code 9. | |
| AnalysisCode10 | String | Analysis code 10. | |
| AnalysisCode11 | String | Analysis code 11. | |
| AnalysisCode12 | String | Analysis code 12. | |
| AnalysisCode13 | String | Analysis code 13. | |
| AnalysisCode14 | String | Analysis code 14. | |
| AnalysisCode15 | String | Analysis code 15. | |
| AnalysisCode16 | String | Analysis code 16. | |
| AnalysisCode17 | String | Analysis code 17. | |
| AnalysisCode18 | String | Analysis code 18. | |
| AnalysisCode19 | String | Analysis code 19. | |
| AnalysisCode20 | String | Analysis code 20. | |
| AverageTimeToPay | Int | The customer average time to pay. | |
| ValueOfCurrentOrdersInSop | Decimal | Value of current sales orders for this customer. | |
| CountryCodeId | Long | Country code record Id. | |
| CountryCode | String | The customers country code. | |
| CountryCodeName | String | The customers country code name. | |
| CountryCodeEuMember | Boolean | Shows if the customer is Eu Member. | |
| MainAddress_1 | String | The customers main address line 1. | |
| MainAddress_2 | String | The customers main address line 2. | |
| MainAddress_3 | String | The customers main address line 3. | |
| MainAddress_4 | String | The customers main address line 4. | |
| MainAddressCity | String | The customers main address city. | |
| MainAddressCounty | String | The customers main address county. | |
| MainAddressPostcode | String | The customers main address postcode. | |
| Contacts | String | Customer contacts. See customer_contacts | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
This resource returns a view of related customers, sales invoice credits, sales invoice credit lines, invoice line profit analysis, products, and product groups that can be queried on any field. The default sort (orderby) fields are by 'sop_invoice_credit_id' and 'sop_invoice_credit_line_id' descending.
| Name | Type | References | Description |
| CustomerId | Long | The associated customer record Id. See customers. | |
| CustomerName | String | The associated customer name. | |
| CustomerReference | String | The associated customer account reference. | |
| InvoiceCreditId | Long | Sales invoice credit Id. | |
| InvoiceCreditType | String | Sales invoice credit type. | |
| InvoiceCreditDocumentNo | String | Sales invoice credit document number. | |
| InvoiceCreditDocumentDate | Datetime | Sales invoice document date time (UTC). | |
| InvoiceCreditDocumentStatus | String | Sales invoice document status. | |
| InvoiceCreditExchangeRate | Decimal | Exchange rate for the sales invoice credit. | |
| InvoiceCreditDateTimeUpdated | Datetime | The date and time the sales invoice credit was last updated (UTC). | |
| InvoiceCreditLineId | Long | The associated sales invoice credit line Id. | |
| InvoiceCreditLineDate | Datetime | The invoice credit line date time (UTC). | |
| InvoiceCreditLineTotalValue | Decimal | The total value of the sop invoice credit line. | |
| InvoiceCreditLineTaxValue | Decimal | The tax value of the sop invoice credit line. | |
| InvoiceCreditLineDateTimeUpdated | Datetime | The date and time the sop invoice credit line was last updated (UTC). | |
| InvoiceLineProfitAnalysisId | Long | The associated sales invoice credit line profit analysis Id. | |
| InvoiceLineProfitAnalysisLineQuantity | Decimal | The quantity of the associated sop invoice credit line. | |
| InvoiceLineProfitAnalysisRealisedCostValue | Decimal | The realised cost value. | |
| InvoiceLineProfitAnalysisRealisedProfitValue | Decimal | The realised profit value. | |
| InvoiceLineProfitAnalysisDateTimeUpdated | Datetime | The date and time the sop invoice credit line profit analysis was last updated (UTC). | |
| ProductId | Long | The associated product record Id. See products. | |
| ProductCode | String | The code of the product ordered. | |
| ProductName | String | The name of the product ordered. | |
| ProductDescription | String | The associated product description. | |
| ProductDateTimeUpdated | Datetime | The date and time the product was last updated (UTC). | |
| ProductGroupId | Long | The associated product group record Id. | |
| ProductGroupCode | String | The associated product group code. | |
| ProductGroupDescription | String | The associated product group description. | |
| ProductGroupDateTimeUpdated | Datetime | The date and time the product group was last updated (UTC). |
Departments are a subdivision of cost centres and are used where specific costs or revenue need to be collated and reported on separately. For example, a cost centre could be a sales area such as North East or South West and different departments could be Administration and Training.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Departments WHERE Id = 1016 SELECT * FROM Departments WHERE Code = 'abc' SELECT * FROM Departments WHERE Name = 'abc' SELECT * FROM Departments WHERE DateTimeUpdated = '2018-02-28T15:23:46.277+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Department record Id. | |
| Code | String | Department code. | |
| Name | String | Department name. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Financial statement layouts are designed to provide a clear representation of your accounts. This resource returns the details of all financial statement layouts. The default sort (orderby) field are by 'financial_report_layout_id' and 'financial_report_row_report_row' ascending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportLayoutId = 46151 SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportLayoutAccountReportType = 'ProfitLoss' SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportLayoutName = 'Sample Profit and Loss Layout' SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowId = 47221 SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowLineType = 'Text' SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowLayoutPositionType = 'Unknown' SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowLayoutDebitOrCreditType = 'Unknown' SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowReportRow = 1 SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowTitle = 'Sales' SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowSubtotalGroup = 1 SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowGroupBreak1 = 0 SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowGroupBreak2 = 0 SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowGroupBreak3 = 0 SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowGroupBreak4 = 0 SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowGroupBreak5 = 0 SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowGroupBreak6 = 0 SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowGroupBreak7 = 0 SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowGroupBreak8 = 0 SELECT * FROM FinancialReportLayoutViews WHERE FinancialReportRowGroupBreak9 = 0 SELECT * FROM FinancialReportLayoutViews WHERE NominalAccountReportCategoryId = 123 SELECT * FROM FinancialReportLayoutViews WHERE NominalAccountReportCategoryCode = 'abc' SELECT * FROM FinancialReportLayoutViews WHERE NominalAccountReportCategoryDescription = 'abc'
| Name | Type | References | Description |
| FinancialReportLayoutId [KEY] | Long | Financial report layout record Id. | |
| FinancialReportLayoutAccountReportType | String | The type of the financial layout. See financial_report_layout_types | |
| FinancialReportLayoutName | String | financial report layout name. | |
| FinancialReportRowId | Long | An asscoiated financial report row Id. | |
| FinancialReportRowLineType | String | The type of the financial layout. See financial_report_row_line_types | |
| FinancialReportRowLayoutPositionType | String | The type of the financial report row layout position. See financial_report_row_layout_position_types | |
| FinancialReportRowLayoutDebitOrCreditType | String | The type of the financial layout. See financial_report_row_layout_debit_or_credit_types | |
| FinancialReportRowReportRow | Int | Value to show the line number of the report row in the layout. | |
| FinancialReportRowTitle | String | The row title. | |
| FinancialReportRowSubtotalGroup | Int | Value to represent the sub total group. | |
| FinancialReportRowGroupBreak1 | Int | Value to represent the report row group break 1. | |
| FinancialReportRowGroupBreak2 | Int | Value to represent the report row group break 2. | |
| FinancialReportRowGroupBreak3 | Int | Value to represent the report row group break 3. | |
| FinancialReportRowGroupBreak4 | Int | Value to represent the report row group break 4. | |
| FinancialReportRowGroupBreak5 | Int | Value to represent the report row group break 5. | |
| FinancialReportRowGroupBreak6 | Int | Value to represent the report row group break 6. | |
| FinancialReportRowGroupBreak7 | Int | Value to represent the report row group break 7. | |
| FinancialReportRowGroupBreak8 | Int | Value to represent the report row group break 8. | |
| FinancialReportRowGroupBreak9 | Int | Value to represent the report row group break 9. | |
| NominalAccountReportCategoryId | Long | An Id specific to each nominal account report category. See nominal_report_category_types | |
| NominalAccountReportCategoryCode | String | The nominal account report category code. | |
| NominalAccountReportCategoryDescription | String | The nominal account report category description. |
This resource returns the details of all accounting periods for all financial years held for the company. A company always has five future financial years and can have unlimited previous years, depending on how long the company has been operating. The default sort (orderby) field are by 'financial_year_start_date' and 'period_number' ascending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM FinancialYearPeriodViews WHERE FinancialYearId = 1 SELECT * FROM FinancialYearPeriodViews WHERE FinancialYearStartDate = '2018-01-01T01:00:00.000+01:00' SELECT * FROM FinancialYearPeriodViews WHERE FinancialYearEndDate = '2018-12-31T01:00:00.000+01:00' SELECT * FROM FinancialYearPeriodViews WHERE YearRelativeToCurrentYear = 0 SELECT * FROM FinancialYearPeriodViews WHERE NumberOfPeriodsInYear = 12 SELECT * FROM FinancialYearPeriodViews WHERE AccountingPeriodId = 1 SELECT * FROM FinancialYearPeriodViews WHERE PeriodNumber = 1 SELECT * FROM FinancialYearPeriodViews WHERE PeriodStartDate = '2018-01-01T01:00:00.000+01:00' SELECT * FROM FinancialYearPeriodViews WHERE PeriodEndDate = '2018-01-31T01:00:00.000+01:00'
| Name | Type | References | Description |
| FinancialYearId [KEY] | Long | An Id specific to each financial year. | |
| FinancialYearStartDate | Date | Date the financial year starts. The returned string includes the time but this will always be 00:00:00. | |
| FinancialYearEndDate | Date | Date the financial year ends. The returned string includes the time but this will always be 00:00:00. | |
| YearRelativeToCurrentYear | Int | Value to represent the year relative to the current financial year. The current financial year is 0. The first previous year is -1. The first future year is 1. | |
| NumberOfPeriodsInYear | Int | The number of periods in the financial year. | |
| AccountingPeriodId | Long | An Id specific to each accounting period. | |
| PeriodNumber | Int | Value to show the period in relation to the associated year. For example, for a year that starts in January, January will be period 1, February period 2 etc. | |
| PeriodStartDate | Date | Date the period starts. The returned string includes the time but this will always be 00:00:00. | |
| PeriodEndDate | Date | Date the period finished. The returned string includes the time but this will always be 00:00:00. |
Nominal accounts are fundamental to the successful management of company finances. The value of every transaction entered into Sage 200 is posted to a nominal account and, is where the revenue and expenditure of the business is recorded. Nominal accounts include a code, and cost centre and a department.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM NominalCodes WHERE Id = 2317 SELECT * FROM NominalCodes WHERE Name = 'Freehold Property' SELECT * FROM NominalCodes WHERE Reference = '0010' SELECT * FROM NominalCodes WHERE CostCentreId = 1015 SELECT * FROM NominalCodes WHERE CostCentreCode = 'abc' SELECT * FROM NominalCodes WHERE DepartmentId = 1016 SELECT * FROM NominalCodes WHERE DepartmentCode = 'abc' SELECT * FROM NominalCodes WHERE NominalAccountType = 'NominalAccountTypePosting' SELECT * FROM NominalCodes WHERE AccountStatusType = 'AccountStatusActive' SELECT * FROM NominalCodes WHERE ReportCategoryId = 2289 SELECT * FROM NominalCodes WHERE DisplayBalancesInSelectionList = false SELECT * FROM NominalCodes WHERE BalanceYearToDate = 123.3 SELECT * FROM NominalCodes WHERE DateTimeUpdated = '2018-02-28T15:23:46.717+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Nominal code record Id. | |
| Name | String | Nominal code name. | |
| Reference | String | Nominal code reference. | |
| CostCentreId | Long |
CostCentres.Id | Nominal code cost centre record Id. See cost_centres |
| CostCentreCode | String | Cost centre code. | |
| DepartmentId | Long |
Departments.Id | Nominal code department record Id. See departments |
| DepartmentCode | String | Department code. | |
| NominalAccountType | String | The type of the nominal code. See nominal_account_types | |
| AccountStatusType | String | The status of the nominal code (Sage 200c Standard and versions of Professional released after February 2018). For example, this can either be 'Active' or 'Hidden'. See account_status_types | |
| ReportCategoryId | Long | Financial report category record Id. See nominal_report_categories | |
| DisplayBalancesInSelectionList | Bool | Whether balances for the nominal code can be shown in selection lists. | |
| BalanceYearToDate | Decimal | The nominal account balance, if balances can be shown for the nominal account. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Nominal report categories are used in financial statements (PL, Balance Sheet) to group nominal codes under headings and to determine whether the nominal code value is reported on the layout for the Balance Sheet (Asset and Liability) or Profit and Loss (Income and Expense).
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM NominalReportCategories WHERE Id = 2258 SELECT * FROM NominalReportCategories WHERE AccountReportType = 'ProfitLoss' SELECT * FROM NominalReportCategories WHERE Code = '1' SELECT * FROM NominalReportCategories WHERE Description = 'Sales' SELECT * FROM NominalReportCategories WHERE AccountReportCategoryType = 'NominalReportingCategoryTypeIncome' SELECT * FROM NominalReportCategories WHERE DateTimeUpdated = '2018-02-28T15:23:45.960+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Nominal report category record Id. | |
| AccountReportType | String | The type of the report.. See financial_report_layout_types | |
| Code | String | Nominal report category code. | |
| Description | String | Nominal report category description. | |
| AccountReportCategoryType | String | The type of the report category. See nominal_report_category_types | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Nominal transaction analysis codes are used to group nominal analysis items on various transaction types
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM NominalTransactionAnalysisCodes WHERE Code = 'Promo0715' SELECT * FROM NominalTransactionAnalysisCodes WHERE Description = 'Promotion July 2015' SELECT * FROM NominalTransactionAnalysisCodes WHERE Active = true SELECT * FROM NominalTransactionAnalysisCodes WHERE DateTimeUpdated = '2018-02-28T15:23:46.413+01:00'
| Name | Type | References | Description |
| Code [KEY] | String | Nominal transaction analysis code. | |
| Description | String | Nominal transaction analysis code description. | |
| Active | Bool | Boolean indicating whether the transaction analysis code is active. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
When working with Microsoft Flow, it is useful to be able to access pending emails to send as notifications to the user from Sage 200.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM PendingEmails WHERE Id = 123 SELECT * FROM PendingEmails WHERE EmailType = 'abc' SELECT * FROM PendingEmails WHERE EmailAddress = 'abc' SELECT * FROM PendingEmails WHERE EmailSubject = 'abc' SELECT * FROM PendingEmails WHERE EmailBody = 'abc' SELECT * FROM PendingEmails WHERE UserNumber = 123 SELECT * FROM PendingEmails WHERE UserName = 'abc' SELECT * FROM PendingEmails WHERE DateTimeUpdated = '2019-10-02T11:46:53Z'
| Name | Type | References | Description |
| Id [KEY] | Long | The unique id of the Sage 200 pending email identifier. | |
| EmailType | String | The type of pending email (which provides the intended purpose). | |
| EmailAddress | String | The email address of the email recipient. | |
| EmailSubject | String | The text to use for the subject of the email. | |
| EmailBody | String | The text to use for the body of the email. | |
| UserNumber | Long | The user id of the email recipient. | |
| UserName | String | The user name of the email recipient. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
A price band is simply a price list. They're used to offer different prices to different customers. Product prices are set in the each price band. The price a customer receives for a product depends on the price band their account is linked to.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM PriceBands WHERE Id = 1064 SELECT * FROM PriceBands WHERE Name = 'Standard' SELECT * FROM PriceBands WHERE Description = 'Standard' SELECT * FROM PriceBands WHERE IsStandardBand = true SELECT * FROM PriceBands WHERE CurrencyId = 2103 SELECT * FROM PriceBands WHERE PriceBandTypeId = 0 SELECT * FROM PriceBands WHERE IsActive = true SELECT * FROM PriceBands WHERE IsTimeBased = false SELECT * FROM PriceBands WHERE ActiveDateTimeFrom = '2019-10-02T11:46:53Z' SELECT * FROM PriceBands WHERE ActiveDateTimeTo = '2019-10-02T11:46:53Z' SELECT * FROM PriceBands WHERE DateTimeUpdated = '2018-02-28T15:23:46.183+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Price band record Id. | |
| Name | String | Price band name. | |
| Description | String | Price band description. | |
| IsStandardBand | Bool | Is this the Standard price band. | |
| CurrencyId | Long | Currency record Id. See currencies | |
| PriceBandTypeId | Long | Price band type record Id; this will be 0 for Universal price bands and 1 for Limited price bands. | |
| IsActive | Bool | Is this price band active. | |
| IsTimeBased | Bool | Is this price band time based. | |
| ActiveDateTimeFrom | Datetime | The date and time this price band is active from. | |
| ActiveDateTimeTo | Datetime | The date and time this price band is active to. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Product groups are used to group stock items together with similar characteristics or requirements. Product Groups provide several default settings for stock items and, have their own unique code and description.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM ProductGroups WHERE Id = 34632 SELECT * FROM ProductGroups WHERE Code = 'NONS' SELECT * FROM ProductGroups WHERE Description = 'Non Stock Item' SELECT * FROM ProductGroups WHERE ProductType = 'EnumStockItemTypeMisc' SELECT * FROM ProductGroups WHERE CanLevelsGoNegative = false SELECT * FROM ProductGroups WHERE DateTimeUpdated = '2018-02-28T15:23:46.310+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Product group Id. | |
| Code | String | Product group code. | |
| Description | String | Product group description. | |
| ProductType | String | Product group type. See product_types | |
| CanLevelsGoNegative | Bool | Can stock levels go negative. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
This returns the selling prices of your products. A price is returned for each price band associated with a product. A price band is simply a price list. The price a customer receives for a product depends on the price band their account is linked to. The 'Standard' price band is the default. The prices returned here do not include any customer specific discounts. The default sort (orderby) field is by 'product_code' ascending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM ProductPriceViews WHERE ProductPriceId = 34760 SELECT * FROM ProductPriceViews WHERE ProductId = 34751 SELECT * FROM ProductPriceViews WHERE ProductCode = 'BOARD001' SELECT * FROM ProductPriceViews WHERE ProductName = 'Whiteboard - Drywipe (900 x 1200)' SELECT * FROM ProductPriceViews WHERE ProductStockUnitName = 'Each' SELECT * FROM ProductPriceViews WHERE PriceBandId = 1064 SELECT * FROM ProductPriceViews WHERE PriceBandName = 'Standard' SELECT * FROM ProductPriceViews WHERE ProductPriceUseStandard = true SELECT * FROM ProductPriceViews WHERE ProductPricePrice = 20 SELECT * FROM ProductPriceViews WHERE CurrencyId = 2103 SELECT * FROM ProductPriceViews WHERE CurrencyName = 'Pound Sterling' SELECT * FROM ProductPriceViews WHERE CurrencySymbol = '£' SELECT * FROM ProductPriceViews WHERE DateTimeUpdated = '2018-02-28T15:23:46.787+01:00'
| Name | Type | References | Description |
| ProductPriceId | Long | Product price record Id. | |
| ProductId | Long | Product record Id. See products | |
| ProductCode [KEY] | String | Product code. | |
| ProductName | String | Product name. | |
| ProductStockUnitName | String | The name of the unit the product is sold in. For example box, crate, bottle. The default unit is each. | |
| PriceBandId | Long | Price band record Id. | |
| PriceBandName | String | The name of the price band. | |
| ProductPriceUseStandard | Bool | 'True' if uses the price from the standard price band is used otherwise 'False' The price of a product can be linked to the price set in the standard price band. This is used when only some product prices are different to the standard price. | |
| ProductPricePrice | Decimal | The selling price for the shown product and price band. | |
| CurrencyId | Long | Currency record Id. See currencies | |
| CurrencyName | String | The name of the currency used for the price. | |
| CurrencySymbol | String | The symbol of the currency used for the price. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Products are used to track stock within Sage 200. This is not just for physical items, but also for items that are ordered direct from suppliers, services, and time or labour that can be included on customer invoices.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: WarehouseHoldings columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Products WHERE Id = 34737 SELECT * FROM Products WHERE Code = 'M' SELECT * FROM Products WHERE Name = 'M' SELECT * FROM Products WHERE Description = 'abc' SELECT * FROM Products WHERE Barcode = 'abc' SELECT * FROM Products WHERE AllowSalesOrder = true SELECT * FROM Products WHERE ProductGroupId = 34633 SELECT * FROM Products WHERE TaxCodeId = 1731 SELECT * FROM Products WHERE DateTimeUpdated = '2019-08-01T18:00:33.140+02:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Product record Id. | |
| Code | String | Product code. | |
| Name | String | Product name. | |
| Description | String | Product description. | |
| Barcode | String | Product barcode. | |
| AllowSalesOrder | Bool | Allowed on a sales order. | |
| ProductGroupId | Long | Product group record Id. See product_groups | |
| TaxCodeId | Long | Tax code record Id. See tax_codes | |
| WarehouseHoldings | String | If stock setting UseMultipleLocations is true, you must specify warehouse holding(s) when creating products. If stock setting UseMultipleLocations is false, then new product will be automatically linked to the default (home) warehouse. See warehouse_holdings | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
A product transaction is created each time a product is moved in, or out of stock. Product transactions are created from various sources such as purchase orders, sales orders, transfers between warehouses etc.. This resource returns the details of product transactions. The default sort (orderby) field is by 'id' descending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM ProductTransactionViews WHERE Id = 36511 SELECT * FROM ProductTransactionViews WHERE ProductId = 34751 SELECT * FROM ProductTransactionViews WHERE ProductCode = 'BOARD001' SELECT * FROM ProductTransactionViews WHERE ProductGroupId = 34640 SELECT * FROM ProductTransactionViews WHERE ProductGroupCode = '0006' SELECT * FROM ProductTransactionViews WHERE TransactionType = 'EnumSecondaryActivityTypeStockTakeAdjustmentIn' SELECT * FROM ProductTransactionViews WHERE TransactionDate = '2015-12-31T01:00:00.000+01:00' SELECT * FROM ProductTransactionViews WHERE SourceAreaReference = 'abc' SELECT * FROM ProductTransactionViews WHERE SourceAreaName = 'Internal' SELECT * FROM ProductTransactionViews WHERE Reference = 'abc' SELECT * FROM ProductTransactionViews WHERE SecondReference = 'STK TAKE' SELECT * FROM ProductTransactionViews WHERE WarehouseName = 'Warehouse' SELECT * FROM ProductTransactionViews WHERE BinName = 'Unspecified' SELECT * FROM ProductTransactionViews WHERE Quantity = 2 SELECT * FROM ProductTransactionViews WHERE UnitCostPrice = 15 SELECT * FROM ProductTransactionViews WHERE UnitIssuePrice = 0 SELECT * FROM ProductTransactionViews WHERE UnitDiscountValue = 0 SELECT * FROM ProductTransactionViews WHERE TotalOrderDiscount = 0 SELECT * FROM ProductTransactionViews WHERE CostValue = 30 SELECT * FROM ProductTransactionViews WHERE IssueValue = 0 SELECT * FROM ProductTransactionViews WHERE Memo = 'abc' SELECT * FROM ProductTransactionViews WHERE UserName = 'Migration' SELECT * FROM ProductTransactionViews WHERE AnalysisCode1 = 'abc' SELECT * FROM ProductTransactionViews WHERE AnalysisCode2 = 'abc' SELECT * FROM ProductTransactionViews WHERE AnalysisCode3 = 'abc' SELECT * FROM ProductTransactionViews WHERE AnalysisCode4 = 'abc' SELECT * FROM ProductTransactionViews WHERE AnalysisCode5 = 'abc' SELECT * FROM ProductTransactionViews WHERE DateTimeUpdated = '2018-02-28T15:23:46.123+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Product transaction Id. | |
| ProductId | Long | Product record Id. See products | |
| ProductCode | String | Product code. | |
| ProductGroupId | Long | Product group record Id. See product_groups | |
| ProductGroupCode | String | Product group code. See product_groups | |
| TransactionType | String | Enum value that describes the transaction that created the product movement. See product_transaction_types | |
| TransactionDate | Date | The date of the transaction. | |
| SourceAreaReference | String | The code of the source of the transaction. | |
| SourceAreaName | String | The name of the source of the transaction. | |
| Reference | String | This can be an optional reference added to the transaction by the user, or an automatically generated reference such as the order number. | |
| SecondReference | String | This can be an additional optional reference added to the transaction by the user, or an automatically generated reference such as the despatch note number. | |
| WarehouseName | String | The warehouse the product was moved from or to. See warehouses | |
| BinName | String | The name of the bin to which the transaction relates to. | |
| Quantity | Decimal | The quantity on the transaction. | |
| UnitCostPrice | Decimal | The cost price per unit for this transaction. | |
| UnitIssuePrice | Decimal | The price used when products are moved out of stock. | |
| UnitDiscountValue | Decimal | The discount amount per unit used for this transaction. | |
| TotalOrderDiscount | Decimal | The total discount value of the transaction. | |
| CostValue | Decimal | The total cost value. | |
| IssueValue | Decimal | The total issue or sales price of the transaction. | |
| Memo | String | Any memo note that was applied to the product transaction. | |
| UserName | String | The name of the Sage 200 user that created the transaction. | |
| AnalysisCode1 | String | Analysis Code 1. | |
| AnalysisCode2 | String | Analysis Code 2. | |
| AnalysisCode3 | String | Analysis Code 3. | |
| AnalysisCode4 | String | Analysis Code 4. | |
| AnalysisCode5 | String | Analysis Code 5. | |
| AnalysisCode6 | String | Analysis code 6. | |
| AnalysisCode7 | String | Analysis code 7. | |
| AnalysisCode8 | String | Analysis code 8. | |
| AnalysisCode9 | String | Analysis code 9. | |
| AnalysisCode10 | String | Analysis code 10. | |
| AnalysisCode11 | String | Analysis code 11. | |
| AnalysisCode12 | String | Analysis code 12. | |
| AnalysisCode13 | String | Analysis code 13. | |
| AnalysisCode14 | String | Analysis code 14. | |
| AnalysisCode15 | String | Analysis code 15. | |
| AnalysisCode16 | String | Analysis code 16. | |
| AnalysisCode17 | String | Analysis code 17. | |
| AnalysisCode18 | String | Analysis code 18. | |
| AnalysisCode19 | String | Analysis code 19. | |
| AnalysisCode20 | String | Analysis code 20. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
When making larger requests for purchase order information, the Purchase Order Line Views resource is a faster alternative to the 'Purchase Orders' resource.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM PurchaseOrderLines WHERE PurchaseOrderId = 42101 SELECT * FROM PurchaseOrderLines WHERE CurrencyId = '0000000001'
| Name | Type | References | Description |
| PurchaseOrderId [KEY] | Long | Unique ID of the purchase order. See _orders | |
| SupplierDocumentNo | String | Supplier purchase order document number. | |
| CurrencyId | Long | The Id for the currency used for the purchase order. See currencies | |
| CurrencyName | String | The name for the currency used for the purchase order. | |
| CurrencySymbol | String | The symbol of the currency used for the purchase order. | |
| SubtotalValue | Decimal | The subtotal value for the order. | |
| SubtotalDiscountValue | Decimal | The subtotal discount value for the order. | |
| SubtotalLandedCostsValue | Decimal | The subtotal landed costs value for the order. | |
| LineId | Long | Associated purchase order line Id. See _order_lines | |
| LineNumber | Short | Purchase order line number. | |
| LineType | String | Purchase order line type. See order_return_line_types | |
| LineProductCode | String | Purchase order line product code. | |
| LineProductDescription | String | Purchase order line product description. This could be stock item description, free text, additional charge or comment. | |
| LineQuantity | Decimal | The quantity ordered. | |
| LineUnitPrice | Decimal | The buying price per item. | |
| LineUnitDiscountPercent | Decimal | The percentage discount per item. | |
| LineUnitDiscountValue | Decimal | The discount value per item. | |
| LineTotalValue | Decimal | The total value of the line. | |
| LineDiscountedUnitPrice | Decimal | The discounted unit price of the line. This is calculated by subtracting the _order_line_unit_discount_value from the _order_line_unit_price. | |
| LineLandedCostsValue | Decimal | The value of landed costs for the order. | |
| LineAnalysisCode1 | String | Analysis code 1. | |
| LineAnalysisCode2 | String | Analysis code 2. | |
| LineAnalysisCode3 | String | Analysis code 3. | |
| LineAnalysisCode4 | String | Analysis code 4. | |
| LineAnalysisCode5 | String | Analysis code 5. | |
| LineAnalysisCode6 | String | Analysis code 6. | |
| LineAnalysisCode7 | String | Analysis code 7. | |
| LineAnalysisCode8 | String | Analysis code 8. | |
| LineAnalysisCode9 | String | Analysis code 9. | |
| LineAnalysisCode10 | String | Analysis code 10. | |
| LineAnalysisCode11 | String | Analysis code 11. | |
| LineAnalysisCode12 | String | Analysis code 12. | |
| LineAnalysisCode13 | String | Analysis code 13. | |
| LineAnalysisCode14 | String | Analysis code 14. | |
| LineAnalysisCode15 | String | Analysis code 15. | |
| LineAnalysisCode16 | String | Analysis code 16. | |
| LineAnalysisCode17 | String | Analysis code 17. | |
| LineAnalysisCode18 | String | Analysis code 18. | |
| LineAnalysisCode19 | String | Analysis code 19. | |
| LineAnalysisCode20 | String | Analysis code 20. | |
| LineDateTimeUpdated | Datetime | The date and time the order line was last updated (UTC). | |
| LineForDirectDelivery | Bool | Indicates if line is marked for direct delivery | |
| LineShowOnSupplierDocs | Bool | Indicates if line will show on supplier documents. | |
| DeliveryAddrPostalName | String | delivery address name. | |
| DeliveryAddrDescription | String | delivery address description. | |
| DeliveryAddrAddress1 | String | delivery address line 1. | |
| DeliveryAddrAddress2 | String | delivery address line 2. | |
| DeliveryAddrAddress3 | String | delivery address line 3. | |
| DeliveryAddrAddress4 | String | delivery address line 4. | |
| DeliveryAddrCity | String | delivery address city. | |
| DeliveryAddrCounty | String | delivery address county. | |
| DeliveryAddrPostCode | String | delivery address post code | |
| DeliveryAddrCountry | String | delivery address country. | |
| DeliveryAddrContact | String | delivery address contact | |
| DeliveryAddrTelephone | String | delivery address telephone number | |
| DeliveryAddrFax | String | delivery address line fax number... | |
| DeliveryAddrEmail | String | delivery address line email. | |
| SupplierId | Long | The associated supplier record Id. See suppliers | |
| SupplierReference | String | The associated supplier account reference. | |
| SupplierName | String | The associated supplier name. | |
| ProductId | Long | The associated product record Id. Only returned where _order_line_type = EnumLineTypeStandard. See products | |
| ProductCode | String | The code of the product ordered. Only returned where _order_line_type = EnumLineTypeStandard | |
| ProductName | String | The name of the product ordered. Only returned where _order_line_type = EnumLineTypeStandard | |
| ProductDescription | String | The associated product description. Only returned where _order_line_type = EnumLineTypeStandard | |
| WarehouseId | Long | The id of the warehouse the product is stored in. Only returned where _order_line_type = EnumLineTypeStandard. See warehouses | |
| WarehouseName | String | The name of the warehouse. Only returned where _order_line_type = EnumLineTypeStandard | |
| TaxCodeId | Long | The id of the tax code set on the line. See tax_codes | |
| TaxCodeCode | Short | The associated tax code. | |
| TaxCodeName | String | The associated tax code name. | |
| TaxCodeRate | Decimal | The associated tax rate. |
Purchase orders are used to represent the purchase of goods or services from a supplier. They are central to a business and define the terms (price, quantity and times) by which the products or services will be received.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM PurchaseOrders WHERE Id = 42101 SELECT * FROM PurchaseOrders WHERE DocumentNo = '0000000001' SELECT * FROM PurchaseOrders WHERE ExchangeRate = 'Sample'
| Name | Type | References | Description |
| Id [KEY] | Long | Purchase order record Id. | |
| DocumentNo | String | Purchase order document number. Note: If the POP setting in Sage 200c Professional, then this property MUST be set. | |
| DocumentDate | Date | Purchase order document date. | |
| DocumentStatus | String | Document status. See pop_document_status_types | |
| AuthorisationStatus | String | Authorisation status. See pop_authorisation_status_types | |
| SupplierId | Long |
Suppliers.Id | Supplier record Id. See suppliers |
| ExchangeRate | Decimal | Exchange rate. | |
| SubtotalGoodsValue | Decimal | Goods value (sum of stock items and free text). | |
| SubtotalChargesNetValue | Decimal | Charges net value. | |
| SubtotalDiscountValue | Decimal | Discount value. | |
| SubtotalLandedCostsValue | Decimal | Landed costs value. | |
| TotalNetValue | Decimal | Net value (sum of all line types). | |
| TotalTaxValue | Decimal | Tax value. | |
| TotalGrossValue | Decimal | Gross value. | |
| SupplierDocumentNo | String | Supplier document number. | |
| SettlementDiscountDays | Short | Settlement discount days. | |
| SettlementDiscountPercent | Decimal | Settlement discount percent. | |
| DocumentDiscountPercent | Decimal | Document discount percent. | |
| DocumentOriginatorId | Long | Document originator id. See users | |
| DocumentOriginatorName | String | Document originator name. | |
| DocumentCreatedById | Long | Document created by id. See users | |
| DocumentCreatedBy | String | Document created by. | |
| RequestedDeliveryDate | Date | Requested delivery date. | |
| AnalysisCode1 | String | Analysis code 1. | |
| AnalysisCode2 | String | Analysis code 2. | |
| AnalysisCode3 | String | Analysis code 3. | |
| AnalysisCode4 | String | Analysis code 4. | |
| AnalysisCode5 | String | Analysis code 5. | |
| AnalysisCode6 | String | Analysis code 6. | |
| AnalysisCode7 | String | Analysis code 7. | |
| AnalysisCode8 | String | Analysis code 8. | |
| AnalysisCode9 | String | Analysis code 9. | |
| AnalysisCode10 | String | Analysis code 10. | |
| AnalysisCode11 | String | Analysis code 11. | |
| AnalysisCode12 | String | Analysis code 12. | |
| AnalysisCode13 | String | Analysis code 13. | |
| AnalysisCode14 | String | Analysis code 14. | |
| AnalysisCode15 | String | Analysis code 15. | |
| AnalysisCode16 | String | Analysis code 16. | |
| AnalysisCode17 | String | Analysis code 17. | |
| AnalysisCode18 | String | Analysis code 18. | |
| AnalysisCode19 | String | Analysis code 19. | |
| AnalysisCode20 | String | Analysis code 20. | |
| Lines | String | The purchase order lines collection. See pop_order_lines | |
| DeliveryAddress_1 | String | The delivery address line 1. | |
| DeliveryAddress_2 | String | The delivery address line 2. | |
| DeliveryAddress_3 | String | The delivery address line 3. | |
| DeliveryAddress_4 | String | The delivery address line 4. | |
| DeliveryAddressCity | String | The delivery address city. | |
| DeliveryAddressCounty | String | The delivery address county. | |
| DeliveryAddressPostcode | String | The delivery address postcode. | |
| DeliveryAddressContact | String | The delivery address contact. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Purchase posted transactions are created when transactions, such as purchases made, refunds or credit notes, are posted against the Purchase Ledger. It is not possible to use this API resource to create posted transactions.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: NominalAnalysisItems,TaxAnalysisItems,BankItems,AllocationSessionItems,AllocationHistoryItems columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM PurchasePostedTransactions WHERE Id = 33018 SELECT * FROM PurchasePostedTransactions WHERE SupplierId = 28936 SELECT * FROM PurchasePostedTransactions WHERE TraderTransactionType = 'TradingAccountEntryTypeInvoice' SELECT * FROM PurchasePostedTransactions WHERE Reference = 'O/BAL' SELECT * FROM PurchasePostedTransactions WHERE SecondReference = 'Opening Balance' SELECT * FROM PurchasePostedTransactions WHERE Queried = 'abc' SELECT * FROM PurchasePostedTransactions WHERE TransactionDate = '2017-12-31T01:00:00.000+01:00' SELECT * FROM PurchasePostedTransactions WHERE PostedDate = '2018-09-13T02:00:00.000+02:00' SELECT * FROM PurchasePostedTransactions WHERE DueDate = '2024-01-30T01:00:00.000+01:00' SELECT * FROM PurchasePostedTransactions WHERE DocumentGoodsValue = 55 SELECT * FROM PurchasePostedTransactions WHERE DocumentGrossValue = 55 SELECT * FROM PurchasePostedTransactions WHERE DocumentTaxValue = 0 SELECT * FROM PurchasePostedTransactions WHERE DocumentDiscountValue = 0 SELECT * FROM PurchasePostedTransactions WHERE DiscountPercent = 0 SELECT * FROM PurchasePostedTransactions WHERE DocumentTaxDiscountValue = 0 SELECT * FROM PurchasePostedTransactions WHERE DocumentAllocatedValue = 55 SELECT * FROM PurchasePostedTransactions WHERE DocumentOutstandingValue = 0 SELECT * FROM PurchasePostedTransactions WHERE BaseGoodsValue = 55 SELECT * FROM PurchasePostedTransactions WHERE BaseGrossValue = 55 SELECT * FROM PurchasePostedTransactions WHERE BaseTaxValue = 0 SELECT * FROM PurchasePostedTransactions WHERE BaseDiscountValue = 0 SELECT * FROM PurchasePostedTransactions WHERE BaseTaxDiscountValue = 0 SELECT * FROM PurchasePostedTransactions WHERE BaseAllocatedValue = 55 SELECT * FROM PurchasePostedTransactions WHERE ControlValueInBaseCurrency = 0 SELECT * FROM PurchasePostedTransactions WHERE ExchangeRate = 1 SELECT * FROM PurchasePostedTransactions WHERE SettledImmediately = false SELECT * FROM PurchasePostedTransactions WHERE VatAdjustmentDocExpected = false SELECT * FROM PurchasePostedTransactions WHERE DiscountDays = 0 SELECT * FROM PurchasePostedTransactions WHERE Urn = 11 SELECT * FROM PurchasePostedTransactions WHERE UserName = 'Migration' SELECT * FROM PurchasePostedTransactions WHERE DateTimeUpdated = '2018-02-28T15:23:46.137+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Id. | |
| SupplierId | Long | Supplier Id. See customers | |
| TraderTransactionType | String | Transaction type. See trader_transaction_types | |
| Reference | String | Transaction reference. | |
| SecondReference | String | Second reference. | |
| Queried | String | Query flag. | |
| TransactionDate | Date | Transaction date. | |
| PostedDate | Date | Posted date. | |
| DueDate | Date | Due date. | |
| DocumentGoodsValue | Decimal | Value of the goods. | |
| DocumentGrossValue | Decimal | Gross value. | |
| DocumentTaxValue | Decimal | Tax value. | |
| DocumentDiscountValue | Decimal | Tax discount value. | |
| DiscountPercent | Decimal | Percentage discount. | |
| DocumentTaxDiscountValue | Decimal | Tax discount value. | |
| DocumentAllocatedValue | Decimal | Allocated value. | |
| DocumentOutstandingValue | Decimal | Outstanding value. | |
| BaseGoodsValue | Decimal | Value of the goods in base currency. | |
| BaseGrossValue | Decimal | Gross value in base currency. | |
| BaseTaxValue | Decimal | Tax value in base currency. | |
| BaseDiscountValue | Decimal | Discount value in base currency. | |
| BaseTaxDiscountValue | Decimal | Tax discount value in base currency. | |
| BaseAllocatedValue | Decimal | Allocated value in base currency. | |
| ControlValueInBaseCurrency | Decimal | Control value in base currency. | |
| ExchangeRate | Decimal | Exchange rate used for transaction. | |
| SettledImmediately | Bool | Immediately settled | |
| VatAdjustmentDocExpected | Bool | Whether a VAT adjustment is expected. | |
| DiscountDays | Short | Number of days discount valid. | |
| Urn | Long | Unique reference number. | |
| UserName | String | User who entered the transaction. | |
| NominalAnalysisItems | String | Nominal analysis items. See purchase_posted_transactions_nominal_analysis_items | |
| TaxAnalysisItems | String | Tax analysis items. See purchase_posted_transactions_tax_analysis_items | |
| BankItems | String | Bank items. See purchase_posted_transactions_bank_items | |
| AllocationSessionItems | String | Allocation session items. See purchase_posted_transactions_allocation_session_items | |
| AllocationHistoryItems | String | Allocation history items. See purchase_posted_transactions_allocation_history_items | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Sales historical transactions are created when transactions are archived from the Sales Ledger. It is not possible to use this API resource to create historical transactions.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: NominalAnalysisItems,TaxAnalysisItems,BankItems columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesHistoricalTransactions WHERE Id = 123 SELECT * FROM SalesHistoricalTransactions WHERE CustomerId = 123 SELECT * FROM SalesHistoricalTransactions WHERE TraderTransactionType = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE Reference = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE SecondReference = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE Queried = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE TransactionDate = '2019-10-02T11:46:53Z' SELECT * FROM SalesHistoricalTransactions WHERE PostedDate = '2019-10-02T11:46:53Z' SELECT * FROM SalesHistoricalTransactions WHERE DueDate = '2019-10-02T11:46:53Z' SELECT * FROM SalesHistoricalTransactions WHERE FullSettlementDate = '2019-10-02T11:46:53Z' SELECT * FROM SalesHistoricalTransactions WHERE DocumentGoodsValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DocumentGrossValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DocumentTaxValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DocumentDiscountValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DiscountPercent = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DocumentTaxDiscountValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DocumentAllocatedValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE DocumentOutstandingValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE BaseGoodsValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE BaseGrossValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE BaseTaxValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE BaseDiscountValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE BaseTaxDiscountValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE BaseAllocatedValue = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE ControlValueInBaseCurrency = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE ExchangeRate = 123.3 SELECT * FROM SalesHistoricalTransactions WHERE SettledImmediately = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE DiscountDays = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE Urn = 123 SELECT * FROM SalesHistoricalTransactions WHERE UserName = 'abc' SELECT * FROM SalesHistoricalTransactions WHERE DateTimeUpdated = '2019-10-02T11:46:53Z'
| Name | Type | References | Description |
| Id [KEY] | Long | Id. | |
| CustomerId | Long | Customer Id. See customers | |
| TraderTransactionType | String | Transaction type. See trader_transaction_types | |
| Reference | String | Transaction reference. | |
| SecondReference | String | Second reference. | |
| Queried | String | Query flag. | |
| TransactionDate | Date | Transaction date. | |
| PostedDate | Date | Posted date. | |
| DueDate | Date | Due date. | |
| FullSettlementDate | Date | Full settlement date. | |
| DocumentGoodsValue | Decimal | Value of the goods. | |
| DocumentGrossValue | Decimal | Gross value. | |
| DocumentTaxValue | Decimal | Tax value. | |
| DocumentDiscountValue | Decimal | Document discount value. | |
| DiscountPercent | Decimal | Percentage discount. | |
| DocumentTaxDiscountValue | Decimal | Tax discount value. | |
| DocumentAllocatedValue | Decimal | Allocated value. | |
| DocumentOutstandingValue | Decimal | Outstanding value. | |
| BaseGoodsValue | Decimal | Value of the goods in base currency. | |
| BaseGrossValue | Decimal | Gross value in base currency. | |
| BaseTaxValue | Decimal | Tax value in base currency. | |
| BaseDiscountValue | Decimal | Discount value in base currency. | |
| BaseTaxDiscountValue | Decimal | Tax discount value in base currency. | |
| BaseAllocatedValue | Decimal | Allocated value in base currency. | |
| ControlValueInBaseCurrency | Decimal | Control value in base currency. | |
| ExchangeRate | Decimal | Exchange rate used for transaction. | |
| SettledImmediately | Bool | Immediately settled. | |
| DiscountDays | Short | Number of days discount valid. | |
| Urn | Long | Unique reference number. | |
| UserName | String | User who entered the transaction. | |
| NominalAnalysisItems | String | Nominal analysis items. See sales_historical_transactions_nominal_analysis_items | |
| TaxAnalysisItems | String | Tax analysis items. See sales_historical_transactions_tax_analysis_items | |
| BankItems | String | Bank items. See sales_historical_transactions_bank_items | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Additional charges can be added to sales orders to account for items such as carriage and insurance. Within the Sage 200 application, users can setup and maintain the list of additional charges that can be referenced when creating a sales order. This API resource can be used to determine what each additional charge is for.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesOrderAdditionalCharges WHERE Id = 42101 SELECT * FROM SalesOrderAdditionalCharges WHERE Code = '0000000001' SELECT * FROM SalesOrderAdditionalCharges WHERE Name = 'Sample'
| Name | Type | References | Description |
| Id [KEY] | Long | Sop additional charge record Id. | |
| Code | String | Sop additional charge code. | |
| Name | String | Sop additional charge name. | |
| ChargeValue | Decimal | Sop additional charge value. | |
| NotionalCostValue | Decimal | Sop additional charge notional cost value. | |
| NominalCodeId | Long |
NominalCodes.Id | Nominal code record Id. See nominal_codes |
| TaxCodeId | Long |
TaxCodes.Id | Tax code record Id. See tax_codes |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
When making larger requests for sales order information, the Sales Order Line Views resource is a faster alternative to the 'Sales Orders' resource. The Sales Order Line Views resource returns more information than the 'Sales Orders' resource, and therefore reduces the number of API requests required to return the same information from multiple resources. This resource returns a view of sales orders, sales order lines, customers, products, warehouses, tax codes and currencies that can be queried on any field. The default sort (orderby) field are by 'sop_order_id' and 'sop_order_line_id' descending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesOrderLines WHERE SalesOrderId = 42101 SELECT * FROM SalesOrderLines WHERE CurrencyId = 2343234543 SELECT * FROM SalesOrderLines WHERE CurrencyName = 'Sample'
| Name | Type | References | Description |
| SalesOrderId [KEY] | Long | Unique Id of the sales order. See sop_orders | |
| CustomerDocumentNo | String | Customer sales order document number. | |
| CurrencyId | Long | The Id for the currency used for the sales order. See currencies | |
| CurrencyName | String | The name for the currency used for the sales order. | |
| CurrencySymbol | String | The symbol of the currency used for the sales order. | |
| DocumentDiscountPercent | Decimal | Document discount percent value, between -99.99 and 99.99. A negative value is treated as a surcharge (e.g. -10 is a 10% surcharge), and a positive value is treated as a discount. | |
| DocumentCreatedBy | String | The person who created the SOP Order | |
| RequestedDeliveryDate | Date | Requested delivery date. | |
| PromisedDeliveryDate | Date | Promised delivery date. | |
| LineId | Long | Associated sales order line Id. See sop_order_lines | |
| LineNumber | Short | Sales order line number. | |
| LineType | String | Sales order line type. See order_return_line_types | |
| LineProductCode | String | Sales order line product code. | |
| LineProductDescription | String | Sales order line product description. This could be stock item description, free text, additional charge or comment. | |
| LineQuantity | Decimal | The quantity ordered. | |
| LineAllocatedQuantity | Decimal | The quantity allocated. | |
| LineDespatchReceiptQuantity | Decimal | The quantity despatched. | |
| LineInvoiceCreditQuantity | Decimal | The quantity invoiced. | |
| LineSellingUnitDescription | String | The selling unit description. | |
| LineSellingUnitPrice | Decimal | The selling price per item. | |
| LineUnitDiscountPercent | Decimal | The percentage discount per item. | |
| LineUnitDiscountValue | Decimal | The discount value per item. | |
| LineCostPrice | Decimal | The cost price. | |
| LineTotalValue | Decimal | The total value of the line. | |
| LineLineTaxValue | Decimal | The tax value of the line. | |
| LineDiscountedUnitPrice | Decimal | The discounted unit price of the line. This is calculated by subtracting the sop_order_line_unit_discount_value from the sop_order_line_selling_unit_price. | |
| LineRequestedDeliveryDate | Date | Requested delivery date. | |
| LinePromisedDeliveryDate | Date | Promised delivery date. | |
| LineAnalysisCode1 | String | Analysis code 1. | |
| LineAnalysisCode2 | String | Analysis code 2. | |
| LineAnalysisCode3 | String | Analysis code 3. | |
| LineAnalysisCode4 | String | Analysis code 4. | |
| LineAnalysisCode5 | String | Analysis code 5. | |
| LineAnalysisCode6 | String | Analysis code 6. | |
| LineAnalysisCode7 | String | Analysis code 7. | |
| LineAnalysisCode8 | String | Analysis code 8. | |
| LineAnalysisCode9 | String | Analysis code 9. | |
| LineAnalysisCode10 | String | Analysis code 10. | |
| LineAnalysisCode11 | String | Analysis code 11. | |
| LineAnalysisCode12 | String | Analysis code 12. | |
| LineAnalysisCode13 | String | Analysis code 13. | |
| LineAnalysisCode14 | String | Analysis code 14. | |
| LineAnalysisCode15 | String | Analysis code 15. | |
| LineAnalysisCode16 | String | Analysis code 16. | |
| LineAnalysisCode17 | String | Analysis code 17. | |
| LineAnalysisCode18 | String | Analysis code 18. | |
| LineAnalysisCode19 | String | Analysis code 19. | |
| LineAnalysisCode20 | String | Analysis code 20. | |
| LineDateTimeUpdated | Datetime | The date and time the sop order line was last updated (UTC). | |
| DeliveryAddrAddress1 | String | SOP delivery address line 1. | |
| DeliveryAddrAddress2 | String | SOP delivery address line 2. | |
| DeliveryAddrAddress3 | String | SOP delivery address line 3. | |
| DeliveryAddrAddress4 | String | SOP delivery address line 4. | |
| DeliveryAddrCity | String | SOP delivery address city. | |
| DeliveryAddrCounty | String | SOP delivery address county. | |
| DeliveryAddrPostCode | String | SOP delivery address post code | |
| DeliveryAddrCountry | String | SOP delivery address country. | |
| DeliveryAddrContact | String | SOP delivery address contact | |
| DeliveryAddrTelephone | String | SOP delivery address telephone number | |
| DeliveryAddrFax | String | SOP delivery address line fax number... | |
| DeliveryAddrEmail | String | SOP delivery address line email. | |
| CustomerId | Long | The associated customer record Id. See customers | |
| CustomerReference | String | The associated customer account reference. | |
| CustomerName | String | The associated customer name. | |
| ProductId | Long | The associated product record Id. Only returned where sop_order_line_type = EnumLineTypeStandard. See products | |
| ProductCode | String | The code of the product ordered. Only returned where sop_order_line_type = EnumLineTypeStandard | |
| ProductName | String | The name of the product ordered. Only returned where sop_order_line_type = EnumLineTypeStandard | |
| ProductDescription | String | The associated product description. Only returned where sop_order_line_type = EnumLineTypeStandard | |
| WarehouseId | Long | The id of the warehouse the product is stored in. Only returned where sop_order_line_type = EnumLineTypeStandard. See warehouses | |
| WarehouseName | String | The name of the warehouse. Only returned where sop_order_line_type = EnumLineTypeStandard | |
| TaxCodeId | Long | The id of the tax code set on the line. See tax_codes | |
| TaxCodeCode | Short | The associated tax code. | |
| TaxCodeName | String | The associated tax code name. | |
| TaxCodeRate | Decimal | The associated tax rate. |
This resource returns a view of sales pro formas, sales pro forma lines, customers, products, warehouses, tax codes and currencies that can be queried on any field. The default sort (orderby) field are by 'sop_proforma_id' and 'sop_proforma_line_id' descending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesOrderProformaLines WHERE SalesOrderProformaId = 346345654564565 SELECT * FROM SalesOrderProformaLines WHERE SalesOrderProformaDocumentStatus = 'Sample'
| Name | Type | References | Description |
| SalesOrderProformaId [KEY] | Long | Unique Id of the sales pro forma | |
| SalesOrderProformaDocumentNo | String | Sales pro forma document number. | |
| SalesOrderProformaDocumentDate | Date | Sales pro forma date. | |
| SalesOrderProformaDocumentStatus | String | Sales pro forma status. See sop_document_status_types | |
| SalesOrderProformaCustomerDocumentNo | String | Customer sales pro forma document number. | |
| SalesOrderProformaCurrencyId | Long | The Id for the currency used for the sales pro forma. See currencies | |
| SalesOrderProformaCurrencyName | String | The name for the currency used for the sales pro forma. | |
| SalesOrderProformaCurrencySymbol | String | The symbol of the currency used for the sales pro forma. | |
| SalesOrderProformaExchangeRate | Decimal | Exchange rate for the sales pro forma. | |
| SalesOrderProformaRequestedDeliveryDate | Date | Requested delivery date. | |
| SalesOrderProformaPromisedDeliveryDate | Date | Promised delivery date. | |
| SalesOrderProformaAnalysisCode1 | String | Analysis code 1. | |
| SalesOrderProformaAnalysisCode2 | String | Analysis code 2. | |
| SalesOrderProformaAnalysisCode3 | String | Analysis code 3. | |
| SalesOrderProformaAnalysisCode4 | String | Analysis code 4. | |
| SalesOrderProformaAnalysisCode5 | String | Analysis code 5. | |
| SalesOrderProformaDateTimeUpdated | Datetime | The date and time the sales pro forma was last updated (UTC). | |
| SalesOrderProformaLineId | Long | Associated sales pro forma line Id | |
| SalesOrderProformaLineNumber | Short | Sales pro forma line number. | |
| SalesOrderProformaLineType | String | Sales pro forma line type. See order_return_line_types | |
| SalesOrderProformaLineProductCode | String | Sales pro forma line product code. | |
| SalesOrderProformaLineProductDescription | String | Sales pro forma line product description. This could be stock item description, free text, additional charge or comment. | |
| SalesOrderProformaLineQuantity | Decimal | The line quantity. | |
| SalesOrderProformaLineSellingUnitDescription | String | The selling unit description. | |
| SalesOrderProformaLineSellingUnitPrice | Decimal | The selling price per item. | |
| SalesOrderProformaLineUnitDiscountPercent | Decimal | The percentage discount per item. | |
| SalesOrderProformaLineUnitDiscountValue | Decimal | The discount value per item. | |
| SalesOrderProformaLineCostPrice | Decimal | The cost price. | |
| SalesOrderProformaLineTotalValue | Decimal | The total value of the line. | |
| SalesOrderProformaLineLineTaxValue | Decimal | The tax value of the line. | |
| SalesOrderProformaLineDiscountedUnitPrice | Decimal | The discounted unit price of the line. This is calculated by subtracting the sop_proforma_line_unit_discount_value from the sop_proforma_line_selling_unit_price. | |
| SalesOrderProformaLineRequestedDeliveryDate | Date | Requested delivery date. | |
| SalesOrderProformaLinePromisedDeliveryDate | Date | Promised delivery date. | |
| SalesOrderProformaLineAnalysisCode1 | String | Analysis code 1. | |
| SalesOrderProformaLineAnalysisCode2 | String | Analysis code 2. | |
| SalesOrderProformaLineAnalysisCode3 | String | Analysis code 3. | |
| SalesOrderProformaLineAnalysisCode4 | String | Analysis code 4. | |
| SalesOrderProformaLineAnalysisCode5 | String | Analysis code 5. | |
| SalesOrderProformaLineAnalysisCode6 | String | Analysis code 6. | |
| SalesOrderProformaLineAnalysisCode7 | String | Analysis code 7. | |
| SalesOrderProformaLineAnalysisCode8 | String | Analysis code 8. | |
| SalesOrderProformaLineAnalysisCode9 | String | Analysis code 9. | |
| SalesOrderProformaLineAnalysisCode10 | String | Analysis code 10. | |
| SalesOrderProformaLineAnalysisCode11 | String | Analysis code 11. | |
| SalesOrderProformaLineAnalysisCode12 | String | Analysis code 12. | |
| SalesOrderProformaLineAnalysisCode13 | String | Analysis code 13. | |
| SalesOrderProformaLineAnalysisCode14 | String | Analysis code 14. | |
| SalesOrderProformaLineAnalysisCode15 | String | Analysis code 15. | |
| SalesOrderProformaLineAnalysisCode16 | String | Analysis code 16. | |
| SalesOrderProformaLineAnalysisCode17 | String | Analysis code 17. | |
| SalesOrderProformaLineAnalysisCode18 | String | Analysis code 18. | |
| SalesOrderProformaLineAnalysisCode19 | String | Analysis code 19. | |
| SalesOrderProformaLineAnalysisCode20 | String | Analysis code 20. | |
| SalesOrderProformaLineDateTimeUpdated | Datetime | The date and time the sop pro forma line was last updated (UTC). | |
| CustomerId | Long | The associated customer record Id. See customers | |
| CustomerReference | String | The associated customer account reference. | |
| CustomerName | String | The associated customer name. | |
| ProductId | Long | The associated product record Id. Only returned where sop_proforma_line_type = EnumLineTypeStandard. See products | |
| ProductCode | String | The code of the product ordered. Only returned where sop_proforma_line_type = EnumLineTypeStandard | |
| ProductName | String | The name of the product ordered. Only returned where sop_proforma_line_type = EnumLineTypeStandard | |
| ProductDescription | String | The associated product description. Only returned where sop_proforma_line_type = EnumLineTypeStandard | |
| WarehouseId | Long | The id of the warehouse the product is stored in. Only returned where sop_proforma_line_type = EnumLineTypeStandard. See warehouses | |
| WarehouseName | String | The name of the warehouse. Only returned where sop_proforma_line_type = EnumLineTypeStandard | |
| TaxCodeId | Long | The id of the tax code set on the line. See tax_codes | |
| TaxCodeCode | Short | The associated tax code. | |
| TaxCodeName | String | The associated tax code name. | |
| TaxCodeRate | Decimal | The associated tax rate. |
This resource returns a view of sales quotes, sales quote lines, customers, products, warehouses, tax codes and currencies that can be queried on any field. The default sort (orderby) field are by 'sop_quote_id' and 'sop_quote_line_id' descending.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesOrderQuoteLines WHERE SalesOrderQuoteId = 3424324324324 SELECT * FROM SalesOrderQuoteLines WHERE SalesOrderQuoteDocumentNo = 'Sample' SELECT * FROM SalesOrderQuoteLines WHERE SalesOrderQuoteCustomerDocumentNo = 'Sample'
| Name | Type | References | Description |
| SalesOrderQuoteId [KEY] | Long | Unique Id of the sales quote | |
| SalesOrderQuoteDocumentNo | String | Sales quote document number. | |
| SalesOrderQuoteDocumentDate | Date | Sales quote date. | |
| SalesOrderQuoteDocumentStatus | String | Sales quote status. See sop_document_status_types | |
| SalesOrderQuoteCustomerDocumentNo | String | Customer sales quote document number. | |
| SalesOrderQuoteCurrencyId | Long | The Id for the currency used for the sales quote. See currencies | |
| SalesOrderQuoteCurrencyName | String | The name for the currency used for the sales quote. | |
| SalesOrderQuoteCurrencySymbol | String | The symbol of the currency used for the sales quote. | |
| SalesOrderQuoteExchangeRate | Decimal | Exchange rate for the sales quote. | |
| SalesOrderQuoteRequestedDeliveryDate | Date | Requested delivery date. | |
| SalesOrderQuotePromisedDeliveryDate | Date | Promised delivery date. | |
| SalesOrderQuoteAnalysisCode1 | String | Analysis code 1. | |
| SalesOrderQuoteAnalysisCode2 | String | Analysis code 2. | |
| SalesOrderQuoteAnalysisCode3 | String | Analysis code 3. | |
| SalesOrderQuoteAnalysisCode4 | String | Analysis code 4. | |
| SalesOrderQuoteAnalysisCode5 | String | Analysis code 5. | |
| SalesOrderQuoteAnalysisCode6 | String | Analysis code 6. | |
| SalesOrderQuoteAnalysisCode7 | String | Analysis code 7. | |
| SalesOrderQuoteAnalysisCode8 | String | Analysis code 8. | |
| SalesOrderQuoteAnalysisCode9 | String | Analysis code 9. | |
| SalesOrderQuoteAnalysisCode10 | String | Analysis code 10. | |
| SalesOrderQuoteAnalysisCode11 | String | Analysis code 11. | |
| SalesOrderQuoteAnalysisCode12 | String | Analysis code 12. | |
| SalesOrderQuoteAnalysisCode13 | String | Analysis code 13. | |
| SalesOrderQuoteAnalysisCode14 | String | Analysis code 14. | |
| SalesOrderQuoteAnalysisCode15 | String | Analysis code 15. | |
| SalesOrderQuoteAnalysisCode16 | String | Analysis code 16. | |
| SalesOrderQuoteAnalysisCode17 | String | Analysis code 17. | |
| SalesOrderQuoteAnalysisCode18 | String | Analysis code 18. | |
| SalesOrderQuoteAnalysisCode19 | String | Analysis code 19. | |
| SalesOrderQuoteAnalysisCode20 | String | Analysis code 20. | |
| SalesOrderQuoteDateTimeUpdated | Datetime | The date and time the sales quote was last updated (UTC). | |
| SalesOrderQuoteLineId | Long | Associated sales quote line Id | |
| SalesOrderQuoteLineNumber | Short | Sales quote line number. | |
| SalesOrderQuoteLineType | String | Sales quote line type. See order_return_line_types | |
| SalesOrderQuoteLineProductCode | String | Sales quote line product code. | |
| SalesOrderQuoteLineProductDescription | String | Sales quote line product description. This could be stock item description, free text, additional charge or comment. | |
| SalesOrderQuoteLineQuantity | Decimal | The line quantity. | |
| SalesOrderQuoteLineSellingUnitDescription | String | The selling unit description. | |
| SalesOrderQuoteLineSellingUnitPrice | Decimal | The selling price per item. | |
| SalesOrderQuoteLineUnitDiscountPercent | Decimal | The percentage discount per item. | |
| SalesOrderQuoteLineUnitDiscountValue | Decimal | The discount value per item. | |
| SalesOrderQuoteLineCostPrice | Decimal | The cost price. | |
| SalesOrderQuoteLineTotalValue | Decimal | The total value of the line. | |
| SalesOrderQuoteLineLineTaxValue | Decimal | The tax value of the line. | |
| SalesOrderQuoteLineDiscountedUnitPrice | Decimal | The discounted unit price of the line. This is calculated by subtracting the sop_quote_line_unit_discount_value from the sop_quote_line_selling_unit_price. | |
| SalesOrderQuoteLineRequestedDeliveryDate | Date | Requested delivery date. | |
| SalesOrderQuoteLinePromisedDeliveryDate | Date | Promised delivery date. | |
| SalesOrderQuoteLineAnalysisCode1 | String | Analysis code 1. | |
| SalesOrderQuoteLineAnalysisCode2 | String | Analysis code 2. | |
| SalesOrderQuoteLineAnalysisCode3 | String | Analysis code 3. | |
| SalesOrderQuoteLineAnalysisCode4 | String | Analysis code 4. | |
| SalesOrderQuoteLineAnalysisCode5 | String | Analysis code 5. | |
| SalesOrderQuoteLineAnalysisCode6 | String | Analysis code 6. | |
| SalesOrderQuoteLineAnalysisCode7 | String | Analysis code 7. | |
| SalesOrderQuoteLineAnalysisCode8 | String | Analysis code 8. | |
| SalesOrderQuoteLineAnalysisCode9 | String | Analysis code 9. | |
| SalesOrderQuoteLineAnalysisCode10 | String | Analysis code 10. | |
| SalesOrderQuoteLineAnalysisCode11 | String | Analysis code 11. | |
| SalesOrderQuoteLineAnalysisCode12 | String | Analysis code 12. | |
| SalesOrderQuoteLineAnalysisCode13 | String | Analysis code 13. | |
| SalesOrderQuoteLineAnalysisCode14 | String | Analysis code 14. | |
| SalesOrderQuoteLineAnalysisCode15 | String | Analysis code 15. | |
| SalesOrderQuoteLineAnalysisCode16 | String | Analysis code 16. | |
| SalesOrderQuoteLineAnalysisCode17 | String | Analysis code 17. | |
| SalesOrderQuoteLineAnalysisCode18 | String | Analysis code 18. | |
| SalesOrderQuoteLineAnalysisCode19 | String | Analysis code 19. | |
| SalesOrderQuoteLineAnalysisCode20 | String | Analysis code 20. | |
| SalesOrderQuoteLineDateTimeUpdated | Datetime | The date and time the sop quote line was last updated (UTC). | |
| CustomerId | Long | The associated customer record Id. See customers | |
| CustomerReference | String | The associated customer account reference. | |
| CustomerName | String | The associated customer name. | |
| ProductId | Long | The associated product record Id. Only returned where sop_quote_line_type = EnumLineTypeStandard. See products | |
| ProductCode | String | The code of the product ordered. Only returned where sop_quote_line_type = EnumLineTypeStandard | |
| ProductName | String | The name of the product ordered. Only returned where sop_quote_line_type = EnumLineTypeStandard | |
| ProductDescription | String | The associated product description. Only returned where sop_quote_line_type = EnumLineTypeStandard | |
| WarehouseId | Long | The id of the warehouse the product is stored in. Only returned where sop_quote_line_type = EnumLineTypeStandard. See warehouses | |
| WarehouseName | String | The name of the warehouse. Only returned where sop_quote_line_type = EnumLineTypeStandard | |
| TaxCodeId | Long | The id of the tax code set on the line. See tax_codes | |
| TaxCodeCode | Short | The associated tax code. | |
| TaxCodeName | String | The associated tax code name. | |
| TaxCodeRate | Decimal | The associated tax rate. |
Sales orders are used to represent the sale of goods or services to a customer. They are central to a business and define the terms (price, quantity and times) by which the products or services will be delivered. Note: Adding traceable items to sales orders. If you're using traceable stock items and an item is set to be sold from a single batch, then the order quantity must be less than or equal to quantity in the batch. If you try to order more than the quantity in the batch, the order cannot be posted via the API.
| Name | Type | References | Description |
| Id [KEY] | Long | Sales order record Id. | |
| DocumentNo | String | Sales order document number. Note: If the SOP setting in Sage 200c Professional or Sage 200 Extra Online is to NOT automatically generate numbers, then this property MUST be set. If the SOP setting in Sage 200 Extra is to automatically generate numbers, or you are using Sage 200c Standard (which doesn't allow you to set this option), then setting this on POST will be ignored. | |
| DocumentDate | Date | Sales order document date. | |
| DocumentStatus | String | Document status. See sop_document_status_types | |
| CustomerId | Long |
Customers.Id | Customer record Id. See customers |
| ExchangeRate | Decimal | Exchange rate. | |
| SubtotalGoodsValue | Decimal | Goods value (sum of stock items and free text). | |
| SubtotalChargeNetValue | Decimal | Charge net value. | |
| SubtotalChargeTaxValue | Decimal | Charge tax value. | |
| SubtotalDiscountValue | Decimal | Discount value | |
| TotalNetValue | Decimal | Net value (sum of all line types). | |
| TotalTaxValue | Decimal | Tax value. | |
| TotalGrossValue | Decimal | Gross value. | |
| CustomerDocumentNo | String | Customer document number. | |
| UseInvoiceAddress | Bool | True if this order uses the customer invoice address, else False. | |
| SettlementDiscountDays | Short | Settlement discount days. | |
| SettlementDiscountPercent | Decimal | Settlement discount percent. | |
| DocumentDiscountPercent | Decimal | Document discount percent value, between -99.99 and 99.99. A negative value is treated as a surcharge (e.g. -10 is a 10% surcharge), and a positive value is treated as a discount. | |
| DocumentCreatedBy | String | The person who created the SOP Order | |
| RequestedDeliveryDate | Date | Requested delivery date. | |
| PromisedDeliveryDate | Date | Promised delivery date. | |
| AnalysisCode1 | String | Analysis code 1. | |
| AnalysisCode2 | String | Analysis code 2. | |
| AnalysisCode3 | String | Analysis code 3. | |
| AnalysisCode4 | String | Analysis code 4. | |
| AnalysisCode5 | String | Analysis code 5. | |
| AnalysisCode6 | String | Analysis code 6. | |
| AnalysisCode7 | String | Analysis code 7. | |
| AnalysisCode8 | String | Analysis code 8. | |
| AnalysisCode9 | String | Analysis code 9. | |
| AnalysisCode10 | String | Analysis code 10. | |
| AnalysisCode11 | String | Analysis code 11. | |
| AnalysisCode12 | String | Analysis code 12. | |
| AnalysisCode13 | String | Analysis code 13. | |
| AnalysisCode14 | String | Analysis code 14. | |
| AnalysisCode15 | String | Analysis code 15. | |
| AnalysisCode16 | String | Analysis code 16. | |
| AnalysisCode17 | String | Analysis code 17. | |
| AnalysisCode18 | String | Analysis code 18. | |
| AnalysisCode19 | String | Analysis code 19. | |
| AnalysisCode20 | String | Analysis code 20. | |
| Lines | String | The sales order lines collection. See sop_order_lines | |
| DeliveryAddressId | Long | The delivery address contact. | |
| DeliveryAddress_1 | String | The delivery address line 1. | |
| DeliveryAddress_2 | String | The delivery address line 2. | |
| DeliveryAddress_3 | String | The delivery address line 3. | |
| DeliveryAddress_4 | String | The delivery address line 4. | |
| DeliveryAddressCity | String | The delivery address city. | |
| DeliveryAddressCounty | String | The delivery address county. | |
| DeliveryAddressPostcode | String | The delivery address postcode. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Sales posted transactions are created when transactions, such as orders invoiced, receipts, refunds or credit notes, are posted against the Sales Ledger. It is not possible to use this API resource to create posted transactions. To post a transaction, the necessary API resource must be invoked. When making larger requests for customer information, the Sales Transactions Views resource can be a faster alternative to this resource.
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: NominalAnalysisItems,TaxAnalysisItems,BankItems,AllocationSessionItems,AllocationHistoryItems columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesPostedTransactions WHERE Id = 29674 SELECT * FROM SalesPostedTransactions WHERE CustomerId = 27849 SELECT * FROM SalesPostedTransactions WHERE TraderTransactionType = 'TradingAccountEntryTypeInvoice' SELECT * FROM SalesPostedTransactions WHERE Reference = 'O/BAL' SELECT * FROM SalesPostedTransactions WHERE SecondReference = 'Opening Balance' SELECT * FROM SalesPostedTransactions WHERE Queried = 'abc' SELECT * FROM SalesPostedTransactions WHERE TransactionDate = '2017-12-31T01:00:00.000+01:00' SELECT * FROM SalesPostedTransactions WHERE PostedDate = '2018-09-13T02:00:00.000+02:00' SELECT * FROM SalesPostedTransactions WHERE DueDate = '2018-02-14T01:00:00.000+01:00' SELECT * FROM SalesPostedTransactions WHERE FullSettlementDate = '2019-04-15T02:00:00.000+02:00' SELECT * FROM SalesPostedTransactions WHERE DocumentGoodsValue = 150 SELECT * FROM SalesPostedTransactions WHERE DocumentGrossValue = 150 SELECT * FROM SalesPostedTransactions WHERE DocumentTaxValue = 0 SELECT * FROM SalesPostedTransactions WHERE DocumentDiscountValue = 0 SELECT * FROM SalesPostedTransactions WHERE DiscountPercent = 0 SELECT * FROM SalesPostedTransactions WHERE DocumentTaxDiscountValue = 0 SELECT * FROM SalesPostedTransactions WHERE DocumentAllocatedValue = 150 SELECT * FROM SalesPostedTransactions WHERE DocumentOutstandingValue = 0 SELECT * FROM SalesPostedTransactions WHERE BaseGoodsValue = 150 SELECT * FROM SalesPostedTransactions WHERE BaseGrossValue = 150 SELECT * FROM SalesPostedTransactions WHERE BaseTaxValue = 0 SELECT * FROM SalesPostedTransactions WHERE BaseDiscountValue = 0 SELECT * FROM SalesPostedTransactions WHERE BaseTaxDiscountValue = 0 SELECT * FROM SalesPostedTransactions WHERE BaseAllocatedValue = 150 SELECT * FROM SalesPostedTransactions WHERE ControlValueInBaseCurrency = 0 SELECT * FROM SalesPostedTransactions WHERE ExchangeRate = 1 SELECT * FROM SalesPostedTransactions WHERE SettledImmediately = false SELECT * FROM SalesPostedTransactions WHERE DiscountDays = 0 SELECT * FROM SalesPostedTransactions WHERE Urn = 1 SELECT * FROM SalesPostedTransactions WHERE UserName = 'Migration' SELECT * FROM SalesPostedTransactions WHERE DateTimeUpdated = '2018-02-28T15:23:46.330+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Id. | |
| CustomerId | Long | Customer Id. See customers | |
| TraderTransactionType | String | Transaction type. See trader_transaction_types | |
| Reference | String | Transaction reference. | |
| SecondReference | String | Second reference. | |
| Queried | String | Query flag. | |
| TransactionDate | Date | Transaction date. | |
| PostedDate | Date | Posted date. | |
| DueDate | Date | Due date. | |
| FullSettlementDate | Date | Full settlement date. | |
| DocumentGoodsValue | Decimal | Value of the goods. | |
| DocumentGrossValue | Decimal | Gross value. | |
| DocumentTaxValue | Decimal | Tax value. | |
| DocumentDiscountValue | Decimal | Document discount value. | |
| DiscountPercent | Decimal | Percentage discount. | |
| DocumentTaxDiscountValue | Decimal | Tax discount value. | |
| DocumentAllocatedValue | Decimal | Allocated value. | |
| DocumentOutstandingValue | Decimal | Outstanding value. | |
| BaseGoodsValue | Decimal | Value of the goods in base currency. | |
| BaseGrossValue | Decimal | Gross value in base currency. | |
| BaseTaxValue | Decimal | Tax value in base currency. | |
| BaseDiscountValue | Decimal | Discount value in base currency. | |
| BaseTaxDiscountValue | Decimal | Tax discount value in base currency. | |
| BaseAllocatedValue | Decimal | Allocated value in base currency. | |
| ControlValueInBaseCurrency | Decimal | Control value in base currency. | |
| ExchangeRate | Decimal | Exchange rate used for transaction. | |
| SettledImmediately | Bool | Immediately settled. | |
| DiscountDays | Short | Number of days discount valid. | |
| Urn | Long | Unique reference number. | |
| UserName | String | User who entered the transaction. | |
| NominalAnalysisItems | String | Nominal analysis items. See sales_posted_transactions_nominal_analysis_items | |
| TaxAnalysisItems | String | Tax analysis items. See sales_posted_transactions_tax_analysis_items | |
| BankItems | String | Bank items. See sales_posted_transactions_bank_items | |
| AllocationSessionItems | String | Allocation session items. See sales_posted_transactions_allocation_session_items | |
| AllocationHistoryItems | String | Allocation history items. See sales_posted_transactions_allocation_history_items | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
This resource returns the details of all sales trading periods for all financial years held for the company. A company can have the trading periods set to be the same as the accounting periods or as different periods. (Sage 200c Professional and Sage 200 Extra Online Only, Sage 200c Standard defaults to financial year periods)
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesTradingPeriods WHERE Id = 1 SELECT * FROM SalesTradingPeriods WHERE PeriodNumber = '1' SELECT * FROM SalesTradingPeriods WHERE StartDate = '2018-01-01T01:00:00.000+01:00' SELECT * FROM SalesTradingPeriods WHERE EndDate = '2018-01-31T01:00:00.000+01:00' SELECT * FROM SalesTradingPeriods WHERE DateTimeUpdated = '2018-02-28T15:23:45.667+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | An unique Id specific to each sales trading period. | |
| PeriodNumber | String | The period number. | |
| StartDate | Date | Date the trading period starts. The returned string includes the time but this will always be 00:00:00. | |
| EndDate | Date | Date the trading period ends. The returned string includes the time but this will always be 00:00:00. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
When making larger API requests for transaction information from the Sales ledger, the Sales Transaction Views resource can be a faster alternative to the 'Sales Posted Transactions' resource. The Sales Transaction Views resource also returns a wider breadth of information than the Sales Posted Transactions.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SalesTransactionViews WHERE PostedCustomerTransactionId = 29674 SELECT * FROM SalesTransactionViews WHERE TransactionType = 'TradingAccountEntryTypeInvoice' SELECT * FROM SalesTransactionViews WHERE TransactionDate = '2017-12-31T01:00:00.000+01:00' SELECT * FROM SalesTransactionViews WHERE PostedDate = '2018-09-13T02:00:00.000+02:00' SELECT * FROM SalesTransactionViews WHERE DueDate = '2018-02-14T01:00:00.000+01:00' SELECT * FROM SalesTransactionViews WHERE DiscountDays = 0 SELECT * FROM SalesTransactionViews WHERE Reference = 'O/BAL' SELECT * FROM SalesTransactionViews WHERE SecondReference = 'Opening Balance' SELECT * FROM SalesTransactionViews WHERE Query = ' ' SELECT * FROM SalesTransactionViews WHERE Status = 'Full' SELECT * FROM SalesTransactionViews WHERE UserName = 'Migration' SELECT * FROM SalesTransactionViews WHERE LedgerType = 'LedgerSales' SELECT * FROM SalesTransactionViews WHERE Urn = 1 SELECT * FROM SalesTransactionViews WHERE ExchangeRate = 1 SELECT * FROM SalesTransactionViews WHERE SettledImmediately = false SELECT * FROM SalesTransactionViews WHERE BaseGoodsValue = 150 SELECT * FROM SalesTransactionViews WHERE BaseGrossValue = 150 SELECT * FROM SalesTransactionViews WHERE BaseDiscountValue = 0 SELECT * FROM SalesTransactionViews WHERE BaseTaxValue = 0 SELECT * FROM SalesTransactionViews WHERE BaseTaxDiscountValue = 0 SELECT * FROM SalesTransactionViews WHERE BaseAllocatedValue = 150 SELECT * FROM SalesTransactionViews WHERE BaseOutstandingValue = 0 SELECT * FROM SalesTransactionViews WHERE DocumentGoodsValue = 150 SELECT * FROM SalesTransactionViews WHERE DocumentGrossValue = 150 SELECT * FROM SalesTransactionViews WHERE DocumentDiscountValue = 0 SELECT * FROM SalesTransactionViews WHERE DocumentTaxValue = 0 SELECT * FROM SalesTransactionViews WHERE DocumentTaxDiscountValue = 0 SELECT * FROM SalesTransactionViews WHERE DocumentAllocatedValue = 150 SELECT * FROM SalesTransactionViews WHERE DocumentOutstandingValue = 0 SELECT * FROM SalesTransactionViews WHERE CustomerId = 27849 SELECT * FROM SalesTransactionViews WHERE CustomerReference = 'COM001' SELECT * FROM SalesTransactionViews WHERE CustomerName = 'Compton Packaging' SELECT * FROM SalesTransactionViews WHERE CurrencyName = 'Pound Sterling' SELECT * FROM SalesTransactionViews WHERE CurrencySymbol = '£'
| Name | Type | References | Description |
| PostedCustomerTransactionId [KEY] | Long | Id of the transaction. | |
| TransactionType | String | Transaction type. See trader_transaction_types | |
| TransactionDate | Date | The date of the transaction. | |
| PostedDate | Date | The date the transaction was posted. | |
| DueDate | Date | The due date of the transaction. | |
| DiscountDays | Short | Days discount valid. | |
| Reference | String | The reference of the transaction. | |
| SecondReference | String | The second reference of the transaction. | |
| Query | String | Query. | |
| Status | String | Status. | |
| UserName | String | User that posted the transaction. | |
| LedgerType | String | Ledger type. See ledger_types | |
| Urn | Long | Unique reference number. | |
| ExchangeRate | Decimal | Exchange Rate. | |
| SettledImmediately | Bool | Immediately settled. | |
| BaseGoodsValue | Decimal | Goods value in base currency. | |
| BaseGrossValue | Decimal | Gross value in base currency. | |
| BaseDiscountValue | Decimal | Discount value in base currency. | |
| BaseTaxValue | Decimal | Tax value in base currency. | |
| BaseTaxDiscountValue | Decimal | Tax discount value in base currency. | |
| BaseAllocatedValue | Decimal | Allocated value in base currency. | |
| BaseOutstandingValue | Decimal | Outstanding value in base currency. | |
| DocumentGoodsValue | Decimal | Goods value. | |
| DocumentGrossValue | Decimal | Gross value. | |
| DocumentDiscountValue | Decimal | Discount value. | |
| DocumentTaxValue | Decimal | Tax value. | |
| DocumentTaxDiscountValue | Decimal | Tax discount value. | |
| DocumentAllocatedValue | Decimal | Allocated value. | |
| DocumentOutstandingValue | Decimal | Outstanding value. | |
| CustomerId | Long | Customer Id. | |
| CustomerReference | String | Customer account code. | |
| CustomerName | String | Customer account name. | |
| CurrencyName | String | Currency. | |
| CurrencySymbol | String | Currency symbol. |
These settings to define how to process and manage your stock.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM StockSettings WHERE Id = 1 SELECT * FROM StockSettings WHERE UseMultipleLocations = true SELECT * FROM StockSettings WHERE ProfitPercentOfRevenue = true SELECT * FROM StockSettings WHERE DateTimeUpdated = '2018-02-28T15:23:45.543+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Stock setting unique Id. | |
| UseMultipleLocations | Bool | When true this setting allows Sage 200 to track stock at different locations. This can be across several warehouses, or a single warehouse split into separate areas (bins). (Sage 200c Standard value is true and cannot be changed). | |
| ProfitPercentOfRevenue | Bool | Profit can be calculated as a percentage of revenue (true), or as a percentage of cost (false). | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Information can be stored for multiple contacts against each Supplier account. Each contact can have its own details such as telephone numbers, fax numbers, email address and website.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM SupplierContacts WHERE Id = 42101 SELECT * FROM SupplierContacts WHERE SupplierId = 325434364565 SELECT * FROM SupplierContacts WHERE FirstName = 'Sample'
| Name | Type | References | Description |
| Id [KEY] | Long | Supplier contact record Id. | |
| SupplierId | Long | Supplier record Id. | |
| Name | String | Contact Name - Concatenated first_name, middle_name and last_name. | |
| FirstName | String | Contact first name. | |
| MiddleName | String | Contact middle name. | |
| LastName | String | Contact surname. | |
| IsDefault | Bool | Is this the default contact for the parent Supplier. See Supplier | |
| DefaultTelephone | String | Default telephone number. | |
| DefaultEmail | String | Default email address. | |
| SalutationId | Long | Contact salutation id. | |
| SalutationIsDefault | Boolean | Contact salutation. | |
| SalutationCode | String | Contact salutation code. | |
| SalutationDescription | String | Contact salutation description. | |
| Emails | String | Supplier emails. See Supplier_emails | |
| Telephones | String | Supplier telephones. See Supplier_telephones | |
| Mobiles | String | Supplier mobiles. See Supplier_mobiles | |
| Faxes | String | Supplier faxes. See Supplier_faxes | |
| Websites | String | Supplier websites. See Supplier_websites | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Suppliers are one of the most important entities within Sage 200 as they are associated with many important resources within the application and underpin most of the main features (e.g. purchase orders, purchase receipts, etc).
The driver uses the Sage 200c Standard Online API to process search criteria. All filters are processed server side except: CountryCode,CountryCodeName,CountryCodeEuMember,BankId,BankAccountNumber,BankAccountName,BankIBAN,BankBIC,MainAddress_1,MainAddress_2,MainAddress_3,MainAddress_4,MainAddressCity,MainAddressCounty,MainAddressPostcode,Contacts columns.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Suppliers WHERE Id = 28846 SELECT * FROM Suppliers WHERE Reference = 'CON001' SELECT * FROM Suppliers WHERE Name = 'Concept Stationery Supplies' SELECT * FROM Suppliers WHERE ShortName = 'Concept' SELECT * FROM Suppliers WHERE Balance = 4346.16 SELECT * FROM Suppliers WHERE OnHold = false SELECT * FROM Suppliers WHERE AccountStatusType = 'AccountStatusActive' SELECT * FROM Suppliers WHERE CurrencyId = 2103 SELECT * FROM Suppliers WHERE ExchangeRateType = 'ExchangeRateSingle' SELECT * FROM Suppliers WHERE TelephoneCountryCode = '44' SELECT * FROM Suppliers WHERE TelephoneAreaCode = '0191' SELECT * FROM Suppliers WHERE TelephoneSubscriberNumber = '643 4343' SELECT * FROM Suppliers WHERE FaxCountryCode = '44' SELECT * FROM Suppliers WHERE FaxAreaCode = '0191' SELECT * FROM Suppliers WHERE FaxSubscriberNumber = '643 4345' SELECT * FROM Suppliers WHERE Website = 'www.sage.co.uk' SELECT * FROM Suppliers WHERE CreditLimit = 17000 SELECT * FROM Suppliers WHERE CountryCodeId = 13 SELECT * FROM Suppliers WHERE DefaultTaxCodeId = 1729 SELECT * FROM Suppliers WHERE VatNumber = 'GB988 3453 23' SELECT * FROM Suppliers WHERE AnalysisCode1 = 'North East' SELECT * FROM Suppliers WHERE AnalysisCode2 = 'Stationery' SELECT * FROM Suppliers WHERE AnalysisCode3 = 'abc' SELECT * FROM Suppliers WHERE AnalysisCode4 = 'abc' SELECT * FROM Suppliers WHERE AnalysisCode5 = 'abc' SELECT * FROM Suppliers WHERE DateTimeUpdated = '2018-02-28T15:23:46.253+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Supplier unique Id. | |
| Reference | String | Supplier account reference. NOTE: Not required if supplier reference is set to | |
| Name | String | Supplier name. | |
| ShortName | String | Supplier short name. | |
| Balance | Decimal | Supplier account balance. | |
| OnHold | Bool | True if supplier account is on hold, else False. | |
| AccountStatusType | String | The status of the supplier account (Sage 200c Standard and versions of Extra/Professional released after July 2017). For example, this can either be 'Active' or 'Hidden'. See account_status_types | |
| CurrencyId | Long |
Currencies.Id | Currency record Id. See currencies |
| ExchangeRateType | String | The type of exchange rate used on the supplier account. See exchange_rate_types | |
| TelephoneCountryCode | String | Telephone country code (Sage 200c Professional and Sage 200 Extra Online Only). | |
| TelephoneAreaCode | String | Telephone area code (Sage 200c Professional and Sage 200 Extra Online Only). | |
| TelephoneSubscriberNumber | String | Telephone subscriber number (Sage 200c Professional and Sage 200 Extra Online Only). | |
| FaxCountryCode | String | Fax country code. | |
| FaxAreaCode | String | Fax area code. | |
| FaxSubscriberNumber | String | Fax subscriber number. | |
| Website | String | Website address. | |
| CreditLimit | Decimal | Credit limit for the supplier. | |
| CountryCodeId | Long | Country code record Id. | |
| CountryCode | String | The customers country code. | |
| CountryCodeName | String | The customers country code name. | |
| CountryCodeEuMember | Boolean | Shows if the customer is Eu Member. | |
| DefaultTaxCodeId | Long |
TaxCodes.Id | Default tax code record Id. See tax_codes |
| VatNumber | String | VAT registration number. | |
| AnalysisCode1 | String | Analysis code 1. | |
| AnalysisCode2 | String | Analysis code 2. | |
| AnalysisCode3 | String | Analysis code 3. | |
| AnalysisCode4 | String | Analysis code 4. | |
| AnalysisCode5 | String | Analysis code 5. | |
| AnalysisCode6 | String | Analysis code 6. | |
| AnalysisCode7 | String | Analysis code 7. | |
| AnalysisCode8 | String | Analysis code 8. | |
| AnalysisCode9 | String | Analysis code 9. | |
| AnalysisCode10 | String | Analysis code 10. | |
| AnalysisCode11 | String | Analysis code 11. | |
| AnalysisCode12 | String | Analysis code 12. | |
| AnalysisCode13 | String | Analysis code 13. | |
| AnalysisCode14 | String | Analysis code 14. | |
| AnalysisCode15 | String | Analysis code 15. | |
| AnalysisCode16 | String | Analysis code 16. | |
| AnalysisCode17 | String | Analysis code 17. | |
| AnalysisCode18 | String | Analysis code 18. | |
| AnalysisCode19 | String | Analysis code 19. | |
| AnalysisCode20 | String | Analysis code 20. | |
| BankId | String | Supplier bank account id. | |
| BankAccountNumber | String | Supplier bank account number. | |
| BankAccountName | String | Supplier bank account name. | |
| BankIBAN | String | Supplier bank account iban number. | |
| BankBIC | String | Supplier bank account BIC number. | |
| MainAddress_1 | String | The customers main address line 1. | |
| MainAddress_2 | String | The customers main address line 2. | |
| MainAddress_3 | String | The customers main address line 3. | |
| MainAddress_4 | String | The customers main address line 4. | |
| MainAddressCity | String | The customers main address city. | |
| MainAddressCounty | String | The customers main address county. | |
| MainAddressPostcode | String | The customers main address postcode. | |
| Contacts | String | Supplier contacts. See supplier_contacts | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Tax codes are normally used for UK business VAT Rates. They are accessed by Sage 200 modules in order to: - Analyse the rates to Nominal Ledger accounts. - Analyse the rates to the VAT Return. - Read percentages for calculations in transactions.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM TaxCodes WHERE Id = 1728 SELECT * FROM TaxCodes WHERE Code = 0 SELECT * FROM TaxCodes WHERE Name = 'Zero rated' SELECT * FROM TaxCodes WHERE TaxRate = 0 SELECT * FROM TaxCodes WHERE Terms = 'EcTermsNotApplicable' SELECT * FROM TaxCodes WHERE TermsDescription = 'Not Applicable' SELECT * FROM TaxCodes WHERE DateTimeUpdated = '2018-02-28T15:23:46.133+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Tax code record Id. | |
| Code | Short | Tax code. | |
| Name | String | Name of the tax code. | |
| TaxRate | Decimal | Tax rate. | |
| Terms | String | Name of the terms. | |
| TermsDescription | String | Description of the terms. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
All stock within Sage 200 regardless of type (Stock, Service/labour, or Miscellaneous), require a holding location. The location indicates where an item is stored and the stock level settings for each product in the warehouse i.e. the re-order level, the minimum and maximum stock levels. Items with a type of 'Stock' have levels recorded for each warehouse location and the levels are used when allocating, issuing and receiving stock. If the stock setting UseMultipleLocations is true, a product can be linked to multiple warehouse holdings. You cannot delete the last warehouse holding associated with a product.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM WarehouseHoldings WHERE Id = 34738 SELECT * FROM WarehouseHoldings WHERE WarehouseId = 34629 SELECT * FROM WarehouseHoldings WHERE ProductId = 34737 SELECT * FROM WarehouseHoldings WHERE ReorderLevel = 0 SELECT * FROM WarehouseHoldings WHERE MinimumLevel = 0 SELECT * FROM WarehouseHoldings WHERE MaximumLevel = 0 SELECT * FROM WarehouseHoldings WHERE ConfirmedQtyInStock = 0 SELECT * FROM WarehouseHoldings WHERE UnconfirmedQtyInStock = 0 SELECT * FROM WarehouseHoldings WHERE QuantityInStock = 0 SELECT * FROM WarehouseHoldings WHERE QuantityAllocatedStock = 0 SELECT * FROM WarehouseHoldings WHERE QuantityAllocatedSop = 0 SELECT * FROM WarehouseHoldings WHERE QuantityAllocatedBom = 0 SELECT * FROM WarehouseHoldings WHERE QuantityAllocated = 0 SELECT * FROM WarehouseHoldings WHERE DateTimeUpdated = '2019-08-01T18:00:33.140+02:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Warehouse holding record Id. | |
| WarehouseId | Long |
Warehouses.Id | Warehouse record Id. See warehouses |
| ProductId | Long |
Products.Id | Product record Id. See products |
| ReorderLevel | Decimal | Reorder stock level. | |
| MinimumLevel | Decimal | Minimum stock quantity level. | |
| MaximumLevel | Decimal | Maximum stock quantity level. | |
| ConfirmedQtyInStock | Decimal | Confirmed stock quantity. | |
| UnconfirmedQtyInStock | Decimal | Unconfirmed stock quantity. | |
| QuantityInStock | Decimal | Total confirmed and unconfirmed stock quantity. | |
| QuantityAllocatedStock | Decimal | Allocated stock quantity. | |
| QuantityAllocatedSop | Decimal | Allocated sales order quantity. | |
| QuantityAllocatedBom | Decimal | Allocated bill of materials quantity. | |
| QuantityAllocated | Decimal | Total Allocated stock, sop and bom quantity. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
All stock within Sage 200, regardless of type (Stock, Service/labour, or Miscellaneous), requires a holding location. By default, the HOME warehouse is created within Sage 200, you can then create your own warehouses.
The driver uses the Sage 200c Standard Online API to process all search criteria.
Supported operators are: =, < , <= , > , >= , != , AND, LIKE , IS NULL , IS NOT NULL.
For example, the following queries are processed server side:
SELECT * FROM Warehouses WHERE Id = 34626 SELECT * FROM Warehouses WHERE Name = 'Supplied Direct' SELECT * FROM Warehouses WHERE DateTimeUpdated = '2018-02-28T15:23:46.190+01:00'
| Name | Type | References | Description |
| Id [KEY] | Long | Warehouse record Id. | |
| Name | String | Warehouse name. | |
| DateTimeUpdated | Datetime | The date and time this entity was last updated (UTC). |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT operations with Sage 200.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Sage 200, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Sage 200:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries:
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| Name | Type | Description |
| CatalogName | String | The database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view. |
| TableType | String | The table type (table or view). |
| Description | String | A description of the table or view. |
| IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Banks table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Banks'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the table or view. |
| SchemaName | String | The schema containing the table or view. |
| TableName | String | The name of the table or view containing the column. |
| ColumnName | String | The column name. |
| DataTypeName | String | The data type name. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| Length | Int32 | The storage size of the column. |
| DisplaySize | Int32 | The designated column's normal maximum width in characters. |
| NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
| NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
| IsNullable | Boolean | Whether the column can contain null. |
| Description | String | A brief description of the column. |
| Ordinal | Int32 | The sequence number of the column. |
| IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
| IsGeneratedColumn | String | Whether the column is generated. |
| IsHidden | Boolean | Whether the column is hidden. |
| IsArray | Boolean | Whether the column is an array. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the GetOAuthAuthorizationURL stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAuthorizationURL' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAuthorizationURL' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native Sage 200 procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Banks table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Banks'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
| IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| PrimaryKeyName | String | The name of the primary key. |
| ForeignKeyName | String | The name of the foreign key. |
| ReferencedCatalogName | String | The database containing the primary key. |
| ReferencedSchemaName | String | The schema containing the primary key. |
| ReferencedTableName | String | The table containing the primary key. |
| ReferencedColumnName | String | The column name of the primary key. |
| ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| Name | Type | Description |
| CatalogName | String | The name of the database containing the key. |
| SchemaName | String | The name of the schema containing the key. |
| TableName | String | The name of the table containing the key. |
| ColumnName | String | The name of the key column. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the index. |
| SchemaName | String | The name of the schema containing the index. |
| TableName | String | The name of the table containing the index. |
| IndexName | String | The index name. |
| ColumnName | String | The name of the column associated with the index. |
| IsUnique | Boolean | True if the index is unique. False otherwise. |
| IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
| Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
| SortOrder | String | The sort order: A for ascending or D for descending. |
| OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
| Name | Type | Description |
| Name | String | The name of the connection property. |
| ShortDescription | String | A brief description. |
| Type | String | The data type of the connection property. |
| Default | String | The default value if one is not explicitly set. |
| Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
| Value | String | The value you set or a preconfigured default. |
| Required | Boolean | Whether the property is required to connect. |
| Category | String | The category of the connection property. |
| IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
| Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
| PropertyName | String | A camel-cased truncated form of the connection property name. |
| Ordinal | Int32 | The index of the parameter. |
| CatOrdinal | Int32 | The index of the parameter category. |
| Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
| Visible | Boolean | Informs whether the property is visible in the connection UI. |
| ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
| Name | Description | Possible Values |
| AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
| COUNT | Whether COUNT function is supported. | YES, NO |
| IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
| IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
| SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
| GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
| NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
| TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
| REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
| REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
| IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
| SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
| DIALECT | Indicates the SQL dialect to use. | |
| KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
| SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
| SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
| DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
| SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
| SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
| SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
| PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
| ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
| PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
| MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
| REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
| REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
| REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
| REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
| REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
| IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
| CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
| CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
| Name | Type | Description |
| NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
| VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| Name | Type | Description |
| Id | String | The database-generated Id returned from a data modification operation. |
| Batch | String | An identifier for the batch. 1 for a single operation. |
| Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
| Message | String | SUCCESS or an error message if the update in the batch failed. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| SubscriptionKey | [DEPRECATED] Your subscription key. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | This determines the scopes that are requested from Sage. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Schema | Used to specify what Sage200 Api to use. The default one is the Standard UK API. |
| Property | Description |
| CompanyId | The ID of your company. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MaxThreads | Specifies the number of concurrent requests. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| SubscriptionKey | [DEPRECATED] Your subscription key. |
[DEPRECATED] Your subscription key.
string
""
[DEPRECATED] Your subscription key. Obtained by subscribing to the appropriate edition API here: https://developer.columbus.sage.com/docs/services/api/uk.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | This determines the scopes that are requested from Sage. |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
string
""
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
string
""
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
This determines the scopes that are requested from Sage.
string
""
By default, the following scopes will be requested: 'openid profile email offline_access'. If you want to override this, you can set this property to a space-separated list of scopes.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are rejected.
This property can take the following forms:
| Description | Example |
| A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
| A path to a local file containing the certificate | C:\cert.cer |
| The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
| The MD5 Thumbprint (hex values can also be either space- or colon-separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
| The SHA1 Thumbprint (hex values can also be either space- or colon-separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Schema | Used to specify what Sage200 Api to use. The default one is the Standard UK API. |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Used to specify what Sage200 Api to use. The default one is the Standard UK API.
string
"StandardUK"
Used to specify what Sage200 Api to use. The default one is the Standard UK API.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| CompanyId | The ID of your company. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| MaxThreads | Specifies the number of concurrent requests. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
The ID of your company.
string
""
The ID of your company. If you have multiple companies connected to your Sage200 Account, by default we use the first one.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the number of concurrent requests.
string
"20"
This property allows you to issue multiple requests simultaneously, thereby improving performance.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
string
""
This property allows you to define which pseudocolumns the Cloud exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
int
60
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.