Skip to main content

Invoice_Cancelled_String

Invoice_Cancelled_String = 'Cancelled'

Example​

procedure ScriptEvent(var Value: variant);
begin
  Value := GetInvoiceStatusNum(Invoice_Cancelled_String); // 3
end;

Usage​

Invoice_Cancelled_String provides the exact Cancelled text paired with invoice lifecycle-status value 3 and recognised by Velox invoice-status conversion.

Value

PropertyValue
Script typeString
Exact literalCancelled
Numeric partner3 through Invoice_Cancelled
Database representationInvoice_Status.Description for row 3

Additional Technical Info​

Invoice_Cancelled_String is the canonical script-visible text Cancelled paired with invoice lifecycle-status value Invoice_Cancelled = 3. Use it when a script needs the Velox name for this lifecycle state or an input to invoice-status conversion.

The string names a lifecycle state. It does not change an invoice, validate a record or send an event.

Implementation

Velox declares and registers the exact String literal Cancelled. GetInvoiceStatusNum compares input with this literal by Delphi SameText, making the conversion case-insensitive for this ASCII token. GetInvoiceStatusCode returns this exact casing for numeric value 3.

The fresh-build Invoice_Status table stores Cancelled in its Description column. The table does not have a separate Code column.

Behaviour

Pass Invoice_Cancelled_String to GetInvoiceStatusNum when converting the canonical name. An external value such as CANCELLED is also recognised by that converter, but the constant itself retains the exact Cancelled spelling and casing.

Unlike the numeric Invoice_Cancelled name, Invoice_Cancelled_String is not registered in the Velox constant tag map. Use the numeric name in <!...!> configuration tags; do not expect <!Invoice_Cancelled_String!> to expand.

Edge cases and quirks

  • GetInvoiceStatusNum ignores letter case but does not trim whitespace. ' Cancelled' and Cancelled therefore return Null.
  • A direct script string comparison is not a substitute for the converter unless the calling context defines the required case behaviour.
  • Invoice_Hdr.StatusNum stores the numeric lifecycle key. The separate Invoice_Hdr.Status column uses the general issue/presentation status domain and does not store this text.
  • The same word may appear as presentation text elsewhere; use this constant only for the invoice lifecycle-status family.

Side effects

Reading or comparing Invoice_Cancelled_String has no I/O or state-changing side effect. Conversion uses a fixed in-process mapping and does not query Invoice_Status.

Errors

Reading the constant does not raise an error. The converter returns Null for unknown or whitespace-padded text rather than raising an invoice-specific exception.

Performance and concurrency

This is an immutable compiled string. Normal access and the fixed three-value converter are constant-time for practical purposes and carry no shared mutable Velox state.

Remarks

The example is source-reviewed and non-destructive. Use the exact constant when constructing canonical output even though the reverse converter accepts different letter casing.

Related entries

Created 2026-07-15