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, https://localhost/Sage300WebApi).
Swagger is part of the Open API Initiative (OAI). For more information on ApenAPI/Swagger
and Swagger UI, see:
 http://swagger.io
 https://github.com/OAI/OpenAPI-Specification
Additional documentation is available for members of the Sage Development Partner Program.
For more information about partner programs, visit sage.com/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:
http://localhost/Sage300WebApi/v1.0/-/SAMLTD/AR/ARCustomers

Component Description Example

{protocol} The application protocol http, https

enabled in IIS setup

{host-application-path} The path to the Web API localhost/Sage300WebApi,

application yourdomain.com

v{version} The version of Sage 300 v1.0, v2.0

Web API
(v1.0 is Sage 300 2017 PU1)

{company} The Org ID of the company SAMLTD, SAMINC

being requested

{app-module} Sage 300 module where the GL, AP, AR

requested resource resides

{resource} The data model being ARCustomers, GLAccounts

requested

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.

Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

AP1099CPRSCodes AP0007 APCLX x x x x x

APAccountSets AP0006 APRAS x x x x x

APDistributionCodes AP0005 APRDC x x x x x

AP0009 APDSH,
APDistributionSets x x x x x
AP0008 APDSD
APPaymentCodes AP0010 APPTP x x x x x

AP0064 APRPH,
AP0065 APRPD,
APRecurringPayables x x x x x
AP0405 APRPHO,
AP0404 APRPDO
AP0018 APVNR,
APRemitToLocations x x x x x
AP0409 APVNRO
AP0012 APRTA,
APTerms x x x x x
AP0011 APRTB
AP0016 APVGR,
APVendorGroups x x x x x
AP0408 APVGRO
AP0015 APVEN,
APVendors x x x x x
AP0407 APVENO
ARAccountSets AR0013 ARRAS x x x x x

ARBillingCycles AR0014 ARRBC x x x x x

ARCommentTypes AR0094 ARCMMTP x x x x x

AR0025 ARGRO,
ARCustomerGroups x x x x x
AR0410 ARGROO
AR0024 ARCUS,
ARCustomers x x x x x
AR0400 ARCUSO
ARDistributionCodes AR0015 ARRDC x x x x x

ARDunningMessages AR0008 ARDUN x x x x x

Sage 300 Web API - Web API Endpoints Page 6 of 18

 Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

AR0010 ARITH,
ARItems AR0009 ARITD, x x x x x
AR0011 ARITT
AR0028 ARNAT,
ARNationalAccounts x x x x x
AR0411 ARNATO
ARPaymentCodes AR0012 ARPTP x x x x x

AR0046 ARSIA,
AR0047 ARSID,
ARRecurringCharges x x x x x
AR0405 ARSIAO,
AR0404 ARSIDO
ARSalespersons AR0018 ARSAP x x x x x

AR0023 ARCSP,
ARShipToLocations x x x x x
AR0412 ARCSPO
AR0016 ARRTA,
ARTerms x x x x x
AR0017 ARRTB
BK0003 BKTT,
BKBankDistributionCodes x x x x x
BK0860 BKTTX
BK0001 BKACCT,
BK0002 BKCUR,
BK0845 BKTRANH,
BKBanks x x x x x
BK0008 BKFORM,
BK0870 BKUNMAT,
BK0840 BKTRAND
BKCreditCardTypes BK0240 BKCCTYP x x x x x

CSCompanyProfile CS0001 CSCOM x x x

CSCurrencyCodes CS0003 CSCCD x x x x x

CS0005 CSCRH,
CSCurrencyRates x x x x x
CS0006 CSCRD
CSCurrencyRateTypes CS0004 CSCRT x x x x x

CS0002 CSFSC,
CSFiscalCalendars x
CS0060 CSFSCST
CS0030 CSSKTB,
CSSchedules x x x x x
CS0032 CSSKAP
GLAccountGroups GL0055 GLACGRP x x x x x

GL0001 GLAMF,
GL0004 GLAIS,
GLAccounts x x x x x
GL0012 GLAVC,
GL0107 GLCAS,

Sage 300 Web API - Web API Endpoints Page 7 of 18

 Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

GL0400 GLAMFO,
GL0401 GLAMFTO,
GL0057 GLACHD,
GL0063 GLPACHD
GLRevaluationCodes GL0020 GLRVAL x x x x x

GLSourceCodes GL0002 GLSRCE x x x x x

ICAccountSets IC0100 ICACCT x x x x x

IC0200 ICBOMH,
ICBillsOfMaterial x
IC0190 ICBOMD
IC0210 ICCATG,
ICCategories x x x x x
IC0220 ICCATTX
IC0310 ICITEM,
IC0750 ICUNIT,
IC0330 ICITMTX,
IC0340 ICITMV,
ICItems x x x x x
IC0313 ICITEMO,
IC0319 ICITMC,
IC0314 ICITEMSO,
IC0312 ICITEMLO
ICItemStructures IC0320 ICITMS x x x x x

ICLocations IC0370 ICLOC x x x x x

IC0390 ICPCOD,
ICPriceListCodes IC0395 ICPCTX, x x x x x
IC0392 ICPCODC
ICUnitsOfMeasure IC0746 ICUCOD x x x x x

ICWeightUnitsOfMeasure IC0758 ICWCOD x x x x x

OE0440 OEMISC,
OEMiscellaneousCharges OE0460 OEMISCT, x x x x x
OE0450 OEMISCO
OEShipViaCodes OE0760 OEVIA x x x x x

OETemplates OE0540 OEPLAT x x x x x

POAccountSets PO0100 POACCT x x x x x

PO0300 POACST,
POAdditionalCosts PO0290 POACD, x x x x x
PO0299 POACSTO
POTemplates PO0605 POPLAT x x x x x

Sage 300 Web API - Web API Endpoints Page 8 of 18

 Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

PO0181 POVUPR,
POVendorContractCosts
PO0191 POVUMB,
x x x x x
PO0192 POVUMS,
PO0183 POVUTX

Sage 300 Web API - Web API Endpoints Page 9 of 18

4. Transaction endpoints

The following transaction endpoints require a special protocol:

 AP PaymentAndAdjustmentBatches. BatchSelector must be specified for POST
requests: ‘PY’ for Payment batches and ‘AD’ for Adjustment batches.
 AR ReceiptAndAdjustmentBatches. BatchRecordType must be specified for POST
requests: ‘CA’ for Receipt batches and ‘AD’ for Adjustment batches.

Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

AP0020 APIBC,
AP0021 APIBH,
AP0022 APIBD,
APInvoiceBatches x x
AP0401 APIBDO,
AP0023 APIBS,
AP0402 APIBHO
AP0030 APBTA,
AP0031 APTCR,
AP0032 APTCN,
APPaymentAndAdjustmentBatches AP0033 APTCP, x x
AP0034 APTCU,
AP0406 APTCRO,
AP0170 APTCC
AR0031 ARIBC,
AR0032 ARIBH,
AR0033 ARIBD,
ARInvoiceBatches x x
AR0401 ARIBDO,
AR0034 ARIBS,
AR0402 ARIBHO
AR0041 ARBTA,
AR0042 ARTCR,
AR0043 ARTCN,
ARReceiptAndAdjustmentBatches AR0044 ARTCP, x x
AR0045 ARTCU,
AR0406 ARTCRO,
AR0170 ARTCC
ARRefundBatches AR0140 ARRFB, x x

Sage 300 Web API – Endpoint reference Page 10 of 18

 Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

AR0141 ARRFH,
AR0142 ARRFD,
AR0145 ARRFDJ,
AR0143 ARRFHO
BK0450 BKENTH,
BKBankEntries x x
BK0460 BKENTD
GL0008 GLBCTL,
GL0006 GLJEH,
GLJournalBatches x x
GL0010 GLJED,
GL0402 GLJEDO
IC0120 ICADEH,
IC0110 ICADED,
IC0125 ICADEHO,
ICAdjustments x x
IC0115 ICADEDO,
IC0117 ICADEDS,
IC0113 ICADEDL
IC0590 ICREEH,
IC0580 ICREED,
IC0595 ICREEHO,
ICReceipts x x
IC0585 ICREEDO,
IC0587 ICREEDS,
IC0582 ICREEDL
IC0640 ICSHEH,
IC0630 ICSHED,
IC0645 ICSHEHO,
ICShipments x x
IC0635 ICSHEDO,
IC0632 ICSHEDL,
IC0636 ICSHEDS
IC0740 ICTREH,
IC0730 ICTRED,
IC0741 ICTREHO,
ICTransfers x x
IC0735 ICTREDO,
IC0738 ICTREDS,
IC0733 ICTREDL
OE0240 OECRDH,
OE0220 OECRDD,
OE0140 OECOINC,
OE0242 OECRDHO,
OECreditDebitNotes OE0221 OECRDDO, x x
OE0223 OECRDDB,
OE0222 OECRDDD,
OE0224 OECRDDDS,
OE0225 OECRDDDL,

Sage 300 Web API - Web API Endpoints Page 11 of 18

 Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

OE0227 OECRDDS,
OE0226 OECRDDL
OE0420 OEINVH,
OE0400 OEINVD,
OE0160 OECOINI,
OE0720 OETERMI,
OE0427 OEINVR,
OE0422 OEINVHO,
OEInvoices OE0401 OEINVDO, x
OE0403 OEINVDB,
OE0402 OEINVDD,
OE0404 OEINVDDS,
OE0405 OEINVDDL,
OE0407 OEINVDS,
OE0406 OEINVDL
OE0520 OEORDH,
OE0500 OEORDD,
OE0180 OECOINO,
OE0740 OETERMO,
OE0526 OEORDQ,
OE0522 OEORDHO,
OEOrders OE0501 OEORDDO, x x
OE0503 OEORDDB,
OE0502 OEORDDD,
OE0504 OEORDDDS,
OE0506 OEORDDDL,
OE0508 OEORDDS,
OE0507 OEORDDL
PO0311 POCRNH,
PO0309 POCRNC,
PO0315 POCRNL,
PO0320 POCRNS,
PO0310 POCRNG,
PO0325 POCRNW,
POCreditDebitNotes x
PO0314 POCRNHO,
PO0318 POCRNLO,
PO0829 POCRNLL,
PO0820 POCRNLS,
PO0323 POCRNSO,
PO0326 POCRND
PO0420 POINVH,
POInvoices PO0416 POINVC, x
PO0430 POINVL,

Sage 300 Web API - Web API Endpoints Page 12 of 18

 Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

PO0440 POINVS,
PO0436 POINVP,
PO0419 POINVG,
PO0438 POINVR,
PO0444 POINVW,
PO0423 POINVHO,
PO0433 POINVLO,
PO0819 POINVLL,
PO0810 POINVLS,
PO0443 POINVSO,
PO0415 POINVD
PO0620 POPORH,
PO0610 POPORC,
PO0630 POPORL,
POPurchaseOrders PO0632 POPORR, x x
PO0619 POPORG,
PO0623 POPORHO,
PO0633 POPORLO
PO0700 PORCPH,
PO0695 PORCPC,
PO0710 PORCPL,
PO0718 PORCPV,
PO0699 PORCPG,
PO0705 PORCPR,
PO0703 PORCPHO,
POReceipts x x
PO0717 PORCPLO,
PO0789 PORCPLL,
PO0780 PORCPLS,
PO0714 PORCPS,
PO0719 PORCPSO,
PO0696 PORCPD,
PO0721 PORCPVO
PO0760 PORQNH,
PO0750 PORQNC,
PO0770 PORQNL,
PORequisitions PO0759 PORQNG, x x
PO0763 PORQNHO,
PO0777 PORQNLV,
PO0773 PORQNLO
PO0731 PORETH, x x
PO0729 PORETC,
POReturns
PO0735 PORETL,
PO0730 PORETG,

Sage 300 Web API - Web API Endpoints Page 13 of 18

 Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

PO0738 PORETHO,
PO0739 PORETLO,
PO0799 PORETLL,
PO0790 PORETLS

Sage 300 Web API - Web API Endpoints Page 14 of 18

5. Process endpoints

Process endpoints invoke special service process resources to perform such tasks as posting
invoices and generating GL batches.
To get a sample payload, enter the appropriate URL with (‘$template’) at the end.
Example:
POST http://localhost/Sage300WebApi/v1.0/-/SAMLTD/AR/ARPostInvoices(‘$template’)

When you are ready to invoke a Sage 300 superview process, add (‘$process’) at the end of
the URL.
Example:
POST http://localhost/Sage300WebApi/v1.0/-/SAMLTD/AR/ARPostInvoices(‘$process’)

Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

APCreateGLBatch AP0042 APGLTR x

APCreateRecurringPayableBatch AP0066 APRCUR x

APCreateRetainageDocumentBatch AP0300 APIRTNG x

APDeleteInactiveRecords AP0052 APPGIA x

APPostInvoices AP0039 APIVPT x

APPostPaymentsAndAdjustments AP0040 APPYPT x

ARCreateGLBatch AR0053 ARGLTR x

ARCreateRecurringCharge AR0059 ARRCUR x

ARCreateRetainageDocumentBatch AR0300 ARIRTNG x

ARPostInvoices AR0048 ARIVPT x

ARPostReceiptsAndAdjustments AR0049 ARPYPT x

ARPostRefunds AR0150 ARRFPT x

GLPostJournal GL0030 GLJPST x

ICCreateGLBatch IC0278 ICGLTR x

Sage 300 Web API – Endpoint reference Page 15 of 18

 Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

ICDayEndProcessing IC0275 ICDEND x

POCreateBatch PO0353 POGLTR x

PODayEndProcessing PO0110 PODEND x

Sage 300 Web API - Web API Endpoints Page 16 of 18

6. Document endpoints

Document endpoints are for reporting and inquiry purposes.

Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

AP1099CPRSAmounts AP0013 APCCS x

APPostedDocuments AP0025 APOBL x

APPostedPayments AP0029 APPYM x

APPostingErrorMessages AP0038 APPTER x

APVendorStatistics AP0019 APVSM x

ARItemStatistics AR0027 ARITS x

ARNationalAccountStatistics AR0029 ARNSM x

ARPayments AR0139 ARPYM x

ARPostedDocuments AR0036 AROBL x

ARPostedReceipts AR0040 ARRRH x

ARSalespersonStatistics AR0030 ARSPS x

GLAccountFiscalSets GL0103 GLAFS x

GLPostedTransactions GL0018 GLPOST x

GLPostingJournalDetails GL0016 GLPJD x

GLProvisionalPostingErrors GL0013 GLPPER x

OE0120 OEAUDH,
OE0100 OEAUDD,
OEPostingJournals OE0123 OEAUDHP, x
OE0110 OEAUDDP,
OE0105 OEAUDDD

OESalesHistory OE0690 OESHHD x

Sage 300 Web API – Endpoint reference Page 17 of 18

 Supported verbs

Endpoint Accpac View GET POST PUT PATCH DELETE

OESalesHistoryDetails OE0685 OESHDT x

OESalesStatistics OE0700 OESTATS x

TX0011 TXAUDH,
TXTaxTracking x
TX0012 TXAUDD

Sage 300 Web API - Web API Endpoints Page 18 of 18