Standard input file/ API status and CCR platform status

Credit Clear (CCR) platform statuses for an invoice are categorized as:

Awaiting Payment
On Payment Arrangement
Paid
Voided

The standard input file and sync API support following statuses:

Active
Hold
Closed

These statuses are auto-mapped to CCR platform statuses, simplifying integration for clients by eliminating the need to manage CCR statuses manually.

This document explains how the Status field from a standard input file or API is interpreted and mapped to internal invoice statuses within the Credit Clear system.

Incoming status from input file/ API	Existing status in CCR platform	Is invoice paused?	Action
Active	N/A (Invoice does not exist in system)	N/A	Create new account/invoice
Active	Awaiting Payment	No	As per client's account sync settings Default: Update invoice
Active	On Payment Arrangement	No	Update invoice
Active	Awaiting Payment or On Payment Arrangement	Yes	Update invoice then un-pause invoice
Active	Voided or Paid	N/A	As per client's account sync settings Default: Create new invoice
Hold	N/A (Invoice does not exist in system)	N/A	Ignore
Hold	Awaiting Payment or On Payment Arrangement	Yes	Update invoice
Hold	Awaiting Payment or On Payment Arrangement	No	Update invoice then pause
Hold	Voided or Paid	N/A	Ignore
Closed	N/A (Invoice does not exist in system)	N/A	Ignore
Closed	Awaiting Payment	N/A	Void invoice
Closed	On Payment Arrangement	N/A	Void invoice and cancel payment arrangement
Closed	Voided or Paid	N/A	No action

📘
Note: To understand and explore account sync settings options, please reach out to Credit Clear support.

📘Note: To understand and explore account sync settings options, please reach out to Credit Clear support.

📘
Note: To understand and explore account sync settings options, please reach out to Credit Clear support.