viewByReferenceID method

ResponseFuture<CreditNote> viewByReferenceID(
  1. SimpleSearchReq request, {
  2. CallOptions? options,
})

Retrieves a single record based on its user-defined, external reference ID.

This read-only operation is utilized for targeted lookups using human-readable identifiers (e.g., "REF-2023-001") rather than internal system IDs or unpredictable UUIDs. Because external reference IDs might occasionally be duplicated across a tenant's dataset (due to legacy data imports, external CRM syncing overlaps, or manual entry overrides), this query guarantees a deterministic response. In the event of a collision, it automatically resolves the conflict by returning only the most recently created or modified record that matches the requested reference string.

Implementation

$grpc.ResponseFuture<$0.CreditNote> viewByReferenceID(
  $1.SimpleSearchReq request, {
  $grpc.CallOptions? options,
}) {
  return $createUnaryCall(_$viewByReferenceID, request, options: options);
}