Skip to main content
POST
/
reporting-schedules
Create a scheduled report delivery
curl --request POST \
  --url https://api.arcuserp.com/v1/reporting-schedules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "report_type": "<string>",
  "params": {},
  "cadence": "monthly",
  "day_of_week": 123,
  "day_of_month": 123,
  "send_time": "06:00",
  "time_zone": "UTC",
  "recipients": [
    "<string>"
  ],
  "format": "csv",
  "message": "<string>"
}
'
import requests

url = "https://api.arcuserp.com/v1/reporting-schedules"

payload = {
"name": "<string>",
"report_type": "<string>",
"params": {},
"cadence": "monthly",
"day_of_week": 123,
"day_of_month": 123,
"send_time": "06:00",
"time_zone": "UTC",
"recipients": ["<string>"],
"format": "csv",
"message": "<string>"
}
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({
name: '<string>',
report_type: '<string>',
params: {},
cadence: 'monthly',
day_of_week: 123,
day_of_month: 123,
send_time: '06:00',
time_zone: 'UTC',
recipients: ['<string>'],
format: 'csv',
message: '<string>'
})
};

fetch('https://api.arcuserp.com/v1/reporting-schedules', 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/reporting-schedules",
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([
'name' => '<string>',
'report_type' => '<string>',
'params' => [

],
'cadence' => 'monthly',
'day_of_week' => 123,
'day_of_month' => 123,
'send_time' => '06:00',
'time_zone' => 'UTC',
'recipients' => [
'<string>'
],
'format' => 'csv',
'message' => '<string>'
]),
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/reporting-schedules"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"report_type\": \"<string>\",\n \"params\": {},\n \"cadence\": \"monthly\",\n \"day_of_week\": 123,\n \"day_of_month\": 123,\n \"send_time\": \"06:00\",\n \"time_zone\": \"UTC\",\n \"recipients\": [\n \"<string>\"\n ],\n \"format\": \"csv\",\n \"message\": \"<string>\"\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/reporting-schedules")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"report_type\": \"<string>\",\n \"params\": {},\n \"cadence\": \"monthly\",\n \"day_of_week\": 123,\n \"day_of_month\": 123,\n \"send_time\": \"06:00\",\n \"time_zone\": \"UTC\",\n \"recipients\": [\n \"<string>\"\n ],\n \"format\": \"csv\",\n \"message\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/reporting-schedules")

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 \"name\": \"<string>\",\n \"report_type\": \"<string>\",\n \"params\": {},\n \"cadence\": \"monthly\",\n \"day_of_week\": 123,\n \"day_of_month\": 123,\n \"send_time\": \"06:00\",\n \"time_zone\": \"UTC\",\n \"recipients\": [\n \"<string>\"\n ],\n \"format\": \"csv\",\n \"message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "reporting_schedule",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "report_type": "<string>",
  "params": {},
  "day_of_week": 123,
  "day_of_month": 123,
  "send_time": "<string>",
  "time_zone": "<string>",
  "recipients": [
    "<string>"
  ],
  "message": "<string>",
  "is_active": true,
  "last_run_at": "2023-11-07T05:31:56Z",
  "last_run_status": "<string>",
  "next_run_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"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.

Body

application/json
name
string
required
Maximum string length: 200
report_type
string
required

Report identifier (e.g. sales_by_product, ar_aging).

params
object

Report parameter map.

cadence
enum<string>
default:monthly
Available options:
daily,
weekly,
monthly
day_of_week
integer | null

0-6 for weekly cadence.

day_of_month
integer | null

1-31 for monthly cadence.

send_time
string
default:06:00

HH:MM local send time.

time_zone
string
default:UTC
recipients
string[]

Recipient email addresses.

format
enum<string>
default:csv
Available options:
csv,
pdf,
xlsx
message
string | null

Response

Reporting schedule created.

A scheduled report delivery (cadence, recipients, format). Mirrors public.reporting_schedules.

id
string<uuid>
object
enum<string>
Available options:
reporting_schedule
entity_id
string<uuid>
name
string
report_type
string
params
object
cadence
enum<string>
Available options:
daily,
weekly,
monthly
day_of_week
integer | null
day_of_month
integer | null
send_time
string
time_zone
string
recipients
string[]
format
enum<string>
Available options:
csv,
pdf,
xlsx
message
string | null
is_active
boolean
last_run_at
string<date-time> | null
last_run_status
string | null
next_run_at
string<date-time> | null
created_at
string<date-time>
updated_at
string<date-time>