Service Design Specification - Object Design for financialReport
airbnb-platformadmin-service documentation
Document Overview
This document outlines the object design for the financialReport model in our application. It includes details about the model’s attributes, relationships, and any specific validation or business logic that applies.
financialReport Data Object
Object Overview
Description: System-generated or admin-generated report snapshots of platform financials for a given period (GDPR/tax).
This object represents a core data structure within the service and acts as the blueprint for database interaction, API generation, and business logic enforcement.
It is defined using the ObjectSettings pattern, which governs its behavior, access control, caching strategy, and integration points with other systems such as Stripe and Redis.
Core Configuration
- Soft Delete: Disabled — Determines whether records are marked inactive (
isActive = false) instead of being physically deleted. - Public Access: accessPrivate — If enabled, anonymous users may access this object’s data depending on API-level rules.
Properties Schema
| Property | Type | Required | Description |
|---|---|---|---|
period |
String | Yes | - |
cityTaxByLocation |
Object | No | - |
totalPayouts |
Double | Yes | - |
createdBy |
ID | Yes | - |
totalRefunds |
Double | Yes | - |
currency |
String | Yes | - |
generatedAt |
Date | Yes | - |
totalRevenue |
Double | Yes | - |
- Required properties are mandatory for creating objects and must be provided in the request body if no default value is set.
Default Values
Default values are automatically assigned to properties when a new object is created, if no value is provided in the request body. Since default values are applied on db level, they should be literal values, not expressions.If you want to use expressions, you can use transposed parameters in any business API to set default values dynamically.
- period: ‘default’
- totalPayouts: 0.0
- createdBy: ‘00000000-0000-0000-0000-000000000000’
- totalRefunds: 0.0
- currency: ‘default’
- generatedAt: new Date()
- totalRevenue: 0.0
Constant Properties
period cityTaxByLocation totalPayouts createdBy totalRefunds currency generatedAt totalRevenue
Constant properties are defined to be immutable after creation, meaning they cannot be updated or changed once set. They are typically used for properties that should remain constant throughout the object’s lifecycle.
A property is set to be constant if the Allow Update option is set to false.
Auto Update Properties
period cityTaxByLocation totalPayouts createdBy totalRefunds currency generatedAt totalRevenue
An update crud API created with the option Auto Params enabled will automatically update these properties with the provided values in the request body.
If you want to update any property in your own business logic not by user input, you can set the Allow Auto Update option to false.
These properties will be added to the update API’s body parameters and can be updated by the user if any value is provided in the request body.
Elastic Search Indexing
period createdBy currency generatedAt totalRevenue
Properties that are indexed in Elastic Search will be searchable via the Elastic Search API. While all properties are stored in the elastic search index of the data object, only those marked for Elastic Search indexing will be available for search queries.
Database Indexing
period createdBy currency generatedAt
Properties that are indexed in the database will be optimized for query performance, allowing for faster data retrieval. Make a property indexed in the database if you want to use it frequently in query filters or sorting.
Secondary Key Properties
createdBy
Secondary key properties are used to create an additional indexed identifiers for the data object, allowing for alternative access patterns. Different than normal indexed properties, secondary keys will act as primary keys and Mindbricks will provide automatic secondary key db utility functions to access the data object by the secondary key.
Relation Properties
createdBy
Mindbricks supports relations between data objects, allowing you to define how objects are linked together. You can define relations in the data object properties, which will be used to create foreign key constraints in the database. For complex joins operations, Mindbricks supportsa BFF pattern, where you can view dynamic and static views based on Elastic Search Indexes. Use db level relations for simple one-to-one or one-to-many relationships, and use BFF views for complex joins that require multiple data objects to be joined together.
- createdBy: ID
Relation to
user.id
The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.
On Delete: Set Null Required: Yes
Formula Properties
generatedAt
Formula properties are used to define calculated fields that derive their values from other properties or external data. These properties are automatically calculated based on the defined formula and can be used for dynamic data retrieval.
- generatedAt: Date
-
Formula:
new Date() -
Calculate After Instance: No
-
Filter Properties
period
Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API’s that have “Auto Params” enabled.
- period: String has a filter named
period