EpicorFree referencePDF, Excel, Word exportEpicor Kinetic

Epicor Business Object Services Reference: Service Names for REST and Function Calls

Epicor business objects are the supported way to read and write data without touching the database. Each one is exposed as a service, and in REST v2 as an OData path. This list helps you find the right service name before you open Swagger.

Download:
ServiceREST v2 pathAreaTypical use
Erp.BO.JobEntrySvc
/api/v2/odata/{Company}/Erp.BO.JobEntrySvc
Production
Create and maintain jobs, materials and operations
Erp.BO.SalesOrderSvc
/api/v2/odata/{Company}/Erp.BO.SalesOrderSvc
Sales
Sales order headers, lines and releases
Erp.BO.QuoteSvc
/api/v2/odata/{Company}/Erp.BO.QuoteSvc
Sales
Quote headers, lines and materials
Erp.BO.POSvc
/api/v2/odata/{Company}/Erp.BO.POSvc
Purchasing
Purchase orders, lines and releases
Erp.BO.PartSvc
/api/v2/odata/{Company}/Erp.BO.PartSvc
Inventory
Part master, plant and warehouse settings
Erp.BO.CustomerSvc
/api/v2/odata/{Company}/Erp.BO.CustomerSvc
Sales
Customer master and ship-to records
Erp.BO.VendorSvc
/api/v2/odata/{Company}/Erp.BO.VendorSvc
Purchasing
Supplier master
Erp.BO.LaborSvc
/api/v2/odata/{Company}/Erp.BO.LaborSvc
Production
Labor entry and clock transactions
Erp.BO.IssueReturnSvc
/api/v2/odata/{Company}/Erp.BO.IssueReturnSvc
Inventory
Issue material to jobs and return it
Erp.BO.APInvoiceSvc
/api/v2/odata/{Company}/Erp.BO.APInvoiceSvc
AP
Supplier invoice entry
Erp.BO.ARInvoiceSvc
/api/v2/odata/{Company}/Erp.BO.ARInvoiceSvc
AR
Customer invoice maintenance
Erp.BO.ProjectSvc
/api/v2/odata/{Company}/Erp.BO.ProjectSvc
Project
Project definitions and phases
Ice.BO.BAQDesignerSvc
/api/v2/odata/{Company}/Ice.BO.BAQDesignerSvc
System
Create and edit BAQs programmatically
Ice.BO.UserFileSvc
/api/v2/odata/{Company}/Ice.BO.UserFileSvc
System
Users and their settings
Ice.BO.UD01Svc
/api/v2/odata/{Company}/Ice.BO.UD01Svc
System
User defined table 01 records (UD01 to UD05 follow the pattern)

Service names are the namespace plus Svc. Many other services exist. Open the Swagger page of your own Kinetic server (the REST help page) for the authoritative list and method names for your version. BAQ based endpoints use the separate BaqSvc path.

Epicor integration scoping

Optional: tell us what you want to connect and we will outline an approach with read-only defaults.

Optional. The tool and every export work without this. No spam.

How to use the list

Search by the business area or the object you need. The service column is the namespace and object name used in function calls, BPM code and the REST path. Replace the Company placeholder with your company id. The path pattern is the same across services, so once you know the service, the method names (GetByID, GetRows, Update) follow from Swagger. For read-only reporting from a BAQ, use the BaqSvc endpoint instead of the table business object.

Choosing between an entity read and a method call

OData entity paths such as the JobHeads or OrderHeds collections under a service suit simple filtered reads. Business logic lives in methods: creating a job through Update without calling the right sequence of methods skips defaults and validations. Prefer the same method sequence the screen uses, for example GetNewJobHead followed by Update, so default values, numbering and security rules still apply.

  • Use GetByID for one record with children
  • Use GetRows with a where clause for filtered lists
  • Use Update for saves and always send the RowMod flag
  • Test in a pilot company before production

Common mistakes

Developers frequently send an API key without a user credential when the environment requires both, miss the required x-api-key header, or bypass methods and write directly through entity endpoints, which leaves required fields blank. Another mistake is using Company in the path when the call needs a Plant context. Check the service in Swagger and read the response error text, which usually names the missing field.

Frequently Asked Questions

What is the difference between Erp.BO and Ice.BO?

Erp.BO services cover business data such as jobs, orders and parts. Ice.BO services cover the platform: users, BAQs, security and the system itself. The prefix tells you which layer the service belongs to.

Where do I find the full list of services?

Open the REST help or Swagger page on your Kinetic server, which lists every service and method for your exact version. This reference only covers the commonly used ones.

Do I need an API key for REST v2?

Kinetic REST v2 requires an API key passed in a header in addition to user authentication. Your admin generates the key in API Key Maintenance. Without it, requests are rejected even with valid credentials.

Can I call a BAQ over REST?

Yes. Published BAQs are exposed through the BaqSvc endpoint under their query name, which returns rows as JSON and honors Epicor security for the calling user.

If you are wiring Epicor to other systems or AI tools, Netray can build read-only connectors and, where you require it, approval-gated write-back using these same services.

Talk to an ExpertExplore More Free Tools

Related Tools

Epicor

Epicor Kinetic Database Tables Reference

Look up the main Erp.* tables in Epicor Kinetic with what each holds and the columns that identify a row. Useful when writing BAQs and SQL.

Epicor

Epicor Part Transaction Types Reference

Decode the TranType codes in Epicor's PartTran table so inventory audits and cost reconciliations stop being guesswork.

Epicor

Epicor BAQ Performance Tuning Checklist

Work through a practical list of checks when a BAQ, dashboard or BPM lookup runs slowly in Epicor Kinetic.

Epicor

Epicor Open Sales Order Releases SQL Generator

Pull open order releases with required dates and quantities to build a backlog or past-due report.

More Epicor tools

See all
Back to All Tools