GetExpenseAnalysis
Gets the results for an Amazon Textract asynchronous operation that analyzes invoices and receipts. Amazon Textract finds contact information, items purchased, and vendor name, from input invoices and receipts.
You start asynchronous invoice/receipt analysis by calling StartExpenseAnalysis, which returns a job identifier (JobId). Upon
completion of the invoice/receipt analysis, Amazon Textract publishes the completion status to the
Amazon Simple Notification Service (Amazon SNS) topic. This topic must be registered in the initial call to
StartExpenseAnalysis. To get the results of the invoice/receipt analysis operation,
first ensure that the status value published to the Amazon SNS topic is SUCCEEDED. If so,
call GetExpenseAnalysis, and pass the job identifier (JobId) from the
initial call to StartExpenseAnalysis.
Use the MaxResults parameter to limit the number of blocks that are returned. If there are
more results than specified in MaxResults, the value of NextToken in
the operation response contains a pagination token for getting the next set of results. To get
the next page of results, call GetExpenseAnalysis, and populate the
NextToken request parameter with the token value that's returned from the previous
call to GetExpenseAnalysis.
For more information, see Analyzing Invoices and Receipts.
Request Syntax
{
"JobId": "string",
"MaxResults": number,
"NextToken": "string"
}Request Parameters
The request accepts the following data in JSON format.
- JobId
-
A unique identifier for the text detection job. The
JobIdis returned fromStartExpenseAnalysis. AJobIdvalue is only valid for 7 days.Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[a-zA-Z0-9-_]+$Required: Yes
- MaxResults
-
The maximum number of results to return per paginated call. The largest value you can specify is 20. If you specify a value greater than 20, a maximum of 20 results is returned. The default value is 20.
Type: Integer
Valid Range: Minimum value of 1.
Required: No
- NextToken
-
If the previous response was incomplete (because there are more blocks to retrieve), Amazon Textract returns a pagination token in the response. You can use this pagination token to retrieve the next set of blocks.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*\S.*Required: No
Response Syntax
{
"AnalyzeExpenseModelVersion": "string",
"DocumentMetadata": {
"Pages": number
},
"ExpenseDocuments": [
{
"Blocks": [
{
"BlockType": "string",
"ColumnIndex": number,
"ColumnSpan": number,
"Confidence": number,
"EntityTypes": [ "string" ],
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Id": "string",
"Page": number,
"Query": {
"Alias": "string",
"Pages": [ "string" ],
"Text": "string"
},
"Relationships": [
{
"Ids": [ "string" ],
"Type": "string"
}
],
"RowIndex": number,
"RowSpan": number,
"SelectionStatus": "string",
"Text": "string",
"TextType": "string"
}
],
"ExpenseIndex": number,
"LineItemGroups": [
{
"LineItemGroupIndex": number,
"LineItems": [
{
"LineItemExpenseFields": [
{
"Currency": {
"Code": "string",
"Confidence": number
},
"GroupProperties": [
{
"Id": "string",
"Types": [ "string" ]
}
],
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
}
}
]
}
]
}
],
"SummaryFields": [
{
"Currency": {
"Code": "string",
"Confidence": number
},
"GroupProperties": [
{
"Id": "string",
"Types": [ "string" ]
}
],
"LabelDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
},
"PageNumber": number,
"Type": {
"Confidence": number,
"Text": "string"
},
"ValueDetection": {
"Confidence": number,
"Geometry": {
"BoundingBox": {
"Height": number,
"Left": number,
"Top": number,
"Width": number
},
"Polygon": [
{
"X": number,
"Y": number
}
]
},
"Text": "string"
}
}
]
}
],
"JobStatus": "string",
"NextToken": "string",
"StatusMessage": "string",
"Warnings": [
{
"ErrorCode": "string",
"Pages": [ number ]
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- AnalyzeExpenseModelVersion
-
The current model version of AnalyzeExpense.
Type: String
- DocumentMetadata
-
Information about a document that Amazon Textract processed.
DocumentMetadatais returned in every page of paginated responses from an Amazon Textract operation.Type: DocumentMetadata object
- ExpenseDocuments
-
The expenses detected by Amazon Textract.
Type: Array of ExpenseDocument objects
- JobStatus
-
The current status of the text detection job.
Type: String
Valid Values:
IN_PROGRESS | SUCCEEDED | FAILED | PARTIAL_SUCCESS - NextToken
-
If the response is truncated, Amazon Textract returns this token. You can use this token in the subsequent request to retrieve the next set of text-detection results.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
.*\S.* - StatusMessage
-
Returns if the detection job could not be completed. Contains explanation for what error occured.
Type: String
- Warnings
-
A list of warnings that occurred during the text-detection operation for the document.
Type: Array of Warning objects
Errors
- AccessDeniedException
-
You aren't authorized to perform the action. Use the Amazon Resource Name (ARN) of an authorized user or IAM role to perform the operation.
HTTP Status Code: 400
- InternalServerError
-
Amazon Textract experienced a service issue. Try your call again.
HTTP Status Code: 500
- InvalidJobIdException
-
An invalid job identifier was passed to an asynchronous analysis operation.
HTTP Status Code: 400
- InvalidKMSKeyException
-
Indicates you do not have decrypt permissions with the KMS key entered, or the KMS key was entered incorrectly.
HTTP Status Code: 400
- InvalidParameterException
-
An input parameter violated a constraint. For example, in synchronous operations, an
InvalidParameterExceptionexception occurs when neither of theS3ObjectorBytesvalues are supplied in theDocumentrequest parameter. Validate your parameter before calling the API operation again.HTTP Status Code: 400
- InvalidS3ObjectException
-
Amazon Textract is unable to access the S3 object that's specified in the request. for more information, Configure Access to Amazon S3 For troubleshooting information, see Troubleshooting Amazon S3
HTTP Status Code: 400
- ProvisionedThroughputExceededException
-
The number of requests exceeded your throughput limit. If you want to increase this limit, contact Amazon Textract.
HTTP Status Code: 400
- ThrottlingException
-
Amazon Textract is temporarily unable to process the request. Try your call again.
HTTP Status Code: 500
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
