API Reference
Document Status: Placeholder - To be completed in Phase 4
Overview
LC DocCheck exposes a set of Azure Functions as HTTP endpoints for document processing and data retrieval.
Authentication
All API endpoints require Entra ID authentication. Include a valid Bearer token in the Authorization header.
Authorization: Bearer <access_token>
Endpoints
Sales Orders
GET /api/salesorders
Retrieve a list of sales orders.
Query Parameters:
| Parameter | Type | Description |
|---|---|---|
limit | number | Maximum records to return (default: 50) |
offset | number | Skip first N records |
status | string | Filter by status |
Response:
{
"items": [...],
"total": 100,
"limit": 50,
"offset": 0
}
GET /api/salesorders/{id}
Retrieve a single sales order with all nested documents.
Documents
POST /api/documents/upload
Request a SAS URL for document upload.
Request Body:
{
"salesOrderId": "uuid",
"documentType": "lc|pi|shipment",
"fileName": "document.pdf"
}
POST /api/documents/extract
Trigger AI extraction on an uploaded document.
Comparisons
POST /api/compare/lc-pi
Compare LC document against Proforma Invoice.
GET /api/compare/results/{id}
Retrieve comparison results.
Error Codes
| Code | Description |
|---|---|
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Missing or invalid token |
| 403 | Forbidden - Insufficient permissions |
| 404 | Not Found - Resource does not exist |
| 500 | Internal Server Error |
Rate Limits
- 100 requests per minute per user
- Document extraction: 10 concurrent requests