Analyze confirmed, normalized historical invoice rows

POST

/scans

curl --request POST \
  --url https://api.invogi.com/v1/scans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "companyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "rows": [ { "supplierName": "example", "supplierTaxId": "example", "invoiceNumber": "example", "issueDate": "2026-04-15", "currency": "GBP", "grossAmount": "example", "purchaseOrderRef": "example", "bankIban": "example", "bankSortCode": "60-16-13", "bankAccountNumber": "31926819", "externalId": "example", "sourceRowNumber": 1 } ] }'

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

companyId

Defaults to the default company

string format: uuid

rows

required

Array<object>

>= 1 items <= 5000 items

object

supplierName

required

string

supplierTaxId

string

invoiceNumber

required

string

issueDate

required

string format: date

currency

Optional. Rows without a currency are analysed in the organization’s base currency (a ledger export is in one functional currency).

string

/^[A-Za-z]{3}$/

grossAmount

required

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

purchaseOrderRef

string

bankIban

string

bankSortCode

UK sort code; used only together with bankAccountNumber

string

Example

60-16-13

bankAccountNumber

UK account number (6-8 digits); used only together with bankSortCode

string

Example

31926819

externalId

string

sourceRowNumber

required

integer

Responses

202

Scan created

Media typeapplication/json

object

id

required

string format: uuid

status

required

string

Allowed values: COMPLETE

invoicesAnalyzed

required

integer

>= 1

rowsSkipped

required

Rows not analyzed because their externalId was already imported or repeated in the file

integer

skippedRows

required

Array<object>

object

sourceRowNumber

required

integer

externalId

required

string

reason

required

string

Allowed values: ALREADY_IMPORTED DUPLICATE_EXTERNAL_ID_IN_FILE

analyzedValue

required

Total gross value of the analysed invoices in the organization’s base currency (analyzedValueCurrency). Invoices with no exchange rate are left out; see unconvertedInvoices.

string

/^-?[0-9]+(\.[0-9]{1,6})?$/

analyzedValueCurrency

required

string

>= 3 characters <= 3 characters

unconvertedInvoices

required

Analysed invoices not included in analyzedValue because no exchange rate was available

integer

decisionCounts

required

object

key

additional properties

integer

findingCounts

required

object

key

additional properties

integer

Example

{
  "status": "COMPLETE",
  "skippedRows": [
    {
      "reason": "ALREADY_IMPORTED"
    }
  ]
}

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

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

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

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