The NX Public API follows a consistent structure and set of conventions across all endpoints to ensure predictability, clarity, and data integrity.
Integrators should adhere to the standards outlined below when constructing requests and processing responses.
🕓 Date and Time Conventions
ISO DateTime Format
- All datetime values in the API are represented as ISO 8601 strings in UTC.
- "updatedAt": "2025-11-02T19:01:40.390Z"
- When parsing datetime fields, integrators should handle the full precision and timezone offset.
NX Date Format (ISO Date)
- YYYY-MM-DD
- "businessDate": "2025-11-02"
- Any request parameters or payloads that include a date value must use this format.
💰 Monetary Values
- All monetary amounts are represented in minor currency units (cents) to ensure precision and consistency.
- "total": 4481
This represents $44.81. - It is the responsibility of the integrator to convert values to standard decimal currency if needed for display or reporting purposes.
⚙️ Field Naming and Structure
- Field names use camelCase for JSON keys.
- Each record includes unique identifiers such as
id,metaId, or related configuration references (parentId,employeeId,venueId, etc.). - Boolean flags (e.g.,
isActive,voided,refunded) are always explicit and never omitted. - Arrays (
items,payments,taxes, etc.) are returned as empty arrays ([]) when no data exists — never asnull.
🧱 Data Relationships
- Relationships between entities are expressed using reference IDs rather than embedded objects.
For example:employeeIdlinks to an Employee record.venueIdlinks to a Venue record.payrollPeriodIdlinks to a Payroll Period record.
This allows for consistent and normalized data access across endpoints.
✅ Response Consistency
- All endpoints share consistent error handling and response structure conventions.
- Successful responses return
"status": "SUCCESS". - Errors return a structured JSON error response (see the “Error Handling” section of the documentation).