sage one...sage one api documentation – version 2.0.1 25 february 2014 page 14 of 157 overview...

SAGE PASTEL

Sage One API Specification

version 2.0.1

28 July 2014

Sage One API Documentation – Version 2.0.1 25 February 2014

Page 1 of 157

Contents Overview ......................................................................................................................................................................... 14

Formats ........................................................................................................................................................................... 14

URL Structure .................................................................................................................................................................. 14

Response Codes + Error Handling ................................................................................................................................... 15

Authentication ................................................................................................................................................................ 16

Methods Overview .......................................................................................................................................................... 17

Save Methods ............................................................................................................................................................. 17

Get Methods ............................................................................................................................................................... 17

Pagination ............................................................................................................................................................... 17

Delete Methods .......................................................................................................................................................... 18

Services ........................................................................................................................................................................... 19

Account Service ........................................................................................................................................................... 19

Get Individual .......................................................................................................................................................... 19

Get List .................................................................................................................................................................... 19

Get List with System Accounts ................................................................................................................................ 19

Save ......................................................................................................................................................................... 20

Account Category Service ........................................................................................................................................... 20

Get Individual .......................................................................................................................................................... 20

Get List .................................................................................................................................................................... 20

Save ......................................................................................................................................................................... 21

Delete ...................................................................................................................................................................... 21

Account Note Service .................................................................................................................................................. 22

Get Individual .......................................................................................................................................................... 22

Get List .................................................................................................................................................................... 22

Account Payment Service ........................................................................................................................................... 22

Get List .................................................................................................................................................................... 22

Save ......................................................................................................................................................................... 23

Account Receipt Service .............................................................................................................................................. 23

Get List .................................................................................................................................................................... 23

Save ......................................................................................................................................................................... 23

Account Note Attachment Service .............................................................................................................................. 25

Attachment Service ..................................................................................................................................................... 25

Get List of files for an Attachment .......................................................................................................................... 25

Get a File ................................................................................................................................................................. 25


Page 2 of 157

Upload Attachment ................................................................................................................................................. 26

Get Company storage ............................................................................................................................................. 26

Delete Attachment .................................................................................................................................................. 27

Asset Service ............................................................................................................................................................... 27

Get Individual .......................................................................................................................................................... 27

Get List .................................................................................................................................................................... 27

Save ......................................................................................................................................................................... 28

Delete ...................................................................................................................................................................... 28

Asset Category Service ................................................................................................................................................ 29

Get Individual .......................................................................................................................................................... 29

Get List .................................................................................................................................................................... 29

Save ......................................................................................................................................................................... 29

Delete ...................................................................................................................................................................... 30

Asset Note Service ...................................................................................................................................................... 30

Get Individual .......................................................................................................................................................... 30

Get List .................................................................................................................................................................... 30

Save ......................................................................................................................................................................... 31

Delete ...................................................................................................................................................................... 31

Asset Note Attachment Service .................................................................................................................................. 32

Asset Location Service................................................................................................................................................. 32

Get Individual .......................................................................................................................................................... 32

Get List .................................................................................................................................................................... 32

Save ......................................................................................................................................................................... 32

Delete ...................................................................................................................................................................... 33

Bank Account Service .................................................................................................................................................. 33

Get Individual .......................................................................................................................................................... 33

Get List .................................................................................................................................................................... 33

Save ......................................................................................................................................................................... 34

Delete ...................................................................................................................................................................... 34

Validate ................................................................................................................................................................... 34

Bank Account Category Service .................................................................................................................................. 36

Get Individual .......................................................................................................................................................... 36

Get List .................................................................................................................................................................... 36

Save ......................................................................................................................................................................... 36

Delete ...................................................................................................................................................................... 37


Page 3 of 157

Bank Account Note Service ......................................................................................................................................... 37

Get Individual .......................................................................................................................................................... 37

Get List .................................................................................................................................................................... 37

Save ......................................................................................................................................................................... 38

Delete ...................................................................................................................................................................... 38

Bank Account Note Attachment Service ..................................................................................................................... 38

Budget Service ............................................................................................................................................................ 39

Get Individual .......................................................................................................................................................... 39

Get List .................................................................................................................................................................... 39

Save ......................................................................................................................................................................... 39

Delete ...................................................................................................................................................................... 40

GetDefaultBudget ................................................................................................................................................... 40

GetBudgetReport .................................................................................................................................................... 41

Validate ................................................................................................................................................................... 41

Cash Movement Service.............................................................................................................................................. 42

Get List .................................................................................................................................................................... 42

Company Service ......................................................................................................................................................... 42

Get Individual .......................................................................................................................................................... 42

Get List .................................................................................................................................................................... 43

Company Note Service ................................................................................................................................................ 44

Get Individual .......................................................................................................................................................... 44

Get List .................................................................................................................................................................... 44

Save ......................................................................................................................................................................... 45

Delete ...................................................................................................................................................................... 45

Company Note Attachment Service ............................................................................................................................ 45

Comparative Profit And Loss Statement Service ........................................................................................................ 45

Get ........................................................................................................................................................................... 45

Comparative Statement of Assets and Liabilities Service ........................................................................................... 46

Get ........................................................................................................................................................................... 46

Customer Service ........................................................................................................................................................ 47

Get Individual .......................................................................................................................................................... 47

Get List .................................................................................................................................................................... 47

Save ......................................................................................................................................................................... 48

Delete ...................................................................................................................................................................... 49

Customer Category Service ......................................................................................................................................... 50


Page 4 of 157

Get Individual .......................................................................................................................................................... 50

Get List .................................................................................................................................................................... 50

Save ......................................................................................................................................................................... 50

Delete ...................................................................................................................................................................... 51

Customer Additional Contact Detail Service ............................................................................................................... 51

Get Individual .......................................................................................................................................................... 51

Get List .................................................................................................................................................................... 51

Save ......................................................................................................................................................................... 52

Delete ...................................................................................................................................................................... 52

Customer Receipt Service ........................................................................................................................................... 52

Get List .................................................................................................................................................................... 52

Customer Return Service ............................................................................................................................................ 53

Get Individual .......................................................................................................................................................... 53

Get List .................................................................................................................................................................... 53

Customer Note Service ............................................................................................................................................... 54

Get Individual .......................................................................................................................................................... 54

Get List .................................................................................................................................................................... 54

Save ......................................................................................................................................................................... 55

Delete ...................................................................................................................................................................... 55

Customer Note Attachment Service ........................................................................................................................... 56

Customer Ageing Service ............................................................................................................................................ 56

Get List .................................................................................................................................................................... 56

Get Individual .......................................................................................................................................................... 56

Customer Sales History Service ................................................................................................................................... 56

Get List .................................................................................................................................................................... 56

Customer Statement Service ...................................................................................................................................... 57

Get List .................................................................................................................................................................... 57

Financial Year Service .................................................................................................................................................. 57

Get Individual .......................................................................................................................................................... 57

Get List .................................................................................................................................................................... 57

Get Current ............................................................................................................................................................. 58

Income VS Expense Service ......................................................................................................................................... 58

Get List .................................................................................................................................................................... 58

Item Service ................................................................................................................................................................ 58

Get Individual .......................................................................................................................................................... 58


Page 5 of 157

Get List .................................................................................................................................................................... 59

Save ......................................................................................................................................................................... 60

Delete ...................................................................................................................................................................... 61

Item Category Service ................................................................................................................................................. 62

Get Individual .......................................................................................................................................................... 62

Get List .................................................................................................................................................................... 62

Save ......................................................................................................................................................................... 62

Delete ...................................................................................................................................................................... 63

Item Note Service ........................................................................................................................................................ 63

Get Individual .......................................................................................................................................................... 63

Get List .................................................................................................................................................................... 63

Save ......................................................................................................................................................................... 64

Delete ...................................................................................................................................................................... 64

Item Note Attachment Service ................................................................................................................................... 64

Journal Entry Service ................................................................................................................................................... 64

Get List .................................................................................................................................................................... 64

Get Individual .......................................................................................................................................................... 65

Save ......................................................................................................................................................................... 65

SaveBatch ................................................................................................................................................................ 66

Calculate .................................................................................................................................................................. 66

Purchase Order Service ............................................................................................................................................... 67

Get Individual .......................................................................................................................................................... 67

Get List .................................................................................................................................................................... 67

Save ......................................................................................................................................................................... 68

Delete ...................................................................................................................................................................... 70

Calculate .................................................................................................................................................................. 70

Quote Service .............................................................................................................................................................. 71

Get Individual .......................................................................................................................................................... 71

Get List .................................................................................................................................................................... 71

Save ......................................................................................................................................................................... 72

Calculate .................................................................................................................................................................. 73

Delete ...................................................................................................................................................................... 74

Email ........................................................................................................................................................................ 74

Sales Representative Service ...................................................................................................................................... 75

Get Individual .......................................................................................................................................................... 75


Page 6 of 157

Get List .................................................................................................................................................................... 75

Save ......................................................................................................................................................................... 75

Delete ...................................................................................................................................................................... 76

Sales Representative Note Service ............................................................................................................................. 76

Get Individual .......................................................................................................................................................... 76

Get List .................................................................................................................................................................... 77

Save ......................................................................................................................................................................... 77

Delete ...................................................................................................................................................................... 78

Sales Representative Note Attachment Service ......................................................................................................... 78

Supplier Service ........................................................................................................................................................... 78

Get Individual .......................................................................................................................................................... 78

Get List .................................................................................................................................................................... 78

Save ......................................................................................................................................................................... 79

Delete ...................................................................................................................................................................... 80

Supplier Ageing Service ............................................................................................................................................... 81

Get List .................................................................................................................................................................... 81

Supplier Category Service ........................................................................................................................................... 81

Get Individual .......................................................................................................................................................... 81

Get List .................................................................................................................................................................... 81

Save ......................................................................................................................................................................... 81

Delete ...................................................................................................................................................................... 82

Supplier Note Service .................................................................................................................................................. 83

Get Individual .......................................................................................................................................................... 83

Get List .................................................................................................................................................................... 83

Save ......................................................................................................................................................................... 84

Delete ...................................................................................................................................................................... 84

Supplier Note Attachment Service .............................................................................................................................. 84

Supplier Invoice Service .............................................................................................................................................. 85

Get Individual .......................................................................................................................................................... 85

Get List .................................................................................................................................................................... 85

Save ......................................................................................................................................................................... 86

Calculate .................................................................................................................................................................. 87

Email ........................................................................................................................................................................ 88

Supplier Return Service ............................................................................................................................................... 88

Get Individual .......................................................................................................................................................... 88


Page 7 of 157

Get List .................................................................................................................................................................... 89

Save ......................................................................................................................................................................... 89

Calculate .................................................................................................................................................................. 90

Email ........................................................................................................................................................................ 91

Supplier Payment Service ........................................................................................................................................... 92

Get List .................................................................................................................................................................... 92

Tax Invoice Service ...................................................................................................................................................... 92

Get Individual .......................................................................................................................................................... 92

Get List .................................................................................................................................................................... 92

Save ......................................................................................................................................................................... 93

Calculate .................................................................................................................................................................. 94

Email ........................................................................................................................................................................ 95

Tax Type Service .......................................................................................................................................................... 95

Get Individual .......................................................................................................................................................... 95

Get List .................................................................................................................................................................... 96

Save ......................................................................................................................................................................... 96

Delete ...................................................................................................................................................................... 96

Top Customers By Outstanding Balance Service ........................................................................................................ 97

Get List .................................................................................................................................................................... 97

Top Customers By Sales Service .................................................................................................................................. 97

Get List .................................................................................................................................................................... 97

Top Purchased Items Service ...................................................................................................................................... 97

Get List .................................................................................................................................................................... 97

Top Selling Items Service ............................................................................................................................................ 98

Get List .................................................................................................................................................................... 98

Top Selling Items By Value On Hand Service .............................................................................................................. 98

Get List .................................................................................................................................................................... 98

Top Suppliers By Outstanding Balance Service ........................................................................................................... 99

Get List .................................................................................................................................................................... 99

Top Suppliers By Purchases Service ............................................................................................................................ 99

Get List .................................................................................................................................................................... 99

Data Models .................................................................................................................................................................... 99

Attachment ................................................................................................................................................................. 99

Ageing Transaction .................................................................................................................................................... 100

Enums ........................................................................................................................................................................ 101


Page 8 of 157

Ageing Period ........................................................................................................................................................ 101

BankTransactionType ............................................................................................................................................ 101

CommercialDocumentLineType ............................................................................................................................ 101

CustomerNotePriority ........................................................................................................................................... 101

CommunicationMethodType ................................................................................................................................ 101

Document Type ..................................................................................................................................................... 101

Effect ..................................................................................................................................................................... 102

ItemReportGroupType .......................................................................................................................................... 102

PaymentMethod ................................................................................................................................................... 102

PeriodComparativeType ....................................................................................................................................... 102

PeriodGroupingType ............................................................................................................................................. 103

QuoteStatusType .................................................................................................................................................. 103

RelativeFrequencyInterval .................................................................................................................................... 103

ReportingLevelType .............................................................................................................................................. 103

Rounding Type ...................................................................................................................................................... 103

SecretarialStakeHolderAddressType ..................................................................................................................... 103

TakeOnBalanceAccountType ................................................................................................................................ 103

ToDoListCategory .................................................................................................................................................. 104

TrialBalanceAccountType ...................................................................................................................................... 104

Tax System ............................................................................................................................................................ 104

Account ..................................................................................................................................................................... 104

Account Category ...................................................................................................................................................... 105

Account Note ............................................................................................................................................................ 105

Account Opening Balance ......................................................................................................................................... 105

Account Payment ...................................................................................................................................................... 105

Account Receipt ........................................................................................................................................................ 106

Account Reporting Value .......................................................................................................................................... 106

Ageing Base ............................................................................................................................................................... 106

Ageing Transaction .................................................................................................................................................... 106

Asset .......................................................................................................................................................................... 107

Asset Category .......................................................................................................................................................... 107

Asset Location ........................................................................................................................................................... 107

Asset Note ................................................................................................................................................................. 107

Balance Sheet Reporting Level .................................................................................................................................. 108

Bank Account ............................................................................................................................................................ 108


Page 9 of 157

Bank Account Category ............................................................................................................................................. 109

Bank Account Note ................................................................................................................................................... 109

Bank Account Opening Balance ................................................................................................................................ 110

Bank Statement Transaction ..................................................................................................................................... 110

Bank Transaction ....................................................................................................................................................... 110

Budget ....................................................................................................................................................................... 111

Budget Item............................................................................................................................................................... 111

Budget Item Account ................................................................................................................................................ 111

Budget Item Period ................................................................................................................................................... 111

Cash Movement ........................................................................................................................................................ 111

Commercial Document ............................................................................................................................................. 112

Commercial Document Lines .................................................................................................................................... 113

Company ................................................................................................................................................................... 113

Company Entity Type ................................................................................................................................................ 114

Company Logo........................................................................................................................................................... 114

Company Note .......................................................................................................................................................... 114

Company Report Layout ........................................................................................................................................... 115

Comparative Grouping Period .................................................................................................................................. 115

Comparative Profit & Loss Statement ...................................................................................................................... 115

Comparative Profit And Loss Statement Line ........................................................................................................... 115

Customer ................................................................................................................................................................... 116

Customer Adjustment ............................................................................................................................................... 117

Customer Ageing ....................................................................................................................................................... 117

Customer Category ................................................................................................................................................... 117

Customer Additional Contact Detail ......................................................................................................................... 118

Customer Commercial Document ............................................................................................................................. 118

Customer Note .......................................................................................................................................................... 119

Customer Opening Balances ..................................................................................................................................... 120

Customer Receipt ...................................................................................................................................................... 120

Customer Return ....................................................................................................................................................... 120

Customer Sales History ............................................................................................................................................. 121

Customer Statement ................................................................................................................................................. 122

Customer Statement Line ......................................................................................................................................... 122

Customer Take-On Balance ....................................................................................................................................... 123

Documentline Dashboard Object.............................................................................................................................. 124


Page 10 of 157

Document Message .................................................................................................................................................. 124

Document Number ................................................................................................................................................... 124

Financial Year ............................................................................................................................................................ 124

Generic Category ...................................................................................................................................................... 125

Generic Note ............................................................................................................................................................. 125

IDateModel ............................................................................................................................................................... 125

Income VS Expense ................................................................................................................................................... 125

IncomeVsExpensesPeriodGrouping .......................................................................................................................... 125

Item ........................................................................................................................................................................... 126

Item Category ............................................................................................................................................................ 126

Item Note .................................................................................................................................................................. 126

Item Opening Balance ............................................................................................................................................... 127

Item Report Group .................................................................................................................................................... 127

Item Take-On Balances ............................................................................................................................................. 127

Journal Entry ............................................................................................................................................................. 128

ListWithAccountReportingValues ............................................................................................................................. 129

ListWithReportingPeriods ......................................................................................................................................... 129

OpeningBalance ........................................................................................................................................................ 129

PaidUserReferral ....................................................................................................................................................... 129

PeriodGrouping ......................................................................................................................................................... 129

ProfitAndLossReportingLevel .................................................................................................................................... 130

ProvisionalTaxAdjustment ........................................................................................................................................ 130

PurchaseOrder .......................................................................................................................................................... 130

Quote ........................................................................................................................................................................ 131

ReportingGroup ........................................................................................................................................................ 132

ReportingLevel .......................................................................................................................................................... 132

ReportingPeriod ........................................................................................................................................................ 132

Reseller ...................................................................................................................................................................... 133

ResellerProductBundle ............................................................................................................................................. 133

SalesBySalesRepresentative ...................................................................................................................................... 133

SalesRepresentative .................................................................................................................................................. 134

SalesRepresentativeNote .......................................................................................................................................... 134

SecretarialCompanyRole ........................................................................................................................................... 134

SecretarialShareCapitalIssued................................................................................................................................... 134

Secretarial ShareClass ............................................................................................................................................... 135


Page 11 of 157

Secretarial ShareHolder ............................................................................................................................................ 135

Secretarial StakeHolder ............................................................................................................................................ 136

Secretarial StakeHolderNote .................................................................................................................................... 137

Secretarial StakeHolderRole ..................................................................................................................................... 137

StatementOfAssetsAndLiabilitiesReportingLevel ..................................................................................................... 138

StorageInformation ................................................................................................................................................... 138

Supplier ..................................................................................................................................................................... 138

Supplier Adjustments ................................................................................................................................................ 139

Supplier Ageing ......................................................................................................................................................... 139

Supplier Category ...................................................................................................................................................... 140

Supplier Commercial Document ............................................................................................................................... 140

Supplier Invoice ......................................................................................................................................................... 141

Supplier Note ............................................................................................................................................................ 142

Supplier Opening Balance ......................................................................................................................................... 142

Supplier Payment ...................................................................................................................................................... 142

Supplier Purchase History ......................................................................................................................................... 143

Supplier Return ......................................................................................................................................................... 143

Supplier Statement ................................................................................................................................................... 144

SupplierStatementLine.............................................................................................................................................. 144

SupplierTakeOnBalance ............................................................................................................................................ 145

SystemAccount ......................................................................................................................................................... 146

SystemAccountReportingGroup ............................................................................................................................... 146

TakeOnAccountBalance ............................................................................................................................................ 146

TakeOnAccountDetail ............................................................................................................................................... 146

TakeOnAccountGroup ............................................................................................................................................... 147

TaxAdjustment .......................................................................................................................................................... 147

TaxInvoice ................................................................................................................................................................. 147

Tax Type .................................................................................................................................................................... 148

ToDoListItem ............................................................................................................................................................. 148

Top Customer By Sales .............................................................................................................................................. 149

Top Purchased Item .................................................................................................................................................. 149

Top Selling Item......................................................................................................................................................... 149

Top Selling Item By Value On Hand .......................................................................................................................... 149

TopSuppliersByPurchases ......................................................................................................................................... 149

Transaction ................................................................................................................................................................ 149


Page 12 of 157

TrialBalance ............................................................................................................................................................... 150

TrialBalanceData ....................................................................................................................................................... 150

TrialBalanceReportingLevel ...................................................................................................................................... 150

VAT201Data .............................................................................................................................................................. 151

Request Models ........................................................................................................................................................ 152

AccountantNoteDueInDateRangeRequestModel ................................................................................................. 152

AccountantNoteRequestModel ............................................................................................................................ 152

AuthenticationCredentials .................................................................................................................................... 152

BalanceSheetRequestModel ................................................................................................................................. 152

BudgetFromHistoricDataRequestModel ............................................................................................................... 152

BudgetRequestModel ........................................................................................................................................... 152

CashMovementRequestModel ............................................................................................................................. 152

ComparativeProfitAndLossStatementRequest ..................................................................................................... 153

ComparitiveStatementOfAssetsAndLiabilitiesRequestModel .............................................................................. 153

CustomerAgeingRequestModel ............................................................................................................................ 153

CustomerSalesHistoryRequestModel ................................................................................................................... 153

CustomerStatementRequestModel ...................................................................................................................... 153

DateRange ............................................................................................................................................................. 154

DocumentLineDashboardRequestModel .............................................................................................................. 154

EmailRequestModel .............................................................................................................................................. 154

IncomeVsExpenseRequestModel.......................................................................................................................... 154

ProfitAndLossStatementRequestModel ............................................................................................................... 154

QuickEnquiryOverviewDetailsRequestModel ....................................................................................................... 155

SalesBySalesRepresentativeRequestModel .......................................................................................................... 155

StatementOfAssetsAndLiabilitiesRequestModel .................................................................................................. 155

SupplierAgeingRequestModel .............................................................................................................................. 155

SupplierPurchaseHistoryRequestModel ............................................................................................................... 155

SupplierStatementRequestModel ........................................................................................................................ 156

TopCustomersBySalesRequestModel ................................................................................................................... 156

TopCustomersByOutstandingBalanceRequestModel ........................................................................................... 156

TopPurchasedItemRequestModel ........................................................................................................................ 156

TopSellingItemRequestModel ............................................................................................................................... 157

TopSellingItemByValueOnHandRequestModel .................................................................................................... 157

TopSuppliersByPurchasesRequestModel ............................................................................................................. 157

TopSuppliersByOutstandingBalanceRequestModel ............................................................................................. 157


Page 13 of 157

TrialBalanceRequestModel ................................................................................................................................... 157

VAT201ReportRequestModel ............................................................................................................................... 157


Page 14 of 157

Overview Sage One supports a RESTful API with limited OData support.

Formats Current supported format is JSON, however future support of XML is planned.

URL Structure The service URLs are built up as follows:

[API URL]/api/[ver]/[service name]/[method name]/[ID (when required)]?[required query string parameters]

Current Host Url: https://www.accounting.sageone.co.za/API/1.0.1

Current Version: 1.0.1

All Calls require the APIKey to be included as a query string parameter. This key will be issued by Pastel.

Any functions dealing with company specific data require the companyid parameter.

Company Get List Example:

http://[API URL]/api/1.0.1/Company/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Individual Company Get Example:

http://[API URL]/api/1.0.1/Company/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Individual Customer Get Example:

http://[API URL]/api/1.0.1/Customer/get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=1

https://www.accounting.sageone.co.za/API/1.0.1


Page 15 of 157

Response Codes + Error Handling All calls to the service will return an HTTP Status code and any other relevant data will be in the Body of the

response.

HTTP Code Description Occurs When:

200 OK Everything performs as expected.

201 Created A new entity has been created.

400 Bad Request A malformed request was sent through or when a validation rule failed. Validation messages will be returned in the response body.

401 Unauthorized The user is not correctly authenticated and the call requires authentication. The user does not have access rights for this method.

404 Not Found The requested entity was not found. Entities are bound to companys. Ensure the entity belongs to the company.

405 Method Not Allowed HTTP Verb is not specified or incorrect verb is used. Or The user does not have access to the specified method. This applies to invited users.

409 Conflict When attempting to delete an item that is currently in use.

500 Internal Sever Error A server side error occurred.

The reason phrase on the response message will clearly detail the error in plain text terms.

Should you require assistance on resolving an error but are unable to do so, the response headers contains a header

with the name LOGUID. By providing this value to our support staff, they will be able to supply additional details

regarding the error.


Page 16 of 157

Authentication This API uses basic webforms authentication. To authenticate a user prior to calling a method, you will need to add a

standard HTTP authorization header to the request.

This will require the username and password, separated by a colon(:) and Base64 encoded.

Here is an example:

Username: [email protected]

Password: #FictitiousPassword123

Authorization header: Basic

ZmljdGl0aW91cy5hY2NvdW50QGZpY3RpdGlvdXNkb21haW4uY28sOiNGaWN0aXRpb3VzUGFzc3dvcmQxMjM=


Page 17 of 157

Methods Overview

Save Methods The save method requires that the request body contains the entity in JSON (XML is not currently supported).

Once validation has been completed, and the entity have been saved, the entity is returned and the new location url

is specified as a response header.

Get Methods Result limit of 100 applies to all queryable methods.

Get() method calls support a subset of the OData protocol.

Supported functions are listed below.

Query string

parameter

Description Example

$filter Selects entries that match a Boolean

expression.

http://[API

URL]/api/[ver]/products?$filter=substringof(Name,

'Ed') eq true

$orderby Orders the results by the specified

property.

http://[API URL]/api/[ver]/products?$orderby=Name

$skip Skips the first n elements. http://[API URL]/api/[ver]/products?$skip=2

$top Returns the first n elements in the list.

If combined with $orderby, the list is

sorted first, and the first nelements of

the sorted list are returned.

http://[API URL]/api/[ver]/products?$top=5

For example, the following Url returns the first three products, ordered by name: http://[API URL]/api/[ver]/products?$top=3&$orderby=Name

NOTE: Filter and Orderby will not work for string values of any kind. Specific methods are exposed to allow querying on string values where applicable.

Pagination

All arrays of objects that get returned are wrapped with the total count for the relevant query and the number of

returned results in the current call.

The Get methods support pagination by using the skip and top key works in the url. If no default order clause is

specified, you will need to provide one.

Examples of call where you supply the sort order:

http://[API URL]/api/[ver]/customer/Get?$skip=2&$top=20&$orderby=ID&apikey=39478ac6-ac2a-44d8-a31c-

7e7e14af4de3& companyid=1

http://[API URL]/api/[ver]/customer/Get?$skip=40&$top=2&$orderby=ID&apikey=39478ac6-ac2a-44d8-a31c-

7e7e14af4de3& companyid=1

Examples of call without the sort order:

http://localhost:9000/api/%5bver%5d/products?$top=3&$orderby=Name


Page 18 of 157

http://[API URL]/api/[ver]/transaction/Get?$skip=2&$top=20&apikey=39478ac6-ac2a-44d8-a31c-7e7e14af4de3&

companyid=1

http://[API URL]/api/[ver]/Customers/Get?$skip=40&$top=2&apikey=39478ac6-ac2a-44d8-a31c-

7e7e14af4de3&companyid=1

Delete Methods Delete operation will only be allowed if no other item/entity or transaction is making use of the item trying to be

deleted.


Page 19 of 157

Services

Account Service

Get Individual

Item Description

Function Get(int Id )

Description Gets an Account for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes

Company Required Yes

Parameters URL Parameter. ID (Integer)

Return Type Account

Example URL http://[API URL]/api/[ver]/Account/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Accounts for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Accounts

Example URL http://[API URL]/api/[ver]/Account/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List with System Accounts

Item Description

Function GetWithSystemAccounts()

Description Gets a list of Accounts for this company including system accounts. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Accounts

Example URL http://[API URL]/api/[ver]/Account/GetWithSystemAccounts?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 20 of 157

Save

Item Description

Function Save

Description Saves or Updates an account. If the ID is not set or is 0, the account is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ID: 1, Category: AccountCategory Object, Active: true, Balance: 1000.00, Description: “Random Account”, ReportingGroupId: 1 }

Return Type Saved account with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/account/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Account Category Service

Get Individual

Item Description


Description Gets a Account Category for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type AccountCategory

Example URL http://[API URL]/api/[ver]/AccountCategory/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Account Categories for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Page 21 of 157


Parameters None

Return Type Array of Account Categories

Example URL http://[API URL]/api/[ver]/AccountCategory/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates an account category. If the ID is not set or is 0, the account category is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { Description: "Sales", ID: 1 }

Return Type Saved account category with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/accountcategory/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description

Function Delete(int Id)

Description Deletes the account category with this ID if no accounts have this category set.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Account Category ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/accountcategory/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 22 of 157

Account Note Service

Get Individual

Item Description


Description Gets an Account Note for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type AccountNote

Example URL http://[API URL]/api/[ver]/AccountNote/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Account Notes for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Account Notes

Example URL http://[API URL]/api/[ver]/AccountNote/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Account Payment Service

Get List

Item Description

Function Get()

Description Gets a list of Account Payments for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Account Payments

Example URL http://[API URL]/api/[ver]/accountpayment/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 23 of 157

Save

Item Description

Function Save

Description Saves or Updates an account payment. If the ID is not set or is 0, the account payment is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { AccountId: 49710, ID: 131, Description: "Account Payment description", Date: "2013-11-14T00:00:00", Reference: "REF001", TaxTypeId: 1, Comments: "Account Payment - Accounting Fees”, Exclusive: 200.00, Tax: 28.00, Total: 228.00, Reconciled: false, BankAccountId: 2101 }

Return Type Saved account payment with a valid ID.

Example URL http://[API URL]/api/[ver]/accountpayment/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Account Receipt Service

Get List

Item Description

Function Get()

Description Gets a list of Account Receipts for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Account Receipts

Example URL http://[API URL]/api/[ver]/accountreceipt /Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save


Page 24 of 157

Description Saves or Updates an account receipt. If the ID is not set or is 0, the account payment is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { AccountId: 49710, ID: 131, Description: "Account Receipt description", Date: "2013-11-14T00:00:00", Reference: "REF001", TaxTypeId: 1, Comments: "Account Receipt - Accounting Fees”, Exclusive: 200.00, Tax: 28.00, Total: 228.00, Reconciled: false, BankAccountId: 2101 }

Return Type Saved account receipt with a valid ID.

Example URL http://[API URL]/api/[ver]/accountreceipt/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 25 of 157

Account Note Attachment Service This service functions based on the Attachment Service, except that the [objectType] needs to be substituted with

the corresponding service name. Please refer to the Attachment Service documentation.

Attachment Service

Get List of files for an Attachment

Item Description


Description Gets a list of all the file attached to the [objectType]

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters URL Parameter. [objectType] ID (Integer)

Return Type List of Files attached { Name: "Chrysanthemum.jpg", Size: 879394, AttachmentUID: "ecd67dc0-580a-4bad-96e0-1cd9739f2a00" }

Example URL http://[API URL]/api/[ver]/[objectType]Attachment/Get/1 ?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&companyid=1234

Get a File

Item Description

Function Get(UID fileUID )

Description Downloads the file with the specified UID

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters URL Parameter. File UID (UID)

Return Type Returns a Byte[] in the HTTPMessageBody

Example URL http://[API URL]/api/[ver]/[objectType]Attachment/Get/ ecd67dc0-580a-4bad-96e0-1cd9739f2a00 ?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&companyid=1234


Page 26 of 157

Upload Attachment

Item Description

Function Save()

Description Uploads an attachment to the service. This is done using an http multipart form data post, with additional form data.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Form data. [objectType]Id

Return Type Attachment Object

Example URL http://[API URL]/api/[ver]/ [objectType]Attachment/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&companyid=1234

Post example

<form id="fileupload" action=" http://[API URL]/api/[ver]/ [objectType]Attachment/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&companyid=1234" method="POST" enctype="multipart/form-data"> <input type="file" name="files[]" multiple="" /> <input type="hidden" name="[objectType]Id" value="56418" /> <input type="submit" /> </form>

Get Company storage

Item Description

Function GetCompanyStorageInformation ()

Description Gets the Used and Allowed storage for the company in bytes.

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Returns a StorageInformation object

Example URL http://[API URL]/api/[ver]/Attachment/ GetCompanyStorageInformation?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&companyid=1234


Page 27 of 157

Delete Attachment

Item Description

Function Delete (UID)

Description Deletes the specified File Attachment

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters None

Return Type None

Example URL http://[API URL]/api/[ver]/[objectType]Attachment/ Delete/ ecd67dc0-580a-4bad-96e0-1cd9739f2a00?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&companyid=1234

Asset Service

Get Individual

Item Description

Function Get(int assetId)

Description Gets an asset for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Asset

Example URL http://[API URL]/api/[ver]/asset/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of asset for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Asset

Example URL http://[API URL]/api/[ver]/asset/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 28 of 157

Save

Item Description

Function Save

Description Saves or Updates an asset account. If the ID is not set or is 0, the asset is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { Description: "Volkswagen Golf", AssetCategoryId: 3755, AssetLocationId: 234, DatePurchased: "2008-08-16T00:00:00", SerialNumber: "", BoughtFrom: "", ID: 5845 }

Return Type Saved asset with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/asset/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description

Function Delete(int assetId)

Description Deletes the asset with this ID if no transactions took place with this Asset. It also deletes all associated Notes.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Asset ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/asset/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 29 of 157

Asset Category Service

Get Individual

Item Description


Description Gets an Asset Category for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type AssetCategory

Example URL http://[API URL]/api/[ver]/AssetCategory/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Asset Categories for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Asset Categories

Example URL http://[API URL]/api/[ver]/AssetCategory/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates an asset category. If the ID is not set or is 0, the asset category is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { Description: "Vehicle", ID: 3755 }

Return Type Saved asset category with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/assetcategory/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 30 of 157

Delete

Item Description


Description Deletes the asset category with this ID if no assets have this category set.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Asset Category ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/assetcategory/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Asset Note Service

Get Individual

Item Description


Description Gets an Asset Note for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type AssetNote

Example URL http://[API URL]/api/[ver]/AssetNote/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Asset Notes for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Asset Notes

Example URL http://[API URL]/api/[ver]/AssetNote/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 31 of 157

Save

Item Description

Function Save

Description Saves or Updates an Asset note. If the ID is not set or is 0, the Asset note is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { AssetId: 5554, ID: 131, Subject: "Asset Subject", EntryDate: "2012-11-14T00:00:00", ActionDate: "2012-11-14T02:00:00", Status: false, Note: "Asset Note - With Attachment", HasAttachment: true }

Return Type Saved account note with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/assetnote/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the asset note with this ID together with all associated attachments.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Asset Note ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/assetnote/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 32 of 157

Asset Note Attachment Service This service functions based on the Attachment Service, except that the [objectType] needs to be substituted with


Asset Location Service

Get Individual

Item Description


Description Gets an Asset Location for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type AssetLocation

Example URL http://[API URL]/api/[ver]/AssetLocation/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Asset Locations for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Asset Categories

Example URL http://[API URL]/api/[ver]/AssetCategory/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates an Asset location. If the ID is not set or is 0, the Asset location is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ID: 2234, AssetLocationId: 2231, Description: "Plant Site A", }


Page 33 of 157

Return Type Saved asset location with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/assetlocation/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the asset location with this ID.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Asset location ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/assetlocation/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Bank Account Service

Get Individual

Item Description

Function Get(int bankaccountId)

Description Gets a bankaccount for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type BankAccount

Example URL http://[API URL]/api/[ver]/bankaccount/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of bankaccounts for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of BankAccounts

Example URL http://[API URL]/api/[ver]/bankaccount/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 34 of 157

Save

Item Description

Function Save

Description Saves or Updates a bank account. If the ID is not set or is 0, the bank account is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { Name: "Absa", BankName: "Absa", AccountNumber: "4445569879", BranchName: "Rivonia", BranchNumber: "66154", Category: BankAccountCategory Object, Active: true, Default: false, Description: "It’s my favourite bank" }

Return Type Saved Bank Account with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/bankaccount/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description

Function Delete(int bankaccountId)

Description Deletes the bankaccount with this ID if no transactions took place with this Bank Account. It also deletes all associated Notes.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Bank Account ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/bankaccount/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Validate

Item Description

Function Validate(int bankaccountId)

Description Validates a bank account based on certain criterias

Http Verb POST

APIKey Required Yes

Login Required Yes



Page 35 of 157

Parameters Request Body. JSON Object: { Name: "Absa", BankName: "Absa", AccountNumber: "4445569879", BranchName: "Rivonia", BranchNumber: "66154", Category: BankAccountCategory Object, Active: true, Default: false, Description: "It’s my favourite bank" }

Return Type None

Example URL http://[API URL]/api/[ver]/bankaccount/Validate?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 36 of 157

Bank Account Category Service

Get Individual

Item Description

Function Get(int bankaccountcategoryId )

Description Gets a Bank Account Category for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Bank Account Category

Example URL http://[API URL]/api/[ver]/BankAccountCategory/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Bank Account categories for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Bank Account Categories

Example URL http://[API URL]/api/[ver]/BankAccountCategory/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a bank account category. If the ID is not set or is 0, the bank account category is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { Description: "Cash Accounts", ID: 1 }


Page 37 of 157

Return Type Saved bank account category with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/bankaccountcategory/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the bank account category with this ID if no bank accounts have this category set.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Bank Account Category ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/bankaccountcategory/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Bank Account Note Service

Get Individual

Item Description


Description Gets a Bank Account Note for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type BankAccountNote

Example URL http://[API URL]/api/[ver]/BankAccountNote/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Bank Account Notes for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Bank Account Notes

Example URL http://[API URL]/api/[ver]/BankAccountNote/Get?apikey={39478ac6-


Page 38 of 157

ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a Bank Account note. If the ID is not set or is 0, the Bank Account note is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { BankAccountId: 5554, ID: 131, Subject: "Bank Account Subject", EntryDate: "2012-11-14T00:00:00", ActionDate: "2012-11-14T02:00:00", Status: false, Note: "Bank Account Note - With Attachment" HasAttachments: false, }

Return Type Saved bank account note with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/bankaccountnote/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the bank account note with this ID together with all associated attachments.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Bank Account Note ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/bankaccountnote/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Bank Account Note Attachment Service This service functions based on the Attachment Service, except that the [objectType] needs to be substituted with



Page 39 of 157

Budget Service

Get Individual

Item Description


Description Gets a Budget for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Budget

Example URL http://[API URL]/api/[ver]/Budget/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Budgets for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Budget

Example URL http://[API URL]/api/[ver]/ Budget/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a Budget. If the ID is not set or is 0, the Bank Account note is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ID: 209, Description: "2013 - 2014 Budget", BudgetItems: [ { ID: 5012, Account: { ID: -1, ReportingLevelType: 4,


Page 40 of 157

Name: Sales, Category: { Comment: "Non-item based sales.", Description: "Sales", ID: 1 } }, BudgetItemPeriods: [ { ID: 51105, Date: "2013-03-01T00:00:00Z", Total: 20000 }, { ID: 51106, Date: "2013-04-01T00:00:00Z", Total: 20000 } ], Total: 240000, AccountTypeId: 4 } ], NumberOfPeriods: 2 }

Return Type Saved budget with a valid ID.

Example URL http://[API URL]/api/[ver]/budget/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the budget with this ID.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Budget ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/budget/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

GetDefaultBudget

Item Description

Function GetDefaultBudget (BudgetRequestModel request)

Description Gets a new budget with the NumberOfPeriods and StartDate defined by the BudgetRequestModel

Http Verb POST

APIKey Required Yes


Page 41 of 157

Login Required Yes


Parameters BudgetRequestModel request

Return Type New budget

Example URL http://[API URL]/api/[ver]/budget/BudgetRequestModel /1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

GetBudgetReport

Item Description

Function GetBudgetReport (BudgetRequestModel request)

Description Gets BudgetReport for the specified Budget ID

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters Budget ID (Integer) RemoveZeroValues (bool)

Return Type Comparative Profit & Loss Statement

Example URL http://[API URL]/api/[ver]/budget/GetBudgetReport?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Validate

Item Description

Function Validate()

Description Validates a budget based on certain criteria

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. Request Body. JSON Object: { ID: 209, Description: "2013 - 2014 Budget", BudgetItems: [ { ID: 5012, Account: { ID: -1, ReportingLevelType: 4, Name: Sales, Category: { Comment: "Non-item based sales.", Description: "Sales",


Page 42 of 157

ID: 1 } }, BudgetItemPeriods: [ { ID: 51105, Date: "2013-03-01T00:00:00Z", Total: 20000 }, { ID: 51106, Date: "2013-04-01T00:00:00Z", Total: 20000 } ], Total: 240000, AccountTypeId: 4 } ], NumberOfPeriods: 2 }

Return Type None

Example URL http://[API URL]/api/[ver]/budget/Validate?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Cash Movement Service

Get List

Item Description

Function Get(CashMovementRequestModel request)

Description Gets a list of CashMovements for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb POST

APIKey Required Yes

Login Required Yes

Company Required No

Parameters CashMovementRequestModel request

Return Type Array of CashMovements

Example URL http://[API URL]/api/[ver]/CashMovement/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Company Service

Get Individual

Item Description

Function Get(int companyId)

Description Gets a company, with the provided ID.

Http Verb GET


Page 43 of 157

APIKey Required Yes

Login Required Yes

Company Required No


Return Type Company

Example URL http://[API URL]/api/[ver]/Company/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Get List

Item Description

Function Get()

Description Gets a list of Companies for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb GET

APIKey Required Yes

Login Required Yes

Company Required No

Parameters None

Return Type Array of Companies

Example URL http://[API URL]/api/[ver]/Company/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}


Page 44 of 157

Company Note Service

Get Individual

Item Description


Description Gets a Company Note for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type CompanyNote

Example URL http://[API URL]/api/[ver]/CompanyNote/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Company Notes for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Company Notes

Example URL http://[API URL]/api/[ver]/CompanyNote/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 45 of 157

Save

Item Description

Function Save

Description Saves or Updates a Company note. If the ID is not set or is 0, the Company note is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ID: 131, Subject: "Company Note Subject", EntryDate: "2012-11-14T00:00:00", ActionDate: "2012-11-14T02:00:00", Status: true, Note: "Company Note " }

Return Type Saved company note with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/companynote/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the company note with this ID if no companies have this note set.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Company Note ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/companynote/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Company Note Attachment Service This service functions based on the Attachment Service, except that the [objectType] needs to be substituted with


Comparative Profit And Loss Statement Service

Get

Item Description

Function Get()

Description Gets the Comparative Profit and Loss Statement Report Data

Http Verb Post


Page 46 of 157

APIKey Required

Yes

Login Required Yes

Company Required

Yes

Parameters ComparativeProfitAndLossStatementRequest

Return Type ComparativeProfitAndLossStatement

Example URL http://[API URL]/api/[ver]/ComparativeProfitAndLossStatement/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Comparative Statement of Assets and Liabilities Service

Get

Item Description

Function Get()

Description Gets the Comparative Statement of Assets and Liabilities Report Data

Http Verb Post

APIKey Required Yes

Login Required Yes

Company Required

Yes

Parameters ComparitiveStatementOfAssetsAndLiabilitiesRequest

Return Type ComparativeStatementOfAssetsAndLiabilities

Example URL http://[API URL]/api/[ver]/ComparativeStatementOfAssetsAndLiabilities/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 47 of 157

Customer Service

Get Individual

Item Description

Function Get(int customerId)

Description Gets a customer for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Customer

Example URL http://[API URL]/api/[ver]/Customer/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of customers for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Customers

Example URL http://[API URL]/api/[ver]/Customer/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 48 of 157

Save

Item Description

Function Save

Description Saves or Updates a customer account. If the ID is not set or is 0, the customer is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { Name: "Mountain Goats", TaxReference: "", ContactName: "Jenny Smith", Telephone: "+27 21 555-3039", Fax: "+27 21 555-2298", Mobile: "", Email: "[email protected]", WebAddress: "www.jenniesagoat.co.za", Active: true, Balance: 0, CreditLimit: 0, CommunicationMethod: 1, CreditLimit: 0, TotalUnallocated: 1034.75, PostalAddress01: "15", PostalAddress02: "Beach", PostalAddress03: "Street", PostalAddress04: "Dover", PostalAddress05: "4578", DeliveryAddress01: "Physical Address 90", DeliveryAddress02: "Olieven", DeliveryAddress03: "Houts", DeliveryAddress04: "Bosch", DeliveryAddress05: "1177", EnableCustomerZone: false, ID: 0 }

Return Type Saved Customer valid ID and with location of new object in the response header.

Example URL http://[API URL]/api/[ver]/Customer/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 49 of 157

Delete

Item Description

Function Delete(int customerId)

Description Deletes the customer with this ID if no transactions took place with this Customer. It also deletes all associated Notes.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Customer ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/Customer/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 50 of 157

Customer Category Service

Get Individual

Item Description

Function Get(int Customer Category Id )

Description Gets a Customer Category for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Customer Category

Example URL http://[API URL]/api/[ver]/CustomerCategory/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Customer categories for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Customer Categories

Example URL http://[API URL]/api/[ver]/CustomerCategory/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a customer category. If the ID is not set or is 0, the customer category is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { Description: "Favourite", ID: 1 }

Return Type Saved customer category with a valid ID and with the location of the new object in the response header.


Page 51 of 157

Example URL http://[API URL]/api/[ver]/customercategory/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the customer category with this ID if no customers have this category set.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Customer Category ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/customercategory/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Customer Additional Contact Detail Service

Get Individual

Item Description

Function Get(int Id)

Description Gets a Customer’s additional contact detail for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Customer Additional Contact Detail

Example URL http://[API URL]/api/[ver]/ CustomerAdditionalContactDetail /Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Customer additional contact details for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Customer Categories

Example URL http://[API URL]/api/[ver]/ CustomerAdditionalContactDetail /Get?apikey={39478ac6-ac2a-44d8-a31c-


Page 52 of 157

7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a customer category. If the ID is not set or is 0, the customer category is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes



Return Type Saved customer category with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/customercategory/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the customer category with this ID if no customers have this category set.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Customer Category ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/customercategory/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Customer Receipt Service

Get List

Item Description

Function Get()

Description Gets a list of Customer Receipt for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes


Page 53 of 157

Login Required Yes


Parameters None

Return Type Array of Customer Receipts

Example URL http://[API URL]/api/[ver]/CustomerReceipt/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Customer Return Service

Get Individual

Item Description


Description Gets a Customer Return for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type CustomerReturn

Example URL http://[API URL]/api/[ver]/CustomerReturn/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Customer Returns for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Customer Returns

Example URL http://[API URL]/api/[ver]/CustomerReturn/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 54 of 157

Customer Note Service

Get Individual

Item Description


Description Gets a Customer Note for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type CustomerNote

Example URL http://[API URL]/api/[ver]/CustomerNote/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Customer Notes for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Customer Notes

Example URL http://[API URL]/api/[ver]/CustomerNote/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 55 of 157

Save

Item Description

Function Save

Description Saves or Updates a Customer note. If the ID is not set or is 0, the Customer note is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { CustomerId: 5554, ID: 131, Subject: "Customer Subject", EntryDate: "2012-11-14T00:00:00", ActionDate: "2012-11-14T02:00:00", Status: false, Note: "Customer Note - With Attachment" }

Return Type Saved customer note with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/customernote/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the customer note with this ID together with all associated attachments.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Customer Note ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/customernote/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 56 of 157

Customer Note Attachment Service This service functions based on the Attachment Service, except that the [objectType] needs to be substituted with


Customer Ageing Service

Get List

Item Description

Function GetList(CustomerAgeingRequestModel request)

Description Gets a list of CustomerAgeings for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb POST

APIKey Required Yes

Login Required Yes

Company Required No

Parameters CustomerAgeingRequestModel request

Return Type Array of CustomerAgeings

Example URL http://[API URL]/api/[ver]/customerageing/GetList?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Get Individual

Item Description

Function Get(CustomerAgeingRequestModel request)

Description Gets a list of CustomerAgeings for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb POST

APIKey Required Yes

Login Required Yes

Company Required No

Parameters CustomerAgeingRequestModel request

Return Type CustomerAgeing

Example URL http://[API URL]/api/[ver]/customerageing/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Customer Sales History Service

Get List

Item Description

Function Get(CustomerSalesHistoryRequestModel request)

Description Gets a list of CustomerSalesHistory for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb POST

APIKey Required Yes

Login Required Yes

Company Required No

Parameters CustomerSalesHistoryRequestModel request

Return Type Array of CustomerSalesHistory

Example URL http://[API


Page 57 of 157

URL]/api/[ver]/customersaleshistory/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Customer Statement Service

Get List

Item Description

Function Get(CustomerStatementRequestModel request)

Description Gets a list of CustomerStatement for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb POST

APIKey Required Yes

Login Required Yes

Company Required No

Parameters CustomerStatementRequestModel request

Return Type Array of CustomerStatement

Example URL http://[API URL]/api/[ver]/CustomerStatement/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Financial Year Service

Get Individual

Item Description


Description Gets a Financial Year for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Financial Year

Example URL http://[API URL]/api/[ver]/FinancialYear/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of financial years for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Financial Years

Example URL http://[API URL]/api/[ver]/FinancialYear/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 58 of 157

Get Current

Item Description

Function GetCurrent()

Description Gets the current Financial Year for this company

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Financial Year

Example URL http://[API URL]/api/[ver]/FinancialYear/GetCurrent?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Income VS Expense Service

Get List

Item Description

Function Get(IncomeVSExpenseRequestModel request)

Description Gets a list of IncomeVSExpense for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb POST

APIKey Required Yes

Login Required Yes

Company Required No

Parameters IncomeVSExpenseRequestModel request

Return Type Array of IncomeVSExpense

Example URL http://[API URL]/api/[ver]/IncomeVSExpense/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Item Service

Get Individual

Item Description

Function Get(int itemId)

Description Gets an item for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes




Example URL http://[API URL]/api/[ver]/Item/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 59 of 157

Get List

Item Description

Function Get()

Description Gets a list of items for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Items

Example URL http://[API URL]/api/[ver]/Item/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 60 of 157

Save

Item Description

Function Save

Description Saves or Updates an item. If the ID is not set or is 0, the item is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { Description: "A Proper Item", Code: “PRP001”, Active: true, PriceInclusive: 228, PriceExclusive: 200, Physical: true, TaxTypeIdSales: 7157, TaxTypeIdPurchases: 7157, LastCost: 10121, AverageCost: 10121, QuantityOnHand: 493, TotalQuantity: 10, TotalCost: 4930, Unit: “Something per Kilo”, ID: 49866 }

Return Type Saved Item with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/Item/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 61 of 157

Delete

Item Description

Function Delete(int itemId)

Description Deletes the item with this ID if no transactions took place with this Item. It also deletes all associated Notes.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Item ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/Item/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 62 of 157

Item Category Service

Get Individual

Item Description

Function Get(int itemCategoryId )

Description Gets a Item Category for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Item Category

Example URL http://[API URL]/api/[ver]/ItemCategory/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Item categories for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Item Categories

Example URL http://[API URL]/api/[ver]/ItemCategory/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates an item category. If the ID is not set or is 0, the item category is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes



Return Type Saved item category with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/itemcategory/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 63 of 157

Delete

Item Description


Description Deletes the item category with this ID if no items have this category set.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Item Category ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/itemcategory/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Item Note Service

Get Individual

Item Description


Description Gets an Item Note for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type ItemNote

Example URL http://[API URL]/api/[ver]/ItemNote/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Item Notes for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Item Notes

Example URL http://[API URL]/api/[ver]/ItemNote/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 64 of 157

Save

Item Description

Function Save

Description Saves or Updates an Item note. If the ID is not set or is 0, the Item note is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ItemId: 5554, ID: 131, Subject: "Item Subject", EntryDate: "2012-11-14T00:00:00", ActionDate: "2012-11-14T02:00:00", Status: false, Note: "Item Note - With Attachment" }

Return Type Saved item note with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/itemnote/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the item note with this ID together with all associated attachments.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Item Note ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/itemnote/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Item Note Attachment Service This service functions based on the Attachment Service, except that the [objectType] needs to be substituted with


Journal Entry Service

Get List

Item Description


Page 65 of 157

Function Get()

Description Gets a list of Journal Entries for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb GET

APIKey Required Yes

Login Required Yes

Company Required No

Parameters None

Return Type Array of JournalEntry objects

Example URL http://[API URL]/api/[ver]/journalentry/GetList?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Get Individual

Item Description


Description Gets a Journal Entry for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type JournalEntry

Example URL http://[API URL]/api/[ver]/journalentry /Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a journal entry. If the ID is not set or is 0, the journal entry is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ID: 131, Date: "2013-11-14T00:00:00", Effect: 1 AccountId: 49710, Reference: "REF001", Description: "Account Payment description", TaxTypeId: 1, Exclusive: 200.00, Tax: 28.00, Total: 228.00, ContraAccountId: 45, Memo: "Account Settled - Insurance”,


Page 66 of 157

HasAttachments: false, AnalysisCategory1: 37, AnalysisCategory2: 201, AnalysisCategory3: 45 }

Return Type Saved a journal entry with a valid ID.

Example URL http://[API URL]/api/[ver]/journalentry/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

SaveBatch

Item Description

Function SaveBatch

Description Saves or Updates journal entries in a batch. If the ID is not set or is 0, the journal entry is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { journalEntries: [{ ID: 0, Date: "2013-11-14T00:00:00", Effect: 1 AccountId: 49710, Reference: "REF001", Description: "Account Payment description", TaxTypeId: 1, Exclusive: 200.00, Tax: 28.00, Total: 228.00, ContraAccountId: 45, Memo: "Account Settled - Insurance”, HasAttachments: false, AnalysisCategory1: 37, AnalysisCategory2: 201, AnalysisCategory3: 45 } ] }

Return Type List of saved journal entries with a valid IDs.

Example URL http://[API URL]/api/[ver]/journalentry/SaveBatch?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Calculate

Item Description

Function Calculate()

Description Calculates the totals for the document based on the lines

Http Verb POST


Page 67 of 157

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ID: 131, Date: "2013-11-14T00:00:00", Effect: 1 AccountId: 49710, Reference: "REF001", Description: "Account Payment description", TaxTypeId: 1, Exclusive: 200.00, Tax: 28.00, Total: 228.00, ContraAccountId: 45, Memo: "Account Settled - Insurance”, HasAttachments: false, AnalysisCategory1: 37, AnalysisCategory2: 201, AnalysisCategory3: 45 }

Return Type Journal Entry with calculated total values

Example URL http://[API URL]/api/[ver]/journalentry/Calculate?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Purchase Order Service

Get Individual

Item Description


Description Gets a Purchase Order for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type PurchaseOrder

Example URL http://[API URL]/api/[ver]/PurchaseOrder/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Purchase Orders for this company. Subset of OData supported. Skip, Top, Orderby and Filter


Page 68 of 157

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of PurchaseOrder

Example URL http://[API URL]/api/[ver]/PurchaseOrder/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a Purchase Order. If the ID is not set or is 0, the Quote is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ExpiryDate: "2012-04-30T00:00:00", SupplierId: 83, Date: "2012-04-08T00:00:00", Inclusive: false, DiscountPercentage: 0, TaxReference: "", DocumentNumber: "SPO0000001", Reference: "465", Message: “Random Message”, Discount: 0, Exclusive: 8000, Tax: 1120, Rounding: 0, Total: 9120, AmountDue: 9120, PostalAddress01: "5 Penns Wood", PostalAddress02: "Farnborough", PostalAddress03: "Hampshire", PostalAddress04: "GU14 6RB", PostalAddress05: "", DeliveryAddress01: "", DeliveryAddress02: "", DeliveryAddress03: "", DeliveryAddress04: "", DeliveryAddress05: "", ID: 510, Lines: [ { LineType: [0 for Item / 1 for Account],


Page 69 of 157

SelectionId: [Item Id / Account Id (Based on LineType)], TaxTypeId: [TaxType Id (0 for a No Tax Company)], Description: [Description], Quantity: 1, UnitPriceExclusive: 100, Unit: “Kilogram” UnitPriceInclusive: 120 Tax: 20, TaxPercentage: 0.14, DiscountPercentage: 0, Exclusive: 100, Discount: 0, Total: 120, Comment: “Hello World” } ] }

Return Type Saved Purchase Order with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/PurchaseOrder/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 70 of 157

Delete

Item Description


Description Deletes the Purchase Order with this ID

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Purchase Order ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/PurchaseOrder/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Calculate

Item Description

Function Calculate()

Description Calculates the totals for the document based on the lines

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ExpiryDate: "2012-04-30T00:00:00", SupplierId: 83, Date: "2012-04-08T00:00:00", Inclusive: false, DiscountPercentage: 0, TaxReference: "", DocumentNumber: "SPO0000001", Reference: "465", Message: “Random Message”, Discount: 0, Exclusive: 8000, Tax: 1120, Rounding: 0, Total: 9120, AmountDue: 9120, PostalAddress01: "5 Penns Wood", PostalAddress02: "Farnborough", PostalAddress03: "Hampshire", PostalAddress04: "GU14 6RB", PostalAddress05: "", DeliveryAddress01: "", DeliveryAddress02: "", DeliveryAddress03: "", DeliveryAddress04: "",


Page 71 of 157

DeliveryAddress05: "", ID: 510, Lines: [ { LineType: [0 for Item / 1 for Account], SelectionId: [Item Id / Account Id (Based on LineType)], TaxTypeId: [TaxType Id (0 for a No Tax Company)], Description: [Description], Quantity: 1, UnitPriceExclusive: 100, Unit: “Kilogram” UnitPriceInclusive: 120 Tax: 20, TaxPercentage: 0.14, DiscountPercentage: 0, Exclusive: 100, Discount: 0, Total: 120, Comment: “Hello World” } ] }

Return Type Purchase Order with calculated total values

Example URL http://[API URL]/api/[ver]/PurchaseOrder/Calculate?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Quote Service

Get Individual

Item Description


Description Gets a Quote for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Quote

Example URL http://[API URL]/api/[ver]/Quote/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Quote for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET


Page 72 of 157

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Quotes

Example URL http://[API URL]/api/[ver]/Quote/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a Quote. If the ID is not set or is 0, the Quote is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ExpiryDate: "2012-04-30T00:00:00", CustomerId: 83, Date: "2012-04-08T00:00:00", Inclusive: false, DiscountPercentage: 0, TaxReference: "", DocumentNumber: "QUO0000001", Reference: "465", Discount: 0, Exclusive: 8000, Tax: 1120, Rounding: 0, Total: 9120, TotalOutstanding: 9120, PostalAddress01: "5 Penns Wood", PostalAddress02: "Farnborough", PostalAddress03: "Hampshire", PostalAddress04: "GU14 6RB", PostalAddress05: "", DeliveryAddress01: "", DeliveryAddress02: "", DeliveryAddress03: "", DeliveryAddress04: "", DeliveryAddress05: "", ID: 510, Lines: [ { LineType: [0 for Item / 1 for Account], SelectionId: [Item Id / Account Id (Based on LineType)], TaxTypeId: [TaxType Id (0 for a No Tax Company)],


Page 73 of 157

Description: [Description], Quantity: 1, UnitPriceExclusive: 100, TaxPercentage: 0.14, DiscountPercentage: 0, Exclusive: 100 } ] }

Return Type Saved Quote with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/Quote/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Calculate

Item Description

Function Calculate(Quote quoteObject)

Description Calculates the quote total values

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ExpiryDate: "2012-04-30T00:00:00", CustomerId: 83, Date: "2012-04-08T00:00:00", Inclusive: false, DiscountPercentage: 0, TaxReference: "", DocumentNumber: "QUO0000001", Reference: "465", Discount: 0, Exclusive: 8000, Tax: 1120, Rounding: 0, Total: 9120, TotalOutstanding: 9120, PostalAddress01: "5 Penns Wood", PostalAddress02: "Farnborough", PostalAddress03: "Hampshire", PostalAddress04: "GU14 6RB", PostalAddress05: "", DeliveryAddress01: "", DeliveryAddress02: "", DeliveryAddress03: "", DeliveryAddress04: "", DeliveryAddress05: "", ID: 510,


Page 74 of 157

Lines: [ { LineType: [0 for Item / 1 for Account], SelectionId: [Item Id / Account Id (Based on LineType)], TaxTypeId: [TaxType Id (0 for a No Tax Company)], Description: [Description], Quantity: 1, UnitPriceExclusive: 100, TaxPercentage: 0.14, DiscountPercentage: 0, Exclusive: 100 } ] }

Return Type Quote object with the calculated total values.

Example URL http://[API URL]/api/[ver]/Quote/Calculate?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the Quote with this ID

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Quote ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/Quote/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Email

Item Description

Function Email

Description Emails the customer quote to the specified email address as an attachment

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ID: 131, EmailAddress: "[email protected]", CCAddress: "[email protected]", Subject: "Quote Number 1", Message: :”This is a quote for this person”


Page 75 of 157

}

Return Type Nothing.

Example URL http://[API URL]/api/[ver]/Quote/Email?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Sales Representative Service

Get Individual

Item Description

Function Get(int SalesRepresentativeId)

Description Gets a Sales Representative for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Sales Representative

Example URL http://[API URL]/api/[ver]/ SalesRepresentative/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Sales Representatives for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Sales Representatives

Example URL http://[API URL]/api/[ver]/ SalesRepresentative /Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a Sales Representative. If the ID is not set or is 0, the Sales Representative is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body.


Page 76 of 157

JSON Object: { ID: 0, FirstName: "Sales", LastName: "Representative", Active: true, Email: "[email protected]", Mobile: "012123456", Telephone: "011123456", CommissionType: 0 }

Return Type Saved Sales Representative valid ID and with location of new object in the response header.

Example URL http://[API URL]/api/[ver]/ SalesRepresentative/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description

Function Delete(int salesRepresentativeId)

Description Deletes the Sales Representative with this ID if no transactions took place with this Sales Representative. It also deletes all associated Notes.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Sales Representative ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/ SalesRepresentative/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Sales Representative Note Service

Get Individual

Item Description


Description Gets a Sales Representative Note for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Sales Representative Note

Example URL http://[API URL]/api/[ver]/SalesRepresentativeNote/Get/1?apikey={39478ac6-


Page 77 of 157

ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Sales Representative Notes for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Sales Representative Notes

Example URL http://[API URL]/api/[ver]/SalesRepresentativeNote/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a Sales Representative Note. If the ID is not set or is 0, the Asset note is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { SalesRepresentativeId: 1, SalesRepresentativeNoteId: 1, ID: 1, Subject: "Unknown", EntryDate: "2013-07-03T00:00:00Z", ActionDate: "2013-07-02T00:00:00Z" }

Return Type Saved Sales Representative Note with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/SalesRepresentativeNote/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 78 of 157

Delete

Item Description


Description Deletes the Sales Representative Note with this ID together with all associated attachments.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Sales Representative Note ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/SalesRepresentativeNote/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Sales Representative Note Attachment Service This service functions based on the Attachment Service, except that the [objectType] needs to be substituted with


Supplier Service

Get Individual

Item Description

Function Get(int supplierId)

Description Gets a supplier for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes




Example URL http://[API URL]/api/[ver]/Supplier/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of suppliers for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Page 79 of 157


Parameters None

Return Type Array of Suppliers

Example URL http://[API URL]/api/[ver]/Suppliers/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a supplier account. If the ID is not set or is 0, the supplier is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { Name: "A Proper Supplier", TaxReference: "Ref SARS 0001", ContactName: "Bobby Jansen", Telephone: "012 122 5556", Fax: "012 444 8889", Mobile: "082 444 5568", Email: "[email protected]", WebAddress: "www.bobbysplace.com", Active: true, Balance: 0, CreditLimit: 4000, PostalAddress01: "15", PostalAddress02: "Beach", PostalAddress03: "Street", PostalAddress04: "Dover", PostalAddress05: "4578", DeliveryAddress01: "Physical Address 90", DeliveryAddress02: "Olieven", DeliveryAddress03: "Houts", DeliveryAddress04: "Bosch", DeliveryAddress05: "1177", ID: 0 }

Return Type Saved Supplier valid ID and with location of new object in the response header.

Example URL http://[API URL]/api/[ver]/Supplier/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 80 of 157

Delete

Item Description

Function Delete(int supplierId)

Description Deletes the supplier with this ID if no transactions took place with this Supplier. It also deletes all associated Notes.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Supplier ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/Supplier/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 81 of 157

Supplier Ageing Service

Get List

Item Description

Function Get(SupplierAgeingRequestModel request)

Description Gets a list of SupplierAgeings for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb POST

APIKey Required Yes

Login Required Yes

Company Required No

Parameters SupplierAgeingRequestModel request

Return Type Array of SupplierAgeings

Example URL http://[API URL]/api/[ver]/supplierageing/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Supplier Category Service

Get Individual

Item Description

Function Get(int SupplierCategoryId )

Description Gets a Supplier Category for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Supplier Category

Example URL http://[API URL]/api/[ver]/SupplierCategory/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Supplier categories for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Supplier Categories

Example URL http://[API URL]/api/[ver]/SupplierCategory/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description


Page 82 of 157

Function Save

Description Saves or Updates a supplier category. If the ID is not set or is 0, the Supplier category is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes



Return Type Saved supplier category with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/suppliercategory/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the supplier category with this ID if no suppliers have this category set.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Supplier Category ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/suppliercategory/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 83 of 157

Supplier Note Service

Get Individual

Item Description


Description Gets a Supplier Note for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type SupplierNote

Example URL http://[API URL]/api/[ver]/SupplierNote/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Supplier Notes for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Supplier Notes

Example URL http://[API URL]/api/[ver]/SupplierNote/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 84 of 157

Save

Item Description

Function Save

Description Saves or Updates a Supplier note. If the ID is not set or is 0, the Supplier note is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { SupplierId: 5554, ID: 131, Subject: "Supplier Subject", EntryDate: "2012-11-14T00:00:00", ActionDate: "2012-11-14T02:00:00", Status: false, Note: "Supplier Note - With Attachment" }

Return Type Saved item note with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/suppliernote/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the Supplier note with this ID together with all associated attachments.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters Supplier Note ID (Integer)

Return Type None

Example URL http://[API URL]/api/[ver]/suppliernote/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Supplier Note Attachment Service This service functions based on the Attachment Service, except that the [objectType] needs to be substituted with



Page 85 of 157

Supplier Invoice Service

Get Individual

Item Description


Description Gets a Supplier Invoice for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type SupplierInvoice

Example URL http://[API URL]/api/[ver]/TaxInvoice/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Supplier Invoices for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of SupplierInvoice

Example URL http://[API URL]/api/[ver]/SupplierInvoice/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 86 of 157

Save

Item Description

Function Save

Description Saves or Updates a Supplier Invoice. If the ID is not set or is 0, the Supplier Invoice is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { DueDate: "2011-03-31T00:00:00", SupplierId: 5, Date: "2011-03-01T00:00:00", Inclusive: false, DiscountPercentage: 0.1, TaxReference: "", DocumentNumber: "INV0000001", Reference: "", Message: “”, Discount: 7200, Exclusive: 64800, Tax: 9072, Rounding: 0, Total: 73872, AmountDue: 0, PostalAddress01: "P O Box 39478", PostalAddress02: "Sandton", PostalAddress03: "2039", PostalAddress04: "", PostalAddress05: "", DeliveryAddress01: "Morningview Park", DeliveryAddress02: "Rivonia Road", DeliveryAddress03: "Sandton", DeliveryAddress04: "2303", DeliveryAddress05: "", ID: 180, Lines: [ { LineType: [0 for Item / 1 for Account], SelectionId: [Item Id / Account Id (Based on LineType)], TaxTypeId: [TaxType Id (0 for a No Tax Company)], Description: [Description], Quantity: 1, UnitPriceExclusive: 100, TaxPercentage: 0.14, DiscountPercentage: 0, Exclusive: 100 } ]


Page 87 of 157

}

Return Type Saved Supplier Invoice with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/SupplierInvoice/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Calculate

Item Description

Function Calculate

Description Calculates all the total values for the supplier invoice based on the lines.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { DueDate: "2011-03-31T00:00:00", SupplierId: 5, Date: "2011-03-01T00:00:00", Inclusive: false, DiscountPercentage: 0.1, TaxReference: "", DocumentNumber: "INV0000001", Reference: "", Message: “”, Discount: 7200, Exclusive: 64800, Tax: 9072, Rounding: 0, Total: 73872, AmountDue: 0, PostalAddress01: "P O Box 39478", PostalAddress02: "Sandton", PostalAddress03: "2039", PostalAddress04: "", PostalAddress05: "", DeliveryAddress01: "Morningview Park", DeliveryAddress02: "Rivonia Road", DeliveryAddress03: "Sandton", DeliveryAddress04: "2303", DeliveryAddress05: "", ID: 180, Lines: [ { LineType: [0 for Item / 1 for Account], SelectionId: [Item Id / Account Id (Based on LineType)], TaxTypeId: [TaxType Id (0 for a No Tax Company)], Description: [Description],


Page 88 of 157

Quantity: 1, UnitPriceExclusive: 100, TaxPercentage: 0.14, DiscountPercentage: 0, Exclusive: 100 } ] }

Return Type Supplier invoice with the calculated total values based on the lines.

Example URL http://[API URL]/api/[ver]/SupplierInvoice/Calculate?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Email

Item Description

Function Email

Description Emails the supplier invoice to the specified email address as an attachment

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ID: 131, EmailAddress: "[email protected]", CCAddress: "[email protected]", Subject: "Quote Number 1", Message: :”This is an invoice for this person” }


Example URL http://[API URL]/api/[ver]/ SupplierInvoice /Email?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Supplier Return Service

Get Individual

Item Description


Description Gets a Supplier Return for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes




Page 89 of 157

Return Type SupplierReturn

Example URL http://[API URL]/api/[ver]/SupplierReturn/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of Supplier Returns for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of SupplierReturn

Example URL http://[API URL]/api/[ver]/SupplierReturn/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a Supplier Return. If the ID is not set or is 0, the Supplier Return is created. If the ID is set, an update is performed

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { SupplierId: 5, Date: "2011-03-01T00:00:00", Inclusive: false, DiscountPercentage: 0.1, TaxReference: "", DocumentNumber: "INV0000001", Reference: "", Message: “”, Discount: 7200, Exclusive: 64800, Tax: 9072, Rounding: 0, Total: 73872, AmountDue: 0, PostalAddress01: "P O Box 39478", PostalAddress02: "Sandton", PostalAddress03: "2039", PostalAddress04: "", PostalAddress05: "",


Page 90 of 157

DeliveryAddress01: "Morningview Park", DeliveryAddress02: "Rivonia Road", DeliveryAddress03: "Sandton", DeliveryAddress04: "2303", DeliveryAddress05: "", ID: 180, Lines: [ { LineType: [0 for Item / 1 for Account], SelectionId: [Item Id / Account Id (Based on LineType)], TaxTypeId: [TaxType Id (0 for a No Tax Company)], Description: [Description], Quantity: 1, UnitPriceExclusive: 100, TaxPercentage: 0.14, DiscountPercentage: 0, Exclusive: 100 } ] }

Return Type Saved Supplier Return with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/SupplierReturn/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Calculate

Item Description

Function Calculate

Description Calculates the total values for the Supplier Return object

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { SupplierId: 5, Date: "2011-03-01T00:00:00", Inclusive: false, DiscountPercentage: 0.1, TaxReference: "", DocumentNumber: "INV0000001", Reference: "", Message: “”, Discount: 7200, Exclusive: 64800, Tax: 9072, Rounding: 0, Total: 73872, AmountDue: 0, PostalAddress01: "P O Box 39478",


Page 91 of 157

PostalAddress02: "Sandton", PostalAddress03: "2039", PostalAddress04: "", PostalAddress05: "", DeliveryAddress01: "Morningview Park", DeliveryAddress02: "Rivonia Road", DeliveryAddress03: "Sandton", DeliveryAddress04: "2303", DeliveryAddress05: "", ID: 180, Lines: [ { LineType: [0 for Item / 1 for Account], SelectionId: [Item Id / Account Id (Based on LineType)], TaxTypeId: [TaxType Id (0 for a No Tax Company)], Description: [Description], Quantity: 1, UnitPriceExclusive: 100, TaxPercentage: 0.14, DiscountPercentage: 0, Exclusive: 100 } ] }

Return Type Supplier Return Object with the calculated total values.

Example URL http://[API URL]/api/[ver]/SupplierReturn/Calculate?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Email

Item Description

Function Email

Description Emails the supplier return to the specified email address as an attachment

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ID: 131, EmailAddress: "[email protected]", CCAddress: "[email protected]", Subject: "Quote Number 1", Message: :”This is an invoice for this person” }


Example URL http://[API URL]/api/[ver]/ SupplierReturn /Email?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 92 of 157

Supplier Payment Service

Get List

Item Description

Function Get()

Description Gets a list of Supplier Payment for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of SupplierPayment

Example URL http://[API URL]/api/[ver]/SupplierPayment/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Tax Invoice Service

Get Individual

Item Description


Description Gets a Tax Invoice for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type Quote

Example URL http://[API URL]/api/[ver]/TaxInvoice/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Get List

Item Description

Function Get()

Description Gets a list of TaxInvoice for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Tax Invoices

Example URL http://[API URL]/api/[ver]/TaxInvoice/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 93 of 157

Save

Item Description

Function Save

Description Saves or Updates a Tax Invoice. If the ID is not set or is 0, the Quote is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { DueDate: "2011-03-31T00:00:00", CustomerId: 5, Date: "2011-03-01T00:00:00", Inclusive: false, DiscountPercentage: 0.1, TaxReference: "", DocumentNumber: "INV0000001", Reference: "", Message: ””, Discount: 7200, Exclusive: 64800, Tax: 9072, Rounding: 0, Total: 73872, AmountDue: 0, PostalAddress01: "P O Box 39478", PostalAddress02: "Sandton", PostalAddress03: "2039", PostalAddress04: "", PostalAddress05: "", DeliveryAddress01: "Morningview Park", DeliveryAddress02: "Rivonia Road", DeliveryAddress03: "Sandton", DeliveryAddress04: "2303", DeliveryAddress05: "", ID: 180, Lines: [ { LineType: [0 for Item / 1 for Account], SelectionId: [Item Id / Account Id (Based on LineType)], TaxTypeId: [TaxType Id (0 for a No Tax Company)], Description: [Description], Quantity: 1, UnitPriceExclusive: 100, TaxPercentage: 0.14, DiscountPercentage: 0, Exclusive: 100 } ]


Page 94 of 157

}

Return Type Saved Tax Invoice with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/TaxInvoice/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Calculate

Item Description

Function Calculate

Description Calculates the total values for the Tax Invoice based on the lines

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { DueDate: "2011-03-31T00:00:00", CustomerId: 5, Date: "2011-03-01T00:00:00", Inclusive: false, DiscountPercentage: 0.1, TaxReference: "", DocumentNumber: "INV0000001", Reference: "", Message: ””, Discount: 7200, Exclusive: 64800, Tax: 9072, Rounding: 0, Total: 73872, AmountDue: 0, PostalAddress01: "P O Box 39478", PostalAddress02: "Sandton", PostalAddress03: "2039", PostalAddress04: "", PostalAddress05: "", DeliveryAddress01: "Morningview Park", DeliveryAddress02: "Rivonia Road", DeliveryAddress03: "Sandton", DeliveryAddress04: "2303", DeliveryAddress05: "", ID: 180, Lines: [ { LineType: [0 for Item / 1 for Account], SelectionId: [Item Id / Account Id (Based on LineType)], TaxTypeId: [TaxType Id (0 for a No Tax Company)], Description: [Description], Quantity: 1,


Page 95 of 157

UnitPriceExclusive: 100, TaxPercentage: 0.14, DiscountPercentage: 0, Exclusive: 100 } ] }

Return Type Tax Invoice object with the calculated total values

Example URL http://[API URL]/api/[ver]/TaxInvoice/Calculate?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Email

Item Description

Function Email

Description Emails the Tax Invoice to the specified email address as an attachment

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ID: 131, EmailAddress: "[email protected]", CCAddress: "[email protected]", Subject: "Quote Number 1", Message: :”This is an tax invoice for this person” }


Example URL http://[API URL]/api/[ver]/ TaxInvoice /Email?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Tax Type Service

Get Individual

Item Description


Description Gets a TaxType for this company, with the provided ID.

Http Verb GET

APIKey Required Yes

Login Required Yes



Return Type TaxType

Example URL http://[API URL]/api/[ver]/TaxType/Get/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx


Page 96 of 157

Get List

Item Description

Function Get()

Description Gets a list of Tax Types for this company. Subset of OData supported. Skip, Top, Orderby and Filter

Http Verb GET

APIKey Required Yes

Login Required Yes


Parameters None

Return Type Array of Tax Types

Example URL http://[API URL]/api/[ver]/TaxType/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Save

Item Description

Function Save

Description Saves or Updates a TaxType. If the ID is not set or is 0, the TaxType is created. If the ID is set, an update is performed.

Http Verb POST

APIKey Required Yes

Login Required Yes


Parameters Request Body. JSON Object: { ID: 7157, Name: "Standard Rated", Percentage: 0.14, IsDefault: false, IsManualTax: false }

Return Type Saved TaxType with a valid ID and with the location of the new object in the response header.

Example URL http://[API URL]/api/[ver]/TaxType/Save?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Delete

Item Description


Description Deletes the TaxType with this ID if this TaxType has no activity.

Http Verb DELETE

APIKey Required Yes

Login Required Yes


Parameters TaxType ID (Integer)


Page 97 of 157

Return Type None

Example URL http://[API URL]/api/[ver]/TaxType/Delete/1?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}&CompanyId=xxx

Top Customers By Outstanding Balance Service

Get List

Item Description

Function Get(TopCustomersByOutstandingBalanceModel request)

Description Gets a list of Customers for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb POST

APIKey Required

Yes

Login Required Yes

Company Required

No

Parameters TopCustomersByOutstandingBalanceRequestModel request


Example URL http://[API URL]/api/[ver]/TopCustomersByOutstandingBalance/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Top Customers By Sales Service

Get List

Item Description

Function Get(TopCustomersBySalesRequestModel request)

Description Gets a list of TopCustomersBySales for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb POST

APIKey Required Yes

Login Required Yes

Company Required No

Parameters TopCustomersBySalesRequestModel request

Return Type Array of TopCustomersBySales

Example URL http://[API URL]/api/[ver]/TopCustomersBySales/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Top Purchased Items Service

Get List

Item Description

Function Get(TopPurchasedItemsRequestModel request)

Description Gets a list of TopPurchasedItems for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb POST

APIKey Required Yes

Login Required Yes


Page 98 of 157

Company Required No

Parameters TopPurchasedItemsRequestModel request

Return Type Array of TopPurchasedItems

Example URL http://[API URL]/api/[ver]/TopPurchasedItems/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Top Selling Items Service

Get List

Item Description

Function Get(TopSellingItemsRequestModel request)

Description Gets a list of TopSellingItems for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb POST

APIKey Required Yes

Login Required Yes

Company Required No

Parameters TopSellingItemsRequestModel request

Return Type Array of TopSellingItems

Example URL http://[API URL]/api/[ver]/TopSellingItems/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Top Selling Items By Value On Hand Service

Get List

Item Description

Function Get(TopSellingItemByValueOnHandRequestModelrequest)

Description Gets a list of TopSellingItemByValueOnHand for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb POST

APIKey Required Yes

Login Required Yes

Company Required No

Parameters TopSellingItemByValueOnHandRequestModel request

Return Type Array of TopSellingItemByValueOnHand

Example URL http://[API URL]/api/[ver]/TopSellingItemByValueOnHand/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}


Page 99 of 157

Top Suppliers By Outstanding Balance Service

Get List

Item Description

Function Get(TopSuppliersByOutstandingBalanceModel request)

Description Gets a list of Suppliers for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb GET

APIKey Required Yes

Login Required Yes

Company Required

No

Parameters TopSuppliersByOutstandingBalanceRequestModel request


Example URL http://[API URL]/api/[ver]/TopSuppliersByOutstandingBalance/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Top Suppliers By Purchases Service

Get List

Item Description

Function Get(TopSuppliersByPurchasesRequestModel request)

Description Gets a list of TopSuppliersByPurchases for the authenticated user. Subset of OData supported. Skip, Top, Orderby and Filter.

Http Verb GET

APIKey Required Yes

Login Required Yes

Company Required No

Parameters TopSuppliersByPurchasesRequestModel request

Return Type Array of Suppliers

Example URL http://[API URL]/api/[ver]/TopSuppliersByPurchases/Get?apikey={39478ac6-ac2a-44d8-a31c-7e7e14af4de3}

Data Models

Attachment

Field Name Type Validation Rules

AttachmentUID UID Read-only

Name String Read-only

Size Long Read-only


Page 100 of 157

Ageing Transaction

Field Name Type

DocumentHeaderId Integer Required

DocumentTypeId Integer Valid CommunicationMethodType

Name

None = 0

Print = 1

Email = 2

Both = 3

Document Type

DocumentNumber String Required

DocumentType DocumentType Valid CommunicationMethodType

Name

None = 0

Print = 1

Email = 2

Both = 3

Document Type

Comment String Required

Date DateTime Required

DueDate DateTime Required


Page 101 of 157

Enums

Ageing Period

Name

Current = 0

Days30 = 1

Days60 = 2

Days90 = 3

Days120Plus = 4

All = 5

BankTransactionType

Name

Account = 1

Customer = 2

Supplier = 3

Transfer = 4

Tax = 5

CommercialDocumentLineType

Name

Item = 0

Account = 1

CustomerNotePriority

Name

Message = 0

Request = 1

CommunicationMethodType

Name

None = 0

Print = 1

Email = 2

Both = 3

Document Type

Name

CustomerOpeningBalance = 0

Quote = 1

TaxInvoice = 2

CustomerReturn = 3

Receipt = 4

WriteOff = 5

CustomerDiscount = 6

RecurringTaxInvoice = 7

DraftTaxInvoice = 8

CustomerJournal = 9

DeliveryNote = 52


Page 102 of 157

SupplierOpeningBalance = 100

PurchaseOrder = 101

SupplierInvoice = 102

SupplierReturn = 103

Payment = 104

SupplierDiscount = 106

SupplierJournal = 109

ItemOpeningBalance = 200

ItemAdjustment = 201

AccountOpeningBalance = 300

CashbookReceipt = 301

CashbookPayment = 302

JournalEntry = 303

BankAccountOpeningBalance = 400

BankAccountTransferFrom = 401

BankAccountTransferTo = 402

SplitCashbookPayment = 403

SplitCashbookReceipt = 404

SplitPayment = 405

SplitReceipt = 406

TaxPayment = 501

TaxRefund = 502

InputTaxAdjustment = 503

OutputTaxAdjustment = 504

InputTaxProvisionAdjustment = 505

OutputTaxProvisionAdjustment = 506

Effect

Name

Debit = 1

Credit = 2

ItemReportGroupType

Sales = 1

Purchases = 2

PaymentMethod

Cash = 1

Cheque = 2

CreditCard = 3

EFT = 4

PeriodComparativeType

None = 0

CurrentYear = 1

LastYear = 2


Page 103 of 157

Budget = 3

PeriodGroupingType

None = 0

Monthly = 1

Quarterly = 2

Yearly = 3

QuoteStatusType

Accepted = 0

Declined = 1

RelativeFrequencyInterval

Unused = 0

First = 1

Second = 2

Third = 3

Fourth = 4

Last = 5

ReportingLevelType

Category = 1

Group = 2

Account = 3

SystemAccount = 4

ItemReportingGroup = 5

BankAccount = 6

Total = 10

Rounding Type

Name

Up = 0

Down = 1

Normal = 2

None = 3

SecretarialStakeHolderAddressType

Physical = 0

Business = 1

Postal = 2

TakeOnBalanceAccountType

Account = 1


Page 104 of 157

SystemAccount = 2

BankAccount = 3

ToDoListCategory

DueTaxInvoice = 0

OverdueTaxInvoice = 1

OutstandingQuote = 2

ExpiredQuote = 3

DueCustomerNote = 4

OverdueCustomerNote = 5

DueSalesRepresentativeNote = 6

OverdueSalesRepresentativeNote = 7

DueItemNote = 8

OverdueItemNote = 9

DueSupplierInvoice = 10

OverdueSupplierInvoice = 11

OutstandingPurchaseOrder = 12

ExpiredPurchaseOrder = 13

DueSupplierNote = 14

OverdueSupplierNote = 15

DueBankAccountNote = 16

OverdueBankAccountNote = 17

DueAccountNote = 18

OverdueAccountNote = 19

DueAssetNote = 20

OverdueAssetNote = 21

DueUserNote = 22

OverdueUserNote = 23

DueCompanyNote = 24

OverdueCompanyNote = 25

TrialBalanceAccountType

ProfitAndLossAccount = 0

StatementOfAssetsAndLiabilityAccount = 1

BankAccount = 2

SystemAccount = 3

Tax System

Name

InvoiceBased = 0

PaymentsBased = 1

NoTax = 2

Account


ID Integer Valid Integer

Name String Required


Page 105 of 157

Less than 100

Unique Name

Category Account Category Required

Active Boolean Required

Balance Decimal Required

Read Only

Description String Less than 4000

Account Category



Description String Required

Less than 100

Unique Name

Account Note



AccountId Integer Valid Integer

Subject String Required

Less than 100

Unique Name

EntryDate DateTime Not Required

Valid DateTime

ActionDate DateTime Not Required

Valid DateTime

Status Boolean Not Required

Valid Boolean

Note String Required

Less than 100

Unique Name

HasAttachments Boolean Not Required

Valid Boolean

Account Opening Balance



Account Payment


ID Integer Required

AccountId Integer Required

Date Date Required


Reference Decimal Required


Page 106 of 157

Account

Receipt

Account

Reportin

g Value

Ageing

Base

Ageing Transaction

TaxTypeId Integer Required

Comments String Required

Exclusive Decimal Required

Tax Decimal Required

Total Decimal Required

Reconciled Integer Required

BankAccountId Integer Required


ID Integer Required


Date Date Required


Reference Decimal Required

TaxTypeId Integer Required





Reconciled Integer Required



ID Integer Required

AccountTypeId Integer Required


AccountCategoryId Integer Required

Debit Decimal Required

Credit Decimal Required


Period Integer Required



Current Decimal Required

Days30 Decimal Required



Days120Plus Decimal Required


DocumentHeaderId Int32 Required

DocumentTypeId Int32 Required


Reference String Required

DocumentType Integer Required

Valid CommunicationMethodType

Name

None = 0


Page 107 of 157

Asset

Asset Category




Less than 100

Unique Description

Asset Location




Less Than 100

No angle brackets

No double spaces

Must be Unique

Asset Note


Print = 1

Email = 2

Both = 3

Document Type



DueDate DateTime Not Required


Current Decimal Required




Days120Plus Decimal Required



Less Than 500

No double spaces

No angle brackets

AssetCategoryId Integer32 Required

AssetLocationId Integer32 Required

SerialNumber String Less Than 100

Required

BoughtFrom String Less Than 100


Page 108 of 157


Subject String Less Than 100

Required


Action Date DateTime Not Required




Balance Sheet Reporting Level




Less Than 100

Category String Valid String

CategoryId Integer Required


Children List<Balance Sheet Reporting Level> Required

ReportingLevelType Integer Required

Valid ReportingLevelType


Level Integer Required

Parent Balance Sheet Reporting Level Required

Total Decimal Not Required

Bank Account




Less than 100

Must be Unique

BankName String Not Required

Less than 50

AccountNumber String Not Required

Less than 50

AccountName String Not Required

Less than 50

BranchName String Not Required

Less than 50

BranchNumber String Not Required

Less than 50

Category Bank Account Category Not Required

Valid Bank Account Category

Active Boolean Not Required


Page 109 of 157

Valid Boolean

Default Boolean Not Required

Valid Boolean

Balance Decimal Not Required

Description String Not required

Less than 4000

LastTransactionDate DateTime Not Required

Valid DateTime

LastImportDate DateTime Not Required

Valid DateTime

ReportingGroupId Integer Not Required

DefaultPaymentMethod Integer Not Required

Valid PaymentMethod

PaymentMethod Integer Not Required

Valid PaymentMethod

Bank Account Category




Less than 100

Unique Description

Bank Account Note



BankAccountId Integer Valid Integer


Less than 100

Unique Name


Valid DateTime


Valid DateTime


Valid Boolean


Less than 100

Unique Name


Valid Boolean


Page 110 of 157

Bank Account Opening Balance




Reason String Required



Bank Statement Transaction



Date DateTime Valid DateTime

BankAccountId Integer Valid Integer from the Bank Account table

BankAccount Bank Account Valid Bank Account

Selection Error! Reference source not ound.

Valid Error! Reference source not ound.

Reference String Valid String

Description String Valid String

Tax Decimal Valid Decimal

Total Decimal Valid Decimal

BankUniqueIdentifer String Valid String

MatchedBankTransactionId Integer Not Required

Valid Integer from the Bank Transaction Model

Bank Transaction




BankAccountId Integer Valid Integer from the Bank Account model

Type BankTransactionType Valid BankTransactionType

SelectionId Integer Not Required

DocumentNumber String Valid String


Description Integer Valid String

TaxTypeId Integer Valid Integer from the Tax Type table

Exlusive Decimal Valid Decimal




Page 111 of 157

Reconciled Boolean Valid Boolean

BankUniqueIdentifier String Valid String

Memo String Valid String

Budget



Description String Less Than 100

Required

BudgetItems List<Budget Item> Valid List of Budget Item

NumberOf Periods Integer Valid Integer

Budget Item



Account Budget Item Account Valid Budget Item Account

BudgetItemPeriods List<Budget Item Period> Valid List of Budget Item Period


AccountTypeId Integer Valid Integer

Budget Item Account



ReportingLevelType Integer Valid ReportingLevelType

Name String Valid String

Category Account Category Valid Account Category

Budget Item Period



Date DateTime Ignore For Updates


Cash Movement

Field Name Type

BankAccount BankAccount

Total Decimal

Date DateTime


Page 112 of 157

Commercial Document



Masterfile Error! Reference ource not found.



Inclusive Boolean Valid Boolean

DiscountPercentage Float Valid Float

TaxReference String Less Than 20

Valid String

DocumentNumber String Less Than 100

Valid String

Reference String Less Than 100

Valid String

Message String Less Than 8000

Valid String

Discount Decimal Valid Decimal

Exclusive Decimal Valid Decimal


Rounding Decimal Valid Decimal


AmountDue Decimal Valid Decimal

Currency

PostalAddress01 String Valid String

Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100

DeliveryAddress01 String Valid String

Less Than 100


Less Than 100


Less Than 100


Less Than 100

Printed Boolean Valid Boolean

Lines List<Commercial Document Lines>

Valid List of Commercial Document Lines


Page 113 of 157

Commercial Document Lines



SelectionId Integer Valid Integer

TaxTypeId Integer Valid Tax Type Integer


LineType Integer Valid CommercialDocumentLineType

Quantity Decimal Valid Decimal

UnitPriceExclusive Decimal Valid Decimal

Unit String Valid String

UnitPriceInclusive Decimal Valid Decimal

TaxPercentage Float Valid Float


Exlusive Decimal Valid Decimal




Comment String Valid String

Company




Less than 100

Must be Unique

CurrencyDecimalDigits Integer Between 0 and 4

NumberDecimalDigits String Between 0 and 4

DecimalSeparator String Valid String

GroupSeparator String Valid String

RoundingValue Integer Valid Integer

TaxSystem Integer Valid Tax System

RoundingType Integer Valid Rounding Type

AgeMonthly Boolean Valid Boolean

DisplayInactiveItems Boolean Valid Boolean

WarnWhenItemCostIsZero Boolean Valid Boolean

WarnWhenItemQuantityIsZero Boolean Valid Boolean

CountryId Integer Valid Integer

ContactName String Valid String

Telephone String Valid String

Fax String Valid String

Mobile String Valid String

Email String Valid String



Page 114 of 157





CompanyInfo01 String Valid String





AgeingBasedOnDueDate Boolean Valid Boolean

Company Entity Type



CountryId Integer Valid Integer


OwnershipDescription String Valid String

HoldingDescription String Valid String

HoldingUnit String Valid String

Created String Valid String

CanIssueShares Boolean Valid Boolean

Company Logo



Image Byte Array Valid Image converted to byte array

Company Note




Less than 100

Unique Name


Valid DateTime


Valid DateTime


Valid Boolean


Less than 100

Unique Name


Valid Boolean


Page 115 of 157

Company Report Layout



ReportTypeId Integer Valid Integer

ReportLayoutTypeId Integer Valid Integer

ReportLayoutId Integer Valid Integer

Comparative Grouping Period


Period Integer Valid Integer

StartDate DateTime Valid DateTime

EndDate DateTime Valid DateTime



Comparative Profit & Loss Statement


FromDate DateTime Valid DateTime

ToDate DateTime Valid DateTime

IsComparative Boolean Valid Boolean

IsBudget Boolean Valid Boolean

ShowVariance Boolean Valid Boolean

Periods List<PeriodGrouping> Valid List of PeriodGrouping

SalesLines List<Comparative Profit And Loss Statement Line>

Valid List of Comparative Profit And Loss Statement Line

CostOfSalesLines List<Comparative Profit And Loss Statement Line>


OtherIncomeLines List<Comparative Profit And Loss Statement Line>


ExpenseLines List<Comparative Profit And Loss Statement Line>


NetProfitBeforeTax List<Decimal> Not Required

Tax List<Decimal> Not Required

NetProfitAfterTax List<Decimal> Not Required

SalesTotal List<Decimal> Valid List of decimal values

CostOfSalesTotal List<Decimal> Valid list of decimal values

OtherIncomeTotal List<Decimal> Valid list of decimal values

ExpenseTotal List<Decimal> Valid list of decimal values

Comparative Profit And Loss Statement Line




Total List<Decimal> Valid list of decimal values

IsSpecialLine Boolean Valid Boolean


Page 116 of 157

Customer




Less than 100

Must be Unique

Category Customer Category Not Required

Valid Customer Category

TaxReference String Not Required

Less than 30

ContactName String Not Required

Less than 30

Telephone String Not Required

Less than 30

Fax String Not Required

Less than 30

Mobile String Not Required

Less than 30

Email String Not Required

Less than 100

WebAddress String Not Required

Less than 100



CreditLimit Decimal Required

CommunicationMethod Integer Not Required


PostalAddress01 String Not Required

Less than 100


Less than 100


Less than 100


Less than 100


Less than 100

DeliveryAddress01 String Not Required

Less than 100


Less than 100


Less than 100


Less than 100


Less than 100

AutoAllocateToOldestInvoice Boolean Not Required


Page 117 of 157

CustomerZoneGuid Guid Valid Guid

CashSale Boolean Not Required

Customer Adjustment



Date DateTime Valid Date Required

CustomerId Integer Valid Integer relating back to a actual Customer id




TaxTypeId Integer Valid Integer relating back to a actual Tax Type Id




ContraAccountId Integer Valid integer relating back to an actual account id


HasAttachments Boolean Valid Boolean

Customer Ageing


Customer Customer Valid Customer object


AgeingTransactions List< Ageing Transaction>

Valid List of

Ageing Transaction


Current Decimal Valid Decimal

Days30 Decimal Valid Decimal



Days120Plus Decimal Valid Decimal

Customer Category




Less than 100

Unique Description


Page 118 of 157

Customer Additional Contact Detail



CustomerId Integer Valid Integer

ContactName StringCustomer Valid String

Less Than 100

Designation String Valid String

Less Than 50

Telephone String Valid String

Less Than 30

Fax String Valid String

Less Than 30

Mobile String Valid String

Less Than 30

Email String Valid String

Less Than 100

Customer Commercial Document


CustomerId Integer Valid Integer relating back to an actual Customer Id

CustomerName String Valid String

Customer Customer Valid Customer

SalesRepresentativeId Integer Not Required

StatusId Integer Not Required



Masterfile Error! Reference source not ound.






Valid String


Valid String


Valid String


Valid String








Page 119 of 157

Currency


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100




Customer Note





NotePriority Integer Not Required

Valid CustomerNotePriority

NoteType Integer Valid Error! Reference source not ound.


Less than 100

Unique Name


Valid DateTime


Valid DateTime


Valid Boolean


Less than 100

Unique Name


Valid Boolean


Page 120 of 157

Customer Opening Balances




Balance Decimal Valid Decimal

Reason String Valid String


Customer Receipt






Less Than 100


Less Than 100


Less Than 100

Comments String Valid String

Less Than 8000



TotalUnallocated Decimal Valid Decimal

Reconciled Boolean Valid Boolean

BankAccountId Integer Valid Integer relating back to an actual Bank Account Id

FinancialInstituteTransactionId String Valid String

PaymentMethod Integer Valid PaymentMethod

Customer Return




Customer Customer Valid Customer object






Page 121 of 157

Masterfile Error! Reference source ot found.






Valid String


Valid String


Valid String


Valid String







Currency


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100




Customer Sales History

Field Name Type

Customer Customer

Date DateTime

Exclusive Decimal


Page 122 of 157

Customer Statement

Field Name Type

Customer Customer

StatementLines List<Customer Statement Line>

Date DateTime

TotalDue Decimal

TotalPaid Decimal

Current Decimal

Days30 Decimal

Days60 Decimal

Days90 Decimal

Days120Plus Decimal

Message String

Current Decimal

Customer Statement Line

Field Name Type


DocumentTypeId Integer Required


Name

None = 0

Print = 1

Email = 2

Both = 3

Document Type

DocumentType Integer Required


Name

None = 0

Print = 1

Email = 2

Both = 3

Document Type


DateAllocation DateTime Required


DocumentNumberAllocation String Required





AgeingPeriod Integer Required

Valid Ageing Period


Page 123 of 157

Debit Decimal Not Required

Credit Decimal Not Required

Customer Take-On Balance




Less than 100

Must be Unique

Category Customer Category Not Required

Valid Customer Customer Category


Less than 30


Less than 30


Less than 30


Less than 30


Less than 30


Less than 100


Less than 100




CommunicationMethod Integer Not Required

Valid Error! Reference source not found.


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100



Page 124 of 157

Less than 100

AutoAllocateToOldestInvoice Boolean Not Required

CustomerZoneGuid Guid Valid Guid

CashSale Boolean Not Required

OpeningBalance Decimal Not Required

OpeningBalanceId Integer Not Required

CategoryDescription String Not Required

CategoryId Integer Not Required

Documentline Dashboard Object


ItemId Integer Valid Integer




Quantitiy Decimal Valid Decimal

Document Message




Name

None = 0

Print = 1

Email = 2

Both = 3

Document Type

Message String Valid String

Document Number




Name

None = 0

Print = 1

Email = 2

Both = 3

Document Type

NextDocumentNumber String Valid String

Financial Year



Page 125 of 157


YearStart DateTime Valid DateTime

YearEnd DateTime Valid DateTime

IsCurrentYear Boolean Valid Boolean

Generic Category



Less Than 100

No double space

No angle brackets

Not empty


Generic Note




Not Empty




Note String Valid String


IDateModel



Income VS Expense

Field Name Type

FromDate DateTime Required

ToDate DateTime Required

Periods List<IncomeVsExpensesPeriodGrouping> Required

List of IncomeVsExpensesPeriodGrouping

IsComparative Boolean Required

UsePurchases Boolean Required

IncomeVsExpensesPeriodGrouping

Field Name Type

IncomeAmount Decimal

ExpenseAmount Decimal


Page 126 of 157

Item




Less than 100

Must be Unique

Category Item Category Not Required

Valid Item Category

Code String Not Required

Less than 100


Valid Boolean

PriceInclusive Decimal Not Required

Valid Decimal

PriceExclusive Decimal Not Required

Valid Decimal

Physical Boolean Not Required

Valid Boolean

TaxTypeIdSales Integer Not Required

Valid Integer

TaxTypeIdPurchases Integer Not Required

Valid Integer

LastCost Decimal Not Required

Valid Decimal

AverageCost Decimal Not Required

Valid Decimal

QuantityOnHand Decimal Not Required

Valid Decimal

TotalQuantity Decimal Not Required

Valid Decimal

TotalCost Decimal Not Required

Valid Decimal


Valid Boolean

Unit String Less Than 100

Valid String

Item Category




Less than 100

Unique Description

Item Note




Page 127 of 157

ItemId Integer Valid Integer


Less than 100

Unique Name


Valid DateTime


Valid DateTime


Valid Boolean


Less than 100

Unique Name


Valid Boolean

Item Opening Balance



ItemId Integer Valid Integer relating back to an actual Item Object

Reason String Valid String


Quantity Decimal Valid Decimal

Cost Decimal Valid Decimal

Item Report Group




Less Than 100

Not Empty

ItemReportingGroupTypeId Integer Valid Integer relating back to an actual ItemReportingGroupType Enum

ReportingGroupId Integer Valid Integer relating back to an actual ReportingGroup Id

Not Required

Item Take-On Balances




Less than 100


Page 128 of 157

Must be Unique

Category Item Category Not Required

Valid Item Category

Code String Not Required

Less than 100


Valid Boolean

PriceInclusive Decimal Not Required

Valid Decimal

PriceExclusive Decimal Not Required

Valid Decimal

Physical Boolean Not Required

Valid Boolean

TaxTypeIdSales Integer Not Required

Valid Integer

TaxTypeIdPurchases Integer Not Required

Valid Integer

LastCost Decimal Not Required

Valid Decimal

AverageCost Decimal Not Required

Valid Decimal

QuantityOnHand Decimal Not Required

Valid Decimal

TotalQuantity Decimal Not Required

Valid Decimal

TotalCost Decimal Not Required

Valid Decimal


Valid Boolean

Unit String Less Than 100

Valid String

OpeningCost Decimal Not Required

Valid Decimal

OpeningQuantity Decimal Not Required

Valid Decimal

OpeningBalanceId Integer Not Required

Valid Integer

OpeningBalanceDate DateTime Not Required

Valid DateTime

CategoryDescription String Valid String

CategoryId Integer Valid Integer relating back to an actual Category object Id

Journal Entry




Effect Effect Valid Effect


Page 129 of 157

AccountId Integer Valid Integer relating back to an actual Account Object Id



TaxTypeId Integer Valid Integer relating back to an actual TaxType Id




ContraAccountId Integer Valid Integer relating back to an actual Account Object Id



Valid Boolean

ListWithAccountReportingValues


ReportingPeriods List<ReportingPeriod> Required

List of ReportingPeriod

ListWithReportingPeriods


ReportingPeriods List<ReportingPeriod> Required

List of ReportingPeriod

OpeningBalance


ID Integer Required




PaidUserReferral


ID Integer Required

ReferrerRegistrationID Integer Required

ReferredRegistrationID Integer Required

Paid Boolean Required

PaidDate DateTime Not Required

Processed Boolean Required

PaymentReference String Required

PeriodGrouping


PeriodGroupingType Integer Required

Valid PeriodGroupingType


StartDate DateTime Required


Page 130 of 157

EndDate DateTime Required

PeriodComparativeType Integer Required

Valid PeriodComparativeType

ProfitAndLossReportingLevel


Total List<Decimal> Not Required

ID Integer Required


Category String Required

CategoryId Integer Not Required


Children List<ProfitAndLossReportingLevel> Required

ReportingLevelType

Integer Required




Parent ProfitAndLossReportingLevel Required

ProvisionalTaxAdjustment


ID Integer ID

Date DateTime Date

Description String Description

Total Decimal Total

PurchaseOrder


DeliveryDate DateTime Required

SupplierId Integer Required

Supplier Supplier Required

ID Integer Required

Masterfile Supplier Required


Inclusive Boolean Required

DiscountPercentage Single Required


Required


Required


Required


Required

Discount Decimal Required



Rounding Decimal Required


Page 131 of 157


AmountDue Decimal Required

PostalAddress01 String Required

Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100

DeliveryAddress01 String Required

Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100

Printed Boolean Required

Quote


ExpiryDate DateTime Required

CustomerId Integer Required

CustomerName String Required

Customer Customer Required



Valid Error! Reference ource not found.

ID Int32 Required

Masterfile Customer Required


Inclusive Boolean Required

DiscountPercentage Single Required

TaxReference String Required



Message String Required




Rounding Decimal Required



Page 132 of 157

AmountDue Decimal Required


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


ReportingGroup


ID Integer Required

ParentReportingGroupId Integer Not Required


AccountCategory Account Category Required

ReportingLevel


ID Integer Required


Less than 100



AccountTypeId Integer Not Required

Children List<ReportingLevel> Required





Parent ReportingLevel Required

ReportingPeriod


Period Integer Required


Page 133 of 157

StartDate DateTime Required

EndDate DateTime Required



Reseller


ID Integer Required

ResellerCode String Required

Less than 100

DisplayName String Required

Less than 100

Password String Required

IncludeInPaymentStatistics Boolean Required

DefaultCountryId Integer Not Required

DefaultDaysToExpiry Integer Not Required

DefaultRegistrationType

Integer Not Required

Valid Error! Reference source ot found.

Created DateTime Required

ResellerProductBundle


ID Integer Required

ResellerId Integer Required

ProductBundle String Required

Reseller Reseller Required

SalesBySalesRepresentative





Name

None = 0

Print = 1

Email = 2

Both = 3

Document Type

SalesRepresentativeId Integer Required



UnitPriceExclusive Decimal Required

Quantity Decimal Not Required

TotalCost Decimal Required



CustomerName String Required


Page 134 of 157

GPAmount Decimal Required

GPPercentage Decimal Required

TotalGroupAverage Decimal Required

TotalReportAverage Decimal Required

SalesRepresentative


ID Integer Required

FirstName String Required

Less than 50

LastName String Required

Less than 50


Less than 30


Less than 30


Less than 100


SalesRepresentativeNote


SalesRepresentativeId Integer Required

SalesRepresentativeNoteId Integer Required


SecretarialCompanyRole


ID Integer Required


Less than 100

SecretarialShareCapitalIssued


ID Integer Required

CertificateNumber String Required

Less than 100

SecretarialShareClassId Integer Required

SecretarialShareholderId Integer Required

AllotmentDate DateTime Required

QuantityOfShares Integer Required

NominalValue Decimal Required

ValueOfShares Decimal Required

ShareStatusId Integer Required

Paid Decimal Required


Page 135 of 157

Secretarial ShareClass


ID Integer Required

ShareClass String Required

Less than 100

Must not contain angle brackets

Must not contain double spaces

QuantityOfShares Integer Required

NominalValue Decimal Required

ValueOfShares Decimal Required

Secretarial ShareHolder


ID Integer Required


Less Than 100

IDNumber String Required

Less Than 100

DateOfBirth DateTime Not Required

Nationality String Not Required

Less Than 100

TaxNumber String Not Required

Less Than 100

HasOwnership Boolean Required

OwnershipAppointmentDate DateTime Not Required

OwnershipResignationDate DateTime Not Required

OwnershipHoldingAmount Integer Not Required


IsPerson Boolean Required


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100

PhysicalAddress01 String Not Required

Less than 100


Less than 100


Less than 100


Less than 100


Page 136 of 157


Less than 100

BusinessAddress01 String Not Required

Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 30


Less than 30


Less than 100


Secretarial StakeHolder


ID Integer Required


Less Than 100

IDNumber String Required

Less Than 100

DateOfBirth DateTime Not Required

Nationality String Not Required

Less Than 100

TaxNumber String Not Required

Less Than 100

HasOwnership Boolean Required

OwnershipAppointmentDate DateTime Not Required

OwnershipResignationDate DateTime Not Required

OwnershipHoldingAmount Integer Not Required


IsPerson Boolean Required


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100



Page 137 of 157

Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 30


Less than 30


Less than 100

Secretarial StakeHolderNote


StakeholderId Integer Required



Not Empty




Note String Valid String


Secretarial StakeHolderRole


ID Integer Required

SecretarialStakeHolderId Integer Required

SecretarialCompanyRoleId Integer Required


AppointmentDate Date Required

ResignationDate Date Not Required


Page 138 of 157

StatementOfAssetsAndLiabilitiesReportingLevel



ID Integer Required


Less than 100




Children List<StatementOfAssetsAndLiabilitiesReportingLevel> Required





Parent StatementOfAssetsAndLiabilitiesReportingLevel Required

StorageInformation

Field Name Type

SizeUsed

Long

MaxSizeAllowed

Long

Supplier




Less than 100

Must be Unique


Category Supplier Category Not Required

Valid Supplier Category


Less than 30


Less than 30


Less than 30


Less than 30


Less than 30


Less than 100


Less than 100




Page 139 of 157



Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100

AutoAllocateToOldestInvoice

Boolean Not Required

Supplier Adjustments



Date DateTime Valid Date Required

SupplierId Integer Valid Integer relating back to an actual supplier id




TaxTypeId Integer Valid Integer relating back to an actual Tax Type Id




ContraAccountId Integer Valid integer relating back to an actual account id


HasAttachments Boolean Valid Boolean

Supplier Ageing

Field Name Type

Supplier Supplier


Page 140 of 157

Date DateTime

AgeingTransactions List< Ageing Transaction>

Supplier Category




Less than 100

Unique Description

No Angle Brackets

No Double spaces

Supplier Commercial Document



Valid Supplier



Masterfile T Valid T





Valid String


Valid String


Valid String


Valid String







Currency


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100



Page 141 of 157

Less Than 100


Less Than 100


Less Than 100


Less Than 100


Lines List<Commercial Document Lines> Valid List of Commercial Document Lines

Supplier Invoice




Valid Supplier








Valid String


Valid String


Valid String


Valid String







Currency


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Page 142 of 157


Less Than 100


Less Than 100


Less Than 100


Less Than 100




Supplier Note



SupplierId Integer Valid Integer


Less than 100

Unique Name


Valid DateTime


Valid DateTime


Valid Boolean


Less than 100

Unique Name


Valid Boolean

Supplier Opening Balance


ID Integer Required




Supplier Payment


ID Integer Required



DocumentNumber Integer Required

Less than 100


Less than 100



Page 143 of 157

Less than 100


Less than 100



TotalUnallocated Decimal Required

Reconciled Boolean Required


PaymentMethod Integer Required

Valid PaymentMethod

Supplier Purchase History

Field Name Type


Valid Supplier



Supplier Return



Valid Supplier








Valid String


Valid String


Valid String


Valid String







Currency


Less Than 100


Less Than 100



Page 144 of 157

Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100




Supplier Statement

Field Name Type


StatementLines List<SupplierStatementLine> Required

Valid List of SupplierStatementLine


TotalDue Decimal Required

TotalPaid Decimal Required

Current Decimal Not Required

Days30 Decimal Not Required



Days120Plus Decimal Not Required


SupplierStatementLine

Field Name Type




Name

None = 0

Print = 1

Email = 2

Both = 3

Document Type

Date DateTime Not Required

DateAllocation DateTime Required



Page 145 of 157

DocumentNumberAllocation String Required





AgingPeriod Integer Required



SupplierTakeOnBalance


OpeningBalance Decimal Not Required

OpeningBalanceID Integer Not Required

OpeningBalanceDate Date Not Required

CategoryDescription String Required

CategoryID Integer Not Required



Less than 100

Must be Unique


Category Supplier Category Not Required

Valid Supplier Category


Less than 30


Less than 30


Less than 30


Less than 30


Less than 30


Less than 100


Less than 100





Less than 100


Less than 100


Less than 100


Page 146 of 157


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100


Less than 100

AutoAllocateToOldestInvoice

Boolean Not Required

SystemAccount

Field Name Type

ID Integer Required




AllowDirectTakeOnBalance Boolean Required

NonDirectTakeOnBalanceURL String Required

SystemAccountReportingGroup

Field Name Type

ID Integer Required

SystemAccountId Integer Required

ReportingGroupId Integer Required

TakeOnAccountBalance

Field Name Type

ID Integer Required


GroupKey Integer Required

Category AccountCategory Required

AccountType Integer Required

Valid TakeOnBalanceAccountType

LinkId Integer Not Required



EntryUrl String Not Required

TakeOnAccountDetail

Field Name Type

ID Integer Required


Page 147 of 157

TakeOnAccountGroups List<TakeOnAccountGroup> Required

List of TakeOnAccountGroup

TakeOnDate Date Required

TakeOnSuspenseAcountBalance Decimal Required

TakeOnAccountGroup

Field Name Type

TakeOnAccountBalances List<TakeOnAccountBalance> Required

List of TakeOnAccountBalance

Order Integer Required

AddUrl String Required


TaxAdjustment

Field Name Type

ID Integer Required

Date Date Required



OpeningBalanceTransaction

Boolean Required

TaxInvoice

Field Name Type


FromDocument String Required

AllowOnlinePayment Boolean Not Required



Customer Customer Valid Customer










Valid String


Valid String


Valid String


Valid String


Page 148 of 157







Currency


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100


Less Than 100




Tax Type

Field Name Type

ID Integer

Name String

Percentage Float

IsDefault Boolean

HasActivity Boolean

IsManualTax Boolean

ToDoListItem

Field Name Type

ID Integer Required

ToDoListCategory

Integer Required

Valid ToDoListCategory



DueDate Date Not Required


Amount Decimal Required


Page 149 of 157

Top Customer By Sales

Field Name Type





Top Purchased Item

Field Name Type

ItemId Integer Required




Quantity Decimal Required

Top Selling Item

Field Name Type





Quantity Decimal Required

Top Selling Item By Value On Hand

Field Name Type



QuantityOnHand Decimal Required

AverageCost Decimal Required

ValueOnHand Decimal Required

TopSuppliersByPurchases

Field Name Type





Transaction

Field Name Type

ID Integer Required


TransactionType Integer Required


Name

None = 0

Print = 1


Page 150 of 157

Email = 2

Both = 3

Document Type

Total Long Required

Date String Required

PaymentMethodId Integer Not Required

Valid PaymentMethod

AllocatedTransactions IEnumerable<Error! Reference source not found.>

Required

TrialBalance

Field Name Type

FromDate Date Required

ToDate Date Required

TrialBalanceLines List<TrialBalance> Required

List of TrialBalance

NetProfit Decimal Required

TrialBalanceData

Field Name Type




AccountCategory Account Category Required

Active String Required


AccountNumber String Required


TrialBalanceAccountTypeId Integer Required

TrialBalanceAccountType Integer Required

Valid TrialBalanceAccountType

Order Integer Required



TrialBalanceReportingLevel

Field Name Type

ID Integer Required





Children List<TrialBalanceReportingLevel> Required





Parent TrialBalanceReportingLevel Required


Page 151 of 157




VAT201Data

Field Name Type

VatCode String Required

VatCodeDescription String Required


Vat Decimal Required

VatType String Required

SortInd Integer Required


Page 152 of 157

Request Models

AccountantNoteDueInDateRangeRequestModel




AccountantNoteRequestModel


CompanyId Integer Not Required

Date Date Required

AuthenticationCredentials


Username String Required

Password string Required

BalanceSheetRequestModel


RunAtDate Date Required

DisplayReportingGroupDetail Boolean Required

BudgetFromHistoricDataRequestModel




ID Integer Required

AdjustmentType Integer Required


AdjustmentPercentage Decimal Required

Rounding Integer Required


BudgetRequestModel


NumberOfPeriods Integer Not Required

BudgetStartDate Date Required

CashMovementRequestModel





IncludeCreditNotes Boolean Required

GroupingType Integer Required



Page 153 of 157

ComparativeProfitAndLossStatementRequest





PeriodGroupingLength Integer Required

Comparative Boolean Required

BudgetId Boolean Not Required

ShowVariance Boolean Required

*Use Purchase – Cost of Sales can be based on either Purchases or Sales; Default is By Purchases *Period Grouping Length – In Months, for example for quarterly groupings use 3

ComparitiveStatementOfAssetsAndLiabilitiesRequestModel




PeriodLength Integer Required


*Period Length – In Months, length between reporting periods; for example if the from date and to date are a year

apart and the period length is 4 you will receive 3 periods on your comparative report.

CustomerAgeingRequestModel




Summary Boolean Required

AgeingPeriod Integer Not Required

Valid Ageing Period

FromCustomer String Not Required

ToCustomer String Not Required

FromCategory String Not Required

ToCategory String Not Required

IncludeActive Boolean Not Required

IncludeInactive Boolean Not Required

BasedOnDueDate Boolean Not Required

CustomerSalesHistoryRequestModel






CustomerStatementRequestModel




Page 154 of 157


FromCustomer String Required

ToCustomer String Required

FromCategory String Required

ToCategory String Required

IncludeActive Boolean Required

IncludeInactive Boolean Required

CommunicationMethod Integer Required


ExcludeZeroBalanceAccounts Boolean Required

Detailed Boolean Required

ExcludeFullyAllocated Boolean Required

ShowBalanceBroughtForward Boolean Required

ExcludeNegativeBalance Boolean Required

UseMinimumBalance Boolean Required

MinimumBalance Decimal Required

DateRange




DocumentLineDashboardRequestModel




IncludeOption Boolean Required

ViewTop Integer Required

EmailRequestModel


ID Integer Required

EmailAddress String Required

CCAddress String Required



IncomeVsExpenseRequestModel







ProfitAndLossStatementRequestModel




Page 155 of 157






BudgetId Integer Not Required

ShowVariance Boolean Required

QuickEnquiryOverviewDetailsRequestModel


LinkId Integer Required

IsCustomer Boolean Required

SalesBySalesRepresentativeRequestModel


FromSalesRepresentative String Required

ToSalesRepresentative String Required



IncludeActive Integer Required



IncludeItems Boolean Required

IncludeAccounts Boolean Required

UseLastCost Boolean Required

StatementOfAssetsAndLiabilitiesRequestModel




SupplierAgeingRequestModel




Summary Boolean Required

AgeingPeriod Integer Not Required

Valid Ageing Period

FromSupplier String Not Required

ToSupplier String Not Required

FromCategory String Not Required

ToCategory String Not Required

IncludeActive Boolean Not Required

IncludeInactive Boolean Not Required

BasedOnDueDate Boolean Not Required

SupplierPurchaseHistoryRequestModel




Page 156 of 157



IncludeSupplierReturns Boolean Required

GroupingType Integer Required o NoGrouping=0, o MonthGrouping=1, o DayGrouping=2

SupplierStatementRequestModel




FromSupplier String Required

ToSupplier String Required

FromCategory String Required

ToCategory String Required

IncludeActive Boolean Required


ExcludeZeroBalanceAccounts Boolean Required

Detailed Boolean Required

ExcludeFullyAllocated Boolean Required

ShowBalanceBroughtForward Boolean Required

ExcludeNegativeBalance Boolean Required

UseMinimumBalance Boolean Required

MinimumBalance Decimal Required

TopCustomersBySalesRequestModel





TopCustomersByOutstandingBalanceRequestModel



TopPurchasedItemRequestModel







Page 157 of 157

TopSellingItemRequestModel






TopSellingItemByValueOnHandRequestModel



UseLastCost Boolean Required


TopSuppliersByPurchasesRequestModel





IncludeSupplierReturns Boolean Required


TopSuppliersByOutstandingBalanceRequestModel



TrialBalanceRequestModel




ShowMovement Boolean Required


VAT201ReportRequestModel


CompanyId Integer Required



IncludeAdjustments Boolean Required

OffsetCredits Boolean Required

sage one...sage one api documentation – version 2.0.1 25 february 2014 page 14 of 157 overview...

Documents