Skip to content

Gestix ERP API Documentation

Welcome to the Gestix ERP API — a RESTful interface that allows external systems and developers to integrate with the Gestix ERP platform.

Current Version

API Version: 4.0.0
Base URL: https://gestix.pt:443/api/{account}/v4.0.0
Specification: OpenAPI 3.0

What can you do with this API?

The Gestix API exposes the core data and operations of the ERP system. You can:

  • Authenticate via API token or username/password to obtain a session token
  • Read and create sales documents — invoices, orders, and receipts
  • Read and create purchase documents — purchases and purchase orders
  • Manage warehouse operations — transfer orders, stock movements, serial numbers
  • Maintain master data — customers, suppliers, articles, locations, categories, families, users
  • Query transactions and inventory data

Quick Start

1. Obtain a session token

All protected endpoints require a session token. Get one by calling GET /helo with your API Token in the Authorization header:

GET /api/{account}/v4.0.0/helo
Authorization: Bearer <your-api-token>

The response returns an xa-token:

{
  "xa-token": "aaMDAwMDAwMDAwMDAxMzY4ODY5OTA4ICAgRlIwMDA3MTQwNjIxXX"
}

2. Use the session token

Pass the xa-token as a bearer token on subsequent requests:

GET /api/{account}/v4.0.0/invoices
Authorization: Bearer <xa-token>

3. Include a nonce on write operations

POST and PUT endpoints require a nonce query parameter — a client-generated, strictly incrementing integer to prevent replay attacks:

POST /api/{account}/v4.0.0/invoices?nonce=123456789
Authorization: Bearer <xa-token>
Content-Type: application/json

Authentication Flows

Flow Endpoint Use Case
API Token → Session Token GET /helo Server-to-server integrations
Username + Password POST /auth Web / user-facing applications

See the Authentication guide for full details.

Base URL

The base URL includes your Gestix account identifier:

https://gestix.pt:443/api/{account}/v4.0.0

Replace {account} with your account code (e.g., 03101176).

Contact & Support