Overview
The Uploads API provides functionality for managing:
- File uploads and storage
- Document management
- File validation
- Signature tracking
- Customer documents
Core Concepts
Document Types
| Type | Description |
|---|
tariffs | Tariff documents |
invoice | Invoice documents |
contract | Contract documents |
other | Other documents |
Document Properties
| Field | Description |
|---|
file_name | Name of file |
content | Base64 encoded data |
document_type | Type of document |
content_length | File size in bytes |
file_extension | File type |
Approval Flow
| Status | Description | Next States |
|---|
pending | Awaiting approval | approved, attached |
approved | Document approved | - |
attached | No approval needed | - |
Signature Flow
| Status | Description | Next States |
|---|
pending | Awaiting signatures | signed, not_required |
signed | Document signed | - |
not_required | No signature needed | - |
Validation Rules
File Rules
- Size: 512B to 20MB
- Types: PDF, JPEG, PNG
- Valid content type
- Valid extension
Approval Rules
- Required approvals set
- Valid approval count
- Status transitions
- Valid approvers
Signature Rules
- Required signatures set
- Valid signature count
- Status transitions
- Valid signers
Security Requirements
- File encryption required
- Size limits enforced
- Content validation
- Access control
- Audit logging
See individual endpoint documentation for detailed request/response formats and examples.
