The HyperAccounts API for Sage 50 Accounts (desktop) uses REST principles to make it easy for third party developers to Create, Read, Update and Search Records in the Sage Database in real-time. All data sent to it or received from it will be in a JSON format.
\nIf you want to clear the value you must pass an empty string as the value. missing properties or null values will be ignored to prevent data loss by customers that accidentally miss a field, maybe from having an older version of the API.
\nOther optional types can either be omitted completely or set to null.
\nThe API uses Simple API Key for authentication. This requires all requests to have an AuthToken Header with the customers unique token in each request or a 403 forbidden error will be returned.
Please contact Hyperext support via support@hyperext.com to obtain your unique token if you do not already have it.
\nAll searchable fields are available in our schema. The API will mirror the date format/system locale set on the environment that hosts the API.
\n\"field\" // Sage table field i.e RECORD_MODIFY_DATE, ACCOUNT_REF etc\n\"type\" // See explanation below\n\"value\" // The value to match in the search\n\"or\" // Optional, bool. Needs to be included in first filter and set to true\n\nThe type field accepts any of the following string values
\"lte\" // Less than or equal\n\"lt\" // Less than\n\"eq\" // Equal\n\"ne\" // Not Equal\n\"gt\" // Greater than\n\"gte\" // greater than or equal\n\"like\" // combined with wildcard search e.g. ACCOUNT_REF LIKE 'TEST%'\n\"nlike\" // Not Like\n\"in\" // eg “value”:“(‘accountRef’,‘accountRef’,‘accountRef’)”\n\"nin\" // Not In\n\nIf you have multiple filters in the same request, the API will use AND to connect the requests. If you wish to use OR you need to include \"or\" in the first filter and set to true. If set to false or not included in the first line, the API will use AND to connect requests.
An example of an OR query is shown below:
[\n {\n \"field\": \"ADDRESS_3\",\n \"type\": \"like\",\n \"value\": \"Blackpool\",\n \"or\": true\n },\n {\n \"field\": \"ADDRESS_4\",\n \"type\": \"like\",\n \"value\": \"Northumberland\"\n }\n]\n\nAdded new endpoint - api/productImage
\nAdded new endpoint - api/trialBalance/{{date}}
\nAdded new endpoint - api/allocateCreditOnAccount
\nAdded new endpoint - api/salesOrder/Update
\nAdded new endpoint - api/purchaseOrder/Update
\nAdded new endpoint - api/purchaseOrder/{id}/updateLedgers
\nAdded new endpoint - api/purchaseOrderItems
\nAdded field \"unitPrice\" to endpoint - api/salesOrderItems
\nChanges to endpoint - api/goodsReceivedNotes so cant create GRN if PO is open in UI
\nFixed bug on endpoint - api/goodsReceivedNotes
\nAdded field \"categoryTitle\" to endpoint - api/coa
\nAdded field \"postedCode\" to endpoint - api/purchaseOrder/{{orderNumber}}
\nAdded nlike (not like) functionality in search
\nAdded nin (not in) functionality in search
\nAdded field \"instrastatImportDutyCode\" to endpoint - api/searchProduct
\nFixed bug with field \"fillGlobalsFromCustomerDefaults on endpoint -api/salesOrder/
\nChanged response text on DELETE sales order endpoint - api/salesOrder/{{orderNumber}} if order is already completed
\nChanged response text on DELETE purchase order endpoint - api/purchaseOrder/{{orderNumber}} if order is already completed
\nAdded field \"reorderLevel\" to endpoint - api/product
\nAdded field \"reorderQty\" to endpoint - api/product
\nChanges to endpoint - api/goodsReceivedNotes
\nAdded OR functionality to search endpoints
\nAdded Webhooks
\nAdded new endpoint - api/searchCustomAlert
\nAdded new endpoint - api/data
\nFixed bug on endpoint - api/purchaseorder
\nAdded field \"date\" to endpoint - api/goodsReceivedNotes
\nAdded field \"supplierGrnNumber\" to endpoint - api/goodsReceivedNotes
\nAdded field \"incoTerms\" to endpoint - api/searchSalesLedger
\nAdded field incoTermsText\"to endpoint - api/searchSalesLedger
\nAdded field \"incoTerms\" to endpoint - api/searchPurchaseLedger
\nAdded field incoTermsText\"to endpoint - api/searchPurchaseLedger
\nAdded new endpoint - api/server
\nChanges to endpoint - api/salesOrderPartialDespatch which will now allow partial invoice creation if pass \"invoice\" in header request
\nAdded new endpoint - /api/salesOrderDeAllocation/{{id}}
\nChanges to PATCH endpoint - api/salesorder/ to allow to reduce line item quantity
\nAdded optional header on endpoint - api/salesOrder/{{id}}/complete when passing through \"gdn\" in header request it will return GDN Number instead of invoice number
\nChanges to endpoint endpoint - api/salesOrder/{{id}}/complete which will now fill in \"Invoice Number\" box in Sage with the invoice number created
\nChanges to endpoint endpoint - api/salesOrderComplete which will now fill in \"Invoice Number\" box in Sage with the invoice number created
\nChanges to endpoint endpoint - api/salesOrderPartialDespatch when passing through \"gdn\" in header request it will return GDN Number
\nChanges to endpoint - api/salesOrderPartialAllocation to allow S1 and S3 stock codes
\nChanges to endpoint - api/salesOrderPartialDespatch to allow S1 and S3 stock codes
\nFixed bug on endpoint - api/searchStock
\nAdded field \"countryCode\" to endpoint - api/salesOrder/
\nAdded field \"countryCode\" to endpoint - api/salesOrder/{{orderNumber}}
\nAdded optional HTTP Error Status responses when passing through \"new-response\" in header request
\nAdded field \"stockCatName\" to endpoint - api/searchProduct
\nAdded field \"countryCodeOfOrigin\" to endpoint - api/product
\nAdded field \"countryCodeOfOrigin\" to endpoint -api/product/{{stockCode}}
\nAdded field \"status\" to endpoint api/salesOrder/{{orderNumber}}
\nAdded field \"priorYear\" to endpoint - api/searchSalesLedger
\nAdded new endpoint - api/salesOrderPartialAllocation
\nAdded new endpoint - api/salesOrderPartialDespatch
\nAdded new endpoint - api/salesordercomplete
\nAdded field \"qtyLastStockTake\" to endpoint - api/searchProduct
\nAdded field \"stockTakeDate\" to endpoint - api/searchProduct
\nAdded field \"lastInvDate\" to endpoint - api/searchSalesLedger
\nAdded field \"taxRate1\" to endpoint - api/searchSalesOrder
\nAdded field \"orderOrQuote\" to endpoint - api/searchSalesOrder
\nAdded field \"unitOfSale\" to endpoint - api/searchSopItem
\nAdded field \"taxRate\" to endpoint - api/searchSopItem
\nAdded field \"recordCreateDate\" to endpoint - api/searchSopItem
\nAdded field \"recordModifyDate\" to endpoint - api/searchSopItem
\nAdded field \"recordCreateDate\" to endpoint - api/searchCustomerAddress
\nAdded field \"recordModifyDate\" to endpoint - api/searchCustomerAddress
\nAdded new endpoint - api/status
\nAdded field \"accountStatus\" to endpoint - api/supplier
\nAdded field \"onHold\" to endpoint - api/supplier
\nAdded field \"accountStatus\" to endpoint - api/supplier/{accountRef}
\nAdded field \"onHold\" to endpoint - api/supplier/{accountRef}
\nAdded field \"reference\" to endpoint - api/purchaseOrder
\nAdded field \"reference\" to endpoint - api/purchaseOrder/{{id}}
\nAdded field \"webPublish\" to endpoint - api/product
\nAdded field \"dueDate\" to endpoint - api/salesOrder/
\nAdded field \"dueDate\" to endpoint - api/salesOrder/{{orderNumber}}
\nChanges to endpoint - api/salesOrder/{{orderNumber}} for fields \"itemsNet\" and \"itemsTax\" to show BASE currency amounts
\nAdded field \"foreignItemsNet\" to endpoint - api/salesOrder/{{orderNumber}}
\nAdded field \"foreignItemsTax\" to endpoint - api/salesOrder/{{orderNumber}}
\nAdded field \"foreignItemsNet\" to endpoint - api/searchSalesOrder
\nAdded field \"foreignItemsTax\" to endpoint - api/searchSalesOrder
\nFixed bug on endpoint - api/searchSopItem
\nFixed bug on endpoint - api/allocatePaymentOnAccount
\nAdded field \"creditPosition\" to endpoint - api/customer/
\nChanges to PATCH endpoint - api/purchaseOrder/ allowing updates after marked as \"ON-ORDER\"
\nFixed bug on endpoint - api/allocatePaymentOnAccount
\nFixed bug on endpoint - api/salesOrder/{{id}}/fullyAllocate
\nFixed foreign rate issue on endpoint - api/transactionPost
\nChanges to PATCH endpoint - api/salesorder/ stopping updates if been marked as allocated, dispatched, on order or delivered
\nChanges to PATCH endpoint - api/purchaseOrder/ stopping updates if been marked as allocated, dispatched, on order or delivered
\nAdded new endpoint to show if RDA enabled - api/setup
\nAdded field \"lockDate\" to endpoint - api/company
\nFixed bug on endpoint - api/searchSalesLedger
\nAdded field \"foreignNetAmount\" to endpoint - api/searchInvoiceItem
\nAdded field \"termsAgreed\" to endpoint - api/supplier/{{supplier}
\nAdded new endpoint - api/courier
\nFixed bug on endpoint - api/salesOrder/{{id}}/fullyAllocate
\nAdded field \"name\" to endpoint - api/searchInvoice
\nAdded field \"name\" to endpoint - api/salesInvoice/{{id}}
\nAdded field \"name\" to endpoint - api/salesInvoice/
\nAdded field \"dueDate\" to endpoint - api/purchaseOrder/
\nFixed bug on endpoint - api/searchProduct
\nAdded fields \"analysis4\" to \"analysis6\" to endpoint -api/searchSalesLedger
\nAdded fields \"analysis4\" to \"analysis6\" to endpoint -api/customer/{{customer}}
\nAdded fields \"analysis4\" to \"analysis6\" to endpoint -api/customer/
\nAdded ability to do IN search requests
\nAdded new endpoint - api/searchProjectTran
\nAdded field \"linkLevel\" to endpoint - api/product
\nAdded field \"linkLevel\" to endpoint - api/product/{{stockCode}}
\nAdded field \"companyRegistrationNumber\" to endpoint - api/searchSalesLedger
\nAdded field \"companyRegistrationNumber\" to endpoint - searchPurchaseLedger
\nAdded field \"lastDiscPurchasePrice\" to endpoint - api/searchProduct
\nAdded field \"lastDiscPurchasePrice\" to endpoint - api/product/{{stockCode}}
\nAdded field \"lastDiscPurchasePrice\" to endpoint - api/product
\nAdded field \"tradeContact\" to endpoint - api/searchPurchaseLedger
\nAdded field \"tradeContact\" to endpoint - api/supplier/{{supplier}}
\nAdded field \"tradeContact\" to endpoint - api/supplier
\nAdded field \"telephone2\" to endpoint - api/searchPurchaseLedger
\nAdded field \"telephone2\" to endpoint - api/supplier/{{supplier}}
\nAdded field \"telephone2\" to endpoint - api/supplier
\nAdded new endpoint - api/searchStock
\nAdded endpoint PATCH - api/customerAddress
\nAdded field \"eoriNumber\" to endpoint - api/supplier
\nAdded field \"eoriNumber\" to endpoint - api/supplier/{{supplier}}
\nAdded field \"eoriNumber\" to endpoint - api/searchPurchaseLedger
\nAdded field \"addressType\" to endpoint - api/customerAddress/{{customer}}/{{addressID}}
\nFixed round issue on endpoint - api/transactionPost
\nFixed foreign rate issue on endpoint - api/transactionPost
\nIncreased field \"description\" on endpoint - api/salesInvoice/ to allow 120 for V29 or newer
\nAdded field \"creditLimit\" to endpoint - api/supplier
\nAdded endpoint - api/searchProjectTransaction
\nChange to endpoint - api/allocatePaymentOnAccount to resolve Sage foreignRate bug
\nAdded field \"currency\" to endpoint - api/allocatePaymentOnAccount
\nAdded fields “address1” to “address5” to endpoint - api/searchPurchaseOrder
\nAdded fields “address1” to “address5” to endpoint - api/purchaseOrder/{{orderNumber}}
\nAdded fields “address1” to “address5” to endpoint - api/purchaseOrder
\nAdded field \"userName\" to endpoint - api/purchaseInvoice
\nAdded fields “analysis1” to “analysis3” to endpoint - api/searchPurchaseOrder
\nAdded fields “analysis1” to “analysis3” to endpoint - api/purchaseOrder
\nAdded fields “analysis1” to “analysis3” to endpoint - api/purchaseOrder/{{orderNumber}}
\nFixed bug on endpoint api/salesOrder/{{id}}/fullyAllocate
\nAdded field \"addressTypeName\" to endpoint - api/searchCustomerAddress
\nAdded field \"addressType\" to endpoint - api/searchCustomerAddress
\nFixed bug on endpoint api/searchInvoiceItem
\nAdded new Read Pricelists endpoint - api/priceList
\nAdded fields “analysis1” to “analysis3” to endpoint - api/searchSalesOrder
\nAdded field “recordCreateDate\" to endpoint - api/searchSalesOrder
\nAdded field “recordModifyDate\" to endpoint - api/searchSalesOrder
\nFixed bug on endpoint - api/transactionPost to allow apostrophes in field \"accountRef\"
\nAdded new endpoint - api/salesOrderItems
\nIncreased field \"description\" on endpoint - api/salesOrder/ to allow 120 for V29 or newer
\nFixed bug with componentCodes on endpoint - api/product
\nAdded endpoint - api/salesorder/{{id}}/hold to mark sales order as “HELD”
\nAdded field \"inactiveFlag\" to endpoint - api/nominal/
\nFixed bug with foreign rates on endpoint - api/batchtransactionPost
\nAdded field “dueDate” to endpoint - api/transactionPost
\nAdded field “dueDate” to endpoint - api/batchtransactionPost
\nAdded field \"agedBalance\" to endpoint - api/search/auditHeaders
\nFixed bug with field componentQty on endpoint - api/product to accept decimal values
\nAdded Default Supplier Nominal to automatically populate when creating supplier if set in Sage Defaults
\nAdded currency check to endpoint POST api/salesOrder/
\nFixed bug with componentCodes on endpoint - api/product
\nFixed bug with allocating payments on endpoint - api/transactionPost
\nFixed bug with response code on endpoint - /api/supplier/{{ID}}
\nFixed discount issue on endpoint - api/salesInvoice
\nAdded field \"lastPaymentDate\" to endpoint api/searchSalesLedger
\nAdded Default Purchase Nominal to automatically populate when creating product if set in Sage Defaults
\nAdded new endpoint Update Exchange Rates - api/currency
\nFixed bug with field \"externalFileURL\" on endpoint - api/purchaseInvoice
\nAdded field \"ignoreCustomerDiscountRate\" to Create Sales Invoice - api/salesInvoice/
\nAdded field \"paymentDueFrom\" to endpoint - api/supplier
\nAdded field \"paymentDueFrom\" to endpoint - api/customer/
\nChanged response on endpoint api/allocatePaymentOnAccount to show GBP amount
\nFixed currency check issue on endpoint - api/salesInvoice/
\nFixed bug on endpoint - api/transactionPost
\nFixed bug on endpoint - api/product
\nFixed bug on endpoint - api/transactionPost
\nAdded new endpoint - api/batchTransactionPost
\nAdded new endpoint - api/stockCat
\nAdded field \"email4\" to endpoint - api/searchSalesLedger
\nAdded field \"email5\" to endpoint - api/searchSalesLedger
\nAdded field \"email6\" to endpoint - api/searchSalesLedger
\nAdded field \"email4\" to endpoint - api/customer/{{ID}}
\nAdded field \"email5\" to endpoint - api/customer/{{ID}}
\nAdded field \"email6\" to endpoint - api/customer/{{ID}}
\nAdded field \"email4\" to endpoint - api/customer/
\nAdded field \"email5\" to endpoint - api/customer/
\nAdded field \"email6\" to endpoint - api/customer/
\nAdded field \"bacsRef\" to endpoint - api/customer/{{customer}}
\nAdded field \"iban\" to endpoint - api/customer/{{customer}}
\nAdded field \"bicSwift\" to endpoint - api/customer/{{customer}}
\nAdded field \"rollNumber\" to endpoint - api/customer/{{customer}}
\nAdded fields \"additionalRef1\" to \"additionalRef3\" to endpoint - api/customer/{{customer}}
\nAdded field \"bacsRef\" to endpoint - api/customer/
\nAdded field \"iban\" to endpoint - api/customer/
\nAdded field \"bicSwift\" to endpoint - api/customer/
\nAdded field \"rollNumber\" to endpoint - api/customer/
\nAdded fields \"additionalRef1\" to \"additionalRef3\" to endpoint - api/customer/
\nAdded field \"bacsRef\" to endpoint - api/searchSalesLedger
\nAdded field \"iban\" to endpoint - api/searchSalesLedger
\nAdded field \"bicSwift\" to endpoint - api/searchSalesLedger
\nAdded field \"rollNumber\" to endpoint - api/searchSalesLedger
\nAdded fields \"additionalRef1\" to \"additionalRef3\" to endpoint - api/searchSalesLedger
\nAdded field \"paymentType\" to endpoint - api/searchSalesLedger
\nAdded field \"qtyOnOrder\" to endpoint - api/product/{{ID}}
\nFixed bug for apostrophes on account references on endpoints api/paymentOnAccount and api/transactionPost
\nChanges to field \"description\" on endpoint - api/purchaseOrder to increase character length to 120. Anything over 120 will go into comment1 and then into comment2
\nAdded field \"recordCreateDate\" to endpoint - api/searchInvoiceItem
\nAdded field \"stockCode\" to endpoint - api/searchInvoiceItem
\nAdded field \"email2\" to endpoint - api/supplier/{{ID}}
\nAdded field \"email3\" to endpoint - api/supplier/{{ID}}
\nAdded field \"email2\" to endpoint - api/supplier
\nAdded field \"email3\" to endpoint - api/supplier
\nAdded endpoint - api/fixedAssets
\nAdded endpoint - api/searchfixedAsset
\nAdded endpoint - api/fixedAssets/{{ID}}
\nAdded fields “address1” to “address5” to endpoint api/project
\nAdded fields \"turnoverYtd\" to endpoint api/customer/{{customer}}
\nFixed bug on endpoint - api/transactionPost
\nAdded field \"paymentDueDays\" to endpoint - api/searchSalesLedger
\nAdded field \"bankRef\" to endpoint - api/salesOrder/
\nAdded endpoint - api/searchCustomerAddress
\nChanges on endpoint - api/allocatePaymentOnAccount to field \"invRef\" now string instead of number
\nFixed bug for unclean disconnect on endpoint - api/project
\nChanges on endpoint - api/customer/ to field \"name\" now no minimum characters
\nAdded new endpoint – api/projectBudgets
\nAdded field “deptNumber” to endpoint - api/transactionPost
\nDeprecated endpoint - api/salesInvoice/{invoiceNumber}/receipts
\nAdded new endpoint – api/goodsReceivedNotes
\nAdded new endpoint – api/searchGoodsReceivedNotes
\nDeprecated endpoint - api/searchDispatch
\nAdded field “settlementDueDays” to endpoint api/salesInvoice/
\nAdded field “settlementDiscRate” to endpoint api/salesInvoice/
\nAdded field “baseSettlementDiscRate” to endpoint api/salesInvoice/
\nFixed bug with fields “projectRef” and “costCodeRef” on endpoint api/purchaseInvoice
\nFixed bug with field “externalFileURL” on endpoint api/purchaseInvoice
\nAdded field ‘projectId’ on endpoint api/purchaseInvoice
\nAdded field ‘costCodeId’ on endpoint api/purchaseInvoice
\nAdded new endpoint POST - api/projectCostCode
\nFixed bug on endpoint - api/searchPurchaseLedger
\nAdded field ‘serviceFlag’ on endpoint api/salesInvoice
\n\n
Added field ‘username’ on endpoint api/transactionPost
\nAdded field ‘itemType’ on endpoint api/searchProduct
\nAdded field ‘serviceFlag’ on endpoint api/salesOrder
\nFixed bug on endpoint - api/searchPopItem
\nFixed bug on endpoint - api/searchSopItem
\nAdded new endpoint api/paymentMethod - GET only
\nAdded field “paymentMethodId” to endpoint api/supplier & api/searchPurchaseLedger
\nBug fix on endpoint: SalesInvoice/{id}/Complete
\nAdded new endpoint: api/SearchInvoiceItem
\nAdded field 'invoiceItemsDataFromStockItemData’to endpoint api/salesInvoice
\nAdded field 'orderItemsDataFromStockItemData’to endpoint api/salesOrder
\nBug fixed on api/purchaseInvoice
\nAdded fields “address1” to “address5” to endpoint - api/searchSalesOrder
\nAdded fields “delAddress1” to “delAddress5” to endpoint - api/searchSalesOrder
\nAdded field “globalDepartment” to endpoint -api/salesOrder/
\nAdded field “fillGlobalsFromCustomerDefaults” to endpoint -api/salesOrder/
\nFixed error with 0 value line on endpoint - api/salesInvoice/
\nAdded field “printed” to POST endpoint - api/salesInvoice/
\nAdded field “emailed” to POST endpoint - api/salesInvoice/
\nFixed bug on endpoint - api/allocatePaymentOnAccount
\nAdded field 'settlementDiscRate’to endpoint api/SalesOrder
\nAdded field 'settlementDueDays’to endpoint api/SalesOrder
\nAdded field 'discountRate’to endpoint api/supplier
\nAdded field 'paymentDueDays’to endpoint api/supplier
\nAdded field 'discountRate’to endpoint api/searchPurchaseLedger
\nAdded field 'paymentDueDays’to endpoint api/searchPurchaseLedger
\nAdded field ‘itemsNet’ to endpoint api/salesOrder
\nAdded field ‘itemsTax’ to endpoint api/salesOrder
\nAdded field ‘netValueDiscountPercentage’ to endpoint api/salesOrder
\nAdded field ‘netValueDiscountPercentage’ to endpoint api/searchSalesOrder
\nAdded field ‘dueDate’ to endpoint api/purchaseInvoice
\nAdded new endpoint (GET) - api/customerAddress
\nAdded field ‘tradeContact’ to endpoint api/searchSalesLedger
\nAdded field “globalNominal” to endpoint api/salesOrder
\nAdded field “globalDetails” to endpoint api/salesOrder
\nAdded field “globalTaxCode” to endpoint api/salesOrder
\nAdded new endpoint (POST) - api/customerAddress
\nAdded field “eoriNumber” to endpoint api/customer
\nAdded field “tradeContact” to endpoint api/customer
\nAdded field “telephone2” to endpoint api/customer
\nAdded field “fax” to endpoint api/customer
\nFixed bug on endpoint api/searchSalesLedger
\nAdded field “reference” to endpoint api/searchPurchaseOrder
\nAdded new endpoint - api/documentLink/{ID}
\nAdded field “foreignRate” to endpoint - api/salesOrder/
\nFix discount issue on endpoint - api/salesInvoice
\nAdded field “itemsNet” to endpoint - api/purchaseOrder
\nAdded field “itemsTax” to endpoint - api/purchaseOrder
\nAdded field “defNomCodeUseDefault” to endpoint - api/customer
\nAdded field “defTaxCodeUseDefault” to endpoint - api/customer
\nFixed storedPrice on endpoint - api/searchPrice
\nAdded field \"eoriNumber to endpoint - api/customer
\nAdded endpoint - api/SopItem
\nVarious changes & additions on api/searchSopItem
\nVarious changes & additions on api/searchPopItem
\nRounding salesPrice to 4 decimals on api/product
\nAdded field ‘id’ to endpoint - api/salesOrder
\nAdded field ‘id’ to endpoint - api/salesInvoice
\nAdded field ‘unitOfsale’ to endpoint - api/salesOrder
\nAdded field ‘unitOfsale’ to endpoint - api/salesInvoice
\nFixed bug on enpoint - api/transactionPost
\nNote: ‘id’ fields on items on endpoints api/salesOrder and api/salesInvoice are READ ONLY
\nFix for transactionPost performance issues
\nAdded field “recordCreatedDate” to endpoint - api/searchUsage
\nAdded field “recordModifyDate” to endpoint - api/searchUsage
\nAdded field “carriageDepartmentNumber” to endpoint - api/salesOrder
\nAdded field “carriageDepartmentNumber” to endpoint - api/salesInvoice
\nAdded field “consignmentRef” to endpoint - api/salesOrder
\nFix for the Sales Receipts / Purchase Payment allocations against invoices
\nFixed bug on endpoint - api/salesInvoice making certain fields optional
\nAdded field “projectRef” to endpoint - api/purchaseInvoice
\nAdded field “costCode” to endpoint - api/purchaseInvoice
\nAdded field “commodityCode” to endpoint - api/product
\nAdded field “barcode” to endpoint - api/product
\nAdded field “webDetails” to endpoint - api/product
\nAdded field “webDescription” to endpoint - api/product
\nAdded field “carriageDepartmentNumber” to endpoint - api/purchaseOrder
\nAdded fields “notes1” to “notes3” to endpoint - api/purchaseOrder
\nAdded fields “analysis1” to “analysis3” to endpoint api/salesInvoice/
\nAdded field “netValueDiscountDescription” to endpoint api/salesInvoice/
\nAdded field “netValueDiscountAmount” to endpoint api/salesInvoice/
\nRenamed netValue fields on endpoint - api/searchInvoice
\nAdded “currency” to endpoint - api/purchaseInvoice
\nAdded “foreignRate” to endpoint - api/purchaseInvoice
\nRefinements to PATCH endpoints
\nAdded “notes3” to endpoint - api/salesInvoice
\nAdded “component1Code” to “component10Code” to endpoint - api/product
\nAdded “component1Qty” to “component10Qty” to endpoint - api/product
\nAdded “exRef” to endpoint - api/purchaseInvoice
\nFixed bug on multiple Patch endpoints removing details from Sage when left blank
\nAdded “lastPurchasePrice” to Patch Product - api/product
\nFixed bug on endpoint - api/searchSalesLedger giving “eoriNumber” error for older versions of Sage
\nAdded feature on endpoint - api/salesorder to allow line item description to auto populate from product if null
\nAdded feature on endpoint - api/project to allow line item “status” field to be changed to ACTIVE, COMPLETED, INITIAL, SNAG, SUSPEND
\nAdded “lastCostPrice” to Search Product - api/searchProduct
\nAdded “countryCodeOfOrigin” to Search Product - api/searchProduct
\nAdded “vatRegNumber” to Search Sales Ledger - api/searchSalesLedger
\nAdded “eoriNumber” to Search Sales Ledger - api/searchSalesLedger
\nAdded endpoint - api/searchDispatch
\nUpdated endpoints api/company & api/nominal to use ODBC
\nFixed bug on endpoint api/purchaseOrder removing details from Sage when left blank
\nUpdated endpoint - api/supplier to be able to specify own Account Ref
\nFixed bug on endpoint - api/salesOrder/{id}/complete failing when message line is included in items
\nAdded endpoint - api/searchPopItem
\nAdded field “netValueDiscountAmount” to Create Sales Order - api/salesOrder/
\nAdded field “email3” to endpoint - api/searchSalesLedger
\nUpdated endpoints - api/coa/ & api/control to use ODBC
\nAdded deptNumber to endpoint - api/journal
\nAdded extraRef to endpoint - api/journal
\nAdded delName to endpoint - api/searchSalesLedger
\nAdded delAddress1 to delAddress5 to endpoint - api/searchSalesLedger
\nAdded orderDate to endpoint - api/salesorder
\nAdded component1Code to component10Code in relation to “Bill Of Materials” to endpoint - api/searchProduct
\nAdded component1Qty to component10Qty in relation to “Bill Of Materials” to endpoint - api/searchProduct
\nUpdated endpoint - api/currency to use ODBC
\nFixed bug on endpoint - api/salesInvoice with auto numbering between sales credits and sales invoices
\nEndpoint - api/salesInvoice address1 to address5 will now populate from Sales Ledger if not supplied in JSON
\nAdded optional address 1-5 to salesInvoice
\nAdded isNegativeLine fields to salesInvoice
\nAdded isCredit option to purchaseInvoice endpoint
\nFixed bug on unclean disconnect issue on api/project
\nAdded isCredit option to purchaseInvoice endpoint
\nAdded discountAmount back into Sales Order
\nFixed bug on SO analysis fields
\nSimplified searchUsage response to avoid corrupt data in created and modified dates
\nFixed an issue in GET project
\nAdded analysis fields to sales order
\nAdded new POST purchase invoice endpoint
\nAdded new POST complete sales order endpoint
\nAdded delName to PO and item.netAmount to SO
\nAdded optional netAmount field to salesInvoice Item to reverse calculate discounts and resolve floating point issues on fractional amounts
\nOn salesInvoice endpoint requests with invoiceTypeCode = 3 or 4 will now use next Credit Number from Sage rather than next Invoice Number as before
\nOn POST purchaseOrder user can optionally specify own PO orderNumber in place of autogenerated number from Sage. Includes protection against overwriting existing records with same ref.
\nStock adjustments fetch previous cost price if not provided
\nCompound discount feature on sales invoices
\nAdded search price endpoint
\nAdded new fields to search Product endpoint
\nFixed an issue when posting/patching sales invoices
\nChanges to Sage connection handling logic to improve performance under load
\nAdded runtime debugging functionality (internal use only)
\nAdded purchaseNominalCode to Product, added itemsNet and itemsTax to GET salesInvoice
\nAdded search project endpoint
\nFixed issue with consignmentRef field in sales invoice
\nAdded accountStatus field to customer
\nFixed an issue with patching a product and added location
\nAdded projectID and costCodeID fileds to purchase order
\nAdded additional fields to audit usage response
\nAdded additional fields to supplier endpoint
\nAdded GET tax code by ID
\nAdded additional fields to customer endpoint
\nAdded LIKE functionality in search
\nAdded consignmentRef to sales invoice
\nAdded departments endpoint
\nAdded Search usage endpoint
\nImproved endpoint response information on Update Ledgers
\nAdded Due date to purchase order
\nAdded api/stock
\nAdded api/searchPurchaseOrder
\nAdded multi company support
\nPrice list endpoint now uses ODBC (performance improvement)
\nAdded VAT number, email 1 and email 2 fields to customer
\nFixed credit invoice numbering issue
\nAdded due date field to purchase order endpoint
\nAdded chart of accounts endpoint
\nAdded control endpoint
\nAdded ability to search by date time
\nAdded company endpoint
\nFixed issue with partial data on customer patch
\nStock code restricted to 30 chars on sales order and sales invoice
\nAdded patch to sales invoice endpoint
\nAdded search purchase ledger endpoint
\nRemoved character limit on stock code
\nAdded additional fields to search sales order
\nAdded balance to nominal endpoint (read only)
\nChanged older agedBalance from 160 to 120
\nAdded additional fields to product and sales ledger search
\nFixed a currency related issue with transactionPost
\nAdded search splits endpoint
\nAdded departmentNumber to purchase order endpoint
\nAdded analysis fields to project
\nMade accountRef on project optional
\nAdded Project transactions endpoint
\nAdded custom accountRef in customer endpoint
\nFixed an issue with stock code being truncated to 15 chars on the Sales Invoice endpoint
\nFixed an issue when patching a purchase order
\nAdded shouldUpdateLedgers flag to sales invoice endpoint
\nAdded shouldAllocatePayment to transaction post endpoint
\nAdded project endpoint
\nDate parsing fix
\nAdded transactionPost endpoint
\nAdded paymentDueDate and projectId to sales invoice
\nAdded DELETE endpoints to sales/purchase order
\nAdded foreign currency related fields to sales invoice
\nAdded Purchase order GET and PATCH endpoints
\nAdded ID field to currency list
\nAdded supplierOrderNumber to Purchase orders
\nAdded transactionPost endpoint
\nReceipt endpoints share code/models with transactionPost
\nAdded foreignRate and invoiceTypeCode to Sales Invoice
\nAdded refundOnAccount endpoint
\nAdded paymentOnAccount endpoint
\nFixed issue with search products
\nAdded status fields to search sales order
\nAdded printed flag to sales invoice
\nAdded customer balance to response
\nAdded orderDueDate to sales order
\nAdded GET Currency
\nAdded products search
\nAdded country code to customers
\nAllow manually entering comment 1 & 2 on sales order items
\nAdded journal endpoint
\nAdded bank endpoint
\nFixed an issue with sales invoice item details not showing
\nAdded ability to update sales order account ref
\nAdded Get Sales Invoice endpoint
\nAdded InvRef field to search sales order
\nSearch sales order table
\nGeneral small improvements
\nAdded post sales receipt endpoint
\nFixed a bug that reported false when fetching suppliers
\nFixed a bug with generating customer references
\nAdded datePosted field to GET sales receipts
\nAdded departmentNumber field to salesOrders
\nBug fix with company name
\nAdded product endpoint
\nAdded http status code
\nFixed a bug in posting a sales order
\nFixed missing dependency issue
\nAdded get sales orders and sales order by order number
\nFixed an issue with special characters in account ref
\nFixed a bug when fetching part-paid sales receipts
\nFixed an issue where you couldn’t clear an optional text field with an empty string
\nAdded sendLettersElectronically to customer object
\nAdditional fields added to customer and sales invoice
\nSome fields changed from mandatory/optional in sales invoice
\nBasic token based authentication added
\nDescription: Checks status of API
\nEndpoint URL: api/status
Method: GET
Parameters: none
\nDescription: Checks server date/time settings
\nEndpoint URL: api/server
Method: GET
Parameters: none
\nDescription: Reads data amounts
\nEndpoint URL: api/data
Method: GET
Parameters: none
\nDescription: Returns API Version.
\nEndpoint URL: api/system/version
Method: GET
Parameters: none
\nDescription: Returns Company Information.
\nEndpoint URL: api/company
Method: GET
Parameters: none
\nDescription: Shows If Remote Data Access Is Enabled
\nEndpoint URL: api/setup
Method: GET
Parameters: none
\nNOTES:
\nDescription: Returns Currencies list from Settings.
\nEndpoint URL: api/currency
Method: GET
Parameters: none
\nDescription: Updates Currencies list from Settings.
\nEndpoint URL: api/currency
Method: PATCH
Parameters:
\nid // required, int, max number 100\ncode // required, string, max 3 chars\nemuMember // optional, int, 0 = false 1 = true\nexchangeRate // optional, double, max 9 chars\nmajorUnit // optional, string, max 20 chars\nminorUnit // optional, string, max 20 chars\nname // optional, string, max 30 chars\nsymbol // optional, string, max 3 chars\n\nDescription: Returns Countries.
\nEndpoint URL: api/country
Method: GET
Parameters: none
\nDescription: Returns Couriers.
\nEndpoint URL: api/courier
Method: GET
Parameters: none
\nDescription: Returns Nominals.
\nEndpoint URL: api/nominal/
Method: GET
Parameters: none
\nDescription: Returns Tax Codes.
\nEndpoint URL: api/taxCode
Method: GET
Parameters: none
\nDescription: Returns Control Accounts.
\nEndpoint URL: api/control
Method: GET
Parameters: none
\nDescription: Fetches all Payment Methods
\nEndpoint URL: api/paymentMethod
Method: GET
Parameters: none
\nDescription: Returns Departments.
\nEndpoint URL: api/department
Method: GET
Parameters: none
\nDescription: Returns 1st Chart Of Accounts.
\nEndpoint URL: api/coa
Method: GET
Parameters: none
\nDescription: Returns Trial Balance
\nEndpoint URL: api/trialBalance/{{date}}
Method: GET
Notes
\nDate is in the format mm-yyyy
\nIf you put a date before the financial year, it will get all the BF (Brought Forward) data and if you select a date after the financial year, it will get all the FUTURE data. Otherwise, it will get the data for the selected date. You can see the current financial month & year via endpoint - api/company
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"AuthToken"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"07b36e89-6fe2-4208-9ae8-a85041b2ded0","id":"07b36e89-6fe2-4208-9ae8-a85041b2ded0","name":"HyperAccounts REST API for Sage 50 Accounts (desktop)","type":"collection"}},"urlObject":{"path":["api","trialBalance","{{date}}"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"d8df1974-a2fd-4e1e-964c-015d1095383d","name":"Read Trial Balance","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"},{"key":"company","value":"{{company}}","type":"text","disabled":true}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{url}}/api/trialBalance/01-2024"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"cache-control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"expires","value":"-1"},{"key":"server","value":"Microsoft-IIS/10.0"},{"key":"x-aspnet-version","value":"4.0.30319"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Wed, 15 Apr 2026 08:18:07 GMT"},{"key":"content-length","value":"3722"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"code\": 200,\n \"response\": {\n \"toPeriod\": \"Month 1, January 2024\",\n \"totalDebit\": 217177.64,\n \"totalCredit\": 217177.64,\n \"nominals\": [\n {\n \"accountRef\": \"0020\",\n \"name\": \"Plant and Machinery\",\n \"debit\": 50000,\n \"credit\": 0\n },\n {\n \"accountRef\": \"0021\",\n \"name\": \"Plant/Machinery Depreciation\",\n \"debit\": 0,\n \"credit\": 4000\n },\n {\n \"accountRef\": \"0040\",\n \"name\": \"Furniture and Fixtures\",\n \"debit\": 16900,\n \"credit\": 0\n },\n {\n \"accountRef\": \"0041\",\n \"name\": \"Furniture/Fixture Depreciation\",\n \"debit\": 0,\n \"credit\": 93\n },\n {\n \"accountRef\": \"0050\",\n \"name\": \"Motor Vehicles\",\n \"debit\": 20300,\n \"credit\": 0\n },\n {\n \"accountRef\": \"0051\",\n \"name\": \"Motor Vehicles Depreciation\",\n \"debit\": 0,\n \"credit\": 1334.48\n },\n {\n \"accountRef\": \"1001\",\n \"name\": \"Stock\",\n \"debit\": 35000,\n \"credit\": 0\n },\n {\n \"accountRef\": \"1100\",\n \"name\": \"Debtors Control Account\",\n \"debit\": 23130.92,\n \"credit\": 0\n },\n {\n \"accountRef\": \"1103\",\n \"name\": \"Prepayments\",\n \"debit\": 1350,\n \"credit\": 0\n },\n {\n \"accountRef\": \"1200\",\n \"name\": \"Bank Current Account\",\n \"debit\": 0,\n \"credit\": 13374.76\n },\n {\n \"accountRef\": \"1210\",\n \"name\": \"Bank Deposit Account\",\n \"debit\": 1510,\n \"credit\": 0\n },\n {\n \"accountRef\": \"1220\",\n \"name\": \"Building Society Account\",\n \"debit\": 2.5,\n \"credit\": 0\n },\n {\n \"accountRef\": \"1230\",\n \"name\": \"Petty Cash\",\n \"debit\": 297,\n \"credit\": 0\n },\n {\n \"accountRef\": \"1240\",\n \"name\": \"Company Credit Card\",\n \"debit\": 0,\n \"credit\": 1056\n },\n {\n \"accountRef\": \"2100\",\n \"name\": \"Creditors Control Account\",\n \"debit\": 0.01,\n \"credit\": 0\n },\n {\n \"accountRef\": \"2109\",\n \"name\": \"Accruals\",\n \"debit\": 0,\n \"credit\": 50\n },\n {\n \"accountRef\": \"2200\",\n \"name\": \"Sales Tax Control Account\",\n \"debit\": 0,\n \"credit\": 6172.15\n },\n {\n \"accountRef\": \"2201\",\n \"name\": \"Purchase Tax Control Account\",\n \"debit\": 1748.98,\n \"credit\": 0\n },\n {\n \"accountRef\": \"2210\",\n \"name\": \"P.A.Y.E.\",\n \"debit\": 0,\n \"credit\": 3326.56\n },\n {\n \"accountRef\": \"2211\",\n \"name\": \"National Insurance\",\n \"debit\": 0,\n \"credit\": 1003.49\n },\n {\n \"accountRef\": \"2230\",\n \"name\": \"Pension Fund\",\n \"debit\": 0,\n \"credit\": 40\n },\n {\n \"accountRef\": \"2300\",\n \"name\": \"Loans\",\n \"debit\": 0,\n \"credit\": 7500\n },\n {\n \"accountRef\": \"2310\",\n \"name\": \"Hire Purchase\",\n \"debit\": 0,\n \"credit\": 7810\n },\n {\n \"accountRef\": \"3000\",\n \"name\": \"Ordinary Shares\",\n \"debit\": 0,\n \"credit\": 96332\n },\n {\n \"accountRef\": \"4000\",\n \"name\": \"Sales North\",\n \"debit\": 0,\n \"credit\": 39832.7\n },\n {\n \"accountRef\": \"4009\",\n \"name\": \"Discounts Allowed\",\n \"debit\": 50,\n \"credit\": 0\n },\n {\n \"accountRef\": \"4905\",\n \"name\": \"Distribution and Carriage\",\n \"debit\": 0,\n \"credit\": 200\n },\n {\n \"accountRef\": \"5000\",\n \"name\": \"Materials Purchased\",\n \"debit\": 9713.9,\n \"credit\": 0\n },\n {\n \"accountRef\": \"5200\",\n \"name\": \"Opening Stock\",\n \"debit\": 40710,\n \"credit\": 0\n },\n {\n \"accountRef\": \"5201\",\n \"name\": \"Closing Stock\",\n \"debit\": 0,\n \"credit\": 35000\n },\n {\n \"accountRef\": \"6202\",\n \"name\": \"Gifts and Samples\",\n \"debit\": 100,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7000\",\n \"name\": \"Gross Wages\",\n \"debit\": 8100,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7006\",\n \"name\": \"Employers N.I.\",\n \"debit\": 831.81,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7009\",\n \"name\": \"Adjustments\",\n \"debit\": 85,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7010\",\n \"name\": \"SSP Reclaimed\",\n \"debit\": 10,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7011\",\n \"name\": \"SMP Reclaimed\",\n \"debit\": 19.2,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7100\",\n \"name\": \"Rent\",\n \"debit\": 6450,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7200\",\n \"name\": \"Electricity\",\n \"debit\": 450,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7304\",\n \"name\": \"Miscellaneous Motor Expenses\",\n \"debit\": 0.5,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7350\",\n \"name\": \"Scale Charges\",\n \"debit\": 30.09,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7500\",\n \"name\": \"Printing\",\n \"debit\": 2.5,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7502\",\n \"name\": \"Telephone\",\n \"debit\": 50,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7504\",\n \"name\": \"Office Stationery\",\n \"debit\": 55,\n \"credit\": 0\n },\n {\n \"accountRef\": \"7903\",\n \"name\": \"Loan Interest Paid\",\n \"debit\": 27.75,\n \"credit\": 0\n },\n {\n \"accountRef\": \"8003\",\n \"name\": \"Vehicle Depreciation\",\n \"debit\": 252.48,\n \"credit\": 0\n },\n {\n \"accountRef\": \"8222\",\n \"name\": \"Bank Interest Received\",\n \"debit\": 0,\n \"credit\": 2.5\n },\n {\n \"accountRef\": \"9999\",\n \"name\": \"Mispostings Account\",\n \"debit\": 0,\n \"credit\": 50\n }\n ]\n },\n \"message\": null\n}"}],"_postman_id":"deb44b51-2acf-4f84-8127-1d24a7669680"}],"id":"681a0fb1-9bdb-4c3c-b95e-6b0bb03fae7b","_postman_id":"681a0fb1-9bdb-4c3c-b95e-6b0bb03fae7b","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"AuthToken"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"07b36e89-6fe2-4208-9ae8-a85041b2ded0","id":"07b36e89-6fe2-4208-9ae8-a85041b2ded0","name":"HyperAccounts REST API for Sage 50 Accounts (desktop)","type":"collection"}}},{"name":"Webhooks","item":[{"name":"Read All Webhooks","event":[{"listen":"test","script":{"id":"3c6d0ff2-2c28-466d-afbb-6d0333794ea8","exec":["tests[\"Read Customer Working\"+pm.response.text()] = responseBody .has(\"name\");"],"type":"text/javascript","packages":{},"requests":{}}}],"id":"8a2bcd3f-999c-422d-a7ac-0aa4af6ead9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{url}}/api/Webhook","description":"Description: Reads All Webhooks
\nEndpoint URL: api/Webhook
Method: GET
Parameters: none
\nDescription: Reads 1 Webhook
\nEndpoint URL: api/Webhook/{{id}}
Method: GET
Parameters: none
\nDescription: Creates a new webhook
\nEndpoint URL: api/Webhook
Method: POST
Parameters:
\nsageFileName // Required, String\nurl // Required, String\nauthorisationHeader // Optional, String\nauthorisationToken // Optional, String\nactive // Optional, Bool (defaults to true)\n\nNote:
\nValue File name\nCustomers SALES.DTA\nSalesInvoices INVOICE.DTA\nSalesInvoiceItems INVITEM.DTA\nSuppliers PURCHASE.DTA\nPurchaseOrders PUORDER.DTA\nPurchaseOrderItems PUOITEM.DTA\nTransactionHeaders HEADER.DTA\nTransactionSplits SPLITS.DTA\nTransactionUsages USAGE.DTA\nSalesOrders SAORDER.DTA\nSalesOrderItems SAOITEM.DTA\nStock STOCK.DTA\nGoodsReceivedNotes GN.DTA\nProjects PROJECT.DTA\nStockTransactions STKTRANS.DTA\nPrices PRICE.DTA\nGoodsDispatchedNotes GN.DTA\n\nDescription: Updates Existing Webhook
\nEndpoint URL: api/Webhook{{id}}
Method: POST
Parameters:
\nsageFileName // Optional, String\nurl // Optional, String\nauthorisationHeader // Optional, String\nauthorisationToken // Optional, String\nactive // Optional, Bool\n\nNote:
\nValue File name\nCustomers SALES.DTA\nSalesInvoices INVOICE.DTA\nSalesInvoiceItems INVITEM.DTA\nSuppliers PURCHASE.DTA\nPurchaseOrders PUORDER.DTA\nPurchaseOrderItems PUOITEM.DTA\nTransactionHeaders HEADER.DTA\nTransactionSplits SPLITS.DTA\nTransactionUsages USAGE.DTA\nSalesOrders SAORDER.DTA\nSalesOrderItems SAOITEM.DTA\nStock STOCK.DTA\nGoodsReceivedNotes GN.DTA\nProjects PROJECT.DTA\nStockTransactions STKTRANS.DTA\nPrices PRICE.DTA\nGoodsDispatchedNotes GN.DTA\n\nDescription: Deletes webhook.
\nEndpoint URL: api/Webhook/{id}
Method DELETE
Params: ID
\nDescription: Searches for customers.
\nEndpoint URL: api/searchSalesLedger
Method: POST
NOTES:
\nDescription: Read 1 customers account. If you are wanting to search for more than 1 customer use endpoint - api/searchSalesLedger
\nEndpoint URL: api/customer/{{customer}}
Method: GET
Parameters: none
\nDescription: Creates a new customer record in Sage. Automatically generates unique accountRef in the form 'AAAA0000' returned in successful response
\nEndpoint URL: api/customer
Method: POST
Parameters:
\naccountRef // optional, string, max 8 chars to override auto generation\nname // required, string, max 60 chars\ncontactName // optional, string, max 30 chars\ncustomerName // optional, string, max 30 chars\ntradeContact // optional, string, max 30 chars\ntelephone // optional, string, max 30 chars\naddress1 // optional, string, max 60 chars\naddress2 // optional, string, max 60 chars\naddress3 // optional, string, max 60 chars\naddress4 // optional, string, max 60 chars\naddress5 // optional, string, max 60 chars\ndeliveryAddress1 // optional, string, max 60 chars\ndeliveryAddress2 // optional, string, max 60 chars\ndeliveryAddress3 // optional, string, max 60 chars\ndeliveryAddress4 // optional, string, max 60 chars\ndeliveryAddress5 // optional, string, max 60 chars\ncountryCode // e.g GB max 2 chars, optional\ncreditLimit // optional, int\npriceListRef // optional, string, max 8 chars\ncurrency // Int max 1 chars, optional, use values from sage Settings > Currencies\nemail // optional, string, max 255 chars\nemail2 // optional, string, max 255 chars\nemail3 // optional, string, max 255 chars\nemail4 // optional, string, max 255 chars\nemail5 //optional, string, max 255 chars\nemail6 // optional, string, max 255 chars\naccountStatus // optional, int, max 2 digits\neoriNumber // optional, string, max 60 chars\ndefTaxCode // optional, int, max 2 digits\ndefNomCodeUseDefault // optional, bool \ndefNomCode // optional, string, max 8 chars\nterms // optional, string, max 30 chars\ntermsAgreed // optional, bool\nbankAccountName // optional, string, max 60 chars\nbankSortCode // optional, string, max 10 chars\nbankAccountNumber // optional, string, max 60 chars\nbacsRef // optional, string, max 60 chars\niban // optional, string, max 60 chars\nbicSwift // optional, string, max 60 chars\nrollNumber // optional, string, max 60 chars\naddtitionalRef1 // optional, string, max 60 chars\naddtitionalRef2 // optional, string, max 60 chars\naddtitionalRef3 // optional, string, max 60 chars\npaymentType // optional, int, max 2 chars\nsendInvoicesElectronically // optional, bool\nsendLettersElectronically // optional, bool\nanalysis1 // optional, string, max 30 chars\nanalysis2 // optional, string, max 30 chars\nanalysis3 // optional, string, max 30 chars\nanalysis4 // optional, string, max 30 chars\nanalysis5 // optional, string, max 30 chars\nanalysis6 // optional, string, max 30 chars\ndeptNumber // optional, int, max 2 chars\npaymentDueDays // optional, int, max 2 chars\npaymentDueFrom // optional, int, max 1 chars\ninactiveAccount // optional, bool\nvatNumber // optional, string, max 20 chars\naccountStatus // optional, int, max 2 chars\nonHold // optional, bool\ncreditPosition // optional, int, max 1 chars\ndiscountRate // optional, double, max 8 chars\ndiscountType // optional, byte, enum type, max 1 chars\nwww // optional, string, max 255 chars\n\nNote:
\nValue Description\n0 Days After Invoice Date\n1 Days From The First Day Of The Following Month\n2 Days Before The Last Day Of The Following Month\n3 Days Of The Month\n4 Days From 1 Month After Invoice Date\n\nConstant Value Description \nsdoNoDiscount 0 No Discount Applied \nsdoValueDiscount 1 Discount Applied by Invoice Value \nsdoQtyDiscountA 2 Discount Applied by Banding A \nsdoQtyDiscountB 3 Discount Applied by Banding B \nsdoQtyDiscountC 4 Discount Applied by Banding C \nsdoQtyDiscountD 5 Discount Applied by Banding D \nsdoQtyDiscountE 6 Discount Applied by Banding E\n\nValue Description\n0 Good\n1 Reminder\n2 Warning\n3 Legal\n\nDescription: Updates an existing customer record.
\nEndpoint URL: api/customer
Method: PATCH
Parameters:
\naccountRef // String, required, max 8 chars\nname // String, optional, max 30 chars\ncontactName // String, optional, max 30 chars\ncustomerName // optional, string, max 30 chars\ntradeContact // optional, string, max 30 chars\ntelephone // String, optional, max 30 chars\naddress1 // String, optional, max 60 chars\naddress2 // String, optional, max 60 chars\naddress3 // String, optional, max 60 chars\naddress4 // String, optional, max 60 chars\naddress5 // String, optional, max 60 chars\ncountryCode // String, optional, max 2 chars\ndeliveryAddress1 // String, optional, max 60 chars\ndeliveryAddress2 // String, optional, max 60 chars\ndeliveryAddress3 // String, optional, max 60 chars\ndeliveryAddress4 // String, optional, max 60 chars\ndeliveryAddress5 // String, optional, max 60 chars\ncurrency // Int, optional, use values from sage Settings > Currencies, max 1 chars\nemail // optional, string, max 255 chars\nemail2 // optional, string, max 255 chars\nemail3 // optional, string, max 255 chars\nemail4 // optional, string, max 255 chars\nemail5 //optional, string, max 255 chars\nemail6 // optional, string, max 255 chars\naccountStatus // optional, int, max 2 digits\neoriNumber // optional, string, max 60 chars\ndefTaxCode // optional, int, max 2 digits\ndefNomCodeUseDefault // optional, bool \ndefNomCode // optional, string, max 8 chars\ndefTaxCodeUseDefault // optional, bool\nterms // optional, string, max 30 chars\ntermsAgreed // optional, bool\ncreditLimit // optional, int\npriceListRef // optional, string, max 8 chars\nbankAccountName // optional, string, max 60 chars\nbankSortCode // optional, string, max 10 chars\nbankAccountNumber // optional, string, max 60 chars\nbacsRef // optional, string, max 60 chars\niban // optional, string, max 60 chars\nbicSwift // optional, string, max 60 chars\nrollNumber // optional, string, max 60 chars\naddtitionalRef1 // optional, string, max 60 chars\naddtitionalRef2 // optional, string, max 60 chars\naddtitionalRef3 // optional, string, max 60 chars\npaymentType // optional, int, max 2 chars\nsendInvoicesElectronically // optional, bool\nsendLettersElectronically // optional, bool\nanalysis1 // optional, string, max 30 chars\nanalysis2 // optional, string, max 30 chars\nanalysis3 // optional, string, max 30 chars\nanalysis4 // optional, string, max 30 chars\nanalysis5 // optional, string, max 30 chars\nanalysis6 // optional, string, max 30 chars\ndeptNumber // optional, int, max 2 chars\npaymentDueDays // optional, int, max 2 chars\npaymentDueFrom // optional, int, max 1 chars\ninactiveAccount // optional, bool\nvatNumber // optional, string, max 20 chars\ncreditPosition // optional, int, max 1 chars\ndiscountRate // optional, double, max 8 chars\ndiscountType // optional, byte, enum type, max 1 chars\nwww // optional, string, max 255 chars\n\nNote:
\nValue Description\n0 Days After Invoice Date\n1 Days From The First Day Of The Following Month\n2 Days Before The Last Day Of The Following Month\n3 Days Of The Month\n4 Days From 1 Month After Invoice Date\n\nConstant Value Description \nsdoNoDiscount 0 No Discount Applied \nsdoValueDiscount 1 Discount Applied by Invoice Value \nsdoQtyDiscountA 2 Discount Applied by Banding A \nsdoQtyDiscountB 3 Discount Applied by Banding B \nsdoQtyDiscountC 4 Discount Applied by Banding C \nsdoQtyDiscountD 5 Discount Applied by Banding D \nsdoQtyDiscountE 6 Discount Applied by Banding E\n\nValue Description\n0 Good\n1 Reminder\n2 Warning\n3 Legal\n\nDescription: Gets the aged debts details for a specific customer
\nEndpoint URL: api/agedDebtors/{accountRef}
Method: GET
Parameters: none
\nDescription: Read 1 customers address. If you are wanting to search for more than 1 customers address use endpoint - api/searchCustomerAddress
\nEndpoint URL: api/customerAddress/{{customer}}/{{addressID}}
Method: GET
Parameters: none
\nDescription: Creates a new customer address record in Sage
\nEndpoint URL: api/customerAddress
Method: POST
Parameters:
\n accountRef // String (max 8 chars), required, customer account must exist\n addressLine1 // String (max 60 chars), optional\n addressLine2 // String (max 60 chars), optional\n addressLine3 // String (max 60 chars), optional\n addressLine4 // String (max 60 chars), optional\n addressLine5 // String (max 60 chars), optional\n countryCode // e.g GB (max 2 chars), optional\n role // String (max 30 chars), optional\n contact // String (max 30 chars), optional\n description // String (max 60 chars), optional\n email // String (max 255 chars), optional\n fax // String (max 30 chars), optional\n name // String (max 60 chars), optional\n notes // String (max 60 chars), optional\n telephone // String (max 30 chars), optional\n telephone2 // String (max 30 chars) optional\n vatNumber // String (max 20 chars) optional\n taxCode // Double (max 8 chars) optional\n addressType // Int (max 1 char), optional\n\nValue Description\n0 Delivery Address\n1 Contact Address\n2 Registered Address\n\nDescription: Updates a customer address record in Sage
\nEndpoint URL: api/customerAddress
Method: PATCH
Parameters:
\n accountRef // String (max 8 chars), required, customer account must exist\n addresNumber // Int (max 2 chars), required\n addressLine1 // String (max 60 chars), optional\n addressLine2 // String (max 60 chars), optional\n addressLine3 // String (max 60 chars), optional\n addressLine4 // String (max 60 chars), optional\n addressLine5 // String (max 60 chars), optional\n countryCode // e.g GB (max 2 chars), optional\n role // String (max 30 chars), optional\n contact // String (max 30 chars), optional\n description // String (max 60 chars), optional\n email // String (max 255 chars), optional\n fax // String (max 30 chars), optional\n name // String (max 60 chars), optional\n notes // String (max 60 chars), optional\n telephone // String (max 30 chars), optional\n telephone2 // String (max 30 chars) optional\n vatNumber // String (max 20 chars) optional\n taxCode // Double (max 8 chars) optional\n addressType // Int (max 1 char), optional\n\nValue Description\n0 Delivery Address\n1 Contact Address\n2 Registered Address\n\nDescription: Searches exisiting customer address
\nEndpoint URL: api/searchCustomerAddress
Method: POST
Description: Searches Alerts on both Customers & Suppliers
\nEndpoint URL: api/searchCustomAlert
Method: POST
Value Description\n1 Invoices\n2 Quotes\n3 Invoices & Quotes\n4 Sales Orders\n5 Invoices & Sales Orders\n6 Quotes & Sales Orders\n7 Invoices & Quotes & Sales Orders\n8 Purchase Orders\n\nValue Description\n0 Customer\n1 Supplier\n\nDescription: Searches the PURCHASE_LEDGER table in Sage.
\nEndpoint URL: api/searchPurchaseLedger
Method: POST
Get Supplier
\nDescription: Fetches a single supplier. If wanting to get full list of suppliers use - api/searchPurchaseLedger.
\nEndpoint URL: api/supplier/{accountRef}
Method: GET
Parameters: accountRef
\nDescription: Creates a new supplier record in Sage
\nEndpoint URL: api/supplier
Method: POST
Parameters:
\nname // String, required, max 60 chars\ncontactName // String, required , max 30 chars\ntradeContact // String, optional, max 30 chars\ntelephone // String, optional, max 30 chars\ntelephone2 // String, optional, max 30 chars\naddress1 // String, optional, max 60 chars\naddress2 // String, optional, max 60 chars\naddress3 // String, optional, max 60 chars\naddress4 // String, optional, max 60 chars\naddress5 // String, optional, max 60 chars\nemail // String, optional, max 255 chars\nemail2 // String, optional, max 255 chars\nemail3 // String, optional, max 255 chars\ndefaultNominalCode // string, optional, max 8 chars\nterms // string, optional, max 30 chars\ncreditLimit // optional, int\ncountryCode // String, optional, max 2 chars\npaymentDueFrom // Int, optional, max 1 chars\ncurrency // Int, optional, max 1 chars, use values from sage Settings > Currencies, not available in Patch\npaymentMethodId // Int, optional, max 1 chars, uses payment method outlined on Bank tab in Supplier Record\ndiscountRate // Double, optional, max 8 chars\npaymentDueDays // Int, optional, max 3 chars\ninactiveFlag // Bool, optional, false = active & true = inactive\naccountStatus // optional, int, max 2 digits\nonHold // optional, bool\nbankAccountName // String, Optional, max 60 chars\nbankSortCode // String, Optional, format 00-00-00\nbankAccountNumber // String, Optional, max 60 chars\ndefaultTaxCode // Int, Optional, max 2 chars\nvatNumber // String, Optional, max 20 chars\neoriNumber // String, Optional, max 17 chars\n\nValue Description\n0 Days After Invoice Date\n1 Days From The First Day Of The Following Month\n2 Days Before The Last Day Of The Following Month\n3 Days Of The Month\n4 Days From 1 Month After Invoice Date\n\nDescription: Edit a supplier record in Sage
\nEndpoint URL: api/supplier
Method: PATCH
Parameters:
\naccountRef // String, required, max 8 chars\nname // String, optional, max 60 chars\naddress1 // String, optional, max 60 chars\naddress2 // String, optional, max 60 chars\naddress3 // String, optional, max 60 chars\naddress4 // String, optional, max 60 chars\naddress5 // String, optional, max 60 chars\ncontactName // String, optional, max 30 chars\ntradeContact // String, optional, max 30 chars\ntelephone // String, optional, max 30 chars\ntelephone2 // String, optional, max 30 chars\nterms // String, optional, max 30 chars\ncreditLimit // optional, int\ndefaultNominalCode // String, optional, max 8 chars\ncountryCode // String, optional, max 2 chars\npaymentDueFrom // Int, optional, max 1 chars\nemail // String, optional, max 255 chars\neoriNumber // String, Optional, max 17 chars\naccountStatus // optional, int, max 2 digits\nonHold // optional, bool\n\nValue Description\n0 Days After Invoice Date\n1 Days From The First Day Of The Following Month\n2 Days Before The Last Day Of The Following Month\n3 Days Of The Month\n4 Days From 1 Month After Invoice Date\n\nDescription: Creates a single product
\nEndpoint URL: api/product
Method: POST
Parameters:
\nstockCode // string, max 30 chars, required\ndescription // string , max 60 chars, optional\nitemType // int, max 3 chars, optional\nnominalCode // string, max 3 chars, optional\nunitOfSale // string, max 8 chars, optional\ndeptNumber // int, max 5 chars, optional\ndeletedFlag // bool, optional\ninactiveFlag // bool, optional\ncustom1 // string, max 30 chars, optional\ncustom2 // string, max 30 chars, optional\ncustom3 // string, max 30 chars, optional\nsalesPrice // double, max 30 chars, optional\nunitWeight // double, max 8 chars optional\ntax code // int, max 2 chars, optional\nqtyAllocated // double, max 8 chars, optional\nqtyInStock // double, max 8 chars, optional\npurchaseRef // string, max 8 chars, optional, supplier account number\nstockTakeDate // Date, format: dd/mm/yyyy, optional\nstockCat // int, max 5 chars optional\nsupplierPartNumber // string, max 30 chars, optional\naverageCostPrice // double, optional\nlastPurchasePrice // double, optional\nlastDiscPurchasePrice // double, max 8 chars, optional\nlocation // string, max 16 chars, optional\npurchaseNominalCode // string, max 8 chars, optional\ncommodityCode // string, max 30 chars, optional\ncountryCodeOfOrigin // string, max 2 chars, optional\nbarcode // string, max 60 chars, optional\nwebDetails // string, max 60 chars, optional\nwebDescription // string, max 1023 chars, optional\nwebPublish // int, max 2 chars, optional\nreorderLevel // double, max 8 chars optional\nreorderQty // double, max 8 chars optional\ncomponent1Code // string, max 30 chars, optional\ncomponent1Qty // double, max 8 chars, optional\ncomponent2Code // string, max 30 chars, optional\ncomponent2Qty // double, max 8 chars, optional\ncomponent3Code // string, max 30 chars, optional\ncomponent3Qty // double, max 8 chars, optional\ncomponent4Code // string, max 30 chars, optional\ncomponent4Qty // double, max 8 chars, optional\ncomponent5Code // string, max 30 chars, optional\ncomponent5Qty // double, max 8 chars, optional\ncomponent6Code // string, max 30 chars, optional\ncomponent6Qty // double, max 8 chars, optional\ncomponent7Code // string, max 30 chars, optional\ncomponent7Qty // double, max 8 chars, optional\ncomponent8Code // string, max 30 chars, optional\ncomponent8Qty // double, max 8 chars, optional\ncomponent9Code // string, max 30 chars, optional\ncomponent9Qty // double, max 8 chars, optional\ncomponent10Code // string, max 30 chars, optional\ncomponent10Qty // double, max 8 chars, optional\nlinkLevel // int, max 2 chars, optional\n\nDescription: Updates a single product
\nEndpoint URL: api/product
Method: PATCH
Parameters:
\nstockCode // string, max 30 chars, required\ndescription // string , max 60 chars, optional\nitemType // int, max 3 chars, optional\nnominalCode // string, max 3 chars, optional\nunitOfSale // string, max 8 chars, optional\ndeptNumber // int, max 5 chars, optional\ndeletedFlag // bool, optional\ninactiveFlag // bool, optional\ncustom1 // string, max 30 chars, optional\ncustom2 // string, max 30 chars, optional\ncustom3 // string, max 30 chars, optional\nsalesPrice // double, max 30 chars, optional\nunitWeight // double, max 8 chars optional\ntax code // int, max 2 chars, optional\nqtyAllocated // double, max 8 chars, optional\nqtyInStock // double, max 8 chars, optional\npurchaseRef // string, max 8 chars, optional, supplier account number\nstockTakeDate // Date, format: dd/mm/yyyy, optional\nstockCat // int, max 5 chars optional\nsupplierPartNumber // string, max 30 chars, optional\naverageCostPrice // double, optional\nlastPurchasePrice // double, optional\nlastDiscPurchasePrice // double, max 8 chars, optional\nlocation // string, max 16 chars, optional\npurchaseNominalCode // string, max 8 chars, optional\ncommodityCode // string, max 30 chars, optional\ncountryCodeOfOrigin // string, max 2 chars, optional\nbarcode // string, max 60 chars, optional\nwebDetails // string, max 60 chars, optional\nwebDescription // string, max 1023 chars, optional\nwebPublish // int, max 2 chars, optional\nreorderLevel // double, max 8 chars optional\nreorderQty // double, max 8 chars optional\ncomponent1Code // string, max 30 chars, optional\ncomponent1Qty // double, max 8 chars, optional\ncomponent2Code // string, max 30 chars, optional\ncomponent2Qty // double, max 8 chars, optional\ncomponent3Code // string, max 30 chars, optional\ncomponent3Qty // double, max 8 chars, optional\ncomponent4Code // string, max 30 chars, optional\ncomponent4Qty // double, max 8 chars, optional\ncomponent5Code // string, max 30 chars, optional\ncomponent5Qty // double, max 8 chars, optional\ncomponent6Code // string, max 30 chars, optional\ncomponent6Qty // double, max 8 chars, optional\ncomponent7Code // string, max 30 chars, optional\ncomponent7Qty // double, max 8 chars, optional\ncomponent8Code // string, max 30 chars, optional\ncomponent8Qty // double, max 8 chars, optional\ncomponent9Code // string, max 30 chars, optional\ncomponent9Qty // double, max 8 chars, optional\ncomponent10Code // string, max 30 chars, optional\ncomponent10Qty // double, max 8 chars, optional\nlinkLevel // int, max 2 chars, optional\n\nDescription: Fetches a single product. If wanting to get full list of products use - api/searchProduct.
\nEndpoint URL: api/product/{stockCode}
Method: GET
Parameters: stockCode
\nDescription: Searches the STOCK table in Sage.
\nEndpoint URL: api/searchProduct
Method: POST
Description: Returns List Of Stock Categories.
\nEndpoint URL: api/stockCat
Method: GET
Parameters: none
\nDescription: Adds product image against product
\nEndpoint URL: api/productImage
Method: POST
Parameters:
\nstockCode // String, required\nimage // Image, required, see notes\n\nHas a \"multipart\" body to allow for passing an image (not a standard JSON)
\nImage formats .gif and .jpg works best because you can preview them in the Sage interface. You can still use other image formats, but they won't display in the Sage UI, you must open them when you edit the product in Sage.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"AuthToken"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"07b36e89-6fe2-4208-9ae8-a85041b2ded0","id":"07b36e89-6fe2-4208-9ae8-a85041b2ded0","name":"HyperAccounts REST API for Sage 50 Accounts (desktop)","type":"collection"}},"urlObject":{"path":["api","productImage"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"a27247d2-bba5-443c-8637-d5c9a7f278df","name":"Create Product Image","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"company","value":"{{company}}","type":"text","disabled":true}],"body":{"mode":"formdata","formdata":[{"key":"stockCode","value":"HYPEREXT","type":"text","uuid":"71e67422-c87c-4bdb-8ded-423e896641c3"},{"key":"image","type":"file","uuid":"2eedc7aa-6b96-4a3d-9b4b-496f176951f6","src":"/C:/Users/hyper/Pictures/HYPEREXT.jpg"}]},"url":"{{url}}/api/productImage"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"cache-control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"expires","value":"-1"},{"key":"server","value":"Microsoft-IIS/10.0"},{"key":"x-aspnet-version","value":"4.0.30319"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Wed, 15 Apr 2026 08:17:01 GMT"},{"key":"content-length","value":"64"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"code\": 200,\n \"response\": \"HYPEREXT\",\n \"message\": null\n}"}],"_postman_id":"d4dd8341-8972-43c9-8da8-ab75fa04ca1d"},{"name":"Read Product Image","id":"57d1d6bf-37fd-4027-9137-d425a32ed304","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/product/{{stockCode}}/webImage","description":"Description: Gets base64 encoded string of image stored in Sage for referenced stock item (product)
\nEndpoint URL: api/product/{stockCode}/webImage
Method: GET
Parameters:stockCode
\nDescription: Adjusts stock
\nEndpoint URL: api/stock
Method: POST
Parameters:
\nstockCode // string, max 30 chars, required\nquantity // Double, max 8 chars, required\ntype // Int, max 1 chars, required 1 = adjustment in 2 = adjustment out\ndate // Date, dd/mm/yyyy, required\ncostPrice // Double, max 26 chars, optional\nreference // string, max 30 chars, optional\ndetails // string, max 60 chars, optional\n\nDescription: Reads stock movements
\nEndpoint URL: api/stock/{{ID}}
Method: GET
Parameters: stockCode
\nDescription: Searches Stock Movements.
\nEndpoint URL: api/searchStock
Method: POST
Description: Fetches price lists single customer.
\nEndpoint URL: api/priceList/{accountRef}
Method: GET
Parameters: accountRef
\nDescription: Fetches All Price Lists.
\nEndpoint URL: api/priceList
Method: GET
Parameters: none
\nDescription: Searches the PRICE table in Sage.
\nEndpoint URL: api/searchPrice
Method: POST
Value Description\nP Customer Price List\nS Special Customer Pricing\nU Special supplier Pricing\n\nDescitpion: Creates new sales order
\nEndpoint URL: api/salesOrder
Method: POST
Parameters:
\n customerAccountRef // String (max 8 chars), required, customer account must exist\n customerOrderNumber // String (max 60 chars), optional\n orderDate // String, Date (dd/mm/yyyy), optional\n customerTelephoneNumber // String (max 30 chars), optional\n contactName // String (max 30 chars), optional\n userName // String (max 30 chars), optional\n address1 // String (max 60 chars), optional\n address2 // String (max 60 chars), optional\n address3 // String (max 60 chars), optional\n address4 // String (max 60 chars), optional\n address5 // String (max 60 chars), optional\n delName // String (max 30 chars), optional, 60 chars on V29 or newer\n delAddress1 // String (max 60 chars), optional\n delAddress2 // String (max 60 chars), optional\n delAddress3 // String (max 60 chars), optional\n delAddress4 // String (max 60 chars), optional\n delAddress5 // String (max 60 chars), optional\n netValueDiscountAmount // Double (max 8 chars), optional\n netValueDiscountDescription // string (max 30 chars), optional\n carrNet // Double (max 8 chars), optional \n carrTax // Double (max 8 chars), optional\n foreignRate // Double (max 2 chars), optional\n notes1 // String (max 60 chars), optional\n notes2 // String (max 60 chars), optional\n notes3 // String (max 60 chars), optional\n analysis1 // String (max 30 chars), optional\n analysis2 // String (max 30 chars), optional\n analysis3 // String (max 30 chars), optional\n carrNomCode // String (max 8 chars), optional\n carrTaxCode // Int (max 2 chars), optional\n currency // Int (max 1 chars), optional, use values from sage Settings > Currencies\n departmentNumber // Int, optional \n carriageDepartmentNumber // Int, optional\n globalNominal // String,(max 8 chars) optional\n globalDetails // String, (max 60 chars), optional\n globalTaxCode // Int, (max 8 chars), optional\n globalDepartment // Int, (max 2 chars), optional\n consignmentRef // String (max 30 chars), optional\n courierNumber // Int (Max 30 chars), optional\n orderDueDate // Date (dd/mm/yyyy), optional\n quoteStatus // Int (max 2 chars), optional\n quoteExpiry // Date (dd/mm/yyyy), optional (only used for quotes)\n orderType // Int, optional\n settlementDiscRate // double, (max 8 chars), optional\n settlementDueDays // int, (max 5 chars), optional\n bankRef // String, (max 8 chars), optional\n fillGlobalsFromCustomerDefaults // bool, optional\n orderItemsDataFromStockItemData // bool, optional\n invoiceItems // array\n stockCode // String (max 30 chars), required\n description // String (max 60 chars for V28 or older, max 120 for V29 or newer), optional\n quantity // Double (max 8 chars), required\n unitPrice // Double (max 8 chars), required\n unitOfSale // string, max 8 chars, optional\n taxRate // Double eg 20.0, (max 8 chars), required\n taxCode // Int eg 1, (max 2 chars), required\n discount // Double eg 25.0, percentage discount (max 8 chars), required\n discountAmount // Double (max 8 chars), optional\n netAmount // Double (max 8 chars), optional\n departmentNumber // Int, required\n nominal // String (max 8 chars), required to update ledgers\n details // String (1023 chars), only for service invoice items\n comment1 // String (max 60 chars), optional\n comment2 // String (max 60 chars), optional\n dueDate // Date (dd/mm/yyyy), optional\n serviceFlag // int, optional (set to 2 for Service Item)\n// THESE THREE FIELDS ONLY USED FOR SALES ORDER **QUOTATIONS**\n orderType // Int, optional, set to value 9 for a quote\n quoteExpiry // optional, date string dd/mm/yyyy \n quoteStatus // optional, 0 by default. \n // 0 - Not a quote \n // 1 - Open\n // 2 - Won\n // 3 - Lost\n // 4 - Invalid\n\nNotes: if you do not provide the address1-5 fields they will be populated by the customer record address details
\nFor field 'orderItemsDataFromStockItemData' if true, any missing information on the invoice items will be filled in from the stock item defaults. Bare in mind this will be making a separate call for the stock data AND a separate call for the tax rate.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"AuthToken"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"07b36e89-6fe2-4208-9ae8-a85041b2ded0","id":"07b36e89-6fe2-4208-9ae8-a85041b2ded0","name":"HyperAccounts REST API for Sage 50 Accounts (desktop)","type":"collection"}},"urlObject":{"path":["api","salesOrder",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"39f486c1-f741-4f28-b5cf-61246284ac4b","name":"Create Sales Order","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"company","value":"{{company}}","disabled":true}],"body":{"mode":"raw","raw":"{\n \"customerAccountRef\": \"SMOK0001\",\n \"orderDate\": \"03/07/2024\",\n \"customerOrderNumber\": \"1001\",\n \"address1\": \"Hyperext\",\n \"address2\": \"Unity House\",\n \"address3\": \"Wigan\",\n \"address4\": \"Westwood Park\",\n \"address5\": \"WN3 4HE\",\n \"countryCode\": \"GB\",\n \"delAddress1\": \"Hyperext\",\n \"delAddress2\": \"Unity House\",\n \"delAddress3\": \"Wigan\",\n \"delAddress4\": \"Westwood Park\",\n \"delAddress5\": \"WN3 4HE\",\n \"contactName\": \"Hyperext\",\n \"customerTelephoneNumber\": \"01744697929\",\n \"notes1\": \"Notes1\",\n \"invoiceItems\": [\n {\n \"stockCode\": \"S3\",\n \"taxCode\": 1,\n \"departmentNumber\": 1,\n \"nominal\": \"4000\",\n \"unitPrice\": 100,\n \"quantity\": 1,\n \"taxRate\": 20,\n \"description\": \"New SO\",\n \"details\": \"New Sales Order\",\n \"serviceFlag\": 1\n }\n ]\n}"},"url":"{{url}}/api/salesOrder/"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Tue, 09 Dec 2025 11:09:25 GMT"},{"key":"Content-Length","value":"56"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"code\": 200,\n \"response\": 67,\n \"message\": null\n}"}],"_postman_id":"54830dc0-bf07-4b48-8dd6-610cdc7f41e3"},{"name":"Update Sales Order","id":"e4b4ca12-9a6e-44d5-bab1-bd3fff719eb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"customerAccountRef\": \"SMOK0001\",\r\n \"orderNumber\": 31,\r\n \"orderDate\": \"03/07/2024\",\r\n \"customerOrderNumber\": \"PO90210\",\r\n \"customerTelephoneNumber\": \"01744 697929\",\r\n \"contactName\": \"Mr Steven Smith\",\r\n \"customerName\": \"Smokey BBQ Co\",\r\n \"userName\": \"Stefano User\",\r\n \"address1\": \"221 Main Street\",\r\n \"address2\": \"Haydock\",\r\n \"address3\": \"St HELENS\",\r\n \"address4\": \"WA10 6RP\",\r\n \"address5\": \"United Kingdom\",\r\n \"delName\": \"Mr Delivery Guy\",\r\n \"delAddress1\": \"22 Acacia Avenue\",\r\n \"delAddress2\": \"Green Fields\",\r\n \"delAddress3\": \"Somewhereville\",\r\n \"delAddress4\": \"Merseyside\",\r\n \"delAddress5\": \"WA11 5EW\",\r\n \"carrNet\": 0.0,\r\n \"carrTax\": 0.0,\r\n \"carrNomCode\": \"4001\",\r\n \"carrTaxCode\": 1,\r\n \"carriageDepartmentNumber\": 2,\r\n \"globalDiscountRate\": null,\r\n \"netValueDiscountAmount\": 100.0,\r\n \"netValueDiscountDescription\": \"test by steve\",\r\n \"currency\": -1,\r\n \"departmentNumber\": 0,\r\n \"orderType\": 0,\r\n \"quoteExpiry\": null,\r\n \"quoteStatus\": 0,\r\n \"orderDueDate\": null,\r\n \"notes1\": \"Test Sales Note 1\",\r\n \"notes2\": \"Sales Note 2\",\r\n \"notes3\": \"Sales Order Notes 3\",\r\n \"analysis1\": \"Test Analysis 1\",\r\n \"analysis2\": \"Test Analysis 2\",\r\n \"analysis3\": \"Test Analysis 3\",\r\n \"consignmentRef\": \"ABC987654333211\",\r\n \"invoiceItems\": [\r\n {\r\n \"id\": 0,\r\n \"stockCode\": \"S1\",\r\n \"description\": \"This is another short description\",\r\n \"nominal\": \"4001\",\r\n \"details\": \"\",\r\n \"taxCode\": 1,\r\n \"taxRate\": 20.0,\r\n \"quantity\": 1.0,\r\n \"unitPrice\": 2500.0,\r\n \"unitOfSale\": \"cm3\",\r\n \"discount\": 60.0,\r\n \"departmentNumber\": 1,\r\n \"discountAmount\": 1500.0,\r\n \"netAmount\": 1000.0\r\n }\r\n ]\r\n}"},"url":"{{url}}/api/salesorder/","description":"Description: Updates Sales Order
\nEndpoint URL: api/salesOrder
Method: PATCH
NOTES:
\nThis endpoint should only be used if you wish to add more line items to an existing Sales Order. For any other changes use endpoint api/salesOrder/Update
\n orderNumber // Int (max 4 chars), required\n customerAccountRef // String (max 8 chars), required, customer account must exist\n customerOrderNumber // String (max 60 chars), optional\n customerTelephoneNumber // String (max 30 chars), optional\n contactName // String (max 30 chars), optional\n userName // String (max 30 chars), optional\n address1 // String (max 60 chars), optional\n address2 // String (max 60 chars), optional\n address3 // String (max 60 chars), optional\n address4 // String (max 60 chars), optional\n address5 // String (max 60 chars), optional\n delName // String (max 30 chars), optional, 60 chars on V29 or newer\n delAddress1 // String (max 60 chars), optional\n delAddress2 // String (max 60 chars), optional\n delAddress3 // String (max 60 chars), optional\n delAddress4 // String (max 60 chars), optional\n delAddress5 // String (max 60 chars), optional\n globalDiscountRate // Double (max 8 chars), optional, overrides line item discounts\n carrNet // Double (max 8 chars), optional \n carrTax // Double (max 8 chars), optional\n foreignRate // Double (max 2 chars), optional\n notes1 // String (max 60 chars), optional\n notes2 // String (max 60 chars), optional\n notes3 // String (max 60 chars), optional\n analysis1 // String (max 30 chars), optional\n analysis2 // String (max 30 chars), optional\n analysis3 // String (max 30 chars), optional\n carrNomCode // String (max 8 chars), optional\n carrTaxCode // Int (max 2 chars), optional\n currency // Int (max 1 chars), optional, use values from sage Settings > Currencies\n departmentNumber // Int, optional\n orderDueDate // Date (dd/mm/yyyy), optional\n quoteStatus // int (max 2 chars), optional\n quoteExpiry // Date (dd/mm/yyyy), optional (only used for quotes)\n orderType // int, optional\n invoiceItems // array\n stockCode // String (max 30 chars), required\n description // String, (max 60 chars), optional\n quantity // Double (max 8 chars), required\n unitPrice // Double (max 8 chars), required\n taxRate // Double eg 20.0 (max 8 chars), required\n taxCode // Int eg 1 (max 2 chars), required\n discount // Double eg 25.0 (max 8 chars), required\n departmentNumber // Int, required\n nominal // String (max 8 chars), required to update ledgers\n details // String, (1023 chars)\n comment1 // String (max 60 chars), optional\n comment2 // String (max 60 chars), optional \n dueDate // Date (dd/mm/yyyy), optional\n// THESE THREE FIELDS ONLY USED FOR SALES ORDER **QUOTATIONS**\n orderType // Int, optional, set to value 9 for a quote\n quoteExpiry // optional, date string dd/mm/yyyy \n quoteStatus // optional, 0 by default. \n // 0 - Not a quote \n // 1 - Open\n // 2 - Won\n // 3 - Lost\n // 4 - Invalid\n\nDescription: Updates Sales Order
\nEndpoint URL: api/salesOrder/update
Method: PATCH
NOTES
\nThis endpoint can NOT be used to add more lines to an existing Sales Order. If you wish to update an existing sales order and add more lines you would need to use endpoint - api/salesOrder
orderNumber // Int (max 4 chars), required\n customerAccountRef // String (max 8 chars), required, customer account must exist\n customerOrderNumber // String (max 60 chars), optional\n customerTelephoneNumber // String (max 30 chars), optional\n contactName // String (max 30 chars), optional\n userName // String (max 30 chars), optional\n address1 // String (max 60 chars), optional\n address2 // String (max 60 chars), optional\n address3 // String (max 60 chars), optional\n address4 // String (max 60 chars), optional\n address5 // String (max 60 chars), optional\n delName // String (max 30 chars), optional, 60 chars on V29 or newer\n delAddress1 // String (max 60 chars), optional\n delAddress2 // String (max 60 chars), optional\n delAddress3 // String (max 60 chars), optional\n delAddress4 // String (max 60 chars), optional\n delAddress5 // String (max 60 chars), optional\n globalDiscountRate // Double (max 8 chars), optional\n carrNet // Double (max 8 chars), optional \n carrTax // Double (max 8 chars), optional\n foreignRate // Double (max 2 chars), optional\n notes1 // String (max 60 chars), optional\n notes2 // String (max 60 chars), optional\n notes3 // String (max 60 chars), optional\n analysis1 // String (max 30 chars), optional\n analysis2 // String (max 30 chars), optional\n analysis3 // String (max 30 chars), optional\n carrNomCode // String (max 8 chars), optional\n carrTaxCode // Int (max 2 chars), optional\n currency // Int (max 1 chars), optional, use values from sage Settings > Currencies\n departmentNumber // Int, optional\n orderDueDate // Date (dd/mm/yyyy), optional\n quoteStatus // int (max 2 chars), optional\n quoteExpiry // Date (dd/mm/yyyy), optional (only used for quotes)\n orderType // int, optional\n invoiceItems // array, optional\n itemId // Int, required \n stockCode // String (max 30 chars), optiona\n description // String, (max 60 chars), optional\n departmentNumber // Int, optional\n nominal // String (max 8 chars), required to update ledgers\n details // String, (1023 chars)\n comment1 // String (max 60 chars), optional\n comment2 // String (max 60 chars), optional \n dueDate // Date (dd/mm/yyyy), optional\n// THESE THREE FIELDS ONLY USED FOR SALES ORDER **QUOTATIONS**\n orderType // Int, optional, set to value 9 for a quote\n quoteExpiry // optional, date string dd/mm/yyyy \n quoteStatus // optional, 0 by default. \n // 0 - Not a quote \n // 1 - Open\n // 2 - Won\n // 3 - Lost\n // 4 - Invalid\n\nDescription: Fetches a single sales order. If wanting to get full list of sales orders use - api/searchSalesOrder.
\nEndpoint URL: api/salesOrder
Method: GET
Parameters: orderNumber
\nValue Allocated Dispatched \n0 Blank Blank\n1 Part Blank\n2 Full Blank\n3 Cancelled Blank\n4 Blank Part\n5 Part Part\n6 Full Part\n7 Cancel Part\n8 Blank Complete\n9 Held Part\n10 Held Blank\n\nDescription: Searches Sales Order.
\nEndpoint URL: api/searchSalesOrder
Method: POST
Value Description\n0 Not Allocated\n1 Partially Allocated\n2 Fully Allocated\n3 Cancelled\n4 Held\n\nValue Description\n0 Not Dispatched\n1 Partially Dispatched\n2 Fully Dispatched\n\nDescription: Partially allocates a Sales Order
\nEndpoint URL: api/salesOrderPartialAllocation
Method: POST
Params:
\n orderNumber // // Required, Int\nitems\n itemId // Required, Int\n allocate // Required, Double\n\nDescription: Fully allocates an unallocated or partially allocated sales order
\nEndpoint URL: api/salesOrder/{{id}}/fullyAllocate
Method: POST
Params: orderNumber
\nDescription: Fully un-allocates an allocated or partially allocated sales order
\nEndpoint URL: api/salesOrderDeAllocation/{{id}}
Method: POST
Params: orderNumber
\nDescription: Partially despatches a Sales Order
\nEndpoint URL: api/salesOrderPartialDespatch
Method: POST
Params:
\n orderNumber // // Required, Int\nitems\n itemId // Required, Int\n allocate // Required, Double\n\nDescription: Completes a sales order, creates goods dispatch record and a goods out stock record. Then creates Sales Invoice and returns the ID.
\nEndpoint URL: api/salesOrder/{id}/complete
Method: POST
Params: orderNumber
\nNOTES: The whole order needs to be fully allocated in Sage before using this request and the items need to be stock items.
\nDescription: Completes a sales order, creates goods dispatch record and a goods out stock record. Then creates Sales Invoice with date entered and returns the ID.
\nEndpoint URL: api/salesOrderComplete
Method: POST
Params:
\n orderNumber // Int (max 4 chars), required\ndate // String, Date (dd/mm/yyyy), optional\n\nDescription: Marks Sales Order as \"HELD\"
\nEndpoint URL: api/salesorder/{{id}}/hold
Method: POST
Params: orderNumber
\nDescription: Deletes sales order.
\nEndpoint URL: api/salesOrder/{id}
Method DELETE
Params: orderNumber
\nDescription: Searches Dispatched Orders
\nEndpoint URL: api/searchDispatch
Method: POST
Description: Searches Sales Order Items.
\nEndpoint URL: api/searchSopItem
Method: POST
Description: Updates quantityOnOrder & unitPrice for a specific order item
\nEndpoint URL: api/salesOrderItems
Method: POST
Parameters:
\nitemId // int, required\nquantityOnOrder, // double, optional\nunitPrice // double, optional\n\nDescription: Creates new Purchase Order
\nEndpoint URL: api/purchaseOrder
Method: POST
Parameters:
\n supplierAccountRef // String (max 8 chars), required\n telephoneNumber // String (max 11 chars), optional\n reference // String (max 7 chars), optional\n orderNumber // Int (max 8 chars), optional on POST required for PATCH\n supplierName // String (max 30 chars), optional\n orderDate // String (dd/mm/yyyy), optional\n userName // String (max 30 chars), required\n contactName // String (max 30 chars), optional\n address1 // String (max 60 chars), optional\n address2 // String (max 60 chars), optional\n address3 // String (max 60 chars), optional\n address4 // String (max 60 chars), optional\n address5 // String (max 60 chars), optional\n delName // String (max 60 chars), optional\n delAddress1 // String (max 60 chars), optional\n delAddress2 // String (max 60 chars), optional\n delAddress3 // String (max 60 chars), optional\n delAddress4 // String (max 60 chars), optional\n delAddress5 // String (max 60 chars), optional\n notes1 // String (max 60 chars), optional\n notes2 // String (max 60 chars), optional\n notes3 // String (max 60 chars), optional\n carriageNet // Double (max 8 chars), required \n carriageTax // Double (max 60 chars), required\n carriageDepartmentNumber // Double (max 8 chars), optional \n currency // Int (max 2 chars), optional, use values from sage Settings > Currencies\n supplierOrderNumber // string (max 60 chars), optional\n departmentNumber // Int (max 2 chars), optional\n projectID // int (max 4 chars), optional\n costCodeID // int (max 4 chars), optional\n dueDate // String (dd/mm/yyyy), optional\n analysis1 // String (max 30 chars), optional\n analysis2 // String (max 30 chars), optional\n analysis3 // String (max 30 chars), optional\n invoiceItems\n stockCode // String (max 30 chars), optional\n description // String (max 120 chars), optional\n quantity // double eg 20.0 (max 8 chars), required\n details // String, optional\n unitPrice // double eg 20.0 (max 8 chars), required\n taxRate // double, eg 20.0 (max 8 chars), required\n taxCode // int eg 1 (max 2 chars), required\n discount // double eg 25.0 (max 8 chars), required\n comment1 // String (max 60 chars), optional\n comment2 // String (max 60 chars), optional\n nominal // String (max 8 chars), optional\n dueDate // String (dd/mm/yyyy), optional\n departmentNumber // Int (max 2 chars), required\n projectRef // Int, optional\n costCode // Int, (max 2 chars) optional\n qtyInvoiced // Int, (max 2 chars) optional\n\nDescription: Updates Purchase Order
\nEndpoint URL: api/purchaseOrder
Method: PATCH
NOTES:
\nThis endpoint should only be used if you wish to add more line items to an existing Purchase Order. For any other changes use endpoint api/purchaseOrder/Update
\n supplierAccountRef // String (max 8 chars), required\n telephoneNumber // String(max 11 chars), optional\n reference // String (max 7 chars), optional\n orderNumber // Int (max 8 chars), optional on POST required for PATCH\n supplierName // String (max 30 chars), optional\n orderDate // String (dd/mm/yyyy), optional\n userName // String (max 30 chars), required\n contactName // String (max 30 chars), optional\n address1 // String (max 60 chars), optional\n address2 // String (max 60 chars), optional\n address3 // String (max 60 chars), optional\n address4 // String (max 60 chars), optional\n address5 // String (max 60 chars), optional\n delName // String (max 60 chars), optional\n delAddress1 // String (max 60 chars), optional\n delAddress2 // String (max 60 chars), optional\n delAddress3 // String (max 60 chars), optional\n delAddress4 // String (max 60 chars), optional\n delAddress5 // String (max 60 chars), optional\n notes1 // String (max 60 chars), optional\n notes2 // String (max 60 chars), optional\n notes3 // String (max 60 chars), optional\n carriageNet // Double (max 8 chars), required \n carriageTax // Double (max 60 chars), required\n carriageDepartmentNumber // Double (max 8 chars), optional \n currency // Int (max 2 chars), optional, use values from sage Settings > Currencies\n supplierOrderNumber // string (max 60 chars), optional\n departmentNumber // Int (max 2 chars), optional\n projectID // int (max 4 chars), optional\n costCodeID // int (max 4 chars), optional\n dueDate // String (dd/mm/yyyy), optional\n analysis1 // optional, string, max 30 chars\n analysis2 // optional, string, max 30 chars\n analysis3 // optional, string, max 30 chars\n invoiceItems\n stockCode // String (max 30 chars), optional\n description // String (max 120 chars), optional\n quantity // double eg 20.0 (max 8 chars), required\n details // String, optional\n unitPrice // double eg 20.0 (max 8 chars), required\n taxRate // double, eg 20.0 (max 8 chars), required\n taxCode // int eg 1 (max 2 chars), required\n discount // double eg 25.0 (max 8 chars), required\n comment1 // String (max 60 chars), optional\n comment2 // String (max 60 chars), optional\n nominal // String (max 8 chars), optional\n dueDate // String (dd/mm/yyyy), optional\n departmentNumber // Int (max 2 chars), required\n projectRef // Int, optional\n costCode // Int, (max 2 chars), optional\n qtyInvoiced // Int, (max 2 chars), optional\n quantityDiff // Int, (max 8 chars), SEE NOTES\n\nField \"quantityDiff\" is required when updating a purchase order which is marked as ON-ORDER. To use this, set the \"quantity\" to the required amount and the \"quantityDiff\" is the difference. For example if you wish to update the purchase order item from 1 to 5, you set the \"quantity\" to 5 and the \"quantityDiff\" to 4. You can use a negative \"quantityDiff\" to reduce the quantity
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"AuthToken"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"07b36e89-6fe2-4208-9ae8-a85041b2ded0","id":"07b36e89-6fe2-4208-9ae8-a85041b2ded0","name":"HyperAccounts REST API for Sage 50 Accounts (desktop)","type":"collection"}},"urlObject":{"path":["api","purchaseOrder",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"613517d4-c801-4dea-99fb-1342fd1d0156","name":"Update Purchase Order","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"company","value":"{{company}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"supplierAccountRef\": \"con001\",\r\n \"orderNumber\": 42,\r\n \"orderDate\": \"19/10/2021\",\r\n \"telephoneNumber\": \"12345678\",\r\n \"supplierName\": \"Test Company\",\r\n \"contactName\": \"name\",\r\n \"userName\": \"Stefano\",\r\n \"delName\": \"Billy Bouncer\",\r\n \"delAddress1\": \"Dublin\",\r\n \"delAddress2\": \"add2\",\r\n \"delAddress3\": \"Dublin\",\r\n \"delAddress4\": \"Dublin\",\r\n \"delAddress5\": \"add5\",\r\n \"carriageNet\": 30.0,\r\n \"carriageTax\": 6.0,\r\n \"carriageNomCode\": \"5000\",\r\n \"globalDiscountRate\": 0.0,\r\n \"supplierOrderNumber\": \"90210\",\r\n \"status\": 0,\r\n \"currency\": 24,\r\n \"departmentNumber\": 3,\r\n \"dueDate\": null,\r\n \"projectID\": 0,\r\n \"costCodeID\": 0,\r\n \"invoiceItems\": [\r\n {\r\n \"stockCode\": \"S1\",\r\n \"description\": \"test jasd\",\r\n \"nominal\": \"5002\",\r\n \"details\": \"\",\r\n \"taxCode\": 0,\r\n \"taxRate\": 0.0,\r\n \"quantity\": 1.0,\r\n \"unitPrice\": 1.0,\r\n \"discount\": 0.0,\r\n \"departmentNumber\": null\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/purchaseOrder/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"no-cache"},{"key":"Pragma","value":"no-cache"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Expires","value":"-1"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNet-Version","value":"4.0.30319"},{"key":"X-Powered-By","value":"ASP.NET"},{"key":"Date","value":"Wed, 03 Jul 2024 14:55:27 GMT"},{"key":"Content-Length","value":"56"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"code\": 200,\n \"response\": 42,\n \"message\": null\n}"}],"_postman_id":"3d2e8c56-c471-4513-85c7-87238ec3cd01"},{"name":"NEW Update Purchase Order","id":"fc6733d2-384f-4f5b-a214-e056c676de76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"supplierAccountRef\": \"TRU001\",\r\n \"userName\": \"TRU001\",\r\n \"carriageNet\": 0,\r\n \"carriageTax\": 0,\r\n \"dueDate\": \"\",\r\n \"supplierName\": \"Truflame Welding Equipment\",\r\n \"delAddress1\": \"T-H-E Section Bending Co Ltd, Houghton Road, North Anston Tr\",\r\n \"delAddress2\": \"Sheffield\",\r\n \"delAddress3\": \"South Yorkshire\",\r\n \"delAddress4\": \"S25 4JJ\",\r\n \"delAddress5\": \"GB\",\r\n \"notes1\": \"Flashback Arrestors\",\r\n \"invoiceItems\": [\r\n {\r\n \"stockCode\": \"S3\",\r\n \"taxCode\": 1,\r\n \"departmentNumber\": 1,\r\n \"dueDate\": \"\",\r\n \"discount\": 0,\r\n \"nominal\": \"6702\",\r\n \"unitPrice\": 15.75,\r\n \"quantity\": 12,\r\n \"taxRate\": 20,\r\n \"description\": \"Flashback Arrestor - Oxygen\",\r\n \"details\": \"HI-LO ELITE DGN FLASHBACK ARRESTOR OXYGEN\\r\\n\",\r\n \"lineInformation\": \"Stock\",\r\n \"serviceFlag\": 1\r\n },\r\n {\r\n \"stockCode\": \"S3\",\r\n \"taxCode\": 1,\r\n \"departmentNumber\": 1,\r\n \"dueDate\": \"\",\r\n \"discount\": 0,\r\n \"nominal\": \"6702\",\r\n \"unitPrice\": 15.75,\r\n \"quantity\": 8,\r\n \"taxRate\": 20,\r\n \"description\": \"Flashback Arrestor - Fuel Gas\",\r\n \"details\": \"HI-LO ELITE DGN FLASHBACK ARRESTOR FUEL GAS\\r\\n\",\r\n \"lineInformation\": \"Stock\",\r\n \"serviceFlag\": 1\r\n }\r\n ],\r\n \"orderNumber\": 731154\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/purchaseOrder/update","description":"Description: Updates Purchase Order
\nEndpoint URL: api/purchaseOrder/update
Method: PATCH
NOTES
\nThis endpoint can NOT be used to add more lines to an existing Purchase Order. If you wish to update an existing Purchase Order and add more lines you would need to use endpoint - api/purchaseOrder
supplierAccountRef // String (max 8 chars), required\n telephoneNumber // String(max 11 chars), optional\n reference // String (max 7 chars), optional\n orderNumber // Int (max 8 chars), optional on POST required for PATCH\n supplierName // String (max 30 chars), optional\n orderDate // String (dd/mm/yyyy), optional\n userName // String (max 30 chars), required\n contactName // String (max 30 chars), optional\n address1 // String (max 60 chars), optional\n address2 // String (max 60 chars), optional\n address3 // String (max 60 chars), optional\n address4 // String (max 60 chars), optional\n address5 // String (max 60 chars), optional\n delName // String (max 60 chars), optional\n delAddress1 // String (max 60 chars), optional\n delAddress2 // String (max 60 chars), optional\n delAddress3 // String (max 60 chars), optional\n delAddress4 // String (max 60 chars), optional\n delAddress5 // String (max 60 chars), optional\n notes1 // String (max 60 chars), optional\n notes2 // String (max 60 chars), optional\n notes3 // String (max 60 chars), optional\n carriageNet // Double (max 8 chars), required \n carriageTax // Double (max 60 chars), required\n carriageDepartmentNumber // Double (max 8 chars), optional \n currency // Int (max 2 chars), optional, use values from sage Settings > Currencies\n supplierOrderNumber // string (max 60 chars), optional\n departmentNumber // Int (max 2 chars), optional\n projectID // int (max 4 chars), optional\n costCodeID // int (max 4 chars), optional\n dueDate // String (dd/mm/yyyy), optional\n analysis1 // optional, string, max 30 chars\n analysis2 // optional, string, max 30 chars\n analysis3 // optional, string, max 30 chars\n invoiceItems\n stockCode // String (max 30 chars), optional\n description // String (max 120 chars), optional\n quantity // double eg 20.0 (max 8 chars), required\n details // String, optional\n unitPrice // double eg 20.0 (max 8 chars), required\n taxRate // double, eg 20.0 (max 8 chars), required\n taxCode // int eg 1 (max 2 chars), required\n discount // double eg 25.0 (max 8 chars), required\n comment1 // String (max 60 chars), optional\n comment2 // String (max 60 chars), optional\n nominal // String (max 8 chars), optional\n dueDate // String (dd/mm/yyyy), optional\n departmentNumber // Int (max 2 chars), required\n projectRef // Int, optional\n costCode // Int, (max 2 chars), optional\n qtyInvoiced // Int, (max 2 chars), optional\n quantityDiff // Int, (max 8 chars), SEE NOTES\n\nField \"quantityDiff\" is required when updating a purchase order which is marked as ON-ORDER. To use this, set the \"quantity\" to the required amount and the \"quantityDiff\" is the difference. For example if you wish to update the purchase order item from 1 to 5, you set the \"quantity\" to 5 and the \"quantityDiff\" to 4. You can use a negative \"quantityDiff\" to reduce the quantity
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"AuthToken"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"07b36e89-6fe2-4208-9ae8-a85041b2ded0","id":"07b36e89-6fe2-4208-9ae8-a85041b2ded0","name":"HyperAccounts REST API for Sage 50 Accounts (desktop)","type":"collection"}},"urlObject":{"path":["api","purchaseOrder","update"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"737ba452-f19b-4608-80ce-88632f56c428","name":"NEW Update Purchase Order","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"company","value":"{{company}}","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\r\n \"supplierAccountRef\": \"CON001\",\r\n \"orderNumber\": 44,\r\n \"delAddress1\": \"TEST2\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/purchaseOrder/update"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":":status","value":200},{"key":"cache-control","value":"no-cache"},{"key":"pragma","value":"no-cache"},{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"expires","value":"-1"},{"key":"server","value":"Microsoft-IIS/10.0"},{"key":"x-aspnet-version","value":"4.0.30319"},{"key":"x-powered-by","value":"ASP.NET"},{"key":"date","value":"Wed, 15 Apr 2026 09:22:03 GMT"},{"key":"content-length","value":"56"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"code\": 200,\n \"response\": 44,\n \"message\": null\n}"}],"_postman_id":"fc6733d2-384f-4f5b-a214-e056c676de76"},{"name":"Read Purchase Order","id":"dc2f8409-3dca-4a69-b1f4-fc6cc615cfe4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{url}}/api/purchaseOrder/{{orderNumber}}","description":"Description: Fetches a single purchase order. If wanting to get full list of purchase orders use - api/searchPurchaseOrder.
\nEndpoint URL: api/purchaseOrder/{{id}}
Method: GET
Parameters: orderNumber
\nValue On Order Delivered \n2 Full Blank\n3 Cancelled Blank\n6 Full Part\n7 Cancel Part\n8 Blank Complete\n\nDescription: Searches ALL purchase orders in Sage.
\nEndpoint URL: api/searchPurchaseOrder
Method: POST
0 - Blank\n5 - On Order\n\n0 - Blank\n1 - Part\n2 - Delivered\n\nDescription: Deletes Purchase Order
\nEndpoint URL: api/purchaseOrder/{id}
Method DELETE
Parameters: orderNumber
\nDescription: Add received notes against PO
\nEndpoint URL: api/goodsReceivedNotes
Method: POST
Parameters:
\norderNumber // Int, required\ndate // String, Date (dd/mm/yyyy), optional\nsupplierGrnNumber // String, Max 20 Chars, optional\n Items\n itemNumber // Int, required\n quantity // Int, required\n\nDescription: Searches Purchase Order Items
\nEndpoint URL: api/searchPopItem
Method: POST
Description: Searches ALL Goods Received Notes in Sage.
\nEndpoint URL: api/searchGoodsReceivedNotes
Method: POST
Description: Searches ALL Deliveries in Sage.
\nEndpoint URL: api/searchDelivery
Method: POST
Description: Post Purchase Order To Ledgers and creates a Purchase Invoice.
\nEndpoint URL: api/purchaseOrder/{id}/updateLedgers
Method: POST
Params: orderNumber
\nDescription: Updates quantityOnOrder & unitPrice for a specific order item
\nEndpoint URL: api/purchaseOrderItems
Method: POST
Parameters:
\nitemId // int, required\nquantityOnOrder, // double, optional\nunitPrice // double, optional\n\nDescription: Searches the INVOICE table in Sage.
\nEndpoint URL: api/searchInvoice
Method: POST
Description: Fetches a single sales invoice. If wanting to get full list of sales invoices use - api/searchInvoice
\nEndpoint URL: api/salesInvoice/{id}
Method: GET
Parameters: orderNumber
\nDescription: Updates a new sales invoice
\nEndpoint URL: api/salesInvoice
Method: POST/PATCH
Parameters: invoiceNumber
\nNOTES:
\nCredit Notes with invoiceTypeCode = 3 or 4 will use next Credit Number from Sage
\nIf using isNegativeLine stockCode must be S1 or S3
\nCant use discount & isNegativeLine together
\nIf using isNegativeLine overall invoice cant be negative
\nFor field ‘invoiceItemsDStockItemData’ if true, any missing information on the invoice items will be filled in from the stock item defaults. Bare in mind this will be making a separate call for the stock data AND a separate call for the tax rate. Example JSON body for defaults below.
\nignoreCustomerDiscountRate only available on creating invoices.
\ninvoiceNumber // Int (max 7 chars), required for patch\ncustomerAccountRef // Required, String (max 8 chars) \norderNumber // String (max 7 chars), optional \ncustomerOrderNumber // String (max 60 chars), Optional\ncustomerTelephoneNumber // String (max 30 chars), optional\ncontactName // String (max 30 chars), optional \nuserName // String (max 30 chars), optional\nname // String (max 60 chars), optional\naddress1 // String (max 60 chars), optional\naddress2 // String (max 60 chars), optional\naddress3 // String (max 60 chars), optional\naddress4 // String (max 60 chars), optional\naddress5 // String (max 60 chars), optional\ndelName // String (max 30 chars), optional\ndelAddress1 // String (max 30 chars), optional\ndelAddress2 // String (max 30 chars), optional\ndelAddress3 // String (max 30 chars), optional\ndelAddress4 // String (max 30 chars), optional\ndelAddress5 // String (max 30 chars), optional\ncarrNet // Double (max 8 chars), optional\ncarrTax // Double (max 8 chars), optional\ncarrNomCode // String (max 8 chars), Optional\ncarrTaxCode // Int (max 2 chars), optional\nglobalTaxCode // Int (max 2 chars), optional\nglobalDepartmentNumber // Int (max 2 chars), optional\nglobalDetails // String (max 60 chars), optional\nglobalNominal // String (max 8 chars), optional\nnetValueDiscountDescription // String (max 60 chars), optional\nnetValueDiscountAmount // Double (max 8 chars), optional\ncurrency // Int (max 1 chars), optional, use values from sage Settings > Currencies\ninvoiceDate // String, Optional, format: dd/mm/yy\ninvoiceTypeCode // Int (max 1 chars), optional, defaults to SI \nforeignRate // Double (max 8 chars), optional\ncarriageDepartmentNumber // Int (max 2 chars), optional\nnotes1 // String (max 60 chars), Optional\nnotes2 // String (max 60 chars), Optional\nnotes3 // String (max 60 chars), Optional\nsettlementDueDays // Double (max 3 chars), optional\nsettlementDiscRate // Double (max 3 chars), optional\nbaseSettlementDiscRate // Int, optional\nanalysis1 // String (max 30 chars), optional\nanalysis2 // String (max 30 chars), optional\nanalysis3 // String (max 30 chars), optional\ndepartmentNumber // Int (max 2 chars), Optional\ndiscount // double (max 8 chars), optional\nforeignGross // double (max 8 chars), optional\npaymentDueDate // string, optional\nshouldUpdateLedgers // bool, optional, defaults to false\nprinted // bool, optional\nemailed // bool, optional\ninvoiceItemsDataFromStockItemData // bool, optional\nignoreCustomerDiscountRate // bool, optional, defaults to false\ninvoiceItems\n stockCode // String (max 30 chars), required\n description // String (max 60 chars for V28 or older, max 120 for V29 or newer), required\n quantity // Double (max 8 chars), required\n unitPrice // Double (max 8 chars), required\n unitOfSale // string, max 8 chars, optional\n taxRate // double eg 20.0 (max 8 chars), required\n taxCode // int eg 1 (max 2 chars), required\n discount // double eg 25.0 (max 8 chars), optional\n netAmount // item net after discount, double (max 8 chars), optional\n // (use instead of discount to avoid rounding issues with\n // fractional discount rates)\n nominal // String (max 8 chars), optional\n comment1 // String (mac 60 chars), optional\n comment2 // String (mac 60 chars), optional\n departmentNumber // Int (max 2 chars), optional\n extOrderRef // String (max 30 chars), optional\n projectId // int (max 4 chars), optional\n isNegativeLine // int (max 1 chars), optional // 0 = positive amount & 1 = negative amount\n serviceFlag // int, optional (set to 2 for Service Item)\n\nValue Description\n0 Sales Order or Product Invoice originating from Invoicing\n1 Product Invoice originating from Sales Order Processing\n2 Service Invoice\n3 Product Credit Note\n4 Service Credit Note\n5 Product Invoice Proforma\n6 Product Invoice Quotation\n7 Service Invoice Proforma\n8 Service Invoice Quotation\n9 Sales Order Quotation\n11 Sales Order Proforma\n\nDescription: Creates a new sales invoice
\nEndpoint URL: api/salesInvoice
Method: POST/PATCH
Parameters: see invoiceTypeCode Field values section below
\nNOTES:
\nCredit Notes with invoiceTypeCode = 3 or 4 will use next Credit Number from Sage
\nIf using isNegativeLine stockCode must be S1 or S3
\nCant use discount & isNegativeLine together
\nIf using isNegativeLine overall invoice cant be negative
\nFor field ‘invoiceItemsDataFromStockItemData’ if true, any missing information on the invoice items will be filled in from the stock item defaults. Bare in mind this will be making a separate call for the stock data AND a separate call for the tax rate. Example JSON body for defaults below.
\nignoreCustomerDiscountRate only available on creating invoices.
\nIf sending non GBP transaction, currency must be set to match account posting to
\ninvoiceNumber // Int (max 7 chars), required for patch\ncustomerAccountRef // Required, String (max 8 chars) \norderNumber // String (max 7 chars), optional \ncustomerOrderNumber // String (max 60 chars), Optional\ncustomerTelephoneNumber // String (max 30 chars), optional\ncontactName // String (max 30 chars), optional \nuserName // String (max 30 chars), optional\nname // String (max 60 chars), optional\naddress1 // String (max 60 chars), optional\naddress2 // String (max 60 chars), optional\naddress3 // String (max 60 chars), optional\naddress4 // String (max 60 chars), optional\naddress5 // String (max 60 chars), optional\ndelName // String (max 30 chars), optional\ndelAddress1 // String (max 30 chars), optional\ndelAddress2 // String (max 30 chars), optional\ndelAddress3 // String (max 30 chars), optional\ndelAddress4 // String (max 30 chars), optional\ndelAddress5 // String (max 30 chars), optional\ncarrNet // Double (max 8 chars), optional\ncarrTax // Double (max 8 chars), optional\ncarrNomCode // String (max 8 chars), Optional\ncarrTaxCode // Int (max 2 chars), optional\nglobalTaxCode // Int (max 2 chars), optional\nglobalDepartmentNumber // Int (max 2 chars), optional\nglobalDetails // String (max 60 chars), optional\nglobalNominal // String (max 8 chars), optional\nnetValueDiscountDescription // String (max 60 chars), optional\nnetValueDiscountAmount // Double (max 8 chars), optional\ncurrency // Int (max 1 chars), required for non GBP invoices, use values from sage Settings > Currencies.\ninvoiceDate // String, Optional, format: dd/mm/yy\ninvoiceTypeCode // Int (max 1 chars), optional, defaults to SI \nforeignRate // Double (max 8 chars), optional\ncarriageDepartmentNumber // Int (max 2 chars), optional\nnotes1 // String (max 60 chars), Optional\nnotes2 // String (max 60 chars), Optional\nnotes3 // String (max 60 chars), Optional\nsettlementDueDays // Double (max 3 chars), optional\nsettlementDiscRate // Double (max 3 chars), optional\nbaseSettlementDiscRate // Int, optional\nanalysis1 // String (max 30 chars), optional\nanalysis2 // String (max 30 chars), optional\nanalysis3 // String (max 30 chars), optional\ndepartmentNumber // Int (max 2 chars), Optional\ndiscount // double (max 8 chars), optional\nforeignGross // double (max 8 chars), optional\npaymentDueDate // string, optional\nshouldUpdateLedgers // bool, optional, defaults to false\nprinted // bool, optional\nemailed // bool, optional\ninvoiceItemsDataFromStockItemData // bool, optional\nignoreCustomerDiscountRate // bool, optional, defaults to false\ninvoiceItems\n stockCode // String (max 30 chars), required\n description // String (max 60 chars for V28 or older, max 120 for V29 or newer), required\n quantity // Double (max 8 chars), required\n unitPrice // Double (max 8 chars), required\n unitOfSale // string, max 8 chars, optional\n taxRate // double eg 20.0 (max 8 chars), required\n taxCode // int eg 1 (max 2 chars), required\n discount // double eg 25.0 (max 8 chars), optional\n netAmount // item net after discount, double (max 8 chars), optional\n // (use instead of discount to avoid rounding issues with\n // fractional discount rates)\n nominal // String (max 8 chars), optional\n comment1 // String (mac 60 chars), optional\n comment2 // String (mac 60 chars), optional\n departmentNumber // Int (max 2 chars), optional\n extOrderRef // String (max 30 chars), optional\n projectId // int (max 4 chars), optional\n isNegativeLine // int (max 1 chars), optional // 0 = positive amount & 1 = negative amount\n serviceFlag // int, optional (set to 2 for Service Item)\n\nValue Description\n0 Sales Order or Product Invoice originating from Invoicing\n1 Product Invoice originating from Sales Order Processing\n2 Service Invoice\n3 Product Credit Note\n4 Service Credit Note\n5 Product Invoice Proforma\n6 Product Invoice Quotation\n7 Service Invoice Proforma\n8 Service Invoice Quotation\n9 Sales Order Quotation\n11 Sales Order Proforma\n\nDescription: Searches items on invoices
\nEndpoint URL: api/searchInvoiceItem
Method: POST
Description: Creates a Purchase Invoice using the TransactionPost object.
\nEndpoint URL: api/purchaseInvoice
Method: POST
Parameters:
\naccountRef // string (max 8 chars), required\ndate // string dd/mm/yyyy, required\ninvRef // string (max 30 chars), optional\ndetails // string (max 60 chars), optional\ncurrency // int, optional //see below notes\nuserName // String (max 30 chars), optional\ndueDate // string, optional, dd/mm/yyyy\nforeignRate // double, optional // see below notes\nitems\n nominalCode // string (max 8 chars), required\n taxCode // int (max 2 chars), required\n netAmount // double (max 8 chars), required\n taxAmount // double (max 8 chars), required\n exRef // string (max 8 chars), optional \n details // string (max 60 chars), optional\n externalFileURL // string, web URL, required \n departmentNumber // int (max 2 chars), optional \n projectRef // string (max 12 chars), optional\n projectId // int, optional\n CostCodeId // int, optional\n costCode // string (max 8 chars), optional\n isNegativeLine // int (max 1 chars), optional // 0 = negative & 1 = positive \n disputed // (max 1 chars), optional // 0 = no & 1 = yes\n\nNOTES:
\nIf currency is set on purchaseInvoice, it must match the id of the currency of the associated Supplier Account.
\nIf currency is set and foreignRate is not set or is ‘null’ the transaction will be stored using the Exchange Rate stored in Sage for the selected currency.
\nIf using isNegativeLine: If set true, this will create a credit line on the transactions for the negative lines matching the invoice on all other information (inv ref etc)
\nIf set true, the parent model cannot have the isCredit field set to true
\nIf set true, the total of ALL the invoice lines must be more than the total of all the credit lines
\nDescription: Reads Document Link from Purchase Order
\nEndpoint URL: api/documentLink/{ID}
Method: GET
Parameters: transactionNumber
\nDescription: Searches the PROJECT table in Sage.
\nEndpoint URL: api/searchProject
Method: POST
Description: Creates a new project
\nEndpoint URL: api/project
Method: POST
Parameters:
\nprojectID // String, required for patch, max 4 chars\naccountRef // String, optional, max 8 chars\nname // String, required, max 100 chars\nreference // String, required, max 12 chars\nstartDate // String, required, dd/MM/yyyy\nendDate // String, required, dd/MM/yyyy\ndescription // String, required, max 255 chars\npriceQuoted // Double, optional, max 8 chars\ntotalBudget // Double, optional, max 8 chars\norderNumber // String, optional, max 30 chars\nanalysis1 // string, optional, max 30 chars\naddress1 // optional, string, max 60 chars\naddress2 // optional, string, max 60 chars\naddress3 // optional, string, max 60 chars\naddress4 // optional, string, max 60 chars\naddress5 // optional, string, max 60 chars\nstatus // string, required, see available status list below\n\nValue Description\nACTIVE Active\nCOMPLETED Completed, closed\nINITIAL Pre-acceptance\nSNAG Completed, open\nSUSPEND Suspended \n\nDescription: Fetches a project details, search by project reference
\nEndpoint URL api/project/{id}
method GET
Parameters: id
\nDescription: Updatesa new project
\nEndpoint URL: api/project
Method: PATCH
Parameters:
\nprojectID // String, required for patch, max 4 chars\naccountRef // String, optional, max 8 chars\nname // String, required, max 100 chars\nreference // String, required, max 12 chars\nstartDate // String, required, dd/MM/yyyy\nendDate // String, required, dd/MM/yyyy\ndescription // String, required, max 255 chars\npriceQuoted // Double, optional, max 8 chars\ntotalBudget // Double, optional, max 8 chars\norderNumber // String, optional, max 30 chars\nanalysis1 // string, optional, max 30 chars\naddress1 // optional, string, max 60 chars\naddress2 // optional, string, max 60 chars\naddress3 // optional, string, max 60 chars\naddress4 // optional, string, max 60 chars\naddress5 // optional, string, max 60 chars\nstatus // string, required, see available status list below\n\nValue Description\nACTIVE Active\nCOMPLETED Completed, closed\nINITIAL Pre-acceptance\nSNAG Completed, open\nSUSPEND Suspended \n\nDescription: Returns a list of project transactions
\nEndpoint URL: api/project/{projectReference}/transactions
Method: GET
Parameters: projectReference
\nDescription: Searches the PROJECT table in Sage.
\nEndpoint URL: api/searchProject
Method: POST
Description: Searches the PROJECT table in Sage.
\nEndpoint URL: api/searchProject
Method: POST
Description: Posts a project only transaction
\nEndpoint URL: api/project/{projectReference}/transactions
Method: POST
Parameters:
\ncodeCodeRef // String, required, max 8 chars\ndate // string, required, dd/mm/yyyy\ndetails // string, optional, max 60 chars\nreference // string, optional, max 8 chars\nquantity // double, required, max 8 chars\nrate // double, required, max 8 chars\ntaxAmount // double,optional, max 8 chars\ntype // transaction type (see enums/types below, should be project specific such as sdoCC - Project Cost Credit)\n\nDescription: Returns a list of all project cost codes
\nEndpoint URL: api/projectCostCodes
Method: GET
Parameters: none
\nDescription: Creates project cost codes.
\nEndpoint URL: api/projectCostCode
Method: POST
Parameters:
\ndescription // String, required, max 60 chars\nreference // String, required, max 8 chars\n\nDescription: Reads Project Budgets
\nEndpoint URL: api/projectBudgets
Method: GET
Parameters: none
\nDescription: Allocate payment on an account
\nEndpoint URL: api/allocatePaymentOnAccount
Method: POST
Parameters:
\naccountRef // String, required, max 8 chars\ninvRef // String, required, max 30 chars\npaymentTransactionNumber // int, required\namount // double, required, max 8 chars\ncurrency // Int, see notes, max 2 chars\n\nNOTES -
\nDuring the allocation process, if the API is unable to find a matching transaction for the given invRef (accountRefs must match too) then the API will post an unallocated payment.
\nCurrency is required if sending a non BASE (foreign) currency.
\nDescription: Allocate credit on an account
\nEndpoint URL: api/allocateCreditOnAccount
Method: POST
Parameters:
\naccountRef // String, required, max 8 chars\ninvRef // String, required, max 30 chars\ncreditTransactionNumber // int, required\namount // double, required, max 8 chars\n\nDescription: Searches the AUDIT_HEADER table in Sage.
\nEndpoint URL: api/search/auditHeaders
Method: POST
Endpoint: api/transactionPost
Method: POST
Description: Allows you to post transactions directly into sage
\nparameters:
\naccountRef // String, required, max 8 chars\ndate // String, required,dd/mm/yyyy\nnominalCode // String, required, max 4 chars\nbankCode // String, only required for payments/receipts, max 8 chars\ndetails // string, optional, max 60 chars\ntaxCode // int, required, max 4 chars\ninvRef // String, required, max 30 chars\ntaxAmount // double, optional (see note)\nnetAmount // double, optional (see note)\ntype // int, required, see TYPE Field, max 1 chars\namountPaid // double, optional, only used for payments, max 8 chars\nexRef // String, optional, max 30 chars\ncurrency // double, optional (see note)\nRate // double, optional (see note)\nshouldAllocatePayment // bool, optional, default false (see note)\nuserName // string, optional, max 30 chars\ndueDate // string, optional, dd/mm/yyyy\ncostCode // String, optional\nprojectID // string, optional\ndeptNumber // int, optional, max 3 chars\n\nThe response ID given for a successful request is the HEADER_NUMBER in sage NOT TRAN_NUMBER.
\nTransactions must be posted in the same currency as the account you are posting to.
\nFor base currency (GBP) transactions you must use netAmount and taxAmount fields.
For foreign currency transactions you must use foreignNetAmount, foreignRate and foreignTaxAmount fields. If the forgeignRate field is not set, it will load the rate from the currency in Sage. For Sales Receipts (SR's) on V29, the foreignRate must match the foreignRate on the Sales Invoice (SI) transaction.
When posting a PP, the invRef value should relate to the invRef value that was posted on the Purchase Invoice transaction you wish to allocate the payment against.
\nDuring the allocation process, if the API is unable to find a matching PI for the given invRef (accountRefs must match too) then the API will post a PA – Purchase Payment on Account instead.
\nThe above behaviour is replicated on the Sales side, so if a Sales Receipt - SR cannot be matched against a Sales Invoice - SI, it will post the transaction as a SA – Sales Receipt on Account.
\nType Value Description \nSI 1 Sales Invoice \nSC 2 Sales Credit \nSR 3 Sales Receipt \nSA 4 Sales Receipt on Account \nSD 5 Sales Discount \nPI 6 Purchase Invoice \nPC 7 Purchase Credit \nPP 8 Purchase Payment \nPA 9 Purchase Payment on Account \nPD 10 Purchase Discount \nBP 11 Bank Payment \nBR 12 Bank Receipt \nCP 13 Cash Payment \nCR 14 Cash Receipt \nJD 15 Journal Debit \nJC 16 Journal Credit \nVP 17 Visa Payment \nVR 18 Visa Receipt \nCC 19 Project Cost Credit \nCD 20 Project Cost Debit - Charge \nPAI 21 Project Adjustment In \nPAO 22 Project Adjustment Out \nCO 23 Project Committed Cost \nSP 24 Sales Payment \nPR 25 Purchase Receipt\n\nEndpoint: api/batchtransactionPost
Method: POST
Description: Allows you to post batch transactions directly into ledger
\nparameters:
\ntype // int, required \ndate // String, required,dd/mm/yyyy\ninvRef // String, required, max 30 chars\naccountRef // String, required, max 8 chars\nbankCode // String, optional, max 8 chars\nuserName // string, optional, max 30 chars\ndueDate // string, optional, dd/mm/yyyy\ndetails // string, optional, max 60 chars\nLines\n nominalCode // String, required, max 4 chars\n taxAmount // double, required \n netAmount // double, required \n taxCode // int, required, max 4 chars\n currency // Required only to be sent with foreign rate transactions\n amount // int, optional, max 8 chars\n exRef // String, optional, max 30 chars\n deptNumber // int, optional, max 3 chars\n\nThis endpoint can not be used to allocate payments.
\nThe response ID given for a successful request is the HEADER_NUMBER in sage NOT TRAN_NUMBER.
\nTransactions must be posted in the same currency as the account you are posting to.
\nFor base currency (GBP) transactions you must use netAmount and taxAmount fields.
For foreign currency transactions you must use foreignNetAmount, foreignRate and foreignTaxAmount fields. If the forgeignRate field is not set, it will load the rate from the currency in Sage. For Sales Receipts (SR's) on V29, the foreignRate must match the foreignRate on the Sales Invoice (SI) transaction.
When posting a PP, the invRef value should relate to the invRef value that was posted on the Purchase Invoice transaction you wish to allocate the payment against.
\nDuring the allocation process, if the API is unable to find a matching PI for the given invRef (accountRefs must match too) then the API will post a PA – Purchase Payment on Account instead.
\nThe above behaviour is replicated on the Sales side, so if a Sales Receipt - SR cannot be matched against a Sales Invoice - SI, it will post the transaction as a SA – Sales Receipt on Account.
\nType Value Description \nSI 1 Sales Invoice \nSC 2 Sales Credit \nSR 3 Sales Receipt \nSA 4 Sales Receipt on Account \nSD 5 Sales Discount \nPI 6 Purchase Invoice \nPC 7 Purchase Credit \nPP 8 Purchase Payment \nPA 9 Purchase Payment on Account \nPD 10 Purchase Discount \nBP 11 Bank Payment \nBR 12 Bank Receipt \nCP 13 Cash Payment \nCR 14 Cash Receipt \nJD 15 Journal Debit \nJC 16 Journal Credit \nVP 17 Visa Payment \nVR 18 Visa Receipt \nCC 19 Project Cost Credit \nCD 20 Project Cost Debit - Charge \nPAI 21 Project Adjustment In \nPAO 22 Project Adjustment Out \nCO 23 Project Committed Cost \nSP 24 Sales Payment \nPR 25 Purchase Receipt\n\nDescription: Searches the AUDIT_SPLIT table in Sage.
\nEndpoint URL: api/searchSplit
Method: POST
Description: Searches the AUDIT_USAGE table in Sage.
\nEndpoint URL: api/searchUsage
Method: POST
Description: Posts a record to the bank account
\nEndpoint URL: api/bank
Method: POST
Parameters:
\nbankCode // string, required, max 8 chars\nnetAmount // double, required, max 8 chars\ntaxAmount // double, required, max 8 chars\ntaxCode // int, required max 4 chars\nnominalCode // string, required, max 4 chars\ninvRef // string, optional, max 30 chars\ndate // date, string, dd/mm/yyyy\ndetails // string, optional, max 60 chars\ntype // int, BP = 11, BR = 12\n\nDescription: Posts journal entries
\nEndpoint URL: api/journal
Method: POST
Parameters:
\ndate // date, string, dd,mm,yyyy\ninvRef // string, optional, max 30 chars\nsplits // array\n details // string, optional, max 30 chars\n taxAmount // double, required, max 8 chars\n netAmount // double, required, max 8 chars\n taxCode // double, max 8 chars\n nominalCode // string, max 8 chars\n type // int, JC = 16, JD = 15\n deptNumber // string, optional, maximum 2 chars\n extraRef // string, optional, maximum 30 chars\n\nEndpoint: api/fixedAssets
Method: POST
Description: Allows you to post fixed assets directly into sage
\nparameters:
\nassetRef // Required, String max 8 chars\ndetails1 // Optional, String, max 60 chars\ndetails2 // Optional,String, max 60 chars\ndetails3 // Optional, String, max 60 chars\nemployee // Optional, String max 15 chars\nserialNumber // Optional, String max 60 chars\npurchaseRef // Optional, String max 8 chars\nbalSheetNomCode // Required, String max 8 chars\nprofitLossNomCode // Required, String max 8 chars\ndepMethodCode // Optional, Int max 2 chars\ndepRate // Optional, Double max 8 chars\ndeptNumber // Optional, Int max 2 chars\nassetCat // Optional, Int max 2 chars\npurchaseDate // Optional, String max 2 chars\ncostPrice // Optional, Double max 8 chars\ndepLast // Optional, Double max 8 chars\ndepToDate // Optional, Double max 8 chars\nnetBook // Optional, Double max 8 chars\n\nDescription: Searches Fixed Assets
\nEndpoint URL: `api/searchfixedAssets
\nMethod: POST
Description: Fetches fixed asset details, search by asset ref
\nEndpoint URL api/fixedAssets/{id}
method GET
Parameters: id
\nDescription: Updates Fixed Asset
\nEndpoint URL: api/fixedAssets
Method: PATCH
Parameters:
\nassetRef // Required, String max 8 chars\ndetails1 // Optional, String, max 60 chars\ndetails2 // Optional,String, max 60 chars\ndetails3 // Optional, String, max 60 chars\nemployee // Optional, String max 15 chars\nserialNumber // Optional, String max 60 chars\npurchaseRef // Optional, String max 8 chars\nbalSheetNomCode // Required, String max 8 chars\nprofitLossNomCode // Required, String max 8 chars\ndepMethodCode // Optional, Int max 2 chars\ndepRate // Optional, Double max 8 chars\ndeptNumber // Optional, Int max 2 chars\nassetCat // Optional, Int max 2 chars\npurchaseDate // Optional, String max 2 chars\ncostPrice // Optional, Double max 8 chars\ndepLast // Optional, Double max 8 chars\ndepToDate // Optional, Double max 8 chars\nnetBook // Optional, Double max 8 chars\n\n