Skip to content

List ERP connections and their five most recent sync runs, without exposing credentials (ADMIN+)

GET
/erp-connections
curl --request GET \
--url https://api.invogi.com/v1/erp-connections \
--header 'Authorization: Bearer <token>'

ERP connections

Media typeapplication/json
object
items
required
Array<object>
object
id
required
string format: uuid
provider
required
string
Allowed values: BUSINESS_CENTRAL ODOO XERO QUICKBOOKS_ONLINE
companyId
required
string format: uuid
companyName
required
string
config
required

Provider-specific, non-secret config as stored (credentials are never included)

object
key
additional properties
any
status
required
string
Allowed values: PENDING CONNECTED ERROR DISABLED
lastSyncedAt
required
string | null format: date-time
lastErrorMessage
required
string | null
createdAt
required
string format: date-time
recentRuns
required
Array<object>
object
id
required
string format: uuid
status
required
string
Allowed values: RUNNING COMPLETED FAILED
vendorsSeen
required
integer
invoicesSeen
required
integer
invoicesImported
required
integer
errorMessage
required
string | null
startedAt
required
string format: date-time
completedAt
required
string | null format: date-time
integrations_enabled
required

False on the free tier (no active subscription); creating

boolean
enterprise_integrations_enabled
required

True only when Business Central and Odoo may be created and synchronized under an active Enterprise subscription

boolean

Example

{
"items": [
{
"provider": "BUSINESS_CENTRAL",
"status": "PENDING",
"recentRuns": [
{
"status": "RUNNING"
}
]
}
]
}

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

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