Skip to main content
POST
/
entities
/
{entity_id}
/
reconciliation
/
compare
Penny-match external records against Arcus (4 resource types)
curl --request POST \
  --url https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_resource": "ar_aging_by_customer",
  "external_records": [
    {
      "external_id": "<string>",
      "total": 123
    }
  ],
  "external_source": "<string>",
  "tolerance_cents": 1
}
'
{
  "object": "reconciliation_compare_result",
  "matched": 123,
  "mismatched": 123,
  "missing_in_arcus": 123,
  "extra_in_arcus": 123,
  "mismatches": [
    {}
  ],
  "missing_in_arcus_records": [
    {}
  ],
  "extra_in_arcus_records": [
    {}
  ]
}

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.

Path Parameters

​
entity_id
string<uuid>
required

Body

application/json
​
external_resource
enum<string>
required
Available options:
ar_aging_by_customer,
ap_aging_by_vendor,
trial_balance_by_account,
resource_counts
​
external_records
object[]
required
Maximum array length: 5000
​
external_source
string | null
​
tolerance_cents
integer
default:1

Response

Comparison result

​
object
enum<string>
Available options:
reconciliation_compare_result
​
matched
integer
​
mismatched
integer
​
missing_in_arcus
integer
​
extra_in_arcus
integer
​
mismatches
object[]
​
missing_in_arcus_records
object[]
​
extra_in_arcus_records
object[]