@unimicro/platform-types

Type declarations for the Unimicro platform's business entities — customers, invoices, accounts, employees and the several hundred others. Types only: the package contains no JavaScript.

npm install --save-dev @unimicro/platform-types

Generated from the platform's own model and republished when the model moves, so it is neither hand-written nor hand-curated. The declarations describe the platform rather than any one company: custom fields do not appear, and arrive under CustomValues at runtime.

Each entity carries the route it answers on as a literal type, because an entity's name and its route are often not the same word.

Dates and times are string aliases — LocalDate is "2026-09-02", which is what the API sends — so they read and write as strings without a cast. The alias names the format; it does not stop a plain string from being assigned.

For what the fields mean — status values, which relations expand, the query syntax — see the platform-api skill that ships with the Unimicro CLI.