Skip to content
Invogi Docs

List scans for the authenticated organization, newest first

GET
/scans
curl --request GET \
  --url 'https://api.invogi.com/v1/scans?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
integer
default: 50 >= 1 <= 200
offset
integer
0
status
Array<string>
Allowed values: CREATED UPLOADED MAPPING_REQUIRED IMPORTING ANALYZING COMPLETE FAILED
company_id
string format: uuid
from
string format: date
to
string format: date

Responses

Section titled “Responses”

200

Section titled “200”

A page of scans matching any selected status

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
status
required
string
Allowed values: CREATED UPLOADED MAPPING_REQUIRED IMPORTING ANALYZING COMPLETE FAILED
rowCount
integer | null
companyId

Detail only: the company the scan imported into

string format: uuid
source

FILE: rows posted to POST /scans. ERP: a free read-only scan of Xero or QuickBooks Online bills (POST /erp-connections/oauth/start with mode SCAN)

string
Allowed values: FILE ERP
erpProvider

List only: the ERP scan’s provider

string | null
historyFrom

ERP scans: bills issued on or after this date were read

string | null format: date
invoicesFound

ERP scans: bills found in the window; above rowCount when the free allowance covered only the most recent

integer | null
errorMessage

ERP scans: why the scan FAILED

string | null
erpConnection
One of:
null
createdAt
string format: date-time
completedAt
string | null format: date-time
total
required
integer
limit
required
integer
offset
required
integer

Example 

{
  "items": [
    {
      "status": "CREATED",
      "source": "FILE",
      "erpConnection": {
        "provider": "XERO",
        "mode": "SYNC",
        "status": "PENDING"
      }
    }
  ]
}

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