Provides integration into Sage One Accounting via it's RESTful API (documented at https://accounting.sageone.co.za/api/1.1.1/Help).

This Connector provides integration into Sage One for Africa, Australia and Malaysia. For other regions, check the Sage One Global Connector. If you do not see your region listed, please contact us.

Revision History

2.0.0.2 - Implemented support for multiple transactions per request
1.0.0.8 - Resolved 500 (Internal Server Error) message caused by XmlDeclaration on RequestXml property
1.0.0.7 - Updated transaction timeout to pull through on the value set in the connection property


Properties

Connection

Type: Connection Input

Username
Type: String

Password
Type: Password

CompanyID
Type: String

Provides the username and password that will be used to access the API. See remarks for more information about Company ID.

Action

Type: List Input
AllowDelete
AssignPaymentsRefundsToTaxPeriod
Calculate
CloseTaxPeriod
Delete
DeleteAll
DeleteBatch
Email
Get
GetAccountsByCategory
GetAll
GetAllSummary
GetBankAccountTransactionListingReportingDetail
GetCompanyNotes
GetCompanyStorageInformation
GetCurrent
GetCustomerAllocationsAndOutstandingDocuments
GetDefault
GetDetail
GetDueInDateRange
GetDueSpecificDate
GetForSpecificDate
GetIncludingDetail
GetSettings
GetSignature
GetSummary
GetSupplierAllocationsAndOutstandingDocuments
GetSupplierTransactionListingReportingDetail
GetTemplateInUse
GetWithoutZeroValues
GetWithSystemAccounts
HasActivity
HasPreviousTransactions
HasUnreportedTransactions
OpenTaxPeriod
Post
RefreshHasAttachments
Save
SaveBatch
SaveSettings
SaveWithBaseType
Validate
The Action Property

Module

Type: List Input
Account
AccountCategory
AccountNote
AccountOpeningBalance
AccountPayment
AccountReceipt
AccountantEvent
AccountantTask
AccountantTaskRecurrence
AdditionalItemPrice
AdditionalPriceList
Allocation
AnalysisCategory
AnalysisType
Asset
AssetCategory
AssetLocation
AssetNote
Attachment
BankAccount
BankAccountCategory
BankAccountNote
BankAccountNoteAttachment
BankAccountOpeningBalance
BankAccountTransactionListing
BankImportMapping
BankStatementTransaction
BankTransaction
BankTransactionAttachment
BASReport
Budget
CashMovement
Company
CompanyEntityType
CompanyNote
ComparativeProfitAndLossStatement
ComparativeStatementOfAssetsAndLiabilities
Customer
CustomerAdditionalContactDetail
CustomerAdjustment
CustomerAgeing
CustomerCategory
CustomerNote
CustomerNoteAttachment
CustomerOpeningBalance
CustomerReceipt
CustomerReturn
CustomerSalesHistory
CustomerStatement
CustomerTransactionListing
CustomerWriteOff
DateFormat
DetailedLedgerTransaction
DocumentHeaderNote
DocumentMessage
EmailSignatureTemplate
EmailTemplatePlaceHolder
FinancialYear
IncomeVsExpense
Item
ItemAdjustment
ItemAttachment
ItemCategory
ItemMovement
ItemNote
ItemNoteAttachment
ItemOpeningBalance
ItemReportGroup
JournalEntry
Login
OutstandingCustomerDocument
OutstandingSupplierDocument
PriceListingReport
ProcessBankAndCreditCardMapping
PurchaseOrder
Quote
ReportingGroup
SalesByItem
SalesBySalesRepresentative
SalesRepresentative
SalesRepresentativeNote
ScheduleFrequency
SecretarialCompanyRole
SecretarialShareClass
SecretarialShareholder
SecretarialStakeHolder
Supplier
SupplierAdjustment
SupplierAgeing
SupplierCategory
SupplierInvoice
SupplierNote
SupplierNoteAttachment
SupplierOpeningBalance
SupplierPayment
SupplierPurchaseHistory
SupplierReturn
SupplierStatement
SupplierTransactionListing
TakeOnBalance
TaxInvoice
TaxPeriod
TaxType
ToDoList
TopCustomersByOutstandingBalance
TopCustomersBySales
TopPurchasedItems
TopSellingItems
TopSellingItemsByValueOnHand
TopSuppliersByOutstandingBalance
TopSuppliersByPurchases
TrialBalance
TrialBalanceExportMapping
VAT201Report
The Module Property

ParameterXml

Type: Xml Input
The ParameterXml Property

RequestXml

Type: Xml Input
The RequestXml Property

ResponseXml

Type: Xml Output
The ResponseXml Property

Demo Video

Remarks

Setting up the Connection

A users' username and password should be placed into the respective fields in the Sage One Connection.

Most integrations apply to a specific Sage One company and will require that the Company ID property is populated with a valid Company ID. 


To obtain the Company ID via the API, use the GET Company (Company/Get)  Node Sample to obtain a list of all companies. The ResponseXml property will contain a list of all companies including the associated Company ID which can then be placed in the Connection.

OData Queries

Some calls support OData Queries. These can be added in the ParameterXml.

<Root>
<key Name="$filter" Value="Name eq 'Flowgear'" />
<key Name="$top" Value="5" />
</Root>

Rate Limiting

The Sage One API imposes a limit of 100 requests per minute. If this limit is exceeded, the Sage One connector will return this error:

Operation is not valid due to the current state of the object 

See https://www.sageone.co.za/request-limit-faq/ for further information.

Example

See https://flowgear.me/s/FKcGptn for an example.

See Also

Sage One API - https://accounting.sageone.co.za/api/1.1.1/

Did this answer your question?