antinvestor_api_ledger library

Dart client library for Ant Investor Ledger Service.

Provides Ledger service functionality using Connect RPC protocol.

Classes

Account
Account represents a specific account within a ledger. Tracks balances and supports multi-currency operations.
ContactLink represents a link between a contact and a profile in the system. Used for associating external contacts with internal profiles across services. This enables unified identity management and contact resolution.
CreateAccountRequest
CreateAccountRequest creates a new account within a ledger.
CreateAccountResponse
CreateAccountResponse returns the newly created account.
CreateLedgerRequest
CreateLedgerRequest creates a new ledger in the chart of accounts.
CreateLedgerResponse
CreateLedgerResponse returns the newly created ledger.
CreateTransactionRequest
CreateTransactionRequest creates a new double-entry transaction.
CreateTransactionResponse
CreateTransactionResponse returns the newly created transaction.
ErrorDetail
Standard error codes used by API responses. Use gRPC status codes; the application-level ErrorDetail below may carry more.
Ledger
Ledger represents a category in the chart of accounts. Ledgers can be hierarchical with parent-child relationships.
LedgerService
LedgerService provides double-entry bookkeeping and financial accounting. All RPCs require authentication via Bearer token.
LedgerServiceApi
LedgerServiceBase
LedgerType
LedgerType defines the fundamental accounting categories. Based on standard accounting equation: Assets = Liabilities + Capital + (Income - Expenses) buf:lint:ignore ENUM_VALUE_PREFIX
ListValue
ListValue is a wrapper around a repeated field of values.
NullValue
NullValue is a singleton enumeration to represent the null value for the Value type union.
PageCursor
PageCursor provides standard offset-based pagination/cursor stream parameters. Used for list operations that return large result sets.
ReverseTransactionRequest
ReverseTransactionRequest reverses a transaction by creating offsetting entries.
ReverseTransactionResponse
ReverseTransactionResponse returns the reversal transaction.
SearchAccountsResponse
SearchAccountsResponse returns accounts matching search criteria.
SearchLedgersResponse
SearchLedgersResponse returns ledgers matching search criteria.
SearchRequest
SearchRequest provides a standard structure for search operations across services. Supports text search, ID-based queries, pagination, property filtering, and extensibility.
SearchTransactionEntriesResponse
SearchTransactionEntriesResponse returns transaction entries matching search criteria.
SearchTransactionsResponse
SearchTransactionsResponse returns transactions matching search criteria.
STATE
STATE represents the lifecycle state of an entity across all services. This enum provides a consistent way to track entity states from creation to deletion. buf:lint:ignore ENUM_VALUE_PREFIX
STATUS
STATUS represents the processing status of an operation or task. This enum is used for tracking asynchronous operations, jobs, and workflows. buf:lint:ignore ENUM_VALUE_PREFIX
StatusRequest
StatusRequest retrieves the current status of an entity or operation.
StatusResponse
StatusResponse returns the current state and status of an entity or operation.
StatusUpdateRequest
StatusUpdateRequest updates the state and/or status of an entity or operation. Used for state transitions and status updates by authorized services.
StatusUpdateResponse
StatusUpdateResponse returns the updated status after a status update operation.
Struct
Struct represents a structured data value, consisting of fields which map to dynamically typed values. In some languages, Struct might be supported by a native representation. For example, in scripting languages like JS a struct is represented as an object. The details of that representation are described together with the proto support for the language.
Timestamp
A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. The count is relative to an epoch at UTC midnight on January 1, 1970, in the proleptic Gregorian calendar which extends the Gregorian calendar backwards to year one.
Transaction
Transaction represents a complete double-entry transaction. Must contain balanced entries (sum of debits = sum of credits).
TransactionEntry
TransactionEntry represents one side of a double-entry transaction. Each transaction must have at least two entries with balanced debits and credits.
TransactionType
TransactionType defines the nature of a transaction. buf:lint:ignore ENUM_VALUE_PREFIX
UpdateAccountRequest
UpdateAccountRequest updates an existing account's metadata.
UpdateAccountResponse
UpdateAccountResponse returns the updated account.
UpdateLedgerRequest
UpdateLedgerRequest updates an existing ledger's metadata.
UpdateLedgerResponse
UpdateLedgerResponse returns the updated ledger.
UpdateTransactionRequest
UpdateTransactionRequest updates a transaction's metadata.
UpdateTransactionResponse
UpdateTransactionResponse returns the updated transaction.
Value
Value represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

Enums

Value_Kind

Extension Types

LedgerServiceClient
LedgerService provides double-entry bookkeeping and financial accounting. All RPCs require authentication via Bearer token.

Constants

Account$json → const Map<String, Object>
CreateAccountRequest$json → const Map<String, Object>
CreateAccountResponse$json → const Map<String, Object>
CreateLedgerRequest$json → const Map<String, Object>
CreateLedgerResponse$json → const Map<String, Object>
CreateTransactionRequest$json → const Map<String, Object>
CreateTransactionResponse$json → const Map<String, Object>
defaultLedgerEndpoint → const String
Ledger$json → const Map<String, Object>
LedgerServiceBase$json → const Map<String, dynamic>
LedgerServiceBase$messageJson → const Map<String, Map<String, dynamic>>
LedgerType$json → const Map<String, Object>
ReverseTransactionRequest$json → const Map<String, Object>
ReverseTransactionResponse$json → const Map<String, Object>
SearchAccountsResponse$json → const Map<String, Object>
SearchLedgersResponse$json → const Map<String, Object>
SearchTransactionEntriesResponse$json → const Map<String, Object>
SearchTransactionsResponse$json → const Map<String, Object>
Transaction$json → const Map<String, Object>
TransactionEntry$json → const Map<String, Object>
TransactionType$json → const Map<String, Object>
UpdateAccountRequest$json → const Map<String, Object>
UpdateAccountResponse$json → const Map<String, Object>
UpdateLedgerRequest$json → const Map<String, Object>
UpdateLedgerResponse$json → const Map<String, Object>
UpdateTransactionRequest$json → const Map<String, Object>
UpdateTransactionResponse$json → const Map<String, Object>

Properties

accountDescriptor → Uint8List
Descriptor for Account. Decode as a google.protobuf.DescriptorProto.
final
createAccountRequestDescriptor → Uint8List
Descriptor for CreateAccountRequest. Decode as a google.protobuf.DescriptorProto.
final
createAccountResponseDescriptor → Uint8List
Descriptor for CreateAccountResponse. Decode as a google.protobuf.DescriptorProto.
final
createLedgerRequestDescriptor → Uint8List
Descriptor for CreateLedgerRequest. Decode as a google.protobuf.DescriptorProto.
final
createLedgerResponseDescriptor → Uint8List
Descriptor for CreateLedgerResponse. Decode as a google.protobuf.DescriptorProto.
final
createTransactionRequestDescriptor → Uint8List
Descriptor for CreateTransactionRequest. Decode as a google.protobuf.DescriptorProto.
final
createTransactionResponseDescriptor → Uint8List
Descriptor for CreateTransactionResponse. Decode as a google.protobuf.DescriptorProto.
final
ledgerDescriptor → Uint8List
Descriptor for Ledger. Decode as a google.protobuf.DescriptorProto.
final
ledgerServiceDescriptor → Uint8List
Descriptor for LedgerService. Decode as a google.protobuf.ServiceDescriptorProto.
final
ledgerTypeDescriptor → Uint8List
Descriptor for LedgerType. Decode as a google.protobuf.EnumDescriptorProto.
final
reverseTransactionRequestDescriptor → Uint8List
Descriptor for ReverseTransactionRequest. Decode as a google.protobuf.DescriptorProto.
final
reverseTransactionResponseDescriptor → Uint8List
Descriptor for ReverseTransactionResponse. Decode as a google.protobuf.DescriptorProto.
final
searchAccountsResponseDescriptor → Uint8List
Descriptor for SearchAccountsResponse. Decode as a google.protobuf.DescriptorProto.
final
searchLedgersResponseDescriptor → Uint8List
Descriptor for SearchLedgersResponse. Decode as a google.protobuf.DescriptorProto.
final
searchTransactionEntriesResponseDescriptor → Uint8List
Descriptor for SearchTransactionEntriesResponse. Decode as a google.protobuf.DescriptorProto.
final
searchTransactionsResponseDescriptor → Uint8List
Descriptor for SearchTransactionsResponse. Decode as a google.protobuf.DescriptorProto.
final
transactionDescriptor → Uint8List
Descriptor for Transaction. Decode as a google.protobuf.DescriptorProto.
final
transactionEntryDescriptor → Uint8List
Descriptor for TransactionEntry. Decode as a google.protobuf.DescriptorProto.
final
transactionTypeDescriptor → Uint8List
Descriptor for TransactionType. Decode as a google.protobuf.EnumDescriptorProto.
final
updateAccountRequestDescriptor → Uint8List
Descriptor for UpdateAccountRequest. Decode as a google.protobuf.DescriptorProto.
final
updateAccountResponseDescriptor → Uint8List
Descriptor for UpdateAccountResponse. Decode as a google.protobuf.DescriptorProto.
final
updateLedgerRequestDescriptor → Uint8List
Descriptor for UpdateLedgerRequest. Decode as a google.protobuf.DescriptorProto.
final
updateLedgerResponseDescriptor → Uint8List
Descriptor for UpdateLedgerResponse. Decode as a google.protobuf.DescriptorProto.
final
updateTransactionRequestDescriptor → Uint8List
Descriptor for UpdateTransactionRequest. Decode as a google.protobuf.DescriptorProto.
final
updateTransactionResponseDescriptor → Uint8List
Descriptor for UpdateTransactionResponse. Decode as a google.protobuf.DescriptorProto.
final

Functions

newLedgerClient({required TransportFactory createTransport, String? endpoint, TokenManager? tokenManager, TokenRefreshCallback? onTokenRefresh, List<Interceptor>? additionalInterceptors, bool noAuth = false}) → Future<ConnectClientBase<LedgerServiceClient>>

Typedefs

LedgerClient = ConnectClientBase<LedgerServiceClient>