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_records": [
    {
      "external_id": "<string>",
      "total": 123
    }
  ],
  "external_source": "<string>",
  "tolerance_cents": 1
}
'

import requests

url = "https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare"

payload = {
    "external_records": [
        {
            "external_id": "<string>",
            "total": 123
        }
    ],
    "external_source": "<string>",
    "tolerance_cents": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    external_records: [{external_id: '<string>', total: 123}],
    external_source: '<string>',
    tolerance_cents: 1
  })
};

fetch('https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'external_records' => [
        [
                'external_id' => '<string>',
                'total' => 123
        ]
    ],
    'external_source' => '<string>',
    'tolerance_cents' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare"

	payload := strings.NewReader("{\n  \"external_records\": [\n    {\n      \"external_id\": \"<string>\",\n      \"total\": 123\n    }\n  ],\n  \"external_source\": \"<string>\",\n  \"tolerance_cents\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_records\": [\n    {\n      \"external_id\": \"<string>\",\n      \"total\": 123\n    }\n  ],\n  \"external_source\": \"<string>\",\n  \"tolerance_cents\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_records\": [\n    {\n      \"external_id\": \"<string>\",\n      \"total\": 123\n    }\n  ],\n  \"external_source\": \"<string>\",\n  \"tolerance_cents\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "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": [
    {}
  ]
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

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_records": [
    {
      "external_id": "<string>",
      "total": 123
    }
  ],
  "external_source": "<string>",
  "tolerance_cents": 1
}
'

import requests

url = "https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare"

payload = {
    "external_records": [
        {
            "external_id": "<string>",
            "total": 123
        }
    ],
    "external_source": "<string>",
    "tolerance_cents": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    external_records: [{external_id: '<string>', total: 123}],
    external_source: '<string>',
    tolerance_cents: 1
  })
};

fetch('https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'external_records' => [
        [
                'external_id' => '<string>',
                'total' => 123
        ]
    ],
    'external_source' => '<string>',
    'tolerance_cents' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare"

	payload := strings.NewReader("{\n  \"external_records\": [\n    {\n      \"external_id\": \"<string>\",\n      \"total\": 123\n    }\n  ],\n  \"external_source\": \"<string>\",\n  \"tolerance_cents\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"external_records\": [\n    {\n      \"external_id\": \"<string>\",\n      \"total\": 123\n    }\n  ],\n  \"external_source\": \"<string>\",\n  \"tolerance_cents\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/entities/{entity_id}/reconciliation/compare")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"external_records\": [\n    {\n      \"external_id\": \"<string>\",\n      \"total\": 123\n    }\n  ],\n  \"external_source\": \"<string>\",\n  \"tolerance_cents\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "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": [
    {}
  ]
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

{
  "error": "not_found",
  "code": "not_found",
  "type": "not_found",
  "hint": "The requested order does not exist or does not belong to this entity.",
  "param": "expand[0]",
  "required": "accounts:read",
  "request_id": "req_abc123"
}

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

Show child attributes

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[]

Overview

All Endpoints

Penny-match external records against Arcus (4 resource types)

Authorizations

Path Parameters

Body

Response