Introduction
The Esuite API is a RESTful API however there are some endpoints which do not allow certain methods for security and data reliability.
Connecting
The API is usually operating on a non-standard port; which will be also be provided as part of the URL.
Usually the URL follows the following standard definition, although the specific URL will be related to the database that you are connecting to.
Esuite has 2 main versions of the API, it is recommended to use the latest version as it will have more complete functionality.
V1
https://esuiteclient.esol.com.au:port/api/endpoint
V2
https://esuiteclient.esol.com.au:port/api/v2/endpoint
Authentication
To use this API, you need an API key which will be provided to you.
It can be provided to you in 2 ways either as a Username and Password pair or a Token.
Endpoints
The following endpoints are available through the API:
| Endpoint | Description | CRUD Completeness |
|---|---|---|
| trans | All functions relating to transactions. | Full CRUD |
| stock | All functions relating to stock. | Full CRUD |
| cust | All functions relating to customers - Sales Ledger | Full CRUD |
| supp | All functions relating to suppliers - Purchase Ledger | Full CRUD |
| notes | All Functions related to notes - All ledgers | Create, Read, and Update - Cannot Delete. |
| sp | Access to customised datasets per integration. | Read Only |
| codes | All Functions related to analysis codes | Read Only |
Responses
The API returns the following error responses:
| Response No | Meaning |
|---|---|
| 400 | Error with URL - Message should provide further information. i.e. Incomplete URL |
| 403 | Not Authorized - Issue with Token provided or token missing |
| 404 | Resource not found - Response should provide further information. |
| 500 | Web Request Failed - Message should provide further information. |
| 501 | Supplied method not supported. |
All Endpoints share the following error responses:
| Response No | Meaning |
|---|---|
| 405 | Method chosen is not implemented for that endpoint. |
{
"StatusCode": "400",
"Description": "No Payload Found"
}
Company
The Company Endpoint lists all of the available companies under the current structure.
endpoint: company
GET
{
"Company": [
{
"CompanyNo": 1234,
"CompanyCode": "COMP1",
"CompanyPrefix": "A",
"CompanyName": "Company A",
"CompanyPhone": "02 9999 9999"
},
{
"CompanyNo": 1235,
"CompanyCode": "COMP2",
"CompanyPrefix": "B",
"CompanyName": "Company B",
"CompanyPhone": "02 9999 9999"
}, {
"CompanyNo": 1236,
"CompanyCode": "COMP3",
"CompanyPrefix": "C",
"CompanyName": "Company C",
"CompanyPhone": "02 9999 9999"
}, {
"CompanyNo": 1237,
"CompanyCode": "COMP4",
"CompanyPrefix": "D",
"CompanyName": "Company D",
"CompanyPhone": "02 9999 9999"
}
]
}
Transaction
The Transaction endpoint defines methods to list, create, and update transactions.
endpoint: trans
Accepted Methods:
| Method | Usage |
|---|---|
| GET | Retrieves one or more transactions |
| POST | Creates a new transaction |
| PUT | Updates an existing transaction |
| DELETE | Deletes an existing transaction |
GET
Returns a single or multiple transactions depending on the parameters passed.
If you provide no parameters then it will attempt to return all transactions in the system.
Examples - note these are just examples and might not return any data for your specific situation.
| Version | Endpoint | Parameters |
|---|---|---|
| V1 | trans | ESIN-150 |
| V2+ | trans | TransDate=2020-08-25 |
| V2+ | trans | AccountRef=CUST01 |
| V2+ | trans | DateFrom=2020-08-25&DateTo=2020-08-30TransType=SIN |
Parameters - this is not the full list of parameters as any field in the transaction table is available to be referenced but these will be the most useful. When searching for transactions, more filters are preferred to less, as it will ensure the most relevant data.
Query Parameters - V1
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| TransRefCode | string | ESIN-1234 | Returns a single transaction corresponding to the transction reference provided |
Query Parameters - V2 Onwards
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| PK | boolean | 1 | Only returns Primary Fields | |
| Limit | integer | 100 | Specifies a limit to the amount of results retrieved | |
| PageNo | integer | 1 | Specifies the PageNo of the results - used with PageSize | |
| PageSize | integer | 100 | Specifies the amount of results per page - used with PageNo | |
| TransRefCode | string | ESIN-1234 | Returns a single transaction corresponding to the transction reference provided | |
| TransType | string | SIN | Return all transactions of a specific type | |
| TransLedger | string | S | Return all transactions of a specific ledger | |
| AccountRef | string | CUST01 | Return all transactions for a specific customer | |
| InfoCreated | date | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all transactions created from the provided date |
| InfoModified | date | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all transactions modified from the provided date |
| TransCreated | date | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all transactions created on the provided date |
| TransModified | date | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all transactions modified on the provided date |
| DateFrom | date | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all transactions where the marked date is on or after the provided date |
| DateTo | date | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all transactions where the marked date is on or before the provided date |
| InclDetails | boolean | 0 | States whether the resultset should include Item Details (defaults to true) | |
| InclDelivery | boolean | 0 | States whether the resultset should include Delivery Details (defaults to false) | |
| InclStkAttributes | boolean | 0 | States whether the resultset should include Stock Attribute Details (defaults to false) | |
| ShowDeleted | boolean | 1 | States whether the resultset should search on Deleted Transactions (defaults to false) |
Result example - Single Transaction:
{
"Trans": [
{
"CompanyNo": "36015",
"TransNo": "1464552",
"LedgerCompanyNo": "36015",
"LocationNo": "30",
"OriginCompanyNo": "36015",
"OriginLocationNo": "30",
"AccountCompanyNo": "36015",
"AccountNo": "2",
"AccountRef": "CASH01",
"BatchNo": "172345",
"BatchType": "SPI",
"BatchRefCode": "SIN:34172",
"TransRefCode": "PSIN-406223",
"TransYourRef": "",
"TransComment": "",
"OrderNo": "",
"InvoiceNo": "406223",
"CampaignCode": "",
"CostCentreCode": "AS-MD",
"SegmentCode": "AST",
"TransLedger": "S",
"TransType": "SIN",
"TransRefNo": "406223",
"TransDate": "2020-09-24 00:00:00",
"TransPeriod": "202103",
"TransDueDate": "202-09-24 00:00:00",
"TransPriceBand": "R",
"PaymentEntryAmt": "15",
"PaymentBankAmt": "15",
"TransCurrency": "AUD",
"TransExRate": "1",
"TransTotalExGST": "13.64",
"TransTotalGST": "1.36",
"TransTotalIncGST": "15",
"TransIncGST": "True",
"AccountAmt": "0",
"AccountOutstanding": "0",
"EDIInterface": "",
"PrintRunNo": "",
"PrintDate": "",
"ExportRunNo": "",
"ExportDate": "",
"TransProformaExGST": "13.64",
"TransProformaGST": "1.36",
"TransProformaIncGST": "15",
"TransCreated": "2020-09-24 12:04:13",
"TransModified": "2020-09-24 12:04:13",
"CreatedUser": "53",
"ModifiedUser": "53",
"SourceTransRefCode": "",
"AltTransRefCode": "",
"EDIAccountRef": "",
"TransSaved": "Y",
"TransStatus": "Y",
"Actioned": "",
"ActionMessage": "",
"T_TrnDet": [
{
"CompanyNo": "36015",
"TransNo": "1464552",
"DetailNo": "7",
"ItemNo": "7",
"AccountCompanyNo": "36015",
"AccountNo": "2",
"JobCode": "",
"StockNo": "43179",
"StockCode": "000250a",
"StockDesc": "Item B",
"LocationNo": "30",
"LocationCode": "AS-MD",
"CampaignCode": "",
"CostCentreCode": "AS-MD",
"SegmentCode": "AST",
"LineType": "S",
"LineGSTType": "GST",
"LineGSTRate": "0.1",
"LineIncGST": "True",
"LinePackQty": "1",
"LinePackInnerQty": "1",
"LineQty": "1",
"LinePriceBand": "R",
"LineUnitPrice": "5",
"LineUnitDiscount": "0",
"LineUnitCostExGST": "0",
"LineDiscountType": "",
"LineTotalExGST": "4.55",
"LineTotalGST": "0.45",
"LineTotalIncGST": "5",
"LineSourceCompanyNo": "0",
"LineSourceTransNo": "0",
"LineSourceDetailNo": "0",
"LineSourceQty": "0",
"LineActionedQty": "0",
"LineCancelledQty": "0",
"LineOutstandingQty": "0",
"LineOutstanding": "",
"LineDetails": "",
"LineDlvMode": "TAK",
"LineDueDate": "",
"LineDlvCompanyNo": "36015",
"LineDlvLocationNo": "30",
"LineDlvQty": "1",
"LineUnit": "",
"LineStockWeight": "0",
"LineStockVolume": "0",
"LineUserStr1": "",
"LineUserStr2": "",
"LineUserStr3": "",
"LineUserStr4": "",
"LineUserStr5": "",
"LineUserStr6": "",
"LineUserNum1": "",
"LineUserNum2": "",
"LineUserNum3": "",
"LineUserNum4": "",
"LineUserAmt1": "",
"LineUserAmt2": "2",
"LineUserDate1": "",
"LineUserDate2": ""
},
{
"CompanyNo": "36015",
"TransNo": "1464552",
"DetailNo": "8",
"ItemNo": "8",
"AccountCompanyNo": "36015",
"AccountNo": "2",
"JobCode": "",
"StockNo": "35310",
"StockCode": "000003",
"StockDesc": "Item A",
"LocationNo": "30",
"LocationCode": "AS-MD",
"CampaignCode": "",
"CostCentreCode": "AS-MD",
"SegmentCode": "AST",
"LineType": "S",
"LineGSTType": "GST",
"LineGSTRate": "0.1",
"LineIncGST": "True",
"LinePackQty": "1",
"LinePackInnerQty": "1",
"LineQty": "1",
"LinePriceBand": "R",
"LineUnitPrice": "10",
"LineUnitDiscount": "0",
"LineUnitCostExGST": "0.67",
"LineDiscountType": "",
"LineTotalExGST": "9.09",
"LineTotalGST": "0.91",
"LineTotalIncGST": "10",
"LineSourceCompanyNo": "0",
"LineSourceTransNo": "0",
"LineSourceDetailNo": "0",
"LineSourceQty": "0",
"LineActionedQty": "0",
"LineCancelledQty": "0",
"LineOutstandingQty": "0",
"LineOutstanding": "",
"LineDetails": "",
"LineDlvMode": "TAK",
"LineDueDate": "",
"LineDlvCompanyNo": "36015",
"LineDlvLocationNo": "30",
"LineDlvQty": "1",
"LineUnit": "",
"LineStockWeight": "0",
"LineStockVolume": "0",
"LineUserStr1": "",
"LineUserStr2": "",
"LineUserStr3": "",
"LineUserStr4": "",
"LineUserStr5": "Grub Screw Packs (set of 8x) - Black",
"LineUserStr6": "",
"LineUserNum1": "",
"LineUserNum2": "",
"LineUserNum3": "",
"LineUserNum4": "",
"LineUserAmt1": "",
"LineUserAmt2": "2",
"LineUserDate1": "",
"LineUserDate2": ""
}
],
"T_TrnDlv": [
{
"CompanyNo": 1234,
"TransNo": 50249,
"TransLedger": "",
"AccountRef": "",
"DlvContactName": "Test Account",
"DlvTitle": "",
"DlvSalute": "",
"DlvFirstname": "TEST",
"DlvLastname": "Account",
"DlvBusinessName": "",
"DlvDivisionName": "",
"DlvAddress1": "1/15 Travellers Street,",
"DlvAddress2": "",
"DlvAddress3": "",
"DlvAddress4": "",
"DlvSuburb": "Altona West",
"DlvState": "SA",
"DlvPostcode": "2588",
"DlvCountry": "AU",
"DlvPhone": "1234567890",
"DlvEmail": "webmaster@travellers.com",
"DlvComments": "",
"DlvFreightMethod": "",
"DlvFreightLabels": "",
"DlvFreightLabelQty": "",
"DlvFreightDate": "",
"DlvUserStr1": "",
"DlvUserStr2": ""
}
]
}
}
]
}
POST / PUT
POST and PUT are very similar - both are used to Create or Update a single transaction.
A minimum viable payload is presented on the right - full fields are available in the Fields List.
The tables below specify any required fields for each table - and the Account Identifier fields describes all of the fields you can supply to specify the account
Account Identifier Fields
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| AccountNo | integer | 150 | This is the internal unique account identifying number. Must be set to -1 for new accounts | |
| AccountRef | string | CUST01 | This is the account reference. | |
| AccountAltRef | string | CUST02 | This is the alternative account reference. | |
| AccountBusinessNumber | string | 123456789 | This is the business number of the account. |
T_Trans
| Method | Field | Type | Format | Example | Description |
|---|---|---|---|---|---|
| Both | BatchType | string | SAR | This specifies the type of transaction | |
| Both | TransLedger | string | S | This specifies the ledger for the transaction | |
| POST | Account Identifier | string | This is one of the account identifiers described above | ||
| POST | TransType | string | SOR | Further specification for Transaction Type | |
| POST | DlvAddressNo | integer | -1 | If overriding the Delivery Address this must be set to -1 | |
| PUT | CompanyNo | integer | 1500 | This is the unique identifier of the specific database | |
| PUT | TransNo | integer | 280 | This is the unique identifier of the specific transaction |
T_TrnDet
| Method | Field | Type | Format | Example | Description |
|---|---|---|---|---|---|
| POST | StockCode | string | ABC123 | This is the unique identifer of the stock item |
T_TrnDlv (Optional)
There are no required fields for the T_TrnDlv Table.
T_Pay (Optional)
| Method | Field | Type | Format | Example | Description |
|---|---|---|---|---|---|
| POST | PaymentType | string | EFT | This is the method of payment used | |
| POST | PaymentAmt | float | 46.2 | This is the total payment amount for this particular method | |
| POST | AuthBankPosted | string | B | This is set when it is a payment method that usually requires banking |
T_Serial (Optional)
| Method | Field | Type | Format | Example | Description |
|---|---|---|---|---|---|
| POST | SerialNo | string | 123456-ABC | This is the serial number for an item | |
| POST | StockCode | string | ABC123 | This is the stock item that the serial number goes against | |
| POST | SerialQty | float | 123.45 | The amount of items that are being actioned against the serial number |
{
"T_Trans":{
"AccountRef":"00000P03",
"TransDate":"2020-08-09",
"TransComment":"",
"TransIncGST":"True",
"TransYourRef":"WEB-183977",
"CostCentreCode":"ABC",
"DlvAddressNo":-1,
"BatchType":"SAR",
"SegmentCode":"W",
"TransLedger":"S",
"LocationNo":23,
"TransUserStr1":2092
},
"T_TrnDet":[{
"StockCode":"ITEM A",
"LineQty":2,
"LineUnitPrice":"39.95",
"LineIncGST":"True"
},
{
"StockCode":"ITEM B",
"LineQty":1,
"LineUnitPrice":"12.00",
"LineIncGST":"True"
}],
"T_Pay":{
"PaymentType":"CASH",
"PaymentAmt":"51.95"
},
"T_TrnDlv":{
"DlvFirstname":"Person",
"DlvLastname":"Incognito",
"DlvAddress1":"123 Fake Street",
"DlvAddress2":"",
"DlvSuburb":"Alabaster",
"DlvState":"VIC",
"DlvPostCode":"3188",
"DlvCountry":"AU",
"DlvPhone":"",
"DlvEmail":"Person@incognito.com",
"DlvBusinessName":"",
"DlvComments":""
}
}
Delete
The delete method will delete a transaction from the system.
Required Fields
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| CompanyNo | integer | 123456 | This is the unique identifier of the specific database | |
| TransNo | integer | S | This is the unique identifier of the specific transaction | |
| BatchType | string | SAR | This specifies the type of transaction |
{
"T_Trans":{
"CompanyNo":123456,
"TransNo":1464547,
"BatchType":"SAR"
}
}
V1
Version 1 is very similar to Version 2, but the GET functionality is limited to a single transaction lookup.
Responses
The Transaction endpoint includes the following specific responses:
| Response No | Meaning |
|---|---|
| 204 | No transaction data found for the specific parameters | 400 | Error with Payload - Message should provide further information. i.e. Error with Payload - No T_Trans Data found |
Creating / Updating a Transaction
{
"T_Trans": {
"CompanyNo": "36015",
"TransNo": "1464547",
"TransRefCode": "PSIN-123456"
}
}
Deleting a Transaction
{
"T_Trans": {
"Deleted": "true",
"CompanyNo": "36015",
"TransNo": "1464547",
"TransRefCode": "PSIN-123456"
}
}
Options
The Options method returns information about specific fields that might be required as well as specific user defined fields and their aliases.
Returned Data - for Sales and Purchase Ledger
| Entry | Definition |
|---|---|
| Version | Shows the current version of the Notes endpoint to compare against the Changelog |
| Active Batch Types | Shows all the active transactions that can be made and their corresponding batch type |
| Custom Fields Transaction | Shows the Transaction Header (T_Trans) level custom fields and their aliases |
| Custom Fields Items | Shows the Transacation Item (T_TrnDet) level custom fields and their aliases |
| Payment Types | Shows all the active payment types that are available to be used |
{
"Version": "1.0.0",
"Sales": {
"Active Batch Types": "POS Invoice=SPI,
Sales Order=SO,
Order with Receipt/New Customer=SAR",
"Custom Fields Transaction": "STransMemo=STransMemo,
Sales Person=STransUserStr1,
Delivery Run=STransUserStr2,
Sort (See UNum1)=STransUserStr3,
Customer Type=STransUserStr4,
Dlv Modes=STransUserStr5,
Comment=STransUserStr6,
STransUserAmt1=STransUserAmt1,
STransUserAmt2=STransUserAmt2,
Staff Points=STransUserNum1,
Delivery Run Sort=STransUserNum2,
STransUserDate1=STransUserDate1,
STransUserDate2=STransUserDate2,
STransUserDate3=STransUserDate3,
STransUserDate4=STransUserDate4,
Message=STransMsgNo",
"Custom Fields Items": "SLineUserStr1=SLineUserStr1,
SLineUserStr2=SLineUserStr2,
Dlv Comment=SLineUserStr3,
Serial No=SLineUserStr4,
Voucher No=SLineUserStr5,
Line Comments=SLineUserStr6,
SLineUserAmt1=SLineUserAmt1,
SLineUserAmt2=SLineUserAmt2,
SLineUserNum1=SLineUserNum1,
SLineUserNum2=SLineUserNum2,
SLineUserDate1=SLineUserDate1,
SLineUserDate2=SLineUserDate2",
"Sales Payment Types": "ACC,CASH,CHQ,COUP,
CRED,EFT,FIN,LBY,
MO,REV,REX,VOUCH,
WEB,XC,XFR,ZIP,
NONE"
},
"Purchase": {
"Active Batch Types": "Order=PO,
Order With Payment=POP,
Invoice=PI,
Invoice With Payment=PIP,
Payment=PP,
Return With Credit=PRT,
Credit Note=PCR",
"Custom Fields Transaction": "PTransMemo=PTransMemo,
Vessel / Voyage=PTransUserStr1,
Delivery Warehouse=PTransUserStr2,
Slot No=PTransUserStr3,
Container No=PTransUserStr4,
Bring in Date=PTransUserStr5,
Status=PTransUserStr6,
PTransUserAmt1=PTransUserAmt1,
PTransUserAmt2=PTransUserAmt2,
PTransUserNum1=PTransUserNum1,
PTransUserNum2=PTransUserNum2,
First Free Day=PTransUserDate1,
Last Free Day=PTransUserDate2,
ETA Due=PTransUserDate3,
Bring in Date=PTransUserDate4,
Message=PTransMsgNo",
"Custom Fields Items": "Our Colour=PLineUserStr1,
Sup Colour=PLineUserStr2,
Sup Range=PLineUserStr3,
Serial No=PLineUserStr4,
PLineUserStr5=PLineUserStr5,
PLineUserStr6=PLineUserStr6,
PLineUserAmt1=PLineUserAmt1,
PLineUserAmt2=PLineUserAmt2,
PLineUserNum1=PLineUserNum1,
PLineUserNum2=PLineUserNum2,
PLineUserDate1=PLineUserDate1,
PLineUserDate2=PLineUserDate2",
"Purchase Payment Types": "CASH,
CHQ,
TTX,
USD,
NONE"
}
}
Stock
The stock endpoint defines methods to list, create, and update stock records.
By default, all stock items that have not been marked as discontinued will be returned.
Headers, and Category Headers are not counted as stock items in this regard, and will need a specific flag passed to be returned.
endpoint: stock
Accepted Methods:
| Method | Usage |
|---|---|
| GET | Retrieves one or more stock items |
| POST | Creates a new stock item |
| PUT | Updates an existing stock item |
| DELETE | Discontinues an existing stock item |
GET
Query Parameters - V2 Onwards
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| PK | boolean | 1 | Only returns Primary Fields | |
| Limit | integer | 100 | Specifies a limit to the amount of results retrieved | |
| PageNo | integer | 1 | Specifies the PageNo of the results - used with PageSize | |
| PageSize | integer | 100 | Specifies the amount of results per page - used with PageNo | |
| StockCode | string | Item A,Item B | Returns data for the selected stock codes - codes can be passed as a comma separated list | |
| InfoCreated | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all stock codes created from the provided date |
| InfoModified | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all stock codes modified from the provided date |
| QtyModified | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all stock codes where the quantities have changed from the provided date |
| StockCreated | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all stock codes created on the provided date |
| StockModified | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all stock codes modified on the provided date |
| Priceband | string | R,T | Includes pricing information for a specified price band - can be single or a comma separated list to return multiple bands | |
| WebEnabled | boolean | 1 | Filters the results by only including items that have been marked as Web Enabled | |
| InclImages | boolean | 1 | States whether the resultset should include Stock Image information (defaults to false) | |
| InclText | boolean | 1 | States whether the resultset should include Stock Text data (defaults to false) | |
| InclAttributes | boolean | 1 | States whether the resultset should include Stock Attribute data (defaults to false) | |
| InclLinks | boolean | 1 | States whether the resultset should include Stock Link data (for Categories or codes under multiple parents) (defaults to false) | |
| InclHeaders | boolean | 1 | States whether the resultset should include Header Data (defaults to false) | |
| ImageSizeNo | int | 1 | Returns the dimensions to include in the Stock Image ResizedImageFileName string. | |
| RemoveBrand | boolean | 1 | Removes the StockBrand Description or Key from the StockDesc if exists (WARNING - will impact performance - and if description isn't set then you could have odd results i.e. if the Key is the letter E then all E's will be removed) |
|
| InclBOM | boolean | 1 | Returns Bill of Material items and Package items if a stockcode is a BOM or Package header. | |
| InclDiscontinued | boolean | 1 | Determines whether the resultset should include discontinued items (defaults to false) | |
| ImageModified | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all stock codes where the image has been modified on or after the provided datetime |
| ImageSizeNo | integer | 1 | Modifies the StkImage filenames to reflect the Image Size X,Y sizes. |
Location Paramters
These paramters are to include and filter the resultset of Stock Location Data.
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| InclStkLoc | boolean | 1 | States whether the resultset should include Stock Loc data (defaults to false) | |
| Locations | string | Loc1,Loc2,Loc3 | Specifies which locations to include in the resultset (can be comma separated list) | |
| LocCompanyList | string | COMP1,COMP2 | Returns summarised stock location data for the specified companies (can be a comma separated list, can be combined with Locations) | |
| StkLocModified | datetime | States whether the resultset should include Stock Link data (for Categories or codes under multiple parents) (defaults to false) |
Location Group Paramters
These paramters change the behaviour of the StkLoc return data by grouping multiple locations together.
The returning data is no longer location specific but is an aggregation of the grouped locations.
It is intended to be used with the above stock parameters but needs InclStkLoc=1 to be set.
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| InclStkLocGroups | boolean | 1 | States whether the resultset should include Stock Loc data (defaults to false) | |
| LocationGroups | string | AVL,NSW | Returns summarised stock location data for the specified groups (can be a comma separated list) | |
| LocCompanyList | string | COMP1,COMP2 | Returns summarised stock location data for the specified companies (can be a comma separated list, can be combined with LocationGroups) |
Branching Parameters
Tree Parameters
These paramters return different elements of the Stock table outside of the stock data.
They feature their own parameters and work outside of the above parameter lists.
If you pass through a Header code then the resultset does not include the initial 0 node and instead starts from the header node supplied.
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| StockTree | boolean | 1 | Returns the Stock Tree made of Header Codes (standard folder structure) | |
| CategoryTree | string | HeaderOne | Returns the Tree made of Category Codes (special Category header structure) | |
| PK | boolean | 1 | Only returns Primary Fields | |
| InclStock | boolean | 1 | Includes Stock Items in the result set creating a completed tree structure (defaults to false) | |
| WebEnabled | boolean | 1 | Only Includes Web Enabled items in the resultset. | |
| Header | string | Accessories | Sets the beginning node to the Header passed through - so to be able to return partial branches. | |
| InCategory | boolean | 1 | For use with StockTree endpoint - returns a tree comprised of only items that feature within the CategoryTree. |
Matrix Parameters
These paramters return specific information about Matrixes when passing through header codes / matrix codes.
They feature their own parameters and work outside of the above parameter lists.
If you are searching for true matrix items, then you do not need to supply Column / Row fields as they will use the setup fields within esuite.
Note that Categories and Matrixes cannot be used in the same query.
Common Fields
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| Matrix | boolean | 1 | Returns Matrix specific information about the code(s) provided | |
| WebEnabled | boolean | 1 | Determines whether the resultset should include Web Enabled Items (defaults to true) | |
| InclDiscontinued | boolean | 1 | Determines whether the resultset should include discontinued items (defaults to false) | |
| InfoCreated | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all stock codes created from the provided date |
| InfoModified | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all stock codes modified from the provided date |
| StockCreated | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all stock codes created on the provided date |
| StockModified | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all stock codes modified on the provided date |
Matrix Specific Parameters
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| Matrixes | string | Mat1,Mat2,...MatN | Limits the resultset to the supplied matrix codes | |
| AllMatrixes | boolean | 1 | Ignores Matrix code lookup and returns all matrix data |
Category Specific Parameters
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| Categories | string | Cat1,Cat2,...CatN | Limits the resultset to the supplied category codes | |
| AllCategories | boolean | 1 | Ignores Category code lookup and returns all category data | |
| Column | string | FieldName | Determines the field that will be viewed as the column | |
| RowN | string | FieldName | Determines the field that will be used as a row. Note that N can be any number. So Row1=FieldName&Row2=FieldName | |
| GroupBy | string | FieldName |
Specifies the Grouping on a resultset if a custom matrix is defined. Use if the items are not in their own section. If using the Group By then the resultset will be presented as CODE-GROUP : [{ Data }] If Grouping is not set completely - then groups will be returned as NULL and grouping might be inaccurate. |
|
| IgnoreBlankGroups | boolean | 1 | Used with GroupBy - only returns data where groups are set | |
| IgnoreBlankHeaders | boolean | 1 | Only return data where they are part of a category. | |
| HideBlankColumns | boolean | 1 | Will only return data where the Column Field has data. (defaults to false) |
Get - Including Priceband / Image Information / Stock Text Information
{
"Stk": [
{
"StockCode": "STOCKCODE1",
"StockNo": 54278,
"StockDesc": "An item's description here",
"StockAltRef": "",
"PurchaseGSTType": "GST",
"ParentStockCode": "PAR 001",
"WebEnabled": "True",
"POSEnabled": "False",
"LineType": "S",
"SalesPackQty": 1,
"SalesPackInnerQty": 1,
"StockBuyThis": "True",
"StockSellThis": "True",
"RecRetailPrice": "1234.56",
"StockBrand": "BRAND",
"StockBarCode": "",
"StockAltBarCode": "",
"CtnBarcode": "",
"StockQty": 129,
"StockOnHandQty": 90,
"StockPurchaseOrderQty": 113,
"StockSalesOrderQty": 39,
"StockReservedQty": 0,
"StockExpectedQty": 203,
"PurchasePackQty": 1,
"PurchasePackInnerQty": 1,
"StockUnit": "",
"SellUnit": "Each",
"BuyUnit": "Each",
"CampaignCode": "",
"CostCentreCode": "",
"SegmentCode": "SEG1",
"WebStatus": "R",
"StockTreeSort": 0,
"LineDlvMode": "",
"StockSerialMode": "N",
"StockHeight": 0,
"StockWidth": 0,
"StockDepth": 0,
"StockWeight": 38,
"StockVolume": 0.24453,
"SupplierCompanyNo": 123,
"SupplierAccountNo": 123456,
"SupplierAccountRef": "SUPP01",
"StockCreated": "30/10/2013",
"StockModified": "10/02/2021 8:21:32 AM",
"StockQtyModified": "25/02/2021 4:42:46 PM",
"StockUserStr1": "",
"StockUserStr2": "",
"StockUserStr3": "",
"StockUserStr4": "",
"StockUserStr5": "",
"StockUserStr6": "",
"StockUserAmt1": 0,
"StockUserAmt2": 0,
"StockUserNum1": 0,
"StockUserNum2": 0,
"StockUserNum3": 0,
"StockUserNum4": 0,
"StockUserDate1": "",
"StockUserDate2": "",
"StockInfoStr1": "B",
"StockInfoStr2": "1200",
"WebStatusDesc": "",
"StockBrandDesc": "BRAND DESCRIPTION",
"ParentDesc": "PARENT 001"
"StockPrice": [
{
"StockNo": "54278",
"PriceBand": "R",
"Currency": "AUD",
"IncGST": "True",
"GSTType": "GST",
"Price": "1234.56",
"Price2": "",
"Price3": "",
"Price4": "",
"Price5": "",
"CompetPrice": "",
"PriceChanged": "7/30/2020 5:28:13 PM",
"PresetMarkup": "",
"MinimumPrice": "",
"WarningPrice": "",
"PriceFormulaAmt": "",
"PriceFormulaAmt2": "",
"PriceFormulaAmt3": "",
"PriceFormulaAmt4": "",
"PriceFormulaAmt5": "",
"StkPriceMethod": "",
"StkPriceBase": ""
}
],
"StockImage": [
{
"StockNo": "54278",
"ImageNo": "1",
"VersionNo": "1",
"FileName": "54278_1.png",
"FileExt": "png",
"ResizedFileName": "1_54278_180_180.jpg",
"ResizedFileExt": "jpg"
}
],
"StockText": [
{
"StockNo": "54278",
"TextNo": "1",
"StockText":"Corner-blocked frame"
}
],
"Attributes": [
{
"StockNo": 54278,
"CodeField": "Attribute1",
"CodeValue": "Value1"
},
{
"StockNo": 54278,
"CodeField": "Attribute2",
"CodeValue": "Value2"
},
{
"StockNo": 54278,
"CodeField": "Attribute3",
"CodeValue": "Value3"
}
],
"StockLinks": [
{
"StockNo": 39402,
"LinkStockNo": 54358,
"LinkPriceBand": "",
"LinkQtyFrom": 0,
"LinkType": "C",
"LinkMode": "",
"LinkCurrency": "",
"LinkGSTType": "",
"LinkIncGST": "False",
"LinkDiscountType": "",
"LinkQty": 0,
"LinkAmount": 0,
"LinkInfo": "",
"LinkStockCode": "ABCDE",
"LinkStockDesc": "Stock Description of Other Code"
}
],
"StockLoc": [
{
"StockNo": 123,
"LedgerCompanyNo": 123,
"LocationNo": 100,
"LocationCode": "A",
"LocationDescription": "ABC Location",
"StockQty": 0,
"StockSalesOrderQty": 0,
"StockOnHandQty": 0,
"StockPurchaseOrderQty": 0,
"StkLocMinQty": 0,
"StkLocMaxQty": 0,
"StkLocReorderQty": 0,
"StockPostedQty": 0,
"StockSalesPickedQty": 0,
"StockValueExGST": 0
},
{
"StockNo": 123,
"LedgerCompanyNo": 123,
"LocationNo": -1,
"LocationCode": "GRP",
"LocationDescription": "GRP LocationGroup",
"StockQty": 0,
"StockSalesOrderQty": 0,
"StockOnHandQty": 0,
"StockPurchaseOrderQty": 0,
"StkLocMinQty": 0,
"StkLocMaxQty": 0,
"StkLocReorderQty": 0,
"StockPostedQty": 0,
"StockSalesPickedQty": 0,
"StockValueExGST": 0
}
]
"StkBOM": [
{
"StockNo": 39402,
"BOMStockNo": 1234567,
"BOMStockCode": "ABC-StockCode",
"BOMStockDesc": "ABC-StockDesc",
"BOMQty": 1,
"BOMFreeIssue": "True",
"BOMOption": "Rail",
"BOMOptionDefault": "True"
}
]
}
}
POST / PUT
POST and PUT are very similar - both are used to Create or Update a single stock code and single price band.
Please note that some stock fields are mandatory outside of the required fields on a per database level.
Please enquire as to whether there are any mandatory fields for your particular implementation.
Please note that complex stock such as BOMs and Packages cannot be created through this endpoint.
There are 2 tables that can be updated via this endpoint
| Table | Description |
|---|---|
| Stk | This is the main stock table holding all the information of the SKU |
| StkPrice | This table holds all of the pricing information for the SKU |
Stock Identifier Fields
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| StockNo | integer | 150 | This is the unique integer identifier of the SKU | |
| StockCode | string | ABC1234 | This is unique string identifer of the SKU |
Accepted Line Type Values
| Value | Type | Description |
|---|---|---|
| S | Stock | This is the standard stock type |
| D | Descriptive | This is for an item which isn't physically held |
| H | Header | This is a folder or parent stock code |
| F | Freight | This is a specific code for freight |
| V | Voucher | This is a code for a gift voucher |
| G | Gift Card | This is for an external gift card provider - currently only Vii is implemented |
Stk
| Method | Field | Type | Format | Example | Description |
|---|---|---|---|---|---|
| PUT | Stock Identifier | string | This is one of the Stock Identifiers described above | ||
| POST | StockCode | string | ABC1234 | This is the unique string identifier of the SKU | |
| POST | LineType | string | S | This determines what type of SKU it is |
StkPrice
| Method | Field | Type | Format | Example | Description |
|---|---|---|---|---|---|
| BOTH | Priceband | string | R | This is the unique string identifier of the Price Band | |
| BOTH | Price | float | 15.95 | This is the main price of the SKU for the particular price band | |
| POST | Currency | string | AUD | This is the currency for the particular price | |
| POST | GSTType | string | GST | This is the main tax type of the price |
Example Payload POST
{
"Stk":{
"StockCode":"ABCD123",
"StockDesc":"This is a stock item",
"LineType":"S",
"ParentStockCode":"HEADER01",
"StockUnit":"kg",
"StockWeight":1.50
},
"StkPrice":{
"PriceBand":"R",
"GSTType":"GST",
"IncGST":false,
"Price":15.95
}
}
Example Payload PUT
{
"Stk":{
"StockCode":"ABCD123",
"StockDesc":"This is a different description",
"StockBrand":"Frozen"
},
"StkPrice":{
"PriceBand":"R",
"GSTType":"FRE",
"IncGST":false,
"Price":12.00
}
}
DELETE
Delete requires one of the Stock Identifier fields provided
Stock Identifier Fields
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| StockNo | integer | 150 | This is the unique integer identifier of the SKU | |
| StockCode | string | ABC1234 | This is unique string identifer of the SKU |
{
"Stk":{
"StockCode":"ABCD1234"
}
}
V1
Version 1 is very similar to Version 2, but the GET functionality is limited to a single stock code lookup.
{
"Stock": [
{
"StockNo": "35310",
"StockCode": "000003",
"StockDesc": "Item A",
"StockOnHandQty": "129",
"StockHeight": "",
"StockWidth": "",
"StockDepth": "",
"StockWeight": "",
"StockVolume": "",
"StockUserStr1": "",
"StockUserStr2": "",
"StockUserStr3": "",
"StockUserStr4": "",
"StockUserStr5": "Grub Screw Packs (set of 8x) - Black",
"StockUserStr6": "",
"StockUserAmt1": "",
"StockUserAmt2": "2",
"StockUserNum1": "",
"StockUserNum2": "",
"StockUserNum3": "",
"StockUserNum4": "",
"StockUserDate1": "",
"StockUserDate2": "",
"StockInfoStr1": "",
"StockInfoStr2": "",
"StockInfoStr1_1": "",
"StockInfoStr2_1": "",
"StockCreated": "11/02/2015 10:35:55 AM",
"StockModified": "24/09/2020 12:03:47 PM",
"StockQtyModified": "24/09/2020 12:04:13 PM",
"StockNo_1": "35310",
"PriceBand": "R",
"Currency": "AUD",
"IncGST": "True",
"GSTType": "GST",
"Price": "10",
"Price2": "",
"Price3": "",
"Price4": "",
"Price5": "",
"CompetPrice": "",
"PriceChanged": "11/02/2015 10:36:52 AM",
"PresetMarkup": "",
"MinimumPrice": "",
"WarningPrice": "",
"PriceFormulaAmt": "",
"PriceFormulaAmt2": "",
"PriceFormulaAmt3": "",
"PriceFormulaAmt4": "",
"PriceFormulaAmt5": "",
"StkPriceMethod": "",
"StkPriceBase": ""
}
]
}
Responses
The Stock endpoint includes the following specific responses:
| Response No | Meaning |
|---|---|
| 204 | No stock data found for the specific parameters |
| 400 | Error with Payload - Message should provide further information. i.e. Error with Payload - No Stock Data presented |
| 403 | Forbidden - Data is read only |
| 406 | Missing Parameters - Too much data would be returned |
Creating or Updating a stockcode
{
"Stk": {
"StockCode": "ABC1234",
"StockDesc": "This is a stock item",
"StockNo": 36015
}
}
Deleting a StockCode
{
"Stk": {
"StockCode": "ABC1234",
"StockDesc": "This is a stock item",
"StockNo": 36015,
"Discontinued":true
}
}
Options
The Options method returns information about specific fields that might be required as well as specific user defined fields and their aliases.
Returned Data
| Entry | Definition |
|---|---|
| Version | Shows the current version of the Notes endpoint to compare against the Changelog |
| Line Types | Shows the types of stock that can be created |
| Line Cost Types | Shows the type of cost method that the stock method can have - if left empty then defaults to system |
| Custom Fields | Shows the Stock Item (Stk) level custom fields and their aliases |
| Text Fields | Shows all different stock text fields available, TextNo = position in string starting from 1 |
{
"Version": "1.0.0",
"Stk": {
"LineTypes": "Stock=S,
Freight=F,
Descriptive=D,
Header=H,
Voucher=V,
Gift Card=G",
"LineCostTypes": "Average=A,
Last Cost=L,
Stocktake=S,
Serial=E,
Batch=B,
Standard=T,
Manual=M,
Non Stock=N",
"Custom Fields": "Supplier SKU=StockAltRef,
Brand=StockBrand,
Our Colour=StockUserStr1,
Sup Colour=StockUserStr2,
Sup Range=StockUserStr3,
Bin Group=StockUserStr4,
PDA Desc=StockUserStr5,
Style Desc=StockUserStr6,
Layby Release=StockUserAmt1,
Supplier Type=StockUserAmt2,
Expiry months=StockUserNum1,
Factor=StockUserNum2,
StockUserNum3=StockUserNum3,
StockUserNum4=StockUserNum4,
StockUserDate1=StockUserDate1,
StockUserDate2=StockUserDate2,
Delivery Instructions=StockInfoStr1,
Supplier Desc=StockInfoStr2,
ManufacturerCode=ManufacturerCode",
"Text Fields": "Stock Info,
Short Desc,
Meta Data,
Keywords",
"Mandatory Fields":"StockUserStr3. PurchaseGSTType"
},
"StkPrice": {
"Priceband": "R,W",
"Currency": "AUD,BZD,EUR,HKD,NZD,USD",
"GSTType": "CAP,DEF,FRE,GST,INP,ITS,NCF,NCG,NT"
}
}
CUST and SUPP
The cust and supp endpoints define methods to list, create, and update accounts.
endpoint: cust - Customer Accounts (Sales Ledger)
endpoint: supp - Supplier Accounts (Purchase Ledger)
Accepted Methods:
| Method | Usage |
|---|---|
| GET | Retrieves one or more accounts |
| POST | Creates a new account |
| PUT | Updates an existing account |
| DELETE | Disables an existing account |
GET
Query Parameters - V1
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| AccountRef | string | CUST01 | Return all accounts for a specific customer |
Query Parameters - V2 Onwards
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| PK | boolean | 1 | Only returns Primary Fields | |
| Limit | integer | 100 | Specifies a limit to the amount of results retrieved | |
| PageNo | integer | 1 | Specifies the PageNo of the results - used with PageSize | |
| PageSize | integer | 100 | Specifies the amount of results per page - used with PageNo | |
| AccountRef | string | CUST01 | Return all accounts for a specific customer | |
| InfoCreated | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all accounts created from the provided date |
| InfoModified | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all accounts modified from the provided date |
| DateCreated | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all accounts created on the provided date |
| DateUpdated | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all accounts modified on the provided date |
| InclB2B | boolean | 1 | States whether the resultset should include Account specific pricing (defaults to false) | |
| InclAddresses | boolean | 1 | States whether the resultset should include all account delivery addresses (defaults to false) | |
| WebAccounts | boolean | 1 | Return all accounts where the Login / Password have been entered (defaults to false) | |
| FieldList | string | AccountRef,AccountAltRef | Return only the fields included in the field list |
{
"Acc": [
{
"CompanyNo": "36015",
"AccountNo": "1849",
"TransLedger": "S",
"AccountName": "Esuite Test",
"AccountStatus": "Y",
"AccountRefNo": "1750",
"AccountRef": "ESUI01",
"AccountAltRef": "",
"AccountCurrency": "",
"AccountPriceBand": "",
"DateCreated": "2015-01-14 16:26:59",
"DateUpdated": "2020-09-24 17:25:13",
"AccountOutstanding": "-998",
"AccountHasOutstanding": "Y",
"AdjustmentIsPercent": "False",
"AdjustmentEntryAmt": "",
"AdjustmentMethod": "",
"AccountHasCreditLimit": "N",
"AccountCreditLimit": "",
"CompanyCode": "",
"MediaCode": "",
"CampaignCode": "TEST",
"CostCentreCode": "",
"SegmentCode": "",
"CountryCode": "",
"AccountContactName": "Esuite Test",
"AccountContactTitle": "",
"AccountSalute": "",
"AccountFirstName": "Esuite",
"AccountLastName": "Test",
"AccountBusinessName": "",
"AccountDivisionName": "",
"AccountAddress1": "132 Not Exist",
"AccountAddress2": "",
"AccountAddress3": "",
"AccountAddress4": "",
"AccountSuburb": "O'Conner",
"AccountState": "NSW",
"AccountPostCode": "2934",
"AccountSortCode": "",
"AccountDPID": "",
"AccountDPIDHouseno": "",
"AccountPhone1": "0000000000",
"AccountPhone2": "",
"AccountMobile": "",
"AccountFax": "",
"AccountEmail": "a@a.a",
"AccountCode1": "",
"AccountCode2": "",
"AccountProfile": "{\\rtf }",
"AccountLastContact": "",
"DedupePrefix": "",
"DedupeCode": "",
"DedupeSuffix": "",
"IntroducedByAccountNo": "",
"NPM": "",
"IsAccountDlvAddress": "True",
"DefaultDlvAddressNo": "1",
"AccountUserStr1": "",
"AccountUserStr2": "",
"AccountUserStr3": "",
"AccountUserStr4": "PAS",
"AccountUserStr5": "",
"AccountUserStr6": "",
"AccountUserAmt1": "",
"AccountUserAmt2": "",
"AccountUserNum1": "",
"AccountUserNum2": "",
"AccountUserDate1": "",
"AccountUserDate2": "",
"AccountBusinessNumber": "",
"AccountTermsType": "U",
"AccountTerms": "30",
"AccountGSTType": "",
"AccountIncGST": "True",
"AccountPayType": "",
"AccountDrawer": "",
"AccountBank": "",
"AccountBranch": "",
"AccountBankAccount": "",
"AccountBankAuthorised": "False",
"AccountExpiry": "",
"AccountGLNo": "",
"AccountWebsite": "",
"AccountLogin": "",
"AccountPassword": "",
"AccountBankSecurityCode": "",
"OrderLeadDays": "",
"ReplicatedHistory": "36015",
"EDIInterface": "",
"EDILedgerCompanyNo": "",
"EDIAccountRef": "",
"EDIAccountCompanyNo": "",
"EDIAccountNo": "",
"PrimaryContactCompanyNo": "36015",
"PrimaryContactNo": "306",
"AccountRemoteOutstanding": "",
"AccountCRMStatus": "",
"AccountCRMDue": "",
"StatementSent": "",
"CreditStatus": "A",
"CreditExceedAction": "",
"DebtLevel": "",
"DebtLevelLast": "",
"DebtLevelHighest": "",
"DebtLevelHighestDate": "",
"PaymentPlan": "False",
"PlanStartDate": "",
"PlanNextDue": "",
"PlanTotal": "",
"PlanInstall": "",
"PlanInstallQty": "",
"PlanFreqDuration": "",
"PlanFreq": "",
"PlanRetainCredit": "False",
"PlanCurrency": "",
"AccountCommPreference": "Email",
"GroupCompanyNo": "",
"GroupAccountNo": "",
"GroupAccountRef": "",
"AccountPoints": "0",
"DefaultMsgNo": "",
"AccountRemotePoints": "",
"AccountMaxNumberOfInvoices": "",
"AccountTradingGLNo": "",
"CreatedUserNo": "53",
"ModifiedUserNo": "53",
"AccDisc": [
{
"CompanyNo": "36015",
"AccountNo": "1849",
"StockNo": "35310",
"PriceBand": "",
"QtyFrom": "0",
"DiscountFilter": "",
"DiscountType": "P",
"DiscCurrency": "AUD",
"DiscIncGST": "True",
"UnitDiscount": "30",
"StockCode": "000003",
"PriceChangedDate": "2020-09-24 17:25:12",
"ExtStockCode": "",
"Required": "False",
"RequiredQty": ""
}
],
"AccDlv": [
{
"CompanyNo": "36015",
"AccountNo": "1849",
"AddressNo": "1",
"AddressDesc": "Delivery Address",
"TransLedger": "",
"AccountRef": "",
"DlvContactName": "Esuite Test",
"DlvTitle": "",
"DlvSalute": "",
"DlvFirstname": "Esuite",
"DlvLastname": "Test",
"DlvBusinessName": "",
"DlvDivisionName": "",
"DlvAddress1": "13 Fake Street",
"DlvAddress2": "",
"DlvAddress3": "",
"DlvAddress4": "",
"DlvSuburb": "ALLAMBEE RESERVE",
"DlvState": "VIC",
"DlvPostcode": "3871",
"DlvCountry": "",
"DlvSortcode": "",
"DlvDPID": "",
"DlvDPIDHouseNo": "",
"DlvPhone": "",
"DlvEmail": "",
"AccDlvUserStr1": "",
"AccDlvUserStr2": ""
}
]
}
]
}
POST / PUT
POST and PUT are very similar - both are used to Create or Update a single account.
Account Identifier Fields
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| CompanyNo | integer | 150 | This is the unique identifier of the specific database - Paired with AccountNo | |
| AccountNo | integer | 150 | This is the internal unique account identifying number - Paired with CompanyNo | |
| AccountRef | string | CUST01 | This is the account reference. |
T_Acc
| Method | Field | Type | Format | Example | Description |
|---|---|---|---|---|---|
| PUT | Account Identifier | string | This is one of the account identifiers described above | ||
| Both | TransLedger | string | S | This specifies the ledger for the transaction | |
| POST | AccountFirstName | string | Person | First Name of the Account | |
| POST | AccountFirstName | string | Incognito | Last Name of the Account |
{
"T_Acc":{
"AccountRef":"ABC1234",
"TransLedger":"S",
"AccountFirstName":"Person",
"AccountLastName":"Incognito",
"AccountAddress1":"123 Somewhere Avenue",
"AccountSuburb":"Avalon Beach",
"AccountPostCode":2017,
"AccountState":"NSW"
}
}
DELETE
Delete requires one of the Account Identifier combinations to be able to find the account.
Account Identifier Fields
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| CompanyNo | integer | 150 | This is the unique identifier of the specific database - Paired with AccountNo | |
| AccountNo | integer | 150 | This is the internal unique account identifying number - Paired with CompanyNo | |
| AccountRef | string | CUST01 | This is the account reference. |
{
"T_Acc": {
"AccountRef": "ABC1234",
"CompanyNo": "36015",
"AccountNo": "144950",
"Deleted": "True"
}
}
V1
Version 1 is very similar to Version 2, but the GET functionality is limited to a single account lookup.
Responses
The cust and supp endpoints include the following specific responses:
| Response No | Meaning |
|---|---|
| 204 | No account data found for the specific parameters |
| 400 | Error with Payload - Message should provide further information. i.e. Error with Payload - No T_Acc Data presented |
| 403 | Forbidden - Account data is read only in this database |
| 406 | Missing Parameters - Too much data would be returned |
Successful Account POST / PUT
{
"T_Acc": {
"AccountRef": "ABC1234",
"CompanyNo": "36015",
"AccountNo": "144950"
}
}
Options
The Options method returns information about specific fields that might be required as well as specific user defined fields and their aliases.
Returned Data
| Entry | Definition |
|---|---|
| Version | Shows the current version of the Notes endpoint to compare against the Changelog |
| Communication Methods | Shows methods of communication that the account can be reached by |
| Custom Fields | Shows the Stock Item (Stk) level custom fields and their aliases |
Cust Endpoint
{
"Cust": {
"Version": "1.0.0",
"Comm Preference": "Email,
Mail,
Email/Mail,
Auto Email,
Fax,
Phone,
SMS,
Other",
"Custom Fields": "Alt Ref=SAccountAltRef,
SAccountUserStr1=SAccountUserStr1,
SAccountUserStr2=SAccountUserStr2,
SAccountUserStr3=SAccountUserStr3,
Referral?=SAccountUserStr4,
SAccountUserStr5=SAccountUserStr5,
SAccountUserStr6=SAccountUserStr6,
SAccountUserAmt1=SAccountUserAmt1,
SAccountUserAmt2=SAccountUserAmt2,
SAccountUserNum1=SAccountUserNum1,
SAccountUserNum2=SAccountUserNum2,
SAccountCode1=SAccountCode1,
SAccountCode2=SAccountCode2,
SAccountUserDate1=SAccountUserDate1,
SAccountUserDate2=SAccountUserDate2,
Default Message=SDefaultMsgNo",
"Mandatory Fields":"AccountUserNum1"
}
}
Supp Endpoint
{
"Supp": {
"Version": "1.0.0",
"Custom Fields": "Alt Ref=PAccountAltRef,
Supplier Type=PAccountUserStr1,
PAccountUserStr2=PAccountUserStr2,
PAccountUserStr3=PAccountUserStr3,
PAccountUserStr4=PAccountUserStr4,
PAccountUserStr5=PAccountUserStr5,
PAccountUserStr6=PAccountUserStr6,
PAccountUserAmt1=PAccountUserAmt1,
Supplier Type=PAccountUserAmt2,
PAccountUserNum1=PAccountUserNum1,
PAccountUserNum2=PAccountUserNum2,
PAccountCode1=PAccountCode1,
PAccountCode2=PAccountCode2,
PAccountUserDate1=PAccountUserDate1,
PAccountUserDate2=PAccountUserDate2,
Default Message=PDefaultMsgNo",
"Mandatory Fields":""
}
}
CUST SUPP PRICING
The customer supplier pricing endpoints define methods to list, create, and update customer discounts.
endpoint: custdisc
Accepted Methods:
| Method | Usage |
|---|---|
| GET | Retrieves one or more customer discounts |
| POST | Creates a new customer discount |
| PUT | Updates an existing customer discount |
GET
Query Parameters - V2 Onwards
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| CompanyNo | int | 35084 | Return all customer discounts of the specific CompanyNo | |
| AccountNo | integer | 150 | Return all customer discounts of the specific AccountNo | |
| StockNo | integer | 150 | Return all customer discounts of the specific StockNo | |
| AccountRef | string | CUST01 | Return all accounts for a specific customer | |
| StockCode | string | ABC1234 | Return all customer discounts of the specific StockCode | |
| Limit | integer | 100 | Specifies a limit to the amount of results retrieved | |
| PageNo | integer | 1 | Specifies the PageNo of the results - used with PageSize | |
| PageSize | integer | 100 | Specifies the amount of results per page - used with PageNo | |
| FieldList | string | AccountRef,AccountAltRef | Return only the fields included in the field list |
{
"Acc": [
{
"CompanyNo": 9999,
"AccountNo": 2,
"StockNo": 1,
"PriceBand": "A",
"QtyFrom": 0,
"DiscountFilter": "",
"DiscountType": "",
"DiscCurrency": "USP",
"DiscIncGST": "False",
"UnitDiscount": 2,
"StockCode": "SIMPLECODS",
"PriceChangedDate": "2022-10-13 08:58:32",
"ExtStockCode": "",
"Required": "False",
"RequiredQty": 0,
"AccountRef": "CUSTU01",
"StockCode_1": "MARKUPCODE",
"StockDesc": "Pack Code 500 / Ctn",
"AccDisc": [
{
"CompanyNo": 9999,
"AccountNo": 2,
"StockNo": 1,
"PriceBand": "A",
"QtyFrom": 0,
"DiscountFilter": "",
"DiscountType": "",
"DiscCurrency": "USP",
"DiscIncGST": "False",
"UnitDiscount": 2,
"StockCode": "SIMPLECODS",
"PriceChangedDate": "2022-10-13 08:58:32",
"ExtStockCode": "",
"Required": "False",
"RequiredQty": 0,
"AccountRef": "CUSTU01",
"StockCode_1": "MARKUPCODE",
"StockDesc": "Pack Code 500 / Ctn"
},
{
"CompanyNo": 9999,
"AccountNo": 2,
"StockNo": 1,
"PriceBand": "B",
"QtyFrom": 0,
"DiscountFilter": "",
"DiscountType": "",
"DiscCurrency": "USD",
"DiscIncGST": "False",
"UnitDiscount": 2,
"StockCode": "SIMPLECODS",
"PriceChangedDate": "2022-10-13 08:58:32",
"ExtStockCode": "",
"Required": "False",
"RequiredQty": 0,
"AccountRef": "CUSTU01",
"StockCode_1": "MARKUPCODE",
"StockDesc": "Pack Code 500 / Ctn"
},
{
"CompanyNo": 9999,
"AccountNo": 2,
"StockNo": 1,
"PriceBand": "C",
"QtyFrom": 0,
"DiscountFilter": "",
"DiscountType": "",
"DiscCurrency": "USD",
"DiscIncGST": "False",
"UnitDiscount": 2,
"StockCode": "SIMPLECODS",
"PriceChangedDate": "2022-10-13 08:58:32",
"ExtStockCode": "",
"Required": "False",
"RequiredQty": 0,
"AccountRef": "CUSTU01",
"StockCode_1": "MARKUPCODE",
"StockDesc": "Pack Code 500 / Ctn"
}
]
}
]
}
POST / PUT
POST and PUT are very similar - both are used to Create or Update a single or multiple customer or supplier pricing.
Account Identifier Fields
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| CompanyNo | int | 35084 | The unique company number of the client | |
| AccountNo | integer | 150 | This is the internal unique account identifying number. | |
| StockNo | integer | 150 | This is the unique integer identifier of the stock | |
| StockCode | string | ITEM 2 | This is the unique stock code for the note use this or StockNo to identify Stock | |
| AccountRef | string | CUST01 | This is the account reference. use this or AccountNo to identify Account | |
| PriceBand | string | A | This is the identifier of the price band | |
| QtyFrom | float | 1.0 | ||
| DiscountFilter | string | This is the identifier of the discount filter |
{
"T_AccDisc":{
"CompanyNo": 9999,
"AccountNo": 2,
"stockNo": 14,
}
}
Responses
The cust and supp endpoints include the following specific responses:
| Response No | Meaning |
|---|---|
| 204 | No account data found for the specific parameters |
| 400 | Error with Payload - Message should provide further information. i.e. Error with Payload - No T_Acc Data presented |
| 403 | Forbidden - Account data is read only in this database |
| 406 | Missing Parameters - Too much data would be returned |
Creating or Updating supplier customer pricing
{
AccDiscPosted 1 records posted
}
Notes
The notes endpoints define methods to list, create, and update CRM information and transactional notes.
endpoint: note
Accepted Methods:
| Method | Usage |
|---|---|
| GET | Retrieves data |
| POST | Creates a new record |
| PUT | Updates an existing account |
| DELETE | Disables an existing account |
GET
Query Parameters
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| PK | boolean | 1 | Only returns Primary Fields | |
| Limit | integer | 100 | Specifies a limit to the amount of results retrieved | |
| PageNo | integer | 1 | Specifies the PageNo of the results - used with PageSize | |
| PageSize | integer | 100 | Specifies the amount of results per page - used with PageNo | |
| NoteType | string | Return all notes for a specific type | ||
| InfoCreated | date | yyyy-mm-dd | 2020-08-25 | Return all notes created from the provided date |
| NoteCreated | date | yyyy-mm-dd | 2020-08-25 | Return all notes created on the provided date |
| DateFrom | date | yyyy-mm-dd | 2020-08-25 | Return all transactions where the marked date is on or after the provided date |
| DateTo | date | yyyy-mm-dd | 2020-08-25 | Return all transactions where the marked date is on or before the provided date |
| InclAttachments | boolean | 1 | States whether the resultset should include information about any attached files (defaults to false) | |
| InclRecur | boolean | 1 | States whether the resultset should include information about recurring settings if the note is a recurring one (defaults to false) |
POST
If T_NotesRecur information is provided then the Note will be automatically converted to a recurring note.
Recurring Definition - T_NotesRecur
| Field | Type | Options | Required |
|---|---|---|---|
| RecurFreq | string | Days,Weekly,Fortnightly,Semi-Monthly,Monthly,Quarterly,Semi-Annually,Annually,Ad-Hoc | true |
| RecurCycleDay | string | Monday,Tuesday,Wednesday,Thursday,Friday,Saturday,Sunday | true |
| RecurStartDate | date | true | |
| RecurFinishDate | date | false |
Attachments Definition - T_NotesAttachments
Currently the only method of including attachments is via SFTP to place the file on the server and then posting the Note record.
The file must be on the server before the note record is passed.
| Field | Type | Example | Required |
|---|---|---|---|
| FileName | string | filename.pdf | true |
Note Linking Fields
These fields are used to connect the note to a transaction, a specific account, or a stockcode
Note that usually if a TransRefCode, AccountRef or StockCode have been provided that is usually enough for identification.
Under rare circumstances the specific company number will also have to be passed.
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| NoteLinkTransRefCode | string | ESIN-123456 | This is the unique identifier of the specific transaction - Can be paired with NoteLinkCompanyNo for circumstances where multiple companies have the same prefix | |
| AccountRef | string | CUST01 | This is the account reference. | |
| NoteLinkCompanyNo | string | ESIN-123456 | This is the unique identifier of the specific company - Usually not necessary if TransRefCode will be unique | |
| NoteLinkTransNo | string | ESIN-123456 | This is the unique identifier of the specific transaction - Usually not necessary if TransRefCode will be unique | |
| AccountCompanyNo | integer | 9985188 | This is the internal unique account company number - found on the Account Record | |
| AccountNo | integer | 9985188 | This is the internal unique account identifying number - Paired with AccountCompanyno | |
| StockNo | integer | 12345 | This is the internal unique account identifying number - Paired with AccountCompanyno | |
| StockCode | string | ITEM 2 | This is the unique stock code for the note | |
| NoteType | string | NOTE | This type of note - specific note types for the client is found in OPTIONS - however special types NOTE and ATTCH exist - NOTE is a general note, and ATTCH is for sole attachments without header information. |
T_Notes
| Method | Field | Type | Format | Example | Description |
|---|---|---|---|---|---|
| PUT | CompanyNo | int | 35084 | The unique company number of the client | |
| PUT | NoteNo | int | 1588505 | The unique note number | |
| POST | TransLedger | string | S | This specifies the ledger for the note | |
| POST | NoteType | string | CALL | The Type of note - see Options | |
| POST | NoteDate | datetime | yyyy-mm-dd hh:mm:ss | 2020-09-27 13:45:00 | Time of the note |
Sample - POST
{
"T_Notes":{
"NoteHeading":"Customer xxx called",
"NoteDetails":"Here are details on what the call was about",
"NoteDate":"2020-10-2 17:45:00",
"NoteType":"CALL",
"TransLedger":"S",
"TransRefCode":"ESIN-406223"
},
"T_NotesRecur":{
"RecurFreq":"Weekly",
"RecurCycleDay":"Thursday",
"RecurStartDate":"2020-10-10"
},
"T_NotesAttachments":[
{
"FileName":"TEST1.PDF"
},
{
"FileName":"TEST2.jpg"
}
]
}
Sample - PUT
{
"T_Notes":{
"CompanyNo":"36015",
"NoteNo":"162921",
"NoteDetails":"Here are the old details on what the call was about, and here are some further details",
"NoteDate":"2020-10-2 17:45:00",
"NoteType":"CALL",
"TransLedger":"S"
}
}
Responses
The notes endpoint includes the following specific responses:
| Response No | Meaning |
|---|---|
| 400 | Error with Payload - Message should provide further information. i.e. Error with Payload - No T_Notes Data presented. |
| 405 | Method is not implemented for this endpoint |
{
"T_Notes": {
"CompanyNo": "36015",
"NoteNo": "162921"
}
}
Options
The Options method returns information about specific fields that might be required as well as specific user defined fields and their aliases.
Returned Data
| Entry | Definition |
|---|---|
| Version | Shows the current version of the Notes endpoint to compare against the Changelog |
| Note Types | Shows the types of note that can be created |
| Note Type Results | Shows the Specific results that can be applied to each note type 1-5 |
| RecurFreq | Shows frequency which the recurring tranasctions can be set to |
| Recur Cycle Day | Shows the different days that the recurring notes can be set to. |
{
"Version": "1.0.0",
"Sales": {
"NoteTypes": "CALL=Call,
EMAIL=Email,
MEET=Meet,
TASK=Task,
EXTRN=Extrn",
"NoteType1Results": "To Do=0,
Call Completed=1,
Call Attempted=1,
Call Left Message=1,
Call Received=1,
Call Cancelled=1",
"NoteType2Results": "To Do=0,
Email Sent=1,
Email Received=1",
"NoteType3Results": "To Do=0,
Meeting Held=1,
Meeting Cancelled=1",
"NoteType4Results": "To Do=0,
Task Done=1,
Letter Sent=1,
Letter Not Sent=1,
Fax Sent=1,
Personal Activity=1,
Personal Vacation=0",
"NoteType5Results": "To Do=0,
Done=1,
Waiting On Response=0,
Response Received=1,
Vacation=1,
Vacation Completed=1"
},
"Purchase": {
"NoteTypes": "ntCALL=Call,
ntEMAIL=Email,
ntMEET=Meet,
ntTASK=Task,
ntEXTRN=Extrn",
"NoteType1Results": "To Do=0,
Call Completed=1,
Call Attempted=1,
Call Left Message=1,
Call Received=1,
Call Cancelled=1",
"NoteType2Results": "To Do=0,
Email Sent=1,
Email Received=1",
"NoteType3Results": "To Do=0,
Meeting Held=1,
Meeting Cancelled=1",
"NoteType4Results": "To Do=0,
Task Done=1,
Letter Sent=1,
Letter Not Sent=1,
Fax Sent=1,
Personal Activity=1,
Personal Vacation=0",
"NoteType5Results": "To Do=0,
Done=1,
Waiting On Response=0,
Response Received=1,
Vacation=1,
Vacation Completed=1"
},
"Recur": {
"RecurFreq": "Days,
Weekly,
Fortnightly,
Semi-Monthly,
Monthly,
Quarterly,
Semi-Annually,
Annually,
Ad-Hoc",
"RecurCycleDay": "Monday,
Tuesday,
Wednesday,
Thursday,
Friday,
Saturday,
Sunday"
}
}
Custom Functions
This endpoint allows access to custom functions specific to each implementation.
Intended to be used to expand accessibility outside of standard functionality.
endpoint: sp
Accepted Methods:
| Method | Usage |
|---|---|
| GET | Accesses custom functionality and retrieves data |
GET
The following is an example of a custom function from esuite and its parameters
W_StkTreeChildren_ByPage
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| ParentStockNo | int | 1190 | Filters the resultset to only items underneath the specified parent stock code | |
| WebEnabled | bit | 0 | Specifies whether the results should be only web enabled items or not (if not entered then will return both) | |
| TextNo | int | 1 | Includes the specified Stock Text field in the result set | |
| IncludeNonStock | bit | 1 | Allows non stock items such as descriptive items in the resultset | |
| PriceBand | string | R | Includes stock specific pricing for the specified price band | |
| PageNo | int | 2 | Works with PageSize to determine the stock items to return to allow pagination | |
| PageSize | int | 20 | Works with PageNo to determine the stock items to return to allow pagination |
Responses
The custom functions endpoint includes the following specific responses:
| Response No | Meaning |
|---|---|
| 400 | Error with Payload - Message should provide further information. i.e. Error with Payload - No Data presented. |
| 403 | Forbidden - You do not have rights to access this. |
| 405 | Not implemented - You are trying to access a method which is not implemented. |
Analysis Codes and User Defined Fields
The Analysis Code endpoint allows the access of data in certain tables.
Analysis codes are typically used to split up the database and allow for specific transactions to go into certain areas.
The User Defined Field parameters will return all available options related to a specific field.
endpoint: code
| Table | Description |
|---|---|
| Location | Returns all of the information relating to individual locations within the current database |
| Cost Centres | Returns the specific cost centre analysis codes used to fragement the database |
| Segments | Returns the specific segment codes used to fragment the database |
| User Defined Fields | Returns the specific items related to a specific user defined field in a table - used with a ledger and fieldname |
GET
The GET Function will allow you to specify which table you want to get the data from.
If a table is provided without a field, then it will return all the data for that table, otherwise it will return all the options for that field.
If the field has multiple options associated with it.
| Parameter | Options | Examples | Description |
|---|---|---|---|
| Table | Loc, CostCentre, Segment, Stock, Cust, Supp, Sales, Purchase, Sales Item, Purchase Item | Returns all of the information relating to specific tables within the current database | |
| Field | Any User Defined Field | AccountUserStr1 - See individual cust/supp/stock/trans endpoints OPTIONS for more information on specific fields | Returns any existing dropdown information to the account user fields - including related fields |
| TransLedger | S,P,I | Defines which Ledger the specific account or transaction / line item user defined field is for Only needs to be specified if table is not in the list above. |
Responses
The code endpoint includes the following specific responses:
| Response No | Meaning |
|---|---|
| 400 | Error with Payload - Message should provide further information. i.e. Error with Payload - No L_Code Data presented. |
| 406 | No parameters provided |
Campaign Codes
Campaigns are typically collections of stock codes or headers used for promotional purposes.
Esuite has 2 main types of campaigns - Auto Campaigns and standard campaigns.
Auto Campaigns are discounts applied across the board to all accounts.
Standard Campaigns are discounts applied only when that campaign code is applied to an account or a customer.
endpoint: campaign
GET
Query Parameters
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| CampaignCode | string | Cmp1, Cmp2, Cmp3 | Returns data related to the campaign codes passed through - can be a comma separated list. | |
| InclStock | boolean | 1 | Specifies whether campaign stock codes should be returned in the dataset (defaults to false) | |
| InclBonus | boolean | 1 | Specifies whether bonus stock codes should be returned in the dataset (defaults to false) | |
| DateFrom | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all campaigns where the Date From is after the specified date (empty dates included) |
| DateTo | datetime | yyyy-mm-dd hh:mm:ss | 2020-08-25 | Return all campaigns where the Date From is after the specified date (empty dates included) |
"Campaigns": [
{
"CampaignCode": "D05",
"CampaignDesc": "5% Off",
"PriceBand": "",
"CostCentreCode": "",
"SegmentCode": "",
"CountryCode": "",
"CampaignDateFrom": "",
"CampaignDateTo": "",
"CampaignStatus": "Y",
"CampaignAuto": "False",
"RebateCostType": "",
"RebateAmt": 0,
"SupplierCompanyNo": 0,
"SupplierAccountNo": 0,
"SupplierAccountRef": "",
"CampaignType": "",
"CampaignGroup": "",
"CampaignPrecedence": "",
"CmpStk": [
{
"CampaignCode": "D05",
"StockNo": 0,
"PriceBand": "",
"QtyFrom": 0,
"CampaignFilter": "",
"Currency": "AUD",
"GSTType": "GST",
"IncGST": "False",
"DiscountType": "%",
"UnitDiscount": 5,
"StockCode": "",
"CmpStkDateFrom": "",
"CmpStkDateTo": "",
"CmpStkSortNo": 0,
"CmpStkNo": 1,
"CmpRequired": "False",
"CmpStkUpdated": "2019-11-28 15:04:21"
}
],
"CmpStkBonus": []
}
Responses
The campaign endpoint includes the following specific responses:
| Response No | Meaning |
|---|---|
| 400 | Error with Payload - Message should provide further information. i.e. Error with Payload - No L_Code Data presented. |
| 406 | No parameters provided |
Options
The Options method returns version information and active campaign codes
Returned Data
| Entry | Definition |
|---|---|
| Version | Shows the current version of the Notes endpoint to compare against the Changelog |
| Campaigns | Returns a comma separated list of campaign codes |
{
"Version": "1.0.0",
"Campaigns": "D05,D07,D10,D12,D15,D18,D20,D25,D36,KITCHEN,RR,SS"
}
Vouchers
This endpoint is used to determine validity and balance of vouchers.
Voucher numbers can only be generated at point of transaction - so the transaction must be referenced after posting to retrieve the voucher numbers.
endpoint: voucher
GET
For security purposes we will not release a full list of active vouchers in the system.
If the InclUsed flag is not set and the voucher balance is 0 then no data will be returned.
At the moment the Voucher endpoint must be provided with one of the three main search terms.
- VoucherNo
- TransRefCode
- AccountRef
Query Parameters
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| VoucherNo | string | P0005551 | Returns information for a specific voucher | |
| TransRefCode | string | TSIN-123456 | Returns all vouchers for a specific transaction | |
| AccountRef | string | ABCD12 | Returns all vouchers for a specific account | |
| InclDisabled | boolean | 1 | Specifies whether disabled / Deleted vouchers should be returned in the dataset (defaults to false) | |
| InclUsed | boolean | 1 | Specifies whether used (zero balance) vouchers should be returned in the dataset (defaults to false) | |
| InclHistory | boolean | 1 | Returns all transactions related to the voucher(s) (defaults to false) |
{
"Vouchers": [
{
"VoucherNo": "T0003726",
"StockNo": 12345,
"VoucherAmount": 500,
"VoucherBalance": 0,
"VoucherCurrency": "AUD",
"VoucherExpiry": "",
"VoucherDisabled": "False",
"VoucherDisabledReason": "",
"VoucherModified": "7/29/2020 6:50:33 PM",
"VoucherName": "",
"SrcCompanyNo": 123456,
"SrcTransNo": 123456,
"SrcDetailNo": 3,
"VoucherCustName": "",
"VoucherDesc": "To be used on your next purchase",
"VoucherType": "C",
"AccountRef": "ABCD12",
"TransRefCode": "TSIN-123456",
"TransDate": "2020-12-07 00:00:00",
"VoucherHistory": [
{
"VoucherNo": "T0003726",
"VoucherName": "",
"PaymentAmt": 249,
"VoucherBalance": 0,
"VoucherType": "C",
"AccountRef": "ABCD12",
"TransRefCode": "TSIN-234567",
"TransDate": "2020-12-07 00:00:00"
},
{
"VoucherNo": "T0003726",
"VoucherName": "",
"PaymentAmt": 140,
"VoucherBalance": 0,
"VoucherType": "C",
"AccountRef": "ABCD12",
"TransRefCode": "TSIN-345678",
"TransDate": "2020-12-07 00:00:00"
},
{
"VoucherNo": "T0003726",
"VoucherName": "",
"PaymentAmt": 129,
"VoucherBalance": 0,
"VoucherType": "C",
"AccountRef": "ABCD12",
"TransRefCode": "TSIN-456789",
"TransDate": "2020-12-07 00:00:00"
}
]
}
]
}
Responses
The voucher endpoint includes the following specific responses:
| Response No | Meaning |
|---|---|
| 204 | Voucher No must have a search term - missing either VoucherNo, Transaction Reference or Account. |
| 400 | Error with Payload - Message should provide further information. i.e. Error with Payload - No L_Code Data presented. |
| 406 | No parameters provided |
Options
The Options method returns version information and active campaign codes
Returned Data
| Entry | Definition |
|---|---|
| Version | Shows the current version of the Notes endpoint to compare against the Changelog |
| Voucher fields | Returns the User Fields associated with Voucher Number / Name / Description |
| Voucher No Generation | Returns the method of generating the voucher with an example |
{
"Version": "1.0.0",
"Voucher Fields": {
"Voucher No": "LineUserStr4",
"Voucher Name": "",
"Voucher Desc": "LineUserStr6"
},
"Voucher No Generation": {
"Method": "Formula Pfx7# - Company Prefix and 7 digits",
"Example": "T1234567"
}
}
Files
This endpoint is used to access images and files attached to Stock Items / Notes and Code data fields.
Files are able to be downloaded through a browser.
If strict parameters aren't sent through then the response will fail.
endpoint: files
GET
Only one file can be recieved at a time, but both Full sized and resized files are able to be retrieved.
There are 4 image types that can be returned:
- Stock
- Code
- Matrix
- Notes
Note that nothing will be returned if an incorrect filename is presented.
Parameters
| Field | Type | Format | Example | Description |
|---|---|---|---|---|
| ImageType | string | Stock | This must be one of the 4 image types above. | |
| Filename | string | 1_54278_180_180.jpg | The above is an example of an automatically resized filename - filenames can be returned via the Stock endpoint. |
Responses
The files endpoint includes the following specific responses:
| Response No | Meaning |
|---|---|
| 400 | Error with Payload - Message should provide further information. i.e. Error with Payload - No File data presented. |
| 406 | No parameters provided |