Skip to content

Overview

The Posto API is the HTTP and JSON API of the Posto ERP. The ERP in the browser and the PoS desktop app use the same API. Your program uses it with an API key or an OAuth token.

The API is under /api on the host of the app. On the Posto cloud, the app host is app.postoerp.com:

https://app.postoerp.com/api/v1/...

Each route of a company is under the tenant slug of that company. A tenant is one company in Posto. The examples in these guides use the tenant acme:

https://app.postoerp.com/api/v1/<tenant>/<module>/<resource>
https://app.postoerp.com/api/v1/acme/sales/invoices

Read Tenants and access for the slug and the access rules.

GET /api/v1/<tenant>/me returns the tenant, the caller and the caller’s access. Use it to test a key:

Terminal window
curl https://app.postoerp.com/api/v1/acme/me \
-H "Authorization: Bearer $POSTO_API_KEY"
{
"data": {
"tenant": { "id": "…", "slug": "acme", "name": "Acme Trade" },
"user": { "id": "…", "name": "Ana Petrovska", "email": "[email protected]" },
"access": { "superadmin": false, "role": "admin", "modules": ["inventory", "retail", "sales"], "grants": [] },
"modules": ["inventory", "retail", "sales"],
"suspended": null,
"trail": false
}
}

access.modules lists the modules of the tenant. modules lists the modules that the caller can read. suspended is null, or the time and the reason of a suspension. A suspended tenant accepts reads and refuses each write.

An answer can have more members than an example shows. Ignore the members that you do not use.

A request with a body sends JSON (Content-Type: application/json).

Each successful answer has the member data with the result:

{ "data": { "id": "01a1d5a5-e127-7a93-87ce-f790c2ad2cf3", "isConfirmed": false } }

A list route of a master or a document returns an array in data. The array has every row that the caller can read. These lists have no paging.

Each error answer has one member, error. Read Errors for its fields:

{ "error": { "code": "not_found", "message": "The document does not exist." } }

The values follow these rules:

Value Format Example
Record id UUID "01a1d5a5-e127-7a93-87ce-f790c2ad2cf3"
Date ISO 8601 date "2026-11-13"
Time ISO 8601 with an offset "2026-11-13T16:02:43.388Z"
Amount, quantity JSON number 236
No value null "dueDays": null

Field names are in camel case, for example subjectId and grandTotalGross.

GET /api/v1/version returns the release and the commit of the server. It needs no key and no tenant:

Terminal window
curl https://app.postoerp.com/api/v1/version
{ "data": { "release": "0.6.1", "commit": null } }

commit is null when the build has no commit.

  1. Make an API key.
  2. Read Resources for the routes of a record.
  3. Read Errors and Rate limits before you go live.