PATCH/extractions/{extractionId}
Overwrites the extraction's header (document type, pricing level of Line, Group or Document, vendor, printed
subtotal and total, received date), so send the complete header, and returns the updated extraction.
Adjustments: omit to leave them, send an empty list to clear them, or send a list to replace them. Only while
the extraction is Ready, Flagged or NoLineItems. Requires EventAdmin on the event.
Path Parameters
| Field | Type | Required | Description |
|---|
| extractionId | uuid | Required | |
Request Body
| Field | Type | Required | Description |
|---|
| documentType | string | Optional | |
| pricingLevel | string | Optional | |
| matchedCollaboratorRecordId | uuid | Optional | |
| printedSubtotal | number | Optional | |
| printedTotal | number | Optional | |
| receivedDate | date-time | Optional | |
| adjustments | UpdateFinancialDocumentExtractionRequestAdjustment[] | Optional | |
| Field | Type | Description |
|---|
| type | string| null | |
| label | string| null | |
| amount | number | |
Response
| Field | Type | Description |
|---|
| id | uuid | |
| orderId | uuid| null | |
| expenseId | uuid| null | |
| state | string| null | |
| createdAt | date-time | |
| failedPhase | string| null | |
| failureReason | string| null | |
| failureCode | string| null | |
| documentType | string| null | |
| pricingLevel | string| null | |
| matchedCollaboratorRecordId | uuid| null | |
| printedSubtotal | number| null | |
| printedTotal | number| null | |
| receivedDate | date-time| null | |
| pageCount | integer | |
| modelTierUsed | string| null | |
| committedOrderDocumentId | uuid| null | |
| gate | GetFinancialDocumentExtractionResponseGateInfo| null | |
| groups | GetFinancialDocumentExtractionResponseGroup[]| null | |
| lines | GetFinancialDocumentExtractionResponseLine[]| null | |
| adjustments | GetFinancialDocumentExtractionResponseAdjustment[]| null | |
| sourcePages | GetFinancialDocumentExtractionResponseSourcePage[]| null | |
| originalFile | GetFinancialDocumentExtractionResponseOriginalFileInfo| null | |
| Field | Type | Description |
|---|
| tieOutPassed | boolean | |
| tieOutDelta | number| null | |
| tieOutBasis | string| null | |
| tieOutApplicable | boolean | |
| traceabilityPassed | boolean | |
| untraceableLineCount | integer | |
| rowCountWarning | boolean | |
| detectedRowCount | integer| null | |
| bestTableAdjustedRowCount | integer| null | |
| emittedLineCount | integer | |
| evaluatedAt | date-time | |
| allPassed | boolean | |
| Field | Type | Description |
|---|
| id | uuid | |
| name | string| null | |
| subtotal | number | |
| index | integer | |
| Field | Type | Description |
|---|
| id | uuid | |
| index | integer | |
| description | string| null | |
| quantity | number | |
| unitPrice | number | |
| lineTotal | number | |
| extractedFinancialLineGroupId | uuid| null | |
| sourcePageNumber | integer | |
| isTraceable | boolean | |
| isBalanceLine | boolean | |
| matchState | string| null | |
| proposedResourceTypeId | uuid| null | |
| proposedResourceVariantId | uuid| null | |
| proposedResourceName | string| null | |
| proposedResourceVariantName | string| null | |
| procurementResourceId | uuid| null | |
| matchSource | string| null | |
| userEdited | boolean | |
| rateCardDifference | GetFinancialDocumentExtractionResponseRateCardDifferenceInfo| null | |
| kind | string| null | |
| Field | Type | Description |
|---|
| type | string| null | |
| label | string| null | |
| amount | number | |
| Field | Type | Description |
|---|
| pageNumber | integer | |
| uri | uri| null | |
| Field | Type | Description |
|---|
| fileId | uuid | |
| fileName | string| null | |
| Field | Type | Description |
|---|
| currentCost | number | |
| extractedCost | number | |
| decision | string| null | |
| canBackfill | boolean | |