Trigger a sync now instead of waiting for the hourly cron (ADMIN+)

POST

/erp-connections/{connectionId}/sync

curl --request POST \
  --url https://api.invogi.com/v1/erp-connections/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/sync \
  --header 'Authorization: Bearer <token>'

Queued (202) when a Queue binding is configured, otherwise runs synchronously and returns the completed result (200).

Authorizations

• bearerAuth

Parameters

Path Parameters

connectionId

required

string format: uuid

Responses

200

Sync completed synchronously (no Queue binding)

Media typeapplication/json

object

sync_run_id

required

string format: uuid

status

required

string

Allowed value: COMPLETED

vendorsSeen

required

integer

invoicesSeen

required

integer

invoicesImported

required

integer

Example

{
  "status": "COMPLETED"
}

202

Sync queued

Media typeapplication/json

object

status

required

string

Allowed value: QUEUED

Example

{
  "status": "QUEUED"
}

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

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

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