Docs

Get Extraction

GET /extractions/{extractionId}

GET/extractions/{extractionId}

Returns one extraction in full: target (order or expense), state (Pending, Matching, Ready, NoLineItems, Flagged, Failed or Committed), failure details, header fields, gate checks, groups, lines with proposed resource matches and rate card differences, adjustments, source page images and the original file. A discarded extraction is deleted, so it has no state. Requires EventAdmin on the event. The id comes from Orders_GetExtractions or Orders_CreateExtraction.

Path Parameters

FieldTypeRequiredDescription
extractionIduuidRequired

Response

FieldTypeDescription
iduuid
orderIduuid| null
expenseIduuid| null
statestring| null
createdAtdate-time
failedPhasestring| null
failureReasonstring| null
failureCodestring| null
documentTypestring| null
pricingLevelstring| null
matchedCollaboratorRecordIduuid| null
printedSubtotalnumber| null
printedTotalnumber| null
receivedDatedate-time| null
pageCountinteger
modelTierUsedstring| null
committedOrderDocumentIduuid| null
gateGetFinancialDocumentExtractionResponseGateInfo| null
groupsGetFinancialDocumentExtractionResponseGroup[]| null
linesGetFinancialDocumentExtractionResponseLine[]| null
adjustmentsGetFinancialDocumentExtractionResponseAdjustment[]| null
sourcePagesGetFinancialDocumentExtractionResponseSourcePage[]| null
originalFileGetFinancialDocumentExtractionResponseOriginalFileInfo| null

GetFinancialDocumentExtractionResponseGateInfo

FieldTypeDescription
tieOutPassedboolean
tieOutDeltanumber| null
tieOutBasisstring| null
tieOutApplicableboolean
traceabilityPassedboolean
untraceableLineCountinteger
rowCountWarningboolean
detectedRowCountinteger| null
bestTableAdjustedRowCountinteger| null
emittedLineCountinteger
evaluatedAtdate-time
allPassedboolean

GetFinancialDocumentExtractionResponseGroup

FieldTypeDescription
iduuid
namestring| null
subtotalnumber
indexinteger

GetFinancialDocumentExtractionResponseLine

FieldTypeDescription
iduuid
indexinteger
descriptionstring| null
quantitynumber
unitPricenumber
lineTotalnumber
extractedFinancialLineGroupIduuid| null
sourcePageNumberinteger
isTraceableboolean
isBalanceLineboolean
matchStatestring| null
proposedResourceTypeIduuid| null
proposedResourceVariantIduuid| null
proposedResourceNamestring| null
proposedResourceVariantNamestring| null
procurementResourceIduuid| null
matchSourcestring| null
userEditedboolean
rateCardDifferenceGetFinancialDocumentExtractionResponseRateCardDifferenceInfo| null
kindstring| null

GetFinancialDocumentExtractionResponseAdjustment

FieldTypeDescription
typestring| null
labelstring| null
amountnumber

GetFinancialDocumentExtractionResponseSourcePage

FieldTypeDescription
pageNumberinteger
uriuri| null

GetFinancialDocumentExtractionResponseOriginalFileInfo

FieldTypeDescription
fileIduuid
fileNamestring| null

GetFinancialDocumentExtractionResponseRateCardDifferenceInfo

FieldTypeDescription
currentCostnumber
extractedCostnumber
decisionstring| null
canBackfillboolean