Synqony.Api.Model 1.5.0

Synqony.Api.Model

Cross-platform .NET library for structured mapping and exchange of business objects in the waste management industry. It defines versioned data models for orders, invoices, master data, and transactional data and serves as the Single Source of Truth for all teams and systems implementing the Synqony API.

This API can be used to send both master data (addresses, services, etc) as well as movement data (orders, invoices) which change frequently. The aim of this package is to provide a single unified interface covering all different angles of the processes involved in the waste management industry.

Table of Contents

• Installation
• Architecture & Inheritance Hierarchy
• Common Types
• Data Model Overview
  • Master Data
  • Transactional Data
  • General / Common
• See Also

Installation

dotnet add package Synqony.Api.Model

Supported Frameworks: netstandard2.0 (.NET 8+, .NET Framework 4.6.1+)

For a typed API client with authentication, serialization, and CRUD operations, see Synqony.Api.Sdk.

Architecture & Inheritance Hierarchy

All API objects follow a consistent inheritance hierarchy:

AuditableBase                   # CreatedAt, CreatedBy, ModifiedAt, ModifiedBy
└── ApiObjectBase               # Id, ExternalId
    ├── ApiRootObjectBase       # Label, Shorthand, Remarks
    │   ├── ApiService
    │   ├── ApiContainerType
    │   └── ...
    ├── ApiOrder                # Orders (without Label/Shorthand)
    ├── ApiInvoice              # Invoices
    ├── ApiAddress              # Addresses
    └── ...

Common fields across all objects:

Common Types

The library provides several shared types used across all API interactions:

• Result<T> – Wrapper for all API responses. Contains Data (the payload) and Messages (status/error messages with EnumApiMessageType codes).
• ListInfo<T> – Paginated list response with Items, PageNo, PageSize, PageCount, and TotalItemCount.
• ListRequestInfo – Request model for paginated queries with Filters (array of ColumnFilter) and Sort.
• ColumnFilter – Filter definition with ColumnName, ColumnValue, and Operation (eq, ne, lt, gt). Supports dot notation for nested fields.
• LinkableEntity – Lightweight reference to another object via ForeignKey (ID), Value (display text), and ResourceType (API endpoint name).
• OAuthTokenRequest / OAuthPasswordRequest – Request models for OAuth 2.0 authentication flows.

Data Model Overview

Master Data

Transactional Data

General / Common

See Also

• Synqony.Api.Sdk – Typed .NET client for the Synqony API with built-in authentication and CRUD operations.