Skip to main content
POST
/
entities
/
{entity_id}
/
migration
/
{resource}
/
bulk
Submit a bulk import job for a resource type
curl --request POST \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/migration/{resource}/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "records": [
    {}
  ],
  "external_source": "<string>",
  "conflict_mode": "skip"
}
'
{
  "object": "migration_dry_run_result",
  "dry_run": true,
  "resource": "<string>",
  "external_source": "<string>",
  "total_records": 123,
  "succeeded_records": 123,
  "failed_records": 123,
  "errors": [
    {}
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Headers

​
Idempotency-Key
string

Client-generated unique key for idempotent POST/PATCH/DELETE operations. Max 255 chars. On retry with the same key, the original response is returned without re-executing the operation. Keys expire after 24 hours. Pattern: or --.

Maximum string length: 255

Path Parameters

​
entity_id
string<uuid>
required
​
resource
enum<string>
required
Available options:
accounts,
products,
orders,
journal-entries,
vendor-bills,
ap-payments

Query Parameters

​
dry_run
boolean

If true, runs validation synchronously and returns results without any DB writes.

Body

application/json
​
records
object[]
required
Required array length: 1 - 1000 elements
​
external_source
string
required

Source system identifier (e.g. "versa", "quickbooks"). Required.

Maximum string length: 60
​
conflict_mode
enum<string>
default:skip

How to handle a record whose (external_source, external_id) already exists in Arcus.

  • skip: leave the existing record unchanged, count as success
  • update: call the canonical UPDATE handler with the incoming payload
  • replace: NULL out the existing record's provenance UNIQUE, then INSERT new record
  • error: abort the entire batch on the first collision (default if not specified: skip)
Available options:
skip,
update,
replace,
error

Response

Dry-run result (no writes made)

Dry-run result (200 response for ?dry_run=true). No DB writes made.

​
object
enum<string>
Available options:
migration_dry_run_result
​
dry_run
enum<boolean>
Available options:
true
​
resource
string
​
external_source
string
​
total_records
integer
​
succeeded_records
integer
​
failed_records
integer
​
errors
object[]