Skip to main content

SourceDocumentResponse

successboolean

Indicates if the request was successful

Example: true
data object
sourceDocumentIdinteger

Database ID of the created source document

Example: 12345
filesUploadedinteger

Total number of files uploaded (including files extracted from ZIP archives)

Example: 3
pdfFilesQueuedinteger

Number of PDF files queued for processing

Example: 2
statusstring

Current processing status of the source document

Possible values: [processing]

Example: processing
messagestring

Human-readable success message

Example: Source document created and processing started
details object
uploadSessionIduuid

Unique identifier for this upload session

Example: 550e8400-e29b-41d4-a716-446655440000
uploadReferencestring

Human-readable upload reference for tracking

Example: API Upload - Sep 30, 2025 at 02:30 PM by api_user
companyCodestringnullable

Company code if provided in request

Example: COMP001
supplierCodestringnullable

Supplier code if provided in request

Example: SUPP123
totalPdfsinteger

Total number of PDF files found in upload

Example: 2
filesProcessedinteger

Number of PDF files successfully queued for processing

Example: 2
SourceDocumentResponse
{
  "success": true,
  "data": {
    "sourceDocumentId": 12345,
    "filesUploaded": 3,
    "pdfFilesQueued": 2,
    "status": "processing",
    "message": "Source document created and processing started",
    "details": {
      "uploadSessionId": "550e8400-e29b-41d4-a716-446655440000",
      "uploadReference": "API Upload - Sep 30, 2025 at 02:30 PM by api_user",
      "companyCode": "COMP001",
      "supplierCode": "SUPP123",
      "totalPdfs": 2,
      "filesProcessed": 2
    }
  }
}