mmodel

type Account struct {
	// Unique identifier for the account (UUID format)
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	ID string `json:"id" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Human-readable name of the account
	// example: Corporate Checking Account
	// maxLength: 256
	Name string `json:"name" example:"Corporate Checking Account" maxLength:"256"`

	// ID of the parent account if this is a sub-account (UUID format)
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	ParentAccountID *string `json:"parentAccountId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Optional external identifier for linking to external systems
	// example: EXT-ACC-12345
	// maxLength: 256
	EntityID *string `json:"entityId" example:"EXT-ACC-12345" maxLength:"256"`

	// Asset code associated with this account (determines currency/asset type)
	// example: USD
	// maxLength: 100
	AssetCode string `json:"assetCode" example:"USD" maxLength:"100"`

	// ID of the organization that owns this account (UUID format)
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	OrganizationID string `json:"organizationId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// ID of the ledger this account belongs to (UUID format)
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	LedgerID string `json:"ledgerId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// ID of the portfolio this account belongs to (UUID format)
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	PortfolioID *string `json:"portfolioId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// ID of the segment this account belongs to (UUID format)
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	SegmentID *string `json:"segmentId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Current operating status of the account
	Status Status `json:"status"`

	// Unique alias for the account (makes referencing easier)
	// example: @treasury_checking
	// maxLength: 100
	Alias *string `json:"alias" example:"@treasury_checking" maxLength:"100"`

	// Type of the account.
	// example: deposit
	Type string `json:"type" example:"deposit"`

	// Indicates if the account is blocked
	Blocked *bool `json:"blocked"`

	// Timestamp when the account was created (RFC3339 format)
	// example: 2021-01-01T00:00:00Z
	// format: date-time
	CreatedAt time.Time `json:"createdAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the account was last updated (RFC3339 format)
	// example: 2021-01-01T00:00:00Z
	// format: date-time
	UpdatedAt time.Time `json:"updatedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the account was soft deleted, null if not deleted (RFC3339 format)
	// example: null
	// format: date-time
	DeletedAt *time.Time `json:"deletedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Custom key-value pairs for extending the account information
	// example: {"department": "Treasury", "purpose": "Operating Expenses", "region": "Global"}
	Metadata map[string]any `json:"metadata,omitempty"`

	// NullFields tracks fields explicitly set to null in the request.
	// Used internally to enable RFC 7396 JSON Merge Patch semantics.
	// Hidden from JSON serialization.
	NullFields []string `json:"-"`

} //	@name	Account

type AccountCache struct {
	RuleType string `json:"ruleType"`
	ValidIf  any    `json:"validIf"`
}

type AccountErrorResponse struct {
	// in: body
	Body struct {
		// Error code identifying the specific error
		// example: 400001
		Code int `json:"code"`

		// Human-readable error message
		// example: Invalid input: field 'assetCode' is required
		Message string `json:"message"`

		// Additional error details if available
		// example: {"field": "assetCode", "violation": "required"}
		Details map[string]any `json:"details,omitempty"`
	}
}

type AccountResponse struct {
	// in: body
	Body Account
}

type AccountRule struct {
	// The rule type for account selection.
	RuleType string `json:"ruleType,omitempty" example:"alias" enum:"alias,account_type"`
	// The rule condition for account selection. String for alias type (e.g. "@cash_account"), array for account_type.
	ValidIf any `json:"validIf,omitempty"`

} // @name AccountRule

type AccountType struct {
	// The unique identifier of the Account Type.
	ID uuid.UUID `json:"id,omitempty" example:"01965ed9-7fa4-75b2-8872-fc9e8509ab0a"`
	// The unique identifier of the Organization.
	OrganizationID uuid.UUID `json:"organizationId,omitempty" example:"01965ed9-7fa4-75b2-8872-fc9e8509ab0a"`
	// The unique identifier of the Ledger.
	LedgerID uuid.UUID `json:"ledgerId,omitempty" example:"01965ed9-7fa4-75b2-8872-fc9e8509ab0a"`
	// The name of the account type.
	Name string `json:"name,omitempty" example:"Current Assets"`
	// Detailed description of the account type.
	Description string `json:"description,omitempty" example:"Assets that are expected to be converted to cash within one year"`
	// A unique key value identifier for the account type.
	KeyValue string `json:"keyValue,omitempty" example:"current_assets"`
	// The timestamp when the account type was created.
	CreatedAt time.Time `json:"createdAt" example:"2021-01-01T00:00:00Z" format:"date-time"`
	// The timestamp when the account type was last updated.
	UpdatedAt time.Time `json:"updatedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`
	// The timestamp when the account type was deleted.
	DeletedAt *time.Time `json:"deletedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`
	// Custom key-value pairs for extending the account type information
	// example: {"department": "Treasury", "purpose": "Operating Expenses", "region": "Global"}
	Metadata map[string]any `json:"metadata,omitempty"`

} // @name AccountType

type Accounts struct {
	// Array of account records returned in this page
	// example: [{"id":"00000000-0000-0000-0000-000000000000","name":"Corporate Checking Account","assetCode":"USD","status":{"code": "ACTIVE"}}]
	Items []Account `json:"items"`

	// Current page number in the pagination
	// example: 1
	// minimum: 1
	Page int `json:"page" example:"1" minimum:"1"`

	// Maximum number of items per page
	// example: 10
	// minimum: 1
	// maximum: 100
	Limit int `json:"limit" example:"10" minimum:"1" maximum:"100"`

} //	@name	Accounts

type AccountsResponse struct {
	// in: body
	Body Accounts
}

type Address struct {
	// Primary address line (street address or PO Box)
	// example: 123 Financial Avenue
	// maxLength: 256
	Line1 string `json:"line1" example:"123 Financial Avenue" maxLength:"256"`

	// Secondary address information like apartment number, suite, or floor
	// example: Suite 1500
	// maxLength: 256
	Line2 *string `json:"line2" example:"Suite 1500" maxLength:"256"`

	// Postal code or ZIP code
	// example: 10001
	// maxLength: 20
	ZipCode string `json:"zipCode" example:"10001" maxLength:"20"`

	// City or locality name
	// example: New York
	// maxLength: 100
	City string `json:"city" example:"New York" maxLength:"100"`

	// State, province, or region name or code
	// example: NY
	// maxLength: 100
	State string `json:"state" example:"NY" maxLength:"100"`

	// Country code in ISO 3166-1 alpha-2 format (two-letter country code)
	// example: US
	// minLength: 2
	// maxLength: 2
	Country string `json:"country" example:"US" minLength:"2" maxLength:"2"` // According to ISO 3166-1 alpha-2

} //	@name	Address

type Addresses struct {
	Primary     *Address `json:"primary,omitempty"`
	Additional1 *Address `json:"additional1,omitempty"`
	Additional2 *Address `json:"additional2,omitempty"`

} // @name Addresses

type Alias struct {
	ID               *uuid.UUID        `json:"id,omitempty" example:"00000000-0000-0000-0000-000000000000"`
	Document         *string           `json:"document,omitempty" example:"91315026015"`
	Type             *string           `json:"type,omitempty" example:"LEGAL_PERSON"`
	LedgerID         *string           `json:"ledgerId" example:"00000000-0000-0000-0000-000000000000"`
	AccountID        *string           `json:"accountId" example:"00000000-0000-0000-0000-000000000000"`
	HolderID         *uuid.UUID        `json:"holderId" example:"00000000-0000-0000-0000-000000000000"`
	Metadata         map[string]any    `json:"metadata,omitempty"`
	BankingDetails   *BankingDetails   `json:"bankingDetails,omitempty"`
	RegulatoryFields *RegulatoryFields `json:"regulatoryFields,omitempty"`
	RelatedParties   []*RelatedParty   `json:"relatedParties,omitempty"`
	CreatedAt        time.Time         `json:"createdAt" example:"2025-01-01T00:00:00Z"`
	UpdatedAt        time.Time         `json:"updatedAt" example:"2025-01-01T00:00:00Z"`
	DeletedAt        *time.Time        `json:"deletedAt" example:"2025-01-01T00:00:00Z"`

} // @name AliasResponse

type Asset struct {
	// Unique identifier for the asset (UUID format)
	ID string `json:"id" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Name of the asset (max length 256 characters)
	Name string `json:"name" example:"US Dollar" maxLength:"256"`

	// Type of the asset (e.g., currency, cryptocurrency, commodity, stock)
	Type string `json:"type" example:"currency"`

	// Unique code/symbol for the asset (max length 100 characters)
	Code string `json:"code" example:"USD" maxLength:"100"`

	// Status of the asset (active, inactive, pending)
	Status Status `json:"status"`

	// ID of the ledger this asset belongs to (UUID format)
	LedgerID string `json:"ledgerId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// ID of the organization that owns this asset (UUID format)
	OrganizationID string `json:"organizationId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Timestamp when the asset was created
	CreatedAt time.Time `json:"createdAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the asset was last updated
	UpdatedAt time.Time `json:"updatedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the asset was deleted (null if not deleted)
	DeletedAt *time.Time `json:"deletedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Additional custom attributes for the asset
	Metadata map[string]any `json:"metadata,omitempty"`

} //	@name	Asset

type AssetErrorResponse struct {
	// in: body
	Body struct {
		// Error code identifying the specific error
		// example: 400001
		Code int `json:"code"`

		// Human-readable error message
		// example: Invalid input: field 'code' is required
		Message string `json:"message"`

		// Additional error details if available
		// example: {"field": "code", "violation": "required"}
		Details map[string]any `json:"details,omitempty"`
	}
}

type AssetResponse struct {
	// in: body
	Body Asset
}

type Assets struct {
	// Array of asset records
	// example: [{"id":"00000000-0000-0000-0000-000000000000","name":"US Dollar","code":"USD","type":"currency"}]
	Items []Asset `json:"items"`

	// Current page number
	// example: 1
	// minimum: 1
	Page int `json:"page" example:"1" minimum:"1"`

	// Maximum number of items per page
	// example: 10
	// minimum: 1
	// maximum: 100
	Limit int `json:"limit" example:"10" minimum:"1" maximum:"100"`

} //	@name	Assets

type AssetsResponse struct {
	// in: body
	Body Assets
}

type Balance struct {
	// Unique identifier for the balance (UUID format)
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	ID string `json:"id" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Organization that owns this balance
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	OrganizationID string `json:"organizationId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Ledger containing the account this balance belongs to
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	LedgerID string `json:"ledgerId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Account that holds this balance
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	AccountID string `json:"accountId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Alias for the account, used for easy identification or tagging
	// example: @person1
	// maxLength: 256
	Alias string `json:"alias" example:"@person1" maxLength:"256"`

	// Unique key for the balance
	// example: asset-freeze
	// maxLength: 100
	Key string `json:"key" example:"asset-freeze" maxLength:"100"`

	// Asset code identifying the currency or asset type of this balance
	// example: USD
	// minLength: 2
	// maxLength: 10
	AssetCode string `json:"assetCode" example:"USD" minLength:"2" maxLength:"10"`

	// Amount available for transactions (in the smallest unit of the asset, e.g. cents)
	// example: 1500
	// minimum: 0
	Available decimal.Decimal `json:"available" example:"1500" minimum:"0"`

	// Amount currently on hold and unavailable for transactions
	// example: 500
	// minimum: 0
	OnHold decimal.Decimal `json:"onHold" example:"500" minimum:"0"`

	// Optimistic concurrency control version
	// example: 1
	// minimum: 1
	Version int64 `json:"version" example:"1" minimum:"1"`

	// Type of account holding this balance
	// example: creditCard
	// maxLength: 50
	AccountType string `json:"accountType" example:"creditCard" maxLength:"50"`

	// Whether the account can send funds from this balance
	// example: true
	AllowSending bool `json:"allowSending" example:"true"`

	// Whether the account can receive funds to this balance
	// example: true
	AllowReceiving bool `json:"allowReceiving" example:"true"`

	// Timestamp when the balance was created (RFC3339 format)
	// example: 2021-01-01T00:00:00Z
	// format: date-time
	CreatedAt time.Time `json:"createdAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the balance was last updated (RFC3339 format)
	// example: 2021-01-01T00:00:00Z
	// format: date-time
	UpdatedAt time.Time `json:"updatedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the balance was softly deleted, null if not deleted (RFC3339 format)
	// example: null
	// format: date-time
	DeletedAt *time.Time `json:"deletedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Custom key-value pairs for extending the balance information
	// example: {"purpose": "Main savings", "category": "Personal"}
	Metadata map[string]any `json:"metadata,omitempty"`
}

type BalanceErrorResponse struct {
	// in: body
	Body struct {
		// Error code identifying the specific error
		// example: 400001
		Code int `json:"code"`

		// Human-readable error message
		// example: Invalid input: field 'assetCode' is required
		Message string `json:"message"`

		// Additional error details if available
		// example: {"field": "assetCode", "violation": "required"}
		Details map[string]any `json:"details,omitempty"`
	}
}

type BalanceOperation struct {
	Balance     *Balance
	Alias       string
	Amount      pkgTransaction.Amount
	InternalKey string
}

type BalanceRedis struct {
	// Unique identifier for the balance (UUID format)
	ID string `json:"id"`

	// Alias for the account, used for easy identification or tagging
	// example: @person1
	// maxLength: 256
	Alias string `json:"alias" example:"@person1" maxLength:"256"`

	// Unique key for the balance (defaults to "default" if not provided)
	// example: default
	// maxLength: 100
	Key string `json:"key" example:"default" maxLength:"100"`

	// Account that holds this balance
	AccountID string `json:"accountId"`

	// Asset code identifying the currency or asset type of this balance
	AssetCode string `json:"assetCode"`

	// Amount available for transactions
	Available decimal.Decimal `json:"available"`

	// Amount currently on hold
	OnHold decimal.Decimal `json:"onHold"`

	// Optimistic concurrency control version
	Version int64 `json:"version"`

	// Type of account holding this balance
	AccountType string `json:"accountType"`

	// Whether the account can send funds (1=true, 0=false)
	AllowSending int `json:"allowSending"`

	// Whether the account can receive funds (1=true, 0=false)
	AllowReceiving int `json:"allowReceiving"`
}

type Balances struct {
	// Array of balance records returned in this page
	// example: [{"id":"00000000-0000-0000-0000-000000000000","accountId":"00000000-0000-0000-0000-000000000000","assetCode":"USD","available":1500}]
	Items []Balance `json:"items"`

	// Current page number in the pagination
	// example: 1
	// minimum: 1
	Page int `json:"page" example:"1" minimum:"1"`

	// Maximum number of items per page
	// example: 10
	// minimum: 1
	// maximum: 100
	Limit int `json:"limit" example:"10" minimum:"1" maximum:"100"`

} // @name Balances

type BankingDetails struct {
	// The branch number or code.
	Branch *string `json:"branch,omitempty" example:"0001"`
	// The account code or number.
	Account *string `json:"account,omitempty" example:"123450"`
	// Type of account.
	Type *string `json:"type,omitempty" example:"CACC"`
	// The date the account was opened.
	OpeningDate *string `json:"openingDate,omitempty" example:"2025-01-01"`
	// The date the account was closed.
	ClosingDate *Date `json:"closingDate,omitempty" example:"2025-12-31"`
	// The International Bank Account Number.
	IBAN *string `json:"iban,omitempty" example:"US12345678901234567890"`
	// The country code where the bank is located.
	CountryCode *string `json:"countryCode,omitempty" example:"US"`
	// The code or identifier for correlation with the bank holding the account.
	BankID *string `json:"bankId,omitempty" example:"12345"`

} // @name BankingDetails

type Contact struct {
	// The primary email address of the holder.
	PrimaryEmail *string `json:"primaryEmail,omitempty" example:"john.doe@example.com"`
	// The secondary email address of the holder.
	SecondaryEmail *string `json:"secondaryEmail,omitempty" example:"john.doe@example.com"`
	// The mobile phone number of the holder, including country code.
	MobilePhone *string `json:"mobilePhone,omitempty" example:"+1555555555"`
	// Any additional phone number of the holder.
	OtherPhone *string `json:"otherPhone,omitempty" example:"+1555555555"`

} // @name Contact

type CreateAccountInput struct {
	// Human-readable name of the account
	// required: false
	// example: Corporate Checking Account
	// maxLength: 256
	Name string `json:"name" validate:"max=256" example:"Corporate Checking Account" maxLength:"256"`

	// ID of the parent account if this is a subaccount (optional)
	// required: false
	// format: uuid
	ParentAccountID *string `json:"parentAccountId" validate:"omitempty,uuid" format:"uuid"`

	// Optional external identifier for linking to external systems
	// required: false
	// example: EXT-ACC-12345
	// maxLength: 256
	EntityID *string `json:"entityId" validate:"omitempty,max=256" example:"EXT-ACC-12345" maxLength:"256"`

	// Asset code that this account will use for balances and transactions
	// required: true
	// example: USD
	// maxLength: 100
	AssetCode string `json:"assetCode" validate:"required,max=100" example:"USD" maxLength:"100"`

	// ID of the portfolio this account belongs to (optional)
	// required: false
	// format: uuid
	PortfolioID *string `json:"portfolioId" validate:"omitempty,uuid" format:"uuid"`

	// ID of the segment this account belongs to (optional)
	// required: false
	// format: uuid
	SegmentID *string `json:"segmentId" validate:"omitempty,uuid" format:"uuid"`

	// Current operating status of the account
	// required: false
	Status Status `json:"status"`

	// Unique alias for the account (optional, must follow alias format rules)
	// required: false
	// example: @treasury_checking
	// maxLength: 100
	Alias *string `` /* 141-byte string literal not displayed */

	// Type of the account
	// required: true
	// example: deposit
	// maxLength: 256
	Type string `json:"type" validate:"required,max=256,invalidstrings=external" example:"deposit"`

	// Whether the account should start blocked
	// required: false
	// default: false
	Blocked *bool `json:"blocked"`

	// Custom key-value pairs for extending the account information
	// required: false
	// example: {"department": "Treasury", "purpose": "Operating Expenses", "region": "Global"}
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,nonested,valuemax=2000"`

} //	@name	CreateAccountInput

type CreateAccountTypeInput struct {
	// The name of the account type.
	Name string `json:"name" validate:"required,max=100" example:"Current Assets"`
	// Detailed description of the account type.
	Description string `json:"description,omitempty" validate:"max=500" example:"Assets that are expected to be converted to cash within one year"`
	// A unique key value identifier for the account type.
	KeyValue string `json:"keyValue" validate:"required,max=50,invalidaccounttype" example:"current_assets"`
	// Custom key-value pairs for extending the account type information
	// required: false
	// example: {"department": "Treasury", "purpose": "Operating Expenses", "region": "Global"}
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,nonested,valuemax=2000"`

} // @name CreateAccountTypeInput

type CreateAdditionalBalance struct {
	// Unique key for the balance
	// required: true
	// maxLength: 100
	// example: asset-freeze
	Key string `json:"key" validate:"required,nowhitespaces,max=100" example:"asset-freeze"`
	// Whether the account should be allowed to send funds from this balance
	// required: false
	// example: true
	AllowSending *bool `json:"allowSending" example:"true"`

	// Whether the account should be allowed to receive funds to this balance
	// required: false
	// example: true
	AllowReceiving *bool `json:"allowReceiving" example:"true"`

} // @name CreateAdditionalBalance

type CreateAliasInput struct {
	// Unique identifier of the ledger of the related account.
	LedgerID string `json:"ledgerId" validate:"required" example:"00000000-0000-0000-0000-000000000000"`
	// Unique identifier of the related account on ledger.
	AccountID string `json:"accountId" validate:"required" example:"00000000-0000-0000-0000-000000000000"`
	// An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value.
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,nonested,valuemax=2000"`
	// Object with banking information of the related account.
	BankingDetails *BankingDetails `json:"bankingDetails"`
	// Object with regulatory fields.
	RegulatoryFields *RegulatoryFields `json:"regulatoryFields,omitempty"`
	// List of related parties to add at creation.
	RelatedParties []*RelatedParty `json:"relatedParties,omitempty"`

} // @name CreateAliasRequest

type CreateAssetInput struct {
	// Name of the asset (required, max length 256 characters)
	Name string `json:"name" validate:"required,max=256" example:"US Dollar"`

	// Type of the asset (e.g., currency, cryptocurrency, commodity, stock)
	Type string `json:"type" validate:"required" example:"currency"`

	// Unique code/symbol for the asset (required, max length 100 characters)
	Code string `json:"code" validate:"required,max=100" example:"USD"`

	// Status of the asset (active, inactive, pending)
	Status Status `json:"status"`

	// Additional custom attributes for the asset
	// Keys max length: 100 characters, Values max length: 2000 characters
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,nonested,valuemax=2000"`

} //	@name	CreateAssetInput

type CreateBalanceInput struct {
	// Request ID for tracing
	// example: 123e4567-e89b-12d3-a456-426614174000
	// format: string uuid
	RequestID string

	// Organization that owns this balance
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	OrganizationID uuid.UUID

	// Ledger containing the account this balance belongs to
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	LedgerID uuid.UUID

	// Account that holds this balance
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	AccountID uuid.UUID

	// Alias for the account, used for easy identification or tagging
	// example: @person1
	// maxLength: 256
	Alias string

	// Unique key for the balance
	// example: asset-freeze
	// maxLength: 100
	Key string

	// Asset code identifying the currency or asset type of this balance
	// example: USD
	// minLength: 2
	// maxLength: 10
	AssetCode string

	// Type of account holding this balance
	// example: creditCard
	// maxLength: 50
	AccountType string

	// Whether the account should be allowed to send funds from this balance
	// example: true
	AllowSending bool

	// Whether the account should be allowed to receive funds to this balance
	// example: true
	AllowReceiving bool
}

type CreateHolderInput struct {
	// Optional field for an external identifier to client correlation purposes.
	ExternalID *string `json:"externalId" example:"G4K7N8M2"`
	// Type of person.
	// * NATURAL_PERSON - Individual
	// * LEGAL_PERSON - Company
	Type *string `json:"type" validate:"required" example:"NATURAL_PERSON" enums:"NATURAL_PERSON,LEGAL_PERSON"`
	// Holders name.
	// **Notes:** If the person type is LEGAL_PERSON, this must be the full legal name. If the person type is NATURAL_PERSON, this should be the individuals full name.
	Name string `json:"name" validate:"required" example:"John Doe"`
	// The holder's identification document.
	Document string `json:"document" validate:"required" example:"91315026015"`
	// Object of addresses.
	Addresses *Addresses `json:"addresses"`
	// Object with contact information.
	Contact *Contact `json:"contact"`
	// Object with natural person information.
	NaturalPerson *NaturalPerson `json:"naturalPerson"`
	// Object with legal person information.
	LegalPerson *LegalPerson `json:"legalPerson"`
	// An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value.
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,nonested,valuemax=2000"`

} // @name CreateHolderRequest

type CreateLedgerInput struct {
	// Display name of the ledger
	// required: true
	// maxLength: 256
	Name string `json:"name" validate:"required,max=256" maxLength:"256"`

	// Current operating status of the ledger (defaults to ACTIVE if not specified)
	// required: false
	Status Status `json:"status"`

	// Custom key-value pairs for extending the ledger information
	// required: false
	// example: {"department": "Finance", "currency": "USD", "region": "North America"}
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,nonested,valuemax=2000"`

} // @name CreateLedgerInput

type CreateMetadataIndexInput struct {
	// The metadata key to index (without "metadata." prefix)
	// required: true
	// maxLength: 100
	MetadataKey string `json:"metadataKey" validate:"required,max=100,metadatakeyformat" example:"tier"`
	// Whether the index should enforce uniqueness
	// required: false
	// default: false
	Unique bool `json:"unique" example:"false"`
	// Whether the index should be sparse (only include documents with the field)
	// required: false
	// default: true
	Sparse *bool `json:"sparse" example:"true"`

} // @name CreateMetadataIndexInput

type CreateOperationRouteInput struct {
	// Short text summarizing the purpose of the operation. Used as an entry note for identification.
	Title string `json:"title,omitempty" validate:"required,max=50" example:"Cashin from service charge"`
	// Detailed description of the operation route purpose and usage.
	Description string `` /* 139-byte string literal not displayed */
	// External reference of the operation route.
	Code string `json:"code,omitempty" validate:"max=100" example:"EXT-001"`
	// The type of the operation route.
	OperationType string `json:"operationType,omitempty" validate:"required" example:"source" enum:"source,destination"`
	// Additional metadata stored as JSON
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`
	// The account selection rule configuration.
	Account *AccountRule `json:"account,omitempty"`

} // @name CreateOperationRouteInput

type CreateOrganizationInput struct {
	// Official legal name of the organization
	// required: true
	// example: Lerian Financial Services Ltd.
	// maxLength: 256
	LegalName string `json:"legalName" validate:"required,max=256" example:"Lerian Financial Services Ltd." maxLength:"256"`

	// UUID of the parent organization if this is a child organization
	// required: false
	// format: uuid
	ParentOrganizationID *string `json:"parentOrganizationId" validate:"omitempty,uuid" format:"uuid"`

	// Trading or brand name of the organization, if different from legal name
	// required: false
	// example: Lerian FS
	// maxLength: 256
	DoingBusinessAs *string `json:"doingBusinessAs" validate:"omitempty,max=256" example:"Lerian FS" maxLength:"256"`

	// Official tax ID, company registration number, or other legal identification
	// required: true
	// example: 123456789012345
	// maxLength: 256
	LegalDocument string `json:"legalDocument" validate:"required,max=256" example:"123456789012345" maxLength:"256"`

	// Physical address of the organization
	// required: false
	Address Address `json:"address"`

	// Current operating status of the organization (defaults to ACTIVE if not specified)
	// required: false
	Status Status `json:"status"`

	// Custom key-value pairs for extending the organization information
	// required: false
	// example: {"industry": "Financial Services", "founded": 2020, "employees": 150}
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,nonested,valuemax=2000"`

} //	@name	CreateOrganizationInput

type CreatePortfolioInput struct {
	// Optional external entity identifier (max length 256 characters)
	EntityID string `json:"entityId" validate:"omitempty,max=256" example:"00000000-0000-0000-0000-000000000000"`

	// Name of the portfolio (required, max length 256 characters)
	Name string `json:"name" validate:"required,max=256" example:"My Portfolio"`

	// Status of the portfolio (active, inactive, pending)
	Status Status `json:"status"`

	// Additional custom attributes for the portfolio
	// Keys max length: 100 characters, Values max length: 2000 characters
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,nonested,valuemax=2000"`

} // @name CreatePortfolioInput

type CreateSegmentInput struct {
	// Name of the segment (required, max length 256 characters)
	Name string `json:"name" validate:"required,max=256" example:"My Segment"`

	// Status of the segment (active, inactive, pending)
	Status Status `json:"status"`

	// Additional custom attributes for the segment
	// Keys max length: 100 characters, Values max length: 2000 characters
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,nonested,valuemax=2000"`

} // @name CreateSegmentInput

type CreateTransactionRouteInput struct {
	// Short text summarizing the purpose of the transaction. Used as an entry note for identification.
	Title string `json:"title,omitempty" validate:"required,max=50" example:"Charge Settlement"`
	// A description for the Transaction Route.
	Description string `json:"description,omitempty" validate:"max=250" example:"Settlement route for service charges"`
	// Additional metadata stored as JSON
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`
	// An object containing accounting data of Operation Routes from the Transaction Route.
	OperationRoutes []uuid.UUID `json:"operationRoutes,omitempty" validate:"required"`

} // @name CreateTransactionRouteInput

type Date struct {
	time.Time
}

type Error struct {
	// Error code identifying the specific error condition
	// example: ERR_INVALID_INPUT
	// maxLength: 50
	Code string `json:"code" example:"ERR_INVALID_INPUT" maxLength:"50"`

	// Short, human-readable error title
	// example: Bad Request
	// maxLength: 100
	Title string `json:"title" example:"Bad Request" maxLength:"100"`

	// Detailed error message explaining the issue
	// example: The request contains invalid fields. Please check the field 'name' and try again.
	// maxLength: 500
	Message string `json:"message" example:"The request contains invalid fields. Please check the field 'name' and try again." maxLength:"500"`

	// Optional type of entity associated with the error
	// example: Organization
	// maxLength: 100
	EntityType string `json:"entityType,omitempty" example:"Organization" maxLength:"100"`

	// Optional detailed field validations for client-side handling
	// example: {"name": "Field 'name' is required"}
	Fields map[string]string `json:"fields,omitempty"`

} // @name Error

type ErrorResponse struct {
	// in: body
	Body Error
}

type Event struct {
	Source         string          `json:"source" example:"midaz"`
	EventType      string          `json:"eventType" example:"transaction"`
	Action         string          `json:"action" example:"APPROVED"`
	TimeStamp      time.Time       `json:"timestamp" example:"2025-06-26T16:00:00Z"`
	Version        string          `json:"version" example:"v2.2.2"`
	OrganizationID string          `json:"organizationId" format:"uuid" example:"00000000-0000-0000-0000-000000000000"`
	LedgerID       string          `json:"ledgerId" format:"uuid" example:"00000000-0000-0000-0000-000000000000"`
	Payload        json.RawMessage `json:"payload" format:"json"`
}

type Holder struct {
	ID            *uuid.UUID     `json:"id,omitempty" example:"00000000-0000-0000-0000-000000000000"`
	ExternalID    *string        `json:"externalId,omitempty" example:"G4K7N8M2"`
	Type          *string        `json:"type,omitempty" example:"NATURAL_PERSON" enums:"NATURAL_PERSON,LEGAL_PERSON"`
	Name          *string        `json:"name,omitempty" example:"John Doe"`
	Document      *string        `json:"document,omitempty" example:"91315026015"`
	Addresses     *Addresses     `json:"addresses,omitempty"`
	Contact       *Contact       `json:"contact,omitempty"`
	NaturalPerson *NaturalPerson `json:"naturalPerson,omitempty"`
	LegalPerson   *LegalPerson   `json:"legalPerson,omitempty"`
	Metadata      map[string]any `json:"metadata,omitempty"`
	CreatedAt     time.Time      `json:"createdAt" example:"2025-01-01T00:00:00Z"`
	UpdatedAt     time.Time      `json:"updatedAt" example:"2025-01-01T00:00:00Z"`
	DeletedAt     *time.Time     `json:"deletedAt" example:"2025-01-01T00:00:00Z"`

} // @name HolderResponse

type IndexStats struct {
	// Number of operations that have used this index
	// example: 1523
	Accesses int64 `json:"accesses" example:"1523"`
	// Timestamp since when the statistics are being collected
	// example: 2024-12-01T10:30:00Z
	// format: date-time
	StatsSince *time.Time `json:"statsSince,omitempty" format:"date-time" example:"2024-12-01T10:30:00Z"`

} // @name IndexStats

type Ledger struct {
	// Unique identifier for the ledger (UUID format)
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	ID string `json:"id" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Display name of the ledger
	// example: Treasury Operations
	// maxLength: 256
	Name string `json:"name" example:"Treasury Operations" maxLength:"256"`

	// Reference to the organization that owns this ledger (UUID format)
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	OrganizationID string `json:"organizationId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Current operating status of the ledger
	Status Status `json:"status"`

	// Timestamp when the ledger was created (RFC3339 format)
	// example: 2021-01-01T00:00:00Z
	// format: date-time
	CreatedAt time.Time `json:"createdAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the ledger was last updated (RFC3339 format)
	// example: 2021-01-01T00:00:00Z
	// format: date-time
	UpdatedAt time.Time `json:"updatedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the ledger was soft deleted, null if not deleted (RFC3339 format)
	// example: null
	// format: date-time
	DeletedAt *time.Time `json:"deletedAt" sql:"index" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Custom key-value pairs for extending the ledger information
	// example: {"department": "Finance", "currency": "USD", "region": "North America"}
	Metadata map[string]any `json:"metadata,omitempty"`

} // @name Ledger

type LedgerErrorResponse struct {
	// in: body
	Body struct {
		// Error code identifying the specific error
		// example: 400001
		Code int `json:"code"`

		// Human-readable error message
		// example: Invalid input: field 'name' is required
		Message string `json:"message"`

		// Additional error details if available
		// example: {"field": "name", "violation": "required"}
		Details map[string]any `json:"details,omitempty"`
	}
}

type LedgerResponse struct {
	// in: body
	Body Ledger
}

type Ledgers struct {
	// Array of ledger records returned in this page
	// example: [{"id":"00000000-0000-0000-0000-000000000000","name":"Treasury Operations","status":{"code":"ACTIVE"}}]
	Items []Ledger `json:"items"`

	// Current page number in the pagination
	// example: 1
	// minimum: 1
	Page int `json:"page" example:"1" minimum:"1"`

	// Maximum number of items per page
	// example: 10
	// minimum: 1
	// maximum: 100
	Limit int `json:"limit" example:"10" minimum:"1" maximum:"100"`

} // @name Ledgers

type LedgersResponse struct {
	// in: body
	Body Ledgers
}

type LegalPerson struct {
	// The registered business name of the company, if applicable.
	TradeName *string `json:"tradeName,omitempty" example:"Lerian Studio"`
	// The type of business or activity the company engages in.
	Activity *string `json:"activity,omitempty" example:"Electronic devices development"`
	// The legal structure of the company.
	Type *string `json:"type,omitempty" example:"Limited Liability"`
	// The date when the company was established.
	FoundingDate *string `json:"foundingDate,omitempty" example:"2025-01-01"`
	// The size classification of the company.
	Size *string `json:"size,omitempty" example:"Medium"`
	// The current status of the legal entity.
	Status *string `json:"status,omitempty" example:"Closed"`
	// Object with details of the company's legal representative.
	Representative *Representative `json:"representative,omitempty"`

} // @name LegalPerson

type MetadataIndex struct {
	// The name of the index in MongoDB
	IndexName string `json:"indexName" example:"metadata.tier_1"`
	// The entity/collection name where the index exists
	EntityName string `json:"entityName" example:"transaction"`
	// The metadata key that is indexed
	MetadataKey string `json:"metadataKey" example:"tier"`
	// Whether the index enforces uniqueness
	Unique bool `json:"unique" example:"false"`
	// Whether the index is sparse
	Sparse bool `json:"sparse" example:"true"`
	// Usage statistics for this index (only available on GET, not on CREATE)
	Stats *IndexStats `json:"stats,omitempty"`

} // @name MetadataIndex

type MetadataIndexErrorResponse struct {
	// in: body
	Body struct {
		// Error code identifying the specific error
		// example: 400001
		Code int `json:"code"`
		// Human-readable error message
		// example: Invalid input: field 'metadataKey' is required
		Message string `json:"message"`
		// Additional error details if available
		// example: {"field": "metadataKey", "violation": "required"}
		Details map[string]any `json:"details,omitempty"`
	}
}

type MetadataIndexResponse struct {
	// in: body
	Body MetadataIndex
}

type MetadataIndexes struct {
	// Array of metadata index records returned in this page
	// example: [{"indexName":"metadata.tier_1","entityName":"transaction","metadataKey":"tier"}]
	Items []MetadataIndex `json:"items"`
	// Current page number in the pagination
	// example: 1
	// minimum: 1
	Page int `json:"page" example:"1" minimum:"1"`
	// Maximum number of items per page
	// example: 10
	// minimum: 1
	// maximum: 100
	Limit int `json:"limit" example:"10" minimum:"1" maximum:"100"`

} // @name MetadataIndexes

type MetadataIndexesResponse struct {
	// in: body
	Body MetadataIndexes
}

type NaturalPerson struct {
	// The person's nickname or preferred name.
	FavoriteName *string `json:"favoriteName,omitempty" example:"John"`
	// The social name or alternate name used by the person, if applicable.
	SocialName *string `json:"socialName,omitempty" example:"John Doe"`
	// Person's gender.
	Gender *string `json:"gender,omitempty" example:"Male"`
	// Person's birth date, formatted as YYYY-MM-DD.
	BirthDate *string `json:"birthDate,omitempty" example:"1990-01-01"`
	// Person's civil status, for example: "Single", "Married", or "Divorced".
	CivilStatus *string `json:"civilStatus,omitempty" example:"Single"`
	// The nationality of the person, for example, "Brazilian".
	Nationality *string `json:"nationality,omitempty" example:"Brazilian"`
	// The name of the person's mother.
	MotherName *string `json:"motherName,omitempty" example:"Jane Doe"`
	// The name of the person's father.
	FatherName *string `json:"fatherName,omitempty" example:"John Doe"`
	// The current status of the individual.
	Status *string `json:"status,omitempty" example:"Active"`

} // @name NaturalPerson

type OperationRoute struct {
	// The unique identifier of the Operation Route.
	ID uuid.UUID `json:"id,omitempty" example:"01965ed9-7fa4-75b2-8872-fc9e8509ab0a"`
	// The unique identifier of the Organization.
	OrganizationID uuid.UUID `json:"organizationId,omitempty" example:"01965ed9-7fa4-75b2-8872-fc9e8509ab0a"`
	// The unique identifier of the Ledger.
	LedgerID uuid.UUID `json:"ledgerId,omitempty" example:"01965ed9-7fa4-75b2-8872-fc9e8509ab0a"`
	// Short text summarizing the purpose of the operation. Used as an entry note for identification.
	Title string `json:"title,omitempty" example:"Cashin from service charge"`
	// Detailed description of the operation route purpose and usage.
	Description string `json:"description,omitempty" example:"This operation route handles cash-in transactions from service charge collections"`
	// External reference of the operation route.
	Code string `json:"code,omitempty" example:"EXT-001"`
	// The type of the operation route.
	OperationType string `json:"operationType,omitempty" example:"source" enum:"source,destination"`
	// Additional metadata stored as JSON
	Metadata map[string]any `json:"metadata,omitempty" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`
	// The account selection rule configuration.
	Account *AccountRule `json:"account,omitempty"`
	// The timestamp when the operation route was created.
	CreatedAt time.Time `json:"createdAt" example:"2021-01-01T00:00:00Z" format:"date-time"`
	// The timestamp when the operation route was last updated.
	UpdatedAt time.Time `json:"updatedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`
	// The timestamp when the operation route was deleted.
	DeletedAt *time.Time `json:"deletedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

} // @name OperationRoute

type OperationRouteCache struct {
	Account *AccountCache `json:"account,omitempty"`
}

type Organization struct {
	// Unique identifier for the organization (UUID format)
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	ID string `json:"id" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Reference to the parent organization, if this is a child organization
	// example: 00000000-0000-0000-0000-000000000000
	// format: uuid
	ParentOrganizationID *string `json:"parentOrganizationId" format:"uuid"`

	// Official legal name of the organization
	// example: Lerian Financial Services Ltd.
	// maxLength: 256
	LegalName string `json:"legalName" example:"Lerian Financial Services Ltd." maxLength:"256"`

	// Trading or brand name of the organization, if different from legal name
	// example: Lerian FS
	// maxLength: 256
	DoingBusinessAs *string `json:"doingBusinessAs" example:"Lerian FS" maxLength:"256"`

	// Official tax ID, company registration number, or other legal identification
	// example: 123456789012345
	// maxLength: 256
	LegalDocument string `json:"legalDocument" example:"123456789012345" maxLength:"256"`

	// Physical address of the organization
	Address Address `json:"address"`

	// Current operating status of the organization
	Status Status `json:"status"`

	// Timestamp when the organization was created (RFC3339 format)
	// example: 2021-01-01T00:00:00Z
	// format: date-time
	CreatedAt time.Time `json:"createdAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the organization was last updated (RFC3339 format)
	// example: 2021-01-01T00:00:00Z
	// format: date-time
	UpdatedAt time.Time `json:"updatedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the organization was soft deleted, null if not deleted (RFC3339 format)
	// example: null
	// format: date-time
	DeletedAt *time.Time `json:"deletedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Custom key-value pairs for extending the organization information
	// example: {"industry": "Financial Services", "founded": 2020, "employees": 150}
	Metadata map[string]any `json:"metadata,omitempty"`

} //	@name	Organization

type OrganizationErrorResponse struct {
	// in: body
	Body struct {
		// Error code identifying the specific error
		// example: 400001
		Code int `json:"code"`

		// Human-readable error message
		// example: Invalid input: field 'legalName' is required
		Message string `json:"message"`

		// Additional error details if available
		// example: {"field": "legalName", "violation": "required"}
		Details map[string]any `json:"details,omitempty"`
	}
}

type OrganizationResponse struct {
	// in: body
	Body Organization
}

type Organizations struct {
	// Array of organization records returned in this page
	// example: [{"id":"00000000-0000-0000-0000-000000000000","legalName":"Lerian Financial Services Ltd.","status":{"code":"ACTIVE"}}]
	Items []Organization `json:"items"`

	// Current page number in the pagination
	// example: 1
	// minimum: 1
	Page int `json:"page" example:"1" minimum:"1"`

	// Maximum number of items per page
	// example: 10
	// minimum: 1
	// maximum: 100
	Limit int `json:"limit" example:"10" minimum:"1" maximum:"100"`

} //	@name	Organizations

type OrganizationsResponse struct {
	// in: body
	Body Organizations
}

type Portfolio struct {
	// Unique identifier for the portfolio (UUID format)
	ID string `json:"id" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Name of the portfolio (max length 256 characters)
	Name string `json:"name" example:"My Portfolio" maxLength:"256"`

	// Optional external entity identifier (max length 256 characters)
	EntityID string `json:"entityId,omitempty" example:"00000000-0000-0000-0000-000000000000" maxLength:"256"`

	// ID of the ledger this portfolio belongs to (UUID format)
	LedgerID string `json:"ledgerId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// ID of the organization that owns this portfolio (UUID format)
	OrganizationID string `json:"organizationId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Status of the portfolio (active, inactive, pending)
	Status Status `json:"status"`

	// Timestamp when the portfolio was created
	CreatedAt time.Time `json:"createdAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the portfolio was last updated
	UpdatedAt time.Time `json:"updatedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the portfolio was deleted (null if not deleted)
	DeletedAt *time.Time `json:"deletedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Additional custom attributes for the portfolio
	Metadata map[string]any `json:"metadata,omitempty"`

} // @name Portfolio

type PortfolioErrorResponse struct {
	// in: body
	Body struct {
		// Error code identifying the specific error
		// example: 400001
		Code int `json:"code"`

		// Human-readable error message
		// example: Invalid input: field 'name' is required
		Message string `json:"message"`

		// Additional error details if available
		// example: {"field": "name", "violation": "required"}
		Details map[string]any `json:"details,omitempty"`
	}
}

type PortfolioResponse struct {
	// in: body
	Body Portfolio
}

type Portfolios struct {
	// Array of portfolio records
	// example: [{"id":"00000000-0000-0000-0000-000000000000","name":"My Portfolio","ledgerId":"00000000-0000-0000-0000-000000000000","status":{"code":"ACTIVE"}}]
	Items []Portfolio `json:"items"`

	// Current page number
	// example: 1
	// minimum: 1
	Page int `json:"page" example:"1" minimum:"1"`

	// Maximum number of items per page
	// example: 10
	// minimum: 1
	// maximum: 100
	Limit int `json:"limit" example:"10" minimum:"1" maximum:"100"`

} // @name Portfolios

type PortfoliosResponse struct {
	// in: body
	Body Portfolios
}

type Queue struct {
	// Organization identifier for the queue message
	// format: uuid
	// example: 00000000-0000-0000-0000-000000000000
	OrganizationID uuid.UUID `json:"organizationId" format:"uuid" example:"00000000-0000-0000-0000-000000000000"`

	// Ledger identifier for the queue message
	// format: uuid
	// example: 00000000-0000-0000-0000-000000000000
	LedgerID uuid.UUID `json:"ledgerId" format:"uuid" example:"00000000-0000-0000-0000-000000000000"`

	// Audit trail identifier for tracking queue operations
	// format: uuid
	// example: 00000000-0000-0000-0000-000000000000
	AuditID uuid.UUID `json:"auditId" format:"uuid" example:"00000000-0000-0000-0000-000000000000"`

	// Account identifier for the queue message
	// format: uuid
	// example: 00000000-0000-0000-0000-000000000000
	AccountID uuid.UUID `json:"accountId" format:"uuid" example:"00000000-0000-0000-0000-000000000000"`

	// Array of data items contained in this queue message
	// required: true
	QueueData []QueueData `json:"queueData"`

} // @name Queue

type QueueData struct {
	// Unique identifier for this queue data item
	// format: uuid
	// example: 00000000-0000-0000-0000-000000000000
	ID uuid.UUID `json:"id" format:"uuid" example:"00000000-0000-0000-0000-000000000000"`

	// Raw JSON payload data
	// example: {"type": "transaction", "amount": 1000}
	Value json.RawMessage `json:"value"`

} // @name QueueData

type RegulatoryFields struct {
	// Document of the participant (identifies which financial-group entity owns the relationship)
	ParticipantDocument *string `json:"participantDocument,omitempty" example:"12345678912345"`

} // @name RegulatoryFields

type RelatedParty struct {
	// Unique identifier of the related party.
	ID *uuid.UUID `json:"id,omitempty" example:"00000000-0000-0000-0000-000000000000"`
	// Document of the related party.
	Document string `json:"document" validate:"required" example:"12345678900"`
	// Name of the related party.
	Name string `json:"name" validate:"required" example:"John Smith"`
	// Role of the related party (PRIMARY_HOLDER, LEGAL_REPRESENTATIVE, RESPONSIBLE_PARTY).
	Role string `json:"role" validate:"required,oneof=PRIMARY_HOLDER LEGAL_REPRESENTATIVE RESPONSIBLE_PARTY" example:"PRIMARY_HOLDER"`
	// Start date of the relationship. Accepts both "2025-01-01" and "2025-01-01T00:00:00Z" formats.
	StartDate Date `json:"startDate" validate:"required" example:"2025-01-01"`
	// End date of the relationship (optional). Accepts both "2025-01-01" and "2025-01-01T00:00:00Z" formats.
	EndDate *Date `json:"endDate,omitempty" example:"2026-01-01"`

} // @name RelatedParty

type Representative struct {
	// The legal representative’s name.
	Name *string `json:"name,omitempty" example:"John Doe"`
	// The document number of the legal representative.
	Document *string `json:"document,omitempty" example:"91315026015"`
	// The email address of the legal representative.
	Email *string `json:"email,omitempty" example:"john.doe@example.com"`
	// The role of the legal representative within the company.
	Role *string `json:"role,omitempty" example:"CFO"`

} // @name Representative

type Segment struct {
	// Unique identifier for the segment (UUID format)
	ID string `json:"id" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Name of the segment (max length 256 characters)
	Name string `json:"name" example:"My Segment" maxLength:"256"`

	// ID of the ledger this segment belongs to (UUID format)
	LedgerID string `json:"ledgerId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// ID of the organization that owns this segment (UUID format)
	OrganizationID string `json:"organizationId" example:"00000000-0000-0000-0000-000000000000" format:"uuid"`

	// Status of the segment (active, inactive, pending)
	Status Status `json:"status"`

	// Timestamp when the segment was created
	CreatedAt time.Time `json:"createdAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the segment was last updated
	UpdatedAt time.Time `json:"updatedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Timestamp when the segment was deleted (null if not deleted)
	DeletedAt *time.Time `json:"deletedAt" example:"2021-01-01T00:00:00Z" format:"date-time"`

	// Additional custom attributes for the segment
	Metadata map[string]any `json:"metadata,omitempty"`

} // @name Segment

type SegmentErrorResponse struct {
	// in: body
	Body struct {
		// Error code identifying the specific error
		// example: 400001
		Code int `json:"code"`

		// Human-readable error message
		// example: Invalid input: field 'name' is required
		Message string `json:"message"`

		// Additional error details if available
		// example: {"field": "name", "violation": "required"}
		Details map[string]any `json:"details,omitempty"`
	}
}

type SegmentResponse struct {
	// in: body
	Body Segment
}

type Segments struct {
	// Array of segment records
	// example: [{"id":"00000000-0000-0000-0000-000000000000","name":"My Segment","ledgerId":"00000000-0000-0000-0000-000000000000","status":{"code":"ACTIVE"}}]
	Items []Segment `json:"items"`

	// Current page number
	// example: 1
	// minimum: 1
	Page int `json:"page" example:"1" minimum:"1"`

	// Maximum number of items per page
	// example: 10
	// minimum: 1
	// maximum: 100
	Limit int `json:"limit" example:"10" minimum:"1" maximum:"100"`

} // @name Segments

type SegmentsResponse struct {
	// in: body
	Body Segments
}

type Status struct {
	// Status code identifier, common values include: ACTIVE, INACTIVE, PENDING, SUSPENDED, DELETED
	Code string `json:"code" validate:"max=100" example:"ACTIVE" maxLength:"100" enum:"ACTIVE,INACTIVE,PENDING,SUSPENDED,DELETED"`

	// Optional human-readable description of the status
	Description *string `json:"description" validate:"omitempty,max=256" example:"Active status" maxLength:"256"`

} // @name Status

type TransactionRedisQueue struct {
	HeaderID          string                     `json:"header_id"`
	TransactionID     uuid.UUID                  `json:"transaction_id"`
	OrganizationID    uuid.UUID                  `json:"organization_id"`
	LedgerID          uuid.UUID                  `json:"ledger_id"`
	Balances          []BalanceRedis             `json:"balances"`
	ParserDSL         pkgTransaction.Transaction `json:"parserDSL"`
	TTL               time.Time                  `json:"ttl"`
	Validate          *pkgTransaction.Responses  `json:"validate"`
	TransactionStatus string                     `json:"transaction_status"`
	TransactionDate   time.Time                  `json:"transaction_date"`
}

type TransactionRoute struct {
	// The unique identifier of the Transaction Route.
	ID uuid.UUID `json:"id,omitempty" example:"01965ed9-7fa4-75b2-8872-fc9e8509ab0a"`
	// The unique identifier of the Organization.
	OrganizationID uuid.UUID `json:"organizationId,omitempty" example:"01965ed9-7fa4-75b2-8872-fc9e8509ab0a"`
	// The unique identifier of the Ledger.
	LedgerID uuid.UUID `json:"ledgerId,omitempty" example:"01965ed9-7fa4-75b2-8872-fc9e8509ab0a"`
	// Short text summarizing the purpose of the transaction. Used as an entry note for identification.
	Title string `json:"title,omitempty" example:"Charge Settlement"`
	// A description for the Transaction Route.
	Description string `json:"description,omitempty" example:"Settlement route for service charges"`
	// Additional metadata stored as JSON
	Metadata map[string]any `json:"metadata,omitempty" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`
	// An object containing accounting data of Operation Routes from the Transaction Route.
	OperationRoutes []OperationRoute `json:"operationRoutes,omitempty"`
	// The timestamp when the transaction route was created.
	CreatedAt time.Time `json:"createdAt" example:"2025-01-01T00:00:00Z"`
	// The timestamp when the transaction route was last updated.
	UpdatedAt time.Time `json:"updatedAt" example:"2025-01-01T00:00:00Z"`
	// The timestamp when the transaction route was deleted.
	DeletedAt *time.Time `json:"deletedAt" example:"2025-01-01T00:00:00Z"`

} // @name TransactionRoute

type TransactionRouteCache struct {
	Source      map[string]OperationRouteCache `json:"source"`
	Destination map[string]OperationRouteCache `json:"destination"`
}

type UpdateAccountInput struct {
	// Updated name of the account
	// required: false
	// example: Primary Corporate Checking Account
	// maxLength: 256
	Name string `json:"name" validate:"max=256" example:"Primary Corporate Checking Account" maxLength:"256"`

	// Updated segment ID for the account
	// required: false
	// format: uuid
	SegmentID *string `json:"segmentId" validate:"omitempty,uuid" format:"uuid"`

	// Updated portfolio ID for the account
	// required: false
	// format: uuid
	PortfolioID *string `json:"portfolioId" validate:"omitempty,uuid" format:"uuid"`

	// Optional external identifier for linking to external systems
	// required: false
	// example: EXT-ACC-12345
	// maxLength: 256
	EntityID *string `json:"entityId" validate:"omitempty,max=256" example:"EXT-ACC-12345" maxLength:"256"`

	// Updated status of the account
	// required: false
	Status Status `json:"status"`

	// Whether the account should be blocked
	// required: false
	Blocked *bool `json:"blocked"`

	// Updated custom key-value pairs for extending the account information
	// required: false
	// example: {"department": "Global Treasury", "purpose": "Primary Operations", "region": "Global"}
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`

	// NullFields tracks fields explicitly set to null in the request.
	// Used internally to enable RFC 7396 JSON Merge Patch semantics.
	// Hidden from JSON serialization.
	NullFields []string `json:"-"`

} // @name UpdateAccountInput

type UpdateAccountTypeInput struct {
	// The name of the account type.
	Name string `json:"name,omitempty" validate:"max=100" example:"Current Assets"`
	// Detailed description of the account type.
	Description string `json:"description,omitempty" validate:"max=500" example:"Assets that are expected to be converted to cash within one year"`
	// Custom key-value pairs for extending the account type information
	// required: false
	// example: {"department": "Treasury", "purpose": "Operating Expenses", "region": "Global"}
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`

} // @name UpdateAccountTypeInput

type UpdateAliasInput struct {
	// An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value.
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`
	// Object with banking information of the related account.
	BankingDetails *BankingDetails `json:"bankingDetails"`
	// Object with regulatory fields.
	RegulatoryFields *RegulatoryFields `json:"regulatoryFields,omitempty"`
	// List of related parties to add (appends to existing).
	RelatedParties []*RelatedParty `json:"relatedParties,omitempty"`

} // @name UpdateAliasRequest

type UpdateAssetInput struct {
	// Updated name of the asset (optional, max length 256 characters)
	Name string `json:"name" validate:"max=256" example:"Bitcoin"`

	// Updated status of the asset (active, inactive, pending)
	Status Status `json:"status"`

	// Updated or additional custom attributes for the asset
	// Keys max length: 100 characters, Values max length: 2000 characters
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`

} //	@name	UpdateAssetInput

type UpdateBalance struct {
	// Whether the account should be allowed to send funds from this balance
	// required: false
	// example: true
	AllowSending *bool `json:"allowSending" example:"true"`

	// Whether the account should be allowed to receive funds to this balance
	// required: false
	// example: true
	AllowReceiving *bool `json:"allowReceiving" example:"true"`

} // @name UpdateBalance

type UpdateHolderInput struct {
	// Optional field for an external identifier to client correlation purposes.
	ExternalID *string `json:"externalId" example:"G4K7N8M"`
	// Holders name.
	Name *string `json:"name" example:"John Doe"`
	// Object of addresses.
	Addresses *Addresses `json:"addresses"`
	// Object with contact information.
	Contact *Contact `json:"contact"`
	// Object with natural person information.
	NaturalPerson *NaturalPerson `json:"naturalPerson"`
	// Object with legal person information.
	LegalPerson *LegalPerson `json:"legalPerson"`
	// An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value.
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`

} // @name UpdateHolderRequest

type UpdateLedgerInput struct {
	// Updated display name of the ledger
	// required: false
	// example: Treasury Operations Global
	// maxLength: 256
	Name string `json:"name" validate:"max=256" example:"Treasury Operations Global" maxLength:"256"`

	// Updated status of the ledger
	// required: false
	Status Status `json:"status"`

	// Updated custom key-value pairs for extending the ledger information
	// required: false
	// example: {"department": "Global Finance", "currency": "USD", "region": "Global"}
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`

} // @name UpdateLedgerInput

type UpdateOperationRouteInput struct {
	// Short text summarizing the purpose of the operation. Used as an entry note for identification.
	Title string `json:"title,omitempty" validate:"max=50" example:"Cashin from service charge"`
	// Detailed description of the operation route purpose and usage.
	Description string `` /* 139-byte string literal not displayed */
	// External reference of the operation route.
	Code string `json:"code,omitempty" validate:"max=100" example:"EXT-001"`
	// Additional metadata stored as JSON
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`
	// The account selection rule configuration.
	Account *AccountRule `json:"account,omitempty"`

} // @name UpdateOperationRouteInput

type UpdateOrganizationInput struct {
	// Updated legal name of the organization
	// required: false
	// example: Lerian Financial Group Ltd.
	// maxLength: 256
	LegalName string `json:"legalName" validate:"max=256" example:"Lerian Financial Group Ltd." maxLength:"256"`

	// Updated UUID of the parent organization if this is a child organization
	// required: false
	// format: uuid
	ParentOrganizationID *string `json:"parentOrganizationId" validate:"omitempty,uuid" format:"uuid"`

	// Updated trading or brand name of the organization
	// required: false
	// example: Lerian Group
	// maxLength: 256
	DoingBusinessAs string `json:"doingBusinessAs" validate:"max=256" example:"Lerian Group" maxLength:"256"`

	// Updated physical address of the organization
	// required: false
	Address Address `json:"address"`

	// Updated status of the organization
	// required: false
	Status Status `json:"status"`

	// Updated custom key-value pairs for extending the organization information
	// required: false
	// example: {"industry": "Financial Technology", "founded": 2020, "employees": 200, "headquarters": "New York"}
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`

} //	@name	UpdateOrganizationInput

type UpdatePortfolioInput struct {
	// Updated external entity identifier (optional, max length 256 characters)
	EntityID string `json:"entityId" validate:"omitempty,max=256" example:"00000000-0000-0000-0000-000000000000"`

	// Updated name of the portfolio (optional, max length 256 characters)
	Name string `json:"name" validate:"max=256" example:"My Portfolio Updated"`

	// Updated status of the portfolio (active, inactive, pending)
	Status Status `json:"status"`

	// Updated or additional custom attributes for the portfolio
	// Keys max length: 100 characters, Values max length: 2000 characters
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`

} // @name UpdatePortfolioInput

type UpdateSegmentInput struct {
	// Updated name of the segment (optional, max length 256 characters)
	Name string `json:"name" validate:"max=256" example:"My Segment Updated"`

	// Updated status of the segment (active, inactive, pending)
	Status Status `json:"status"`

	// Updated or additional custom attributes for the segment
	// Keys max length: 100 characters, Values max length: 2000 characters
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`

} // @name UpdateSegmentInput

type UpdateTransactionRouteInput struct {
	// Short text summarizing the purpose of the transaction. Used as an entry note for identification.
	Title string `json:"title,omitempty" validate:"max=50" example:"Charge Settlement"`
	// A description for the Transaction Route.
	Description string `json:"description,omitempty" validate:"max=250" example:"Settlement route for service charges"`
	// Additional metadata stored as JSON
	Metadata map[string]any `json:"metadata" validate:"dive,keys,keymax=100,endkeys,omitempty,nonested,valuemax=2000"`
	// An object containing accounting data of Operation Routes from the Transaction Route.
	OperationRoutes *[]uuid.UUID `json:"operationRoutes,omitempty"`

} // @name UpdateTransactionRouteInput