Skip to main content
POST
/
entities
/
{entity_id}
/
migration
/
counters
/
advance
curl --request POST \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/migration/counters/advance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "counter_type": "invoice",
  "advance_to": 342665
}
'
{
  "object": "migration_counter_advance_result",
  "total": 123,
  "succeeded": 123,
  "failed": 123,
  "results": [
    {
      "counter_type": "<string>",
      "previous_value": 123,
      "current_value": 123,
      "prefix": "<string>",
      "padding": 123,
      "version": 123,
      "advanced": true,
      "next_issued_preview": "<string>",
      "error": "<string>",
      "code": "<string>"
    }
  ]
}

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

Optional idempotency key. If supplied, retrying the same call within 24 hours returns the previous result.

Path Parameters

​
entity_id
string<uuid>
required

Body

application/json

Single-counter advance payload.

​
counter_type
string
required

One of the counter_type enum values: order, invoice, quote, po, rma, journal, account, vendor_bill, ap_payment, check, transfer, vendor_return, refund, inventory_txn, work_order, fixed_asset, lease, lease_payment, deposit, vendor_credit, payment_batch.

Example:

"invoice"

​
advance_to
integer
required

New current_value for the counter. Next-issued = advance_to + 1. Must be >= existing current_value (monotonic; decrement not allowed).

Required range: x >= 0
Example:

342665

​
prefix
string

Required only when creating a new counter row (entity does not have one yet). Existing rows preserve their prefix.

Maximum string length: 20
​
padding
integer

Optional. Used only when creating a new counter row. Defaults to 7.

Required range: 1 <= x <= 12

Response

Counter advance result

Result envelope for counter advance. Each row in results reports independently; a failure on one counter does not roll back the others.

​
object
enum<string>
Available options:
migration_counter_advance_result
​
total
integer
​
succeeded
integer
​
failed
integer
​
results
object[]