Table of Contents

• Introduction
• Feature Capabilities
• Use Cases
• Business Benefits
• Limitations

Introduction

Ordway now supports API filtering based on fields that belong to associated (related) objects, enabling more powerful queries across customer, subscription, invoice, and product relationships.

This enhancement allows integrators to perform joined filtering without additional API calls or external data processing.

What’s New

The API now accepts filter parameters that reference associated module attributes, not just primary object fields.

Example

This query returns customers whose associated Contact record has the name "John".

Feature Capabilities

Supported Filter Patterns

• Parent → Child (One-to-One / One-to-Many)

  GET /api/customers?contact.email=john@example.com GET /api/subscriptions?product.name=API Product

• Multiple associated filters

  GET /api/customers?contact.first_name=John&contact.last_name=Doe

• Combine direct and associated conditions

  GET /api/customers?status=Active&contact.city=Boston

Use Cases

Subscription Audits

Identify subscriptions tied to specific product metadata:

Invoice Filtering

Fetch invoices belonging to customers with a specific name:

Business Benefits

• Reduces API complexity — eliminates multi-step queries.

• Improves integration efficiency — fewer requests required.

• Enhances reporting accuracy — supports relational filtering without backend joins.

• Enables robust automation — workflows can use more precise API queries.

• Saves engineering effort by removing the need to merge parent/child data manually.

Limitations

• Filtering is currently case-sensitive.

• Only fields defined in object relationships are supported.