1. U4 ERPx
  2. Getting Started

Getting Started

Welcome to the ERPx API Developer Portal. Here you’ll learn API fundamentals, their role in ERPx, and how to make your first call. Includes integration, automation, security, and best practices for new developers.

What is an API?

An API (Application Programming Interface) enables software systems to communicate with one another. Instead of directly interacting with ERPx’s database or internal logic, you use APIs as a safe, consistent, and documented interface.

  • APIs expose ERPx data and configuration such as managing employees, processing invoices, configuring new attribute values, or updating common parameter setup in a predictable and secure way.
  • APIs typically use HTTP requests and return structured data in JSON, which makes them straightforward to consume from modern applications.    

Why APIs for ERPx?

ERPx manages key business processes, including finance, HR, procurement, and project management. APIs enable the following:

  • Integration of ERPx with other enterprise systems such as CRMs and payroll providers.
  • Automation of tasks that would otherwise require manual input.
  • Expansion of ERPx features with custom applications, dashboards, or mobile tools.
  • Connection of ERPx to external services like recruitment systems and payment processors.

APIs allow for integration and automation while maintaining the security and consistency of ERPx data.    

How the ERPx API works

Our APIs are designed in alignment with established industry standards:

  • RESTful APIs: Utilise HTTP methods such as GET, POST, PUT, and DELETE for consistent operations.
  • JSON Responses: Provide uniform, machine-readable data formats for seamless integration.
  • Versioned Endpoints: Maintain interface stability throughout platform advancements.
  • Secure Authentication: Incorporate OAuth 2.0 and support federated identity providers to ensure robust security.    

Quick start

Authenticate:
Get an access token from your Identity Provider (see Authentication & Security).

Choose endpoint:
Check the API Reference for the resource you need (e.g., employees, projects, invoices).

Send request:

curl -X GET "https://api.userp.com/v1/employees" \
  -H "Authorization: Bearer <your-access-token>" \
  -H "Content-Type: application/json"
{
  "data": [
    {
      "id": "12345",
      "firstName": "Anna",
      "lastName": "Smith",
      "email": "anna.smith@company.com"
    }
  ]
}

Before you begin

  • Confirm you have an ERPx tenant and access to Unit4 Identity Services (U4IDS).
  • Choose whether you’re building a user-facing app (with login/consent) or a machine-to-machine integration (ERPx user setup, credentials managed securely).    

Best practices

  • Start with read-only endpoints (e.g., GET /employees) before creating or updating data.
  • Test in a non-production environment to protect live data.
  • Follow API rate limits and design integrations accordingly.
  • Implement comprehensive error handling from the start to build resilient integrations.
  • Monitor your integration with logging and alerting for API errors.    

Next steps