Sage 300 Web API
Sage 300 Web API
Endpoint reference
December 2016
? 2016 The Sage Group plc or its licensors. All rights reserved. Sage, Sage logos, and Sage product and service names mentioned herein are the trademarks of The Sage Group plc or its licensors. All other trademarks are the property of their respective owners.
Contents
1. Overview ......................................................................................................... 4 2. Web API request resource URL .................................................................... 5 3. Master data endpoints ................................................................................... 6 4. Transaction endpoints................................................................................. 10 5. Process endpoints ....................................................................................... 15 6. Document endpoints ................................................................................... 17
Sage 300 Web API ? Endpoint reference
Page 3 of 18
1. Overview
This document lists endpoints for the Sage 300 Web API. The Sage 300 Web API makes it easy to develop services that integrate with Sage 300 data and business logic. You can use the Web API to create integrated services for Sage 300 using many frameworks and tools--even just a web browser. Swagger UI generates visual and dynamic documentation of the Sage 300 Web API endpoints and their models. You can use it to try supported verbs for endpoint paths. The defaulted company for these operations is SAMLTD. To access the Swagger JSON document and Swagger UI page, navigate to protocol://servername/Sage300WebApi, where protocol is http or https and servername is the name of your Sage 300 server (for example, ). Swagger is part of the Open API Initiative (OAI). For more information on ApenAPI/Swagger and Swagger UI, see: Additional documentation is available for members of the Sage Development Partner Program. For more information about partner programs, visit us/partners.
Sage 300 Web API ? Endpoint reference
Page 4 of 18
2. Web API request resource URL
Construct a URL for the Sage 300 Web API as follows: {protocol}://{host-application-path}/v{version}/-/{company}/{app-module}/{resource}
Example:
Component {protocol} {host-application-path} v{version}
{company} {app-module} {resource}
Description
Example
The application protocol enabled in IIS setup
http, https
The path to the Web API application
localhost/Sage300WebApi,
The version of Sage 300 Web API
v1.0, v2.0 (v1.0 is Sage 300 2017 PU1)
The Org ID of the company SAMLTD, SAMINC being requested
Sage 300 module where the GL, AP, AR requested resource resides
The data model being requested
ARCustomers, GLAccounts
Sage 300 Web API ? Endpoint reference
Page 5 of 18
3. Master data endpoints
Master data endpoints are setup functions where you can do the following supported verbs.
Endpoint
AP1099CPRSCodes APAccountSets APDistributionCodes APDistributionSets APPaymentCodes
APRecurringPayables
APRemitToLocations APTerms APVendorGroups APVendors ARAccountSets ARBillingCycles ARCommentTypes ARCustomerGroups ARCustomers ARDistributionCodes ARDunningMessages
Accpac View
AP0007 APCLX
AP0006 APRAS
AP0005 APRDC AP0009 APDSH, AP0008 APDSD AP0010 APPTP AP0064 APRPH, AP0065 APRPD, AP0405 APRPHO, AP0404 APRPDO AP0018 APVNR, AP0409 APVNRO AP0012 APRTA, AP0011 APRTB AP0016 APVGR, AP0408 APVGRO AP0015 APVEN, AP0407 APVENO AR0013 ARRAS
AR0014 ARRBC
AR0094 ARCMMTP AR0025 ARGRO, AR0410 ARGROO AR0024 ARCUS, AR0400 ARCUSO AR0015 ARRDC
AR0008 ARDUN
Supported verbs
GET
POST
PUT
PATCH DELETE
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
Sage 300 Web API - Web API Endpoints
Page 6 of 18
Endpoint
ARItems ARNationalAccounts ARPaymentCodes
ARRecurringCharges
ARSalespersons ARShipToLocations ARTerms BKBankDistributionCodes
BKBanks
BKCreditCardTypes CSCompanyProfile CSCurrencyCodes CSCurrencyRates CSCurrencyRateTypes CSFiscalCalendars CSSchedules GLAccountGroups
GLAccounts
Accpac View
AR0010 ARITH, AR0009 ARITD, AR0011 ARITT AR0028 ARNAT, AR0411 ARNATO
AR0012 ARPTP
AR0046 ARSIA, AR0047 ARSID, AR0405 ARSIAO, AR0404 ARSIDO
AR0018 ARSAP
AR0023 ARCSP, AR0412 ARCSPO AR0016 ARRTA, AR0017 ARRTB BK0003 BKTT, BK0860 BKTTX BK0001 BKACCT, BK0002 BKCUR, BK0845 BKTRANH, BK0008 BKFORM, BK0870 BKUNMAT, BK0840 BKTRAND
BK0240 BKCCTYP
CS0001 CSCOM
CS0003 CSCCD
CS0005 CSCRH, CS0006 CSCRD
CS0004 CSCRT
CS0002 CSFSC, CS0060 CSFSCST CS0030 CSSKTB, CS0032 CSSKAP
GL0055 GLACGRP
GL0001 GLAMF, GL0004 GLAIS, GL0012 GLAVC, GL0107 GLCAS,
Supported verbs
GET
POST
PUT
PATCH DELETE
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
Sage 300 Web API - Web API Endpoints
Page 7 of 18
Endpoint
GLRevaluationCodes GLSourceCodes ICAccountSets ICBillsOfMaterial ICCategories
ICItems
ICItemStructures ICLocations ICPriceListCodes ICUnitsOfMeasure ICWeightUnitsOfMeasure OEMiscellaneousCharges OEShipViaCodes OETemplates POAccountSets POAdditionalCosts POTemplates
Accpac View
GL0400 GLAMFO, GL0401 GLAMFTO, GL0057 GLACHD, GL0063 GLPACHD GL0020 GLRVAL
GL0002 GLSRCE
IC0100 ICACCT IC0200 ICBOMH, IC0190 ICBOMD IC0210 ICCATG, IC0220 ICCATTX IC0310 ICITEM, IC0750 ICUNIT, IC0330 ICITMTX, IC0340 ICITMV, IC0313 ICITEMO, IC0319 ICITMC, IC0314 ICITEMSO, IC0312 ICITEMLO IC0320 ICITMS
IC0370 ICLOC IC0390 ICPCOD, IC0395 ICPCTX, IC0392 ICPCODC IC0746 ICUCOD
IC0758 ICWCOD OE0440 OEMISC, OE0460 OEMISCT, OE0450 OEMISCO OE0760 OEVIA
OE0540 OEPLAT
PO0100 POACCT PO0300 POACST, PO0290 POACD, PO0299 POACSTO PO0605 POPLAT
Supported verbs
GET
POST
PUT
PATCH DELETE
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
x
Sage 300 Web API - Web API Endpoints
Page 8 of 18
................
................
In order to avoid copyright disputes, this page is only a partial summary.
To fulfill the demand for quickly locating and searching documents.
It is intelligent file search solution for home and business.
Related searches
- sage manuscript submission guidelines
- sage journal of dental research
- sage bankruptcy financial management course
- sage dental arvada
- sage dental arvada co
- sage medical journal
- sage simply accounting software
- sage simply accounting 2015 download
- 300 rum vs 300 win mag
- sage green pantone
- 300 win mag vs 300 rum
- sage bankruptcy second course