Skip to content
More support Support portal
Contact us
  • There are no suggestions because the search field is empty.

General Settings in quickclaim

General Settings

General settings are stored per organisation in the GeneralSettings table as settingName / settingValue pairs.

For boolean settings, the application treats only the exact string "true" as enabled.

Value

Behaviour

"true"

Enabled

"false"

Disabled

Missing

Disabled (unless the code provides a default)

Any other value

Disabled
issueInvoiceForUnpaidClaims

Controls when invoices are created for Agency claims.

Behaviour

false (default behaviour)

The system waits until the NDIS claim detail has been received before issuing invoices.

After claim detail is successfully processed as PAID, transactions of that claim move to:

 
IN_PROGRESS → PENDING_ISSUE_INVOICE

true

Invoices are issued immediately after the claim batch is submitted, before the NDIS payment outcome is known.

Once claim detail is received:

  • successfully paid claims are generally closed as PAID
  • invoice generation has already occurred

This is why the setting is called "issue invoice for unpaid claims"—the invoice is created while the claim is still awaiting an NDIS payment result.

adjustmentConfig

Determines how price-capped claims are handled.

Note

This setting only has an effect when issueInvoiceForUnpaidClaims is also enabled.

Behaviour

Both settings = true

If NDIS pays less than the claimed amount due to price capping:

  • the transaction is routed to Invoice Adjustment
  • the adjustment process uses:
    • the previously issued invoice
    • the actual amount paid
  • an adjustment invoice is generated

adjustmentConfig = false

Price-capped claims are not sent through Invoice Adjustment.

Instead they are treated as successfully completed and paid after claim detail processing.

NDIS cancellations

NDIS cancellations are handled independently of this setting.

Scenario

Behaviour

Invoice already exists

Always sent to Invoice Adjustment

No invoice exists

Transaction is rejected

 
claimingGroupByExpression

Controls how Agency claim invoices are grouped.

The value is a comma-separated list of transaction fields.

Example:

 
ndisNumber

or

 
participantId,financialContact.id

The application:

  1. reads each configured field from the transaction
  2. concatenates the values
  3. passes the resulting grouping key into the invoice stored procedure

Transactions with the same grouping value are intended to be invoiced together.

Defaults

Flow

Default

issue-invoices-for-claims-v2

ndisNumber

issue-invoices-for-unpaid-claims

ndisNumber

AR App v2.2

Always starts with participantId,financialContact.id, then appends this setting if configured

 
claimReferenceUserField

Controls which user field is included in the generated NDIS claim reference.

Default:

 
userField1Value

The generated claim reference is approximately:

 
orgId_ndisRego_randomId_selectedUserFieldValue

The final value is truncated to 50 characters.

This setting does not affect invoice grouping.

It only controls the claim reference sent to NDIS and stored in workflow records.

invoicingGroupByExpression

Controls how PL/SL invoices are grouped.

Like claimingGroupByExpression, this is a comma-separated list of transaction fields used to generate the grouping key passed into the invoice stored procedure.

Defaults observed

Flow

Default

Non-AR flow

clientNumber,userField2Value

AR App v2.2

Always starts with participantId,financialContactId, then appends this setting if configured

 
issued-invoice-aggregation-template-INV

A JSONata transformation template used after raw issued invoice rows have been created for invoice-origin records (origin = "INV").

It controls how invoice rows are transformed into the final output, including:

  • invoice line fields
  • descriptions
  • dates
  • GL/D fields
  • user fields
  • credit fields
  • …
issued-invoice-aggregation-template-CLAIM

Equivalent to issued-invoice-aggregation-template-INV, but applied to claim-origin records (origin = "CLAIM").

This allows Agency claim invoices to have a different output layout from PL/SL invoices.

ndis-contact

Stores the configured NDIS contact ID for an organisation.

During Service Delivery import validation:

  • Agency transactions must use this configured contact
  • if a different contact is supplied, the transaction is marked Incomplete
  • a validation error indicates that the configured NDIS contact must be used

If ndis-contact is not configured, this validation rule is skipped.

serviceDeliveryImportPersistErrors

You could document it like this to stay consistent with the rest of the page:

serviceDeliveryImportPersistErrors

Controls whether invalid Service Delivery bulk import rows are persisted as shift records.

Valid values

Value

Behaviour

YES

Invalid rows are persisted as errored shift records for review.

NO

Invalid rows are not persisted. They are only returned in the generated error file.

null (or not configured)

Behaves the same as NO.

 
Behaviour

When this setting is enabled (YES):

  • invalid rows from a Service Delivery bulk import are saved as errored shift records
  • users can review and correct them within the application
  • the rows are still included in the generated error file

When disabled (NO or null):

  • invalid rows are not persisted
  • validation failures are only reported in the generated error file