ReferenceData Types

Data Types

This page documents the common data types used across the Parsify API.

UUIDs

All resource identifiers are UUID v4 strings.

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

UUIDs are assigned by the server on creation and are immutable. Always treat IDs as opaque strings — do not parse or derive meaning from their structure.

Timestamps

All timestamps are returned in ISO 8601 format in UTC, using the Z suffix.

{
  "created_at": "2024-01-16T10:00:00Z",
  "updated_at": "2024-01-16T14:30:00Z"
}

When sending timestamps in request bodies (e.g., date filters), use the same ISO 8601 format. The API will reject non-UTC timestamps.

Monetary Values

All monetary values are represented as decimal strings with exactly two decimal places.

{
  "gross_pay": "5000.00",
  "net_pay": "3750.50",
  "tax_withheld": "1249.50"
}

Monetary values are returned as strings rather than floating-point numbers to avoid precision loss. Use a decimal library in your application when performing arithmetic on these values.

Pagination Envelope

All list endpoints return a paginated response envelope. See the Pagination page for full details.

{
  "count": 142,
  "next": "https://api.parsifyhq.com/api/v1/documents/?page=2",
  "previous": null,
  "results": [...]
}

Enums

String enum fields (such as job status) are documented on each endpoint’s reference page. Enum values are always lowercase and use underscores as separators (e.g., "in_progress", "completed", "failed").

PaginationIndex