Skip to content
Invogi Docs

Get the server-authoritative executive summary for a scan

GET
/scans/{scanId}/summary
curl --request GET \
  --url https://api.invogi.com/v1/scans/example/summary \
  --header 'Authorization: Bearer <token>'

Potential exposure includes only current duplicate candidates, once per invoice. Verified benefit includes only prevented outcomes and verified recovery (cash received or credit applied) on findings that are still confirmed.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
scanId
required
string

Responses

Section titled “Responses”

200

Section titled “200”

Executive AP control-check summary

Media typeapplication/json
object
scan
required
object
id
required
string format: uuid
status
required
string
Allowed values: CREATED UPLOADED MAPPING_REQUIRED IMPORTING ANALYZING COMPLETE FAILED
source
required
string
Allowed values: FILE ERP
rowCount
required
integer | null
companyId
required
string format: uuid
companyName
required
string
createdAt
required
string format: date-time
completedAt
required
string | null format: date-time
baseCurrency
required

ISO 4217 alphabetic currency code, case-insensitive and stored upper-case. A code that is not a currency suppliers invoice in (including XXX, funds and precious-metal codes) is rejected with INVALID_REQUEST. Invoices whose currency cannot be read from an uploaded document are stored with the ISO placeholder XXX and raise a CURRENCY_UNKNOWN finding.

string
/^[A-Za-z]{3}$/
invoicesAnalyzed
required
integer
decisionCounts
required
object
PASS
required
integer
REVIEW
required
integer
BLOCK
required
integer
findingCounts
required
object
total
required
integer
open
required
integer
confirmed
required
integer
cleanInvoices
required
integer
flaggedInvoices
required
integer
highRiskExceptions
required
integer
supplierBankAnomalies
required
integer
potentialDuplicateExposure
required
object
inBase
required
object
grossAmount
required
string
/^-?[0-9]+(\.[0-9]{1,6})?$/
count
required
integer
unconvertedCount
required
integer
byCurrency
required
Array<object>
object
currency
required

ISO 4217 alphabetic currency code, case-insensitive and stored upper-case. A code that is not a currency suppliers invoice in (including XXX, funds and precious-metal codes) is rejected with INVALID_REQUEST. Invoices whose currency cannot be read from an uploaded document are stored with the ISO placeholder XXX and raise a CURRENCY_UNKNOWN finding.

string
/^[A-Za-z]{3}$/
grossAmount
required
string
/^-?[0-9]+(\.[0-9]{1,6})?$/
count
required
integer
paymentEvidence
One of:
null
unusedSupplierCredits

Supplier credits this scan read from Xero or QuickBooks that are still unused 30+ days after issue and flagged (open, confirmed or accepted), at their unused balance. Empty for file scans.

object
inBase
required
object
grossAmount
required
string
/^-?[0-9]+(\.[0-9]{1,6})?$/
count
required
integer
unconvertedCount
required
integer
byCurrency
required
Array<object>
object
currency
required

ISO 4217 alphabetic currency code, case-insensitive and stored upper-case. A code that is not a currency suppliers invoice in (including XXX, funds and precious-metal codes) is rejected with INVALID_REQUEST. Invoices whose currency cannot be read from an uploaded document are stored with the ISO placeholder XXX and raise a CURRENCY_UNKNOWN finding.

string
/^[A-Za-z]{3}$/
grossAmount
required
string
/^-?[0-9]+(\.[0-9]{1,6})?$/
count
required
integer
verifiedBenefit
required

Prevented outcomes on this scan’s invoices, plus verified recovery (active applications) on recovery cases sourced from its invoices or payments.

object
inBase
required
object
grossAmount
required
string
/^-?[0-9]+(\.[0-9]{1,6})?$/
count
required
integer
unconvertedCount
required
integer
byCurrency
required
Array<object>
object
currency
required

ISO 4217 alphabetic currency code, case-insensitive and stored upper-case. A code that is not a currency suppliers invoice in (including XXX, funds and precious-metal codes) is rejected with INVALID_REQUEST. Invoices whose currency cannot be read from an uploaded document are stored with the ISO placeholder XXX and raise a CURRENCY_UNKNOWN finding.

string
/^[A-Za-z]{3}$/
grossAmount
required
string
/^-?[0-9]+(\.[0-9]{1,6})?$/
count
required
integer
topFindings
required
Array<object>
<= 3 items
object
id
required
string format: uuid
invoiceId
required
string | null format: uuid
invoiceNumber
required
string
supplierName
required
string | null
type
required
string
severity
required
string
Allowed values: INFO LOW MEDIUM HIGH CRITICAL
confidence
required

Decimal confidence from 0 to 1

string | null
summary
required
string
recommendedAction
required
string | null
evidence
required
object
key
additional properties
any
disposition
required
string
Allowed values: OPEN CONFIRMED ACCEPTED_RISK
decision
required
string | null
Allowed values: PASS REVIEW BLOCK
amount
required
string
/^-?[0-9]+(\.[0-9]{1,6})?$/
currency
required

ISO 4217 alphabetic currency code, case-insensitive and stored upper-case. A code that is not a currency suppliers invoice in (including XXX, funds and precious-metal codes) is rejected with INVALID_REQUEST. Invoices whose currency cannot be read from an uploaded document are stored with the ISO placeholder XXX and raise a CURRENCY_UNKNOWN finding.

string
/^[A-Za-z]{3}$/
dataCoverage
required
object
supplierTaxId
required
object
count
required
integer
total
required
integer
bankDetails
required
object
count
required
integer
total
required
integer
purchaseOrderReference
required
object
count
required
integer
total
required
integer
matchedPurchaseOrder
required
object
count
required
integer
total
required
integer
fxConverted
required
object
count
required
integer
total
required
integer

Example 

{
  "scan": {
    "status": "CREATED",
    "source": "FILE"
  },
  "baseCurrency": "GBP",
  "potentialDuplicateExposure": {
    "byCurrency": [
      {
        "currency": "GBP"
      }
    ]
  },
  "paymentEvidence": {
    "paymentBackedCandidates": {
      "byCurrency": [
        {
          "currency": "GBP"
        }
      ]
    }
  },
  "unusedSupplierCredits": {
    "byCurrency": [
      {
        "currency": "GBP"
      }
    ]
  },
  "verifiedBenefit": {
    "byCurrency": [
      {
        "currency": "GBP"
      }
    ]
  },
  "topFindings": [
    {
      "severity": "INFO",
      "disposition": "OPEN",
      "decision": "PASS",
      "currency": "GBP"
    }
  ]
}

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"
  }
}

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"
  }
}