Skip to main content
POST
/
ar
/
assess-late-fees
Assess late fees (finance charges)
curl --request POST \
  --url https://api.arcuserp.com/v1/ar/assess-late-fees \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dry_run": false
}
'
{
  "assessed": [
    {
      "source_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "late_fee_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_name": "<string>",
      "invoice_number": "<string>",
      "balance_due": 123,
      "fee_amount": 123,
      "days_overdue": 123,
      "compounding": "monthly"
    }
  ],
  "skipped": [
    {
      "source_order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reason": "<string>"
    }
  ],
  "total_fee_amount": 123,
  "dry_run": true
}

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.

Body

application/json
account_id
string<uuid> | null

Scope assessment to a single customer account. Omit to assess all eligible accounts.

dry_run
boolean
default:false

Preview mode: calculates fees and returns preview data without persisting any records or posting GL entries.

Response

Late fee assessment results

assessed
object[]

Invoices that received a finance charge

skipped
object[]

Invoices that were evaluated but skipped (exempt, already charged today, min not met, etc.)

total_fee_amount
number

Sum of all fee_amount values in the assessed array

dry_run
boolean

Reflects the dry_run parameter; true means no records were persisted