Skip to content
Invogi Docs

Analyze a previously uploaded invoice document

POST
/invoices/from-upload
curl --request POST \
  --url https://api.invogi.com/v1/invoices/from-upload \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: respond-async' \
  --data '{ "upload_id": "example", "purchase_order_ref": "example", "company_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

Analyzes synchronously by default. Send Prefer: respond-async to request background analysis; when honored the response is UploadAnalysisQueued with Preference-Applied: respond-async, and progress is read from GET /uploads/{uploadId}/status.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
Prefer
string

Example 

respond-async

RFC 7240 preference. respond-async opts into queued analysis.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
upload_id
required
string
purchase_order_ref
string
company_id

Defaults to the default company

string format: uuid

Example generated

{
  "upload_id": "example",
  "purchase_order_ref": "example",
  "company_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Responses

Section titled “Responses”

202

Section titled “202”

Analysis result, or queued when Prefer: respond-async was honored

Media typeapplication/json
One of:
object
id
required
string format: uuid
status
required
string
Allowed value: COMPLETE
decision
required
string | null
Allowed values: PASS REVIEW BLOCK
risk_score
required
integer | null
<= 100

Example 

{
  "status": "COMPLETE",
  "decision": "PASS"
}

Headers

Section titled “Headers”
Preference-Applied
string

Present with respond-async only when the analysis was queued.

400

Section titled “400”

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}

401

Section titled “401”

Missing or invalid API key

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}

403

Section titled “403”

API key lacks required scope/role

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}

404

Section titled “404”

Resource not found

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}

409

Section titled “409”

Conflicting idempotency key or resource processing state

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}

429

Section titled “429”

Request-rate or customer-usage limit exceeded; inspect the stable error code

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: NOT_FOUND UNAUTHORIZED FORBIDDEN INVALID_REQUEST CONFLICT RATE_LIMITED USAGE_LIMIT_EXCEEDED PROCESSING_FAILED
message
required
string
request_id
required
string

Example 

{
  "error": {
    "code": "NOT_FOUND"
  }
}