List open invoices for multi-invoice payment modal
curl --request GET \
--url https://api.arcuserp.com/v1/payments/multi-invoice-candidates \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.arcuserp.com/v1/payments/multi-invoice-candidates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.arcuserp.com/v1/payments/multi-invoice-candidates', 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/payments/multi-invoice-candidates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.arcuserp.com/v1/payments/multi-invoice-candidates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/payments/multi-invoice-candidates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/payments/multi-invoice-candidates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_number": "<string>",
"invoice_number": "<string>",
"invoice_status": "<string>",
"source_order_number": "<string>",
"order_total": 123,
"amount_paid": 123,
"balance_due": 123,
"document_type": "<string>",
"business_date": "2023-11-07T05:31:56Z",
"is_invoice_doc": true,
"due_date": "2023-12-25",
"payment_status": "<string>"
}
],
"meta": {
"count": 123,
"limit": 123,
"offset": 123,
"total_open_count": 123,
"total_open_amount": 123,
"search": "<string>",
"filtered_count": 123,
"filtered_amount": 123
}
}{
"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"
}Payments
List open invoices for multi-invoice payment modal
Returns open invoices (balance_due > 0, document_type IN (invoice, sales_order)) for a given account, sorted by due_date ASC, then by business date (COALESCE(invoice_date, order_date, created_at)) ASC, then created_at ASC. Each row carries invoice_number (NULL until the document is invoiced; the document’s own label is COALESCE(invoice_number, order_number)), business_date (the day the document was issued, which is NOT created_at for a migrated document) and is_invoice_doc (the two-mode invoice-document verdict). The LIST is paged (limit/offset); meta.total_open_count and meta.total_open_amount report the TRUE full-account open totals (unbounded by limit) so callers never mistake a capped page sum for the account balance. Pass search (order-number substring or amount prefix) to locate a specific document past the first page; meta.filtered_count / filtered_amount then describe the search-matched subset. Requires payments:read scope.
GET
/
payments
/
multi-invoice-candidates
List open invoices for multi-invoice payment modal
curl --request GET \
--url https://api.arcuserp.com/v1/payments/multi-invoice-candidates \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.arcuserp.com/v1/payments/multi-invoice-candidates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.arcuserp.com/v1/payments/multi-invoice-candidates', 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/payments/multi-invoice-candidates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.arcuserp.com/v1/payments/multi-invoice-candidates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.arcuserp.com/v1/payments/multi-invoice-candidates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.arcuserp.com/v1/payments/multi-invoice-candidates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"order_number": "<string>",
"invoice_number": "<string>",
"invoice_status": "<string>",
"source_order_number": "<string>",
"order_total": 123,
"amount_paid": 123,
"balance_due": 123,
"document_type": "<string>",
"business_date": "2023-11-07T05:31:56Z",
"is_invoice_doc": true,
"due_date": "2023-12-25",
"payment_status": "<string>"
}
],
"meta": {
"count": 123,
"limit": 123,
"offset": 123,
"total_open_count": 123,
"total_open_amount": 123,
"search": "<string>",
"filtered_count": 123,
"filtered_amount": 123
}
}{
"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
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.
Query Parameters
Account to list open invoices for.
Required range:
x <= 200Optional. Filters the list to open documents whose order number OR invoice number contains this string (case-insensitive), or whose balance_due starts with it. total_open_count/amount stay full-account; filtered_count/amount match this filter.
Maximum string length:
64Was this page helpful?