Input Types

AccountConfigInput

Fields to create a system configuration for an account.

Input Fields

`enableConcurrentPosting` - `Boolean`	When `true`, optimizes the account for a ridiculously high rate of entries written. Tradeoff is that read operations for balances become much more expensive and slow; use with caution. In updates you can enable, but not disable. Defaults to `false`.

AccountFilterInput

Filter conditions to apply to an account query. Filters are only applied if the field is used by the specified index.

Input Fields

`accountId` - `FilterValue`	Filter on the `accountId` field. Required when using index `AccountIndex.ACCOUNT_ID`.
`externalId` - `FilterValue`	Filter on the `externalId` field. Required when using index `AccountIndex.EXTERNAL_ID`.
`name` - `FilterValue`	Filter on the `name` field. Only available when using index `AccountIndex.NAME`.
`code` - `FilterValue`	Filter on the `code` field. Only available when using index `AccountIndex.CODE`.
`status` - `FilterValue`	Filter on the `status` field. Only available when using index `AccountIndex.STATUS`.
`custom` - `CustomIndexFilter`	Filter conditions for a custom index. Only available when using index `AccountIndex.CUSTOM`.
`search` - `SearchFilter`	Filter conditions for a search. Only available when using index `AccountIndex.SEARCH`.
`codeUnique` - `FilterValue`	Filter on the `code` field. Required when using index `AccountIndex.CODE_UNIQUE`.

AccountIndexInput

Specify the pre-defined AccountIndex and sort order to use in a query.

Input Fields

`name` - `AccountIndex!`	Indexes for querying Accounts. To optimize query performance and apply desired filters, choose the appropriate index.
`sort` - `SortOrder`	`ASC` (ascending) or `DESC` (descending).

AccountInput

Fields to create a new account.

Input Fields

`accountId` - `UUID!`	Unique identifier for the account.
`externalId` - `String`	Allows specifying a unique external ID associated with this account.
`code` - `String!`	Shorthand code for the account.
`name` - `String!`	Account name.
`normalBalanceType` - `DebitOrCredit!`	Determines whether account should use a debit- or credit-normal balance. Default: `CREDIT`
`accountSetIds` - `[UUID]`	IDs of AccountSets to add this account to.
`description` - `String`	Description of the account.
`status` - `Status!`	Current status for the account. Default: `ACTIVE`
`metadata` - `JSON`	Metadata attached to this account.
`config` - `AccountConfigInput`	System config for the account.

AccountSetConfigInput

Fields to create a system configuration for an account set.

Input Fields

`enableConcurrentPosting` - `Boolean`	When `true`, optimizes the account set for a ridiculously high rate of entries written. Tradeoff is that read operations for balances become much more expensive and slow; use with caution. In updates you can enable, but not disable. Defaults to `false`.

AccountSetFilterInput

Filter conditions to apply to an account set query. Filters are only applied if the field is used by the specified index.

Input Fields

`accountSetId` - `FilterValue`	Filter on the `accountSetId` field. Required when using index `AccountSetIndex.ACCOUNT_SET_ID`.
`journalId` - `FilterValue`	Specify the Journal to use with `eq`. Required for all indexes.
`name` - `FilterValue`	Filter on the `name` field. Only available when using index `AccountSetIndex.NAME`.
`custom` - `CustomIndexFilter`	Filter conditions for a custom index. Only available when using index `AccountSetIndex.CUSTOM`.
`search` - `SearchFilter`	Filter conditions for a search. Only available when using index `AccountSetIndex.SEARCH`.

AccountSetIndexInput

Specify the pre-defined AccountSetIndex and sort order to use in a query.

Input Fields

`name` - `AccountSetIndex!`	Indexes for querying AccountSets. To optimize query performance and apply desired filters, choose the appropriate index.
`sort` - `SortOrder`	`ASC` (ascending) or `DESC` (descending).

AccountSetInput

Fields to create a new account set.

Input Fields

`accountSetId` - `UUID!`	Unique identifier for the set.
`journalId` - `UUID`	The journal for the set. If omitted, the default journal will be used.
`name` - `String!`	Name for the set.
`description` - `String`	Description of the account set.
`normalBalanceType` - `DebitOrCredit!`	Determines whether the account set should use a debit- or credit-normal balance. Default: `CREDIT`
`metadata` - `JSON`	Metadata attached to this account set.
`config` - `AccountSetConfigInput`	System config for the account set.

AccountSetMemberInput

Input Fields

`memberType` - `AccountSetMemberType`	Whether the member to add is an Account or AccountSet
`memberId` - `UUID!`	Identifier for the member to add. When adding accounts, this is the `accountId`. When adding account sets, this is the `accountSetId`.

AccountSetMembersFilterInput

Filter conditions to apply when querying members of an account set.

Input Fields

`accountSetId` - `FilterValue`	Filter on the `accountSetId` field.
`memberId` - `FilterValue`	Filter on the `memberId` field: the UUID of a member `Account` or `AccountSet`.

AccountSetUpdateInput

AccountSet fields to update.

Input Fields

`name` - `String`	Name for the set.
`description` - `String`	Description of the account set.
`normalBalanceType` - `DebitOrCredit`	Determines whether the account set should use a debit- or credit-normal balance.
`metadata` - `JSON`	Metadata attached to this account set.
`config` - `AccountSetConfigInput`	System config for the account set.

AccountUpdateInput

Account fields to update.

Input Fields

`externalId` - `String`	Allows specifying a unique external ID associated with this account.
`code` - `String`	Shorthand code for the account.
`name` - `String`	Account name.
`normalBalanceType` - `DebitOrCredit`	Determines whether account should use a debit- or credit-normal balance.
`description` - `String`	Description of the account.
`status` - `Status`	Current status for the account.
`metadata` - `JSON`	Metadata attached to this account.
`config` - `AccountConfigInput`	System config for the account.

BalanceFilterInput

Filter conditions to apply to a balance query. Filters are only applied if the field is used by the specified index.

Input Fields

`journalId` - `FilterValue`	Specify the Journal to use with `eq`. If omitted, the default journal will be used.
`accountId` - `FilterValue`	Filter on the `accountId` field. Required when using index `BalanceIndex.ACCOUNT_ID`.
`currency` - `FilterValue`	Filter on the `currency` field.
`calculationId` - `FilterValue`	Filter on `calculationId` field when using `BalanceIndex.DIMENSION`
`dimension` - `DimensionFilterValue`	Filter on `dimension` field when using `BalanceIndex.Dimension`
`custom` - `CustomIndexFilter`	Filter conditions for a custom index. Only available when using index `BalanceIndex.CUSTOM`.
`search` - `SearchFilter`	Filter conditions for a search. Only available when using index `BalanceIndex.SEARCH`.

BalanceHistoryFilterInput

Filter conditions to apply to a balance history query.

Input Fields

`modified` - `FilterValue`	Filter on the `modified` timestamp.
`committed` - `FilterValue`	Filter on the transaction commit timestamp for the specific balance record version.

BalanceIndexInput

Specify the pre-defined BalanceIndex and sort order to use in a query.

Input Fields

`name` - `BalanceIndex!`	Indexes for querying Balances. To optimize query performance and apply desired filters, choose the appropriate index.
`sort` - `SortOrder`	`ASC` (ascending) or `DESC` (descending).

BatchExecuteStatementInput

Input Fields

`sqls` - `[String]`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Between

Input Fields

`begin` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`end` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

BulkQueryInput

Input Fields

`name` - `String`	Human readable name of this bulk execution. Default: `"Bulk Query"`
`key` - `String!`	Key to file to execute.
`executionId` - `UUID!`	Unique Identifier for this execution of a bulk query.
`query` - `String!`	Parameterized GraphQL query string to execute.
`transform` - `String`	Optional jq transform to run on variables in file identified by `key`. The result of the transform must be a list of json variables. @example("map(.accountId)")

CalculationFilterInput

Input Fields

`calculationId` - `FilterValue`	Conditional logic by which to apply a filter on a query. Each FilterValue object must contain just one key/value pair. Valid: `{ eq: "123" }` Invalid: `{ eq: "123", gt: "100" }`
`code` - `FilterValue`	Conditional logic by which to apply a filter on a query. Each FilterValue object must contain just one key/value pair. Valid: `{ eq: "123" }` Invalid: `{ eq: "123", gt: "100" }`
`status` - `FilterValue`	Conditional logic by which to apply a filter on a query. Each FilterValue object must contain just one key/value pair. Valid: `{ eq: "123" }` Invalid: `{ eq: "123", gt: "100" }`

calculationId - FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

code - FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

status - FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

CalculationIndexInput

Input Fields

`name` - `CalculationIndex!`
`sort` - `SortOrder`	`ASC` (ascending) or `DESC` (descending).

CancelStatementInput

Input Fields

`id` - `String!`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

CardInitializeInput

Input Fields

`journalId` - `UUID`	The unique identifier for the journal that card transactions will post to by default. If omitted, the default journal will be used.
`settlementAccountId` - `UUID`	A unique identifier to an existing settlement account that card transactions will post to by default. If not provided, a default card transaction account will be used as the settlement account.

CreateCalculationInput

Input Fields

`calculationId` - `UUID!`	Unique identifier for this calculation.
`code` - `String!`	Unique shorthand code for this balance calculation.
`description` - `String!`	Human readable description of this calculation.
`dimensions` - `[PartitionKeyInput]!`	Group by these values to index the calculation. The `account`, `transaction` and `entry` are available for use in the dimension computation on `context.vars`.
`condition` - `Expression`	A boolean expression indicating if an balance entry should be written. The `account`, `transaction` and `entry` are available for use in the dimension computation on `context.vars`. @example("has(context.vars.account.metadata.policyPayment)")

CreateClientInput

Input Fields

`principal` - `String!`	Principal that this client applies to. If you're supplying your own OIDC this will be the `iss` claim on your JWT. If using Twisp IAM/OIDC token exchange, this will be the IAM principal you signed with, typically a role ARN.
`name` - `String!`	Unique name of the client.
`policies` - `[PolicyInput]!`	The policies to evaluate.

CreateGroupInput

Input Fields

`id` - `UUID!`	Unique ID for the group.
`name` - `String!`	A human-friendly name for the group, such as 'Admins' or 'DataAnalysts'.
`description` - `String!`	A brief description of the group's purpose, intended to provide additional context.
`policy` - `String!`	A set of policies to apply to this group, formatted as a JSON list that define the permissions granted to users within this group. The structure of these policies matches the Policy type, but serialized as a JSON string. Example: `policy: "[{\"actions\": [\"\"],\"effect\": \"DENY\",\"resources\":[\"\"],\"assertions\": {\"always false\": \"1 == 0\"}}]"`

CreateIndexInput

Input Fields

`name` - `String!`	Unique identifier of this index. Typically human readable.
`on` - `IndexOnEnum!`	The type of record this index applies to.
`search` - `Boolean`	If this index is a search index, `unique`, `partition` and `sort` are ignored.
`unique` - `Boolean`	Indicates if this index is unique.
`partition` - `[PartitionKeyInput]!`	The partition key used for this index.
`sort` - `[IndexKeyInput]!`	The sort key to use for supporting range queries.
`constraints` - `ExpressionMap`	Map of named CEL expressions specifying the conditions for including a record in this index. Records are only included in the index if all expressions evaluate to `true`, i.e. they are combined with a logical AND. Each expression must return a boolean value. For example, a custom index on a `metadata.category` field might use the constraints `{ hasCategory: "has(document.metadata.category)" }` to ensure that only records whose `metadata` document has a defined value for the `category` field are included.

CreateScheduleInput

Input Fields

`jobType` - `JobType!`	The job type to create the schedule for. Currently only one schedule per job-type is supported.
`jobName` - `String!`	A job name that's unique per job type.
`principal` - `String!`	The Twisp principal to run the job on a schedule. This should have a matching `client` policy.
`scheduleExpression` - `String!`	A schedule expression to run this job on. cron/rate/once supported see https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html for valid syntax.
`timezone` - `String!`	The timezone to run this schedule on based on https://www.iana.org/time-zones example: "America/Los_Angeles" or "UTC" Supports ST rules defined in https://docs.aws.amazon.com/scheduler/latest/UserGuide/schedule-types.html
`metadata` - `JSON!`	JSON metadata to pass to running job.

CreateSearchIndexInput

Input Fields

name - String! Unique identifier of this index. Typically human readable.

on - IndexOnEnum! The type of record this index applies to.

constraints - ExpressionMap

Map of named CEL expressions specifying the conditions for including a record in this index.

Records are only included in the index if all expressions evaluate to true, i.e. they are combined with a logical AND. Each expression must return a boolean value.

For example, a custom index on a metadata.category field might use the constraints { hasCategory: "has(document.metadata.category)" } to ensure that only records whose metadata document has a defined value for the category field are included.

CreateTenantInput

Input Fields

`id` - `UUID!`	Unique ID for the tenant.
`accountId` - `String!`	A globally unique identifier representing an environment within the organization. This accountId, when combined with an AWS region, is used to calculate the database tenant.
`name` - `String!`	A human-friendly name for the tenant, used for display purposes and easier identification.
`description` - `String!`	A brief description of the tenant, providing additional context about its purpose or characteristics.

CreateUpload

Input Fields

`key` - `String!`	Unique identifier of file. e.g. `path/to/file.json`
`uploadType` - `UploadType!`	The type of upload. Currently only supports `BULK_GRAPHQL_VARIABLES` Default: `BULK_GRAPHQL_VARIABLES`
`contentType` - `String!`	`contentType` of file. Currently only type supported is `application/json`. File should be array of json objects to pass to bulk query as variables, each item in array representing a single execution of the query. Default: `"application/json"`

CreateUserInput

Input Fields

`id` - `UUID!`	Unique ID for the user.
`groupIds` - `[UUID!]!`	A list of unique identifiers for the groups to which the user belongs. The user's permissions are determined by the combined policies of these groups.
`email` - `String!`	The user's email address, which serves as a unique identifier and primary means of contact.

CustomIndexFilter

Query conditions for a custom index.

Input Fields

`index` - `String!`	The `name` of the custom index to use.
`partition` - `[CustomIndexFilterValue]`	Query conditions for specifying the index partition to use.
`sort` - `[CustomIndexFilterValue]`	Query conditions for specifying sort order.

CustomIndexFilterValue

Filter conditionals for querying the partition or sort key of a custom index.

Input Fields

`alias` - `String!`	Identifier for the key to apply the filter to.
`value` - `FilterValue`	Conditions to apply at this key.

DescribeStatementInput

Input Fields

`id` - `String!`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

DescribeTableInput

Input Fields

`database` - `String!`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`maxResults` - `Int!`	The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
`nextToken` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`schema` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`table` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

DimensionBetween

Input Fields

`begin` - `JSON`	JSON object.
`end` - `JSON`	JSON object.

DimensionFilterValue

Input Fields

`eq` - `JSON`	JSON object.
`like` - `JSON`	JSON object.
`lt` - `JSON`	JSON object.
`lte` - `JSON`	JSON object.
`gt` - `JSON`	JSON object.
`gte` - `JSON`	JSON object.
`between` - `DimensionBetween`

Effective

Input Fields

`cumulative` - `Date`	Cumulative account balance as of a particular effective date. Example: `"2023-10-17"`
`period` - `String`	Account balance of a particular effective time period. Supported periods are in formats: `YYYY`, `YYYY-MM`, `YYYY-MM-DD`. Useful for reconciliation/balances files. Example: `"2023-10"`
`range` - `PeriodRange`	Effective account balances over a range of time periods. Useful for income statement. Example: `{gte: "2023-10", lte: "2023-12"}`

EndpointFilterInput

Input Fields

`endpointId` - `FilterValue`	Filter on the `endpointId` field. Required when using index `EndpointInded.ENDPOINT_ID`.
`status` - `FilterValue`	Filter on the `status` field. Only available when using index `EndpointIndex.STATUS`.

EndpointIndexInput

Input Fields

`name` - `EndpointIndex!`
`sort` - `SortOrder`	`ASC` (ascending) or `DESC` (descending).

EndpointInput

Fields to create a new endpoint.

Input Fields

`endpointId` - `UUID!`	Unique identifier for the endpoint.
`status` - `EndpointStatus`	Current status of the endpoint. Default: `ENABLED`
`endpointType` - `EndpointType`	The type of endpoint this endpoint is. Default: `WEBHOOK`
`url` - `String!`	The url where this endpoint will transmit subscribed events to.
`subscription` - `[String!]!`	A list of subscriptions that are available, supporting wildcards `*`. Format: `<entity>.<created\|updated\|deleted>` Supported entities: journal account accountcontext accountset accountsetmember trancode transaction entry balance customindex custombalance endpoint
`description` - `String!`	description of this endpoint.
`filters` - `ExpressionMap`	Map of named CEL expressions specifying conditions for sending an event to the endpoint. Record is only sent if all expressions evaluate to true, i.e. they are combined with a logical AND. Each expression must return a boolean value.

EndpointUpdateInput

Fields to update an existing endpoint.

Input Fields

`status` - `EndpointStatus`	Current status of the endpoint.
`endpointType` - `EndpointType`	The type of endpoint this endpoint is.
`url` - `String`	The url where this endpoint will transmit subscribed events to.
`subscription` - `[String]`	A list of subscriptions that are available, supporting wildcards `*`. Format: `<entity>.<created\|updated\|deleted>` Supported entities: journal account accountcontext accountset accountsetmember trancode transaction entry balance customindex custombalance endpoint
`description` - `String`	description of this endpoint.
`filters` - `ExpressionMap`	Map of named CEL expressions specifying conditions for sending an event to the endpoint. Record is only sent if all expressions evaluate to true, i.e. they are combined with a logical AND. Each expression must return a boolean value.

EntryFilterInput

Filter conditions to apply to an entry query. Filters are only applied if the field is used by the specified index.

Input Fields

`entryId` - `FilterValue`	Filter on the `entryId` field. Required when using index `EntryIndex.ENTRY_ID`.
`journalId` - `FilterValue`	Conditional logic by which to apply a filter on a query. Each FilterValue object must contain just one key/value pair. Valid: `{ eq: "123" }` Invalid: `{ eq: "123", gt: "100" }`
`currency` - `FilterValue`	Conditional logic by which to apply a filter on a query. Each FilterValue object must contain just one key/value pair. Valid: `{ eq: "123" }` Invalid: `{ eq: "123", gt: "100" }`
`layer` - `FilterValue`	Conditional logic by which to apply a filter on a query. Each FilterValue object must contain just one key/value pair. Valid: `{ eq: "123" }` Invalid: `{ eq: "123", gt: "100" }`
`transactionId` - `FilterValue`	Filter on the `transactionId` field. Required when using index `EntryIndex.TRANSACTION_ID`.
`custom` - `CustomIndexFilter`	Filter conditions for a custom index. Only available when using index `EntryIndex.CUSTOM`.
`search` - `SearchFilter`	Filter conditions for a search. Only available when using index `EntryIndex.SEARCH`.

EntryIndexInput

Specify the pre-defined EntryIndex and sort order to use in a query.

Input Fields

`name` - `EntryIndex!`	Indexes for querying Entries. To optimize query performance and apply desired filters, choose the appropriate index.
`sort` - `SortOrder`	`ASC` (ascending) or `DESC` (descending).

EntryUpdateInput

Entry fields to update.

Input Fields

`description` - `String`	Description of the entry.
`metadata` - `JSON`	Metadata attached to this entry.

ExecuteStatementInput

Input Fields

`sql` - `String!`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

ExecuteStatementSyncInput

Input Fields

`sql` - `String!`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

FilterValue

Conditional logic by which to apply a filter on a query.

Each FilterValue object must contain just one key/value pair.

Valid: { eq: "123" }
Invalid: { eq: "123", gt: "100" }

Input Fields

`eq` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`like` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`lt` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`lte` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`gt` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`gte` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`all` - `Boolean`	The `Boolean` scalar type represents `true` or `false`.
`between` - `Between`

GetStatementResultInput

Input Fields

`id` - `String!`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`nextToken` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

IndexKeyInput

Specify a named expression to sort the records within a custom index.

Used for sorting and for querying by range conditions.

Input Fields

alias - String! Identifier for this key. Should be a short, human-readable name.

`alias` - `String!`	Identifier for this key. Should be a short, human-readable name.
`value` - `Expression!`	CEL expression which resolves to the value that is to be sorted. Within the expression, the `document` object represents the record. To sort by a field on the record, use `document.<field_name>`.
`sort` - `SortOrder!`	Whether the sort is in ascending or descending order.

value - Expression!

CEL expression which resolves to the value that is to be sorted.

Within the expression, the document object represents the record. To sort by a field on the record, use document.<field_name>.

sort - SortOrder! Whether the sort is in ascending or descending order.

JournalConfigInput

Fields to create a system configuration for a journal.

Input Fields

`enableEffectiveBalances` - `Boolean`	When `true`, records point-in-time effective balances for all accounts in the journal. Defaults to `false`.

JournalFilterInput

Filter conditions to apply to a journal query. Filters are only applied if the field is used by the specified index.

Input Fields

`journalId` - `FilterValue`	Filter on the `journalId` field. Required when using index `JournalIndex.JOURNAL_ID`.
`name` - `FilterValue`	Filter on the `name` field. Only available when using index `JournalIndex.NAME`.
`status` - `FilterValue`	Filter on the `status` field. Only available when using index `JournalIndex.STATUS`.
`code` - `FilterValue`	Filter on the `code` field. Only available when using index `JournalIndex.CODE`.

JournalIndexInput

Specify the pre-defined JournalIndex and sort order to use in a query.

Input Fields

`name` - `JournalIndex!`	Indexes for querying Journals. To optimize query performance and apply desired filters, choose the appropriate index.
`sort` - `SortOrder`	`ASC` (ascending) or `DESC` (descending).

JournalInput

Fields to create a new Journal.

Input Fields

`journalId` - `UUID!`	Unique identifier for the journal.
`name` - `String!`	Name for the journal.
`description` - `String`	Description of the journal.
`status` - `Status!`	Operational status of the journal. Default: `ACTIVE`
`code` - `String`	Optional unique code for the journal.
`config` - `JournalConfigInput`	System config for the journal.

JournalUpdateInput

Journal fields to update.

Input Fields

`name` - `String`	Name for the journal.
`description` - `String`	Description of the journal.
`status` - `Status`	Operational status of the journal.
`code` - `String`	The code used to refer to this journal.

ListDatabasesInput

Input Fields

`maxResults` - `Int!`	The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
`nextToken` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

ListSchemasInput

Input Fields

`maxResults` - `Int!`	The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
`nextToken` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`schemaPattern` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`database` - `String!`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

ListStatementsInput

Input Fields

`maxResults` - `Int!`	The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
`nextToken` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`statementName` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`status` - `SqlStatementStatus!`

ListTablesInput

Input Fields

`maxResults` - `Int!`	The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
`database` - `String!`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`nextToken` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`schemaPattern` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`tablePattern` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

LithicTransactionInput

Input Fields

`accountId` - `UUID!`	Unique identifier for the account this transaction will post to.
`webhook` - `JSON!`	The Transaction webhook object from Lithic.
`journalId` - `UUID`	Unique identifier for the journal this transaction applies to. If not provided, defaults to the default journal that card transaction codes are configured with.
`settlementAccountId` - `UUID`	Unique identifier of the settlement account that transactions will settle from. If not provided, defaults to the default card settlement account.

MoneyFormatInput

Formatting options for money amounts.

Input Fields

`locale` - `String!`	Locale represents a Unicode locale identifier. Examples: `'de-DE'`, `'hi-IN'`
`groupDigits` - `Boolean!`	When true, whole digits will be grouped according to locale. For example, with locale `en-US` the number `1234567.89` is formatted with grouped digits as `1,234,567.89`. With other locales, these groupings may apply differently. Default: `false`
`addPlusSign` - `Boolean!`	When true, prefix the number with plus `+` symbol when the number is positive. Negative numbers are always displayed with a minus `-` symbol. Default: `false`
`roundingMode` - `RoundingMode!`	Defines the rounding behavior when the fractional units exceed the `maxDigits`. Default: `HALF_UP`
`currencyDisplay` - `CurrencyDisplay!`	Defines how to render the currency indicator. Default: `SYMBOL`
`minDigits` - `Int!`	Minimum number of fractional digits. When not specified, it will use the default fractional digits for the currency. For example, USD amounts default to 2 minimum digits. Default: `255`
`maxDigits` - `Int!`	Maximum number of fractional digits to show, which informs how rounding behavior is applied via the `roundingMode`. Defaults to 6. Default: `6`

ParamDefinitionInput

Define a parameter that can be used when posting transactions using this tran code.

Input Fields

`name` - `String!`	Name for the parameter. This is how values passed are accessed. For example, a parameter with name `fromAccount` can be accessed in the `accountId` field of an TranCodeEntryInput with `params.fromAccount`.
`type` - `ParamDataType!`	Data type for the parameter. Default: `STRING`
`default` - `Expression`	Default value for the parameter. If not provided, the parameter is consider a 'required' parameter, and a value must be provided when posting a transaction.
`description` - `String`	Describe the purpose of this parameter. Help an engineer out.

PartitionKeyInput

Specify a named expression to define a partition key.

Input Fields

alias - String! Identifier for this partition key. Should be a short, human-readable name.

value - Expression!

CEL expression which resolves to the value that is to be used for the partition key.

Within the expression, the document object represents the record. To access a field on the document, use document.<field_name>.

PeriodRange

Input Fields

`lte` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`gte` - `String`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

PolicyInput

Input Fields

`effect` - `PolicyEffect!`	Whether this Policy is an `ALLOW` or `DENY`.
`actions` - `[PolicyAction]!`	The set of actions to allow or deny.
`resources` - `[String]!`	The resources to allow or deny. In the format `<namespace>.<resource>` The following namespaces exist: `financial` `tenancy` `public` `system` As do the following resources in the financial namespace: `Account` `AccountSet` `AccountSetMember` `Transaction` `Entry` `Balance` `TranCode` `Journal` You can use `*` to wildcard as well.
`assertions` - `ExpressionMap`	A map of expressions to evaluate this policy with.

SearchFilter supports Opensearch Query DSL under the "query" key

See https://opensearch.org/docs/latest/query-dsl/ for more information on how to construct these queries.

Input Fields

`index` - `String!`	The `name` of the search index to use.
`query` - `JSON!`	The Opensearch DSL query to use.
`sort` - `[JSON]`	The open search DSL sort to use.

TranCodeEntryInput

Defines the values for the entries written when transactions are posted with this tran code.

Input Fields

`entryType` - `Expression!`	Entry type for an entry written when this tran code is invoked. Expression must resolve to a String type.
`accountId` - `Expression!`	Account ID for an entry written when this tran code is invoked. Expression must resolve to a UUID type.
`layer` - `Expression!`	Layer for an entry written when this tran code is invoked. Expression must resolve to a Layer enum type.
`direction` - `Expression!`	Direction for an entry written when this tran code is invoked. Expression must resolve to a DebitOrCredit enum type.
`units` - `Expression!`	Units of currency for an entry written when this tran code is invoked. Expression must resolve to a Decimal type.
`currency` - `Expression!`	Currency used for an entry written when this tran code is invoked. Expression must resolve to a CurrencyCode type.
`description` - `Expression`	Description for an entry written when this tran code is invoked." Expression must resolve to a String type.
`metadata` - `Expression`	Metadata for the entry posted with this tran code. Expression must resolve to a JSON type. Example: `"{ 'x': 1, 'y': { 'z': 2 }}"`
`condition` - `Expression`	A boolean expression that indicates if this entry should be written. Example: `"params.amount > 0"`

TranCodeFilterInput

Filter conditions to apply to a tran code query. Filters are only applied if the field is used by the specified index.

Input Fields

`tranCodeId` - `FilterValue`	Filter on the `tranCodeId` field. Required when using index `TranCodeIndex.TRAN_CODE_ID`.
`code` - `FilterValue`	Filter on the `code` field. Only available when using index `TranCodeIndex.CODE`.
`status` - `FilterValue`	Filter on the `status` field. Only available when using index `TranCodeIndex.STATUS`.
`custom` - `CustomIndexFilter`	Filter conditions for a custom index. Only available when using index `TranCodeIndex.CUSTOM`.
`search` - `SearchFilter`	Filter conditions for a search. Only available when using index `TranCodeIndex.SEARCH`.

TranCodeIndexInput

Specify the pre-defined TranCodeIndex and sort order to use in a query.

Input Fields

`name` - `TranCodeIndex!`	Indexes for querying TranCodes. To optimize query performance and apply desired filters, choose the appropriate index.
`sort` - `SortOrder`	`ASC` (ascending) or `DESC` (descending).

TranCodeInput

Fields to create a new TranCode.

Input Fields

`tranCodeId` - `UUID!`	Internal UUID for the transaction code record.
`code` - `String!`	The tran code represented as a unique string identifier. Example: `'ACH_CREDIT'`
`description` - `String`	Explanation of what this tran code represents and how it should be used. This provides documentation for the tran code.
`params` - `[ParamDefinitionInput]`	Define the parameters that can be used when posting transactions using this tran code.
`transaction` - `TranCodeTransactionInput!`	Define the values for the transaction posted when this tran code is invoked.
`entries` - `[TranCodeEntryInput!]!`	Define the values of entries written when transactions are posted with this tran code.
`metadata` - `JSON`	Metadata attached to this tran code.

TranCodeTransactionInput

Define the values for the transaction posted when this tran code is invoked.

Input Fields

`effective` - `Expression!`	Effective date for the transaction posted with this tran code. Expression must be a valid ISO 8601 formatted date. @example("date('2022-12-23')")
`journalId` - `Expression`	Journal ID for the transaction posted with this tran code. If omitted, the default journal will be used. Expression must resolve to a UUID type. @example("uuid('b28f5684-0834-4292-8016-d2f2fb0367a9')")
`correlationId` - `Expression`	Correlation ID for the transaction posted with this tran code. Expression must resolve to a String type. Example: `"'5a028997'"`
`externalId` - `Expression`	External ID for the transaction posted with this tran code. Expression must resolve to a String type. Example: `"'45415819'"`
`description` - `Expression`	Description for the transaction posted with this tran code. Expression must resolve to a String type. @example("'TX for ' + string(params.amount)")
`metadata` - `Expression`	Metadata for the transaction posted with this tran code. Expression must resolve to a JSON type. Example: `"{ 'x': 1, 'y': { 'z': 2 }}"`

TranCodeUpdateInput

TranCode fields to update.

Input Fields

`description` - `String`	Explanation of what this tran code represents and how it should be used. This provides documentation for the tran code.
`params` - `[ParamDefinitionInput]`	Define the parameters that can be used when posting transactions using this tran code. Replaces existing parameters definition.
`transaction` - `TranCodeTransactionInput`	Define values for transaction posted when this tran code is invoked. Replaces existing transaction definition.
`entries` - `[TranCodeEntryInput]`	Define the values of entries written when transactions are posted with this tran code. Replaces existing entry definition.
`status` - `Status`	Operational status of the tran code.
`metadata` - `JSON`	Metadata attached to this tran code.

TransactionFilterInput

Filter conditions to apply to a transaction query. Filters are only applied if the field is used by the specified index.

Input Fields

`journalId` - `FilterValue`	Specify the Journal to use with `eq`. If omitted, the default journal will be used.
`transactionId` - `FilterValue`	Filter on the `transactionId` field. Required when using index `TransactionIndex.TRANSACTION_ID`.
`correlationId` - `FilterValue`	Filter on the `correlationId` field. Required when using index `TransactionIndex.CORRELATION_ID`.
`externalId` - `FilterValue`	Filter on the `externalId` field. Required when using index `TransactionIndex.EXTERNAL_ID`.
`custom` - `CustomIndexFilter`	Filter conditions for a custom index. Only available when using index `TransactionIndex.CUSTOM`.
`search` - `SearchFilter`	Filter conditions for a search. Only available when using index `TransactionIndex.SEARCH`.
`transactionIds` - `[UUID]`	Retrieve up to 100 transactions by id.

TransactionIndexInput

Specify the pre-defined TransactionIndex and sort order to use in a query.

Input Fields

`name` - `TransactionIndex!`	Indexes for querying Transactions. To optimize query performance and apply desired filters, choose the appropriate index.
`sort` - `SortOrder`	`ASC` (ascending) or `DESC` (descending).

TransactionInput

Fields to post a new Transaction.

Input Fields

`transactionId` - `UUID!`	The ID is required to ensure an idempotent transaction.
`tranCode` - `String!`	String corresponding to the `code` of a TranCode to be used for this transaction.
`tranCodeVersion` - `Int`	Version of the tran code to use in this transaction. If not supplied, the latest version will be used.
`params` - `JSON`	Params object specifying values for the params defined in the corresponding TranCode.

TransactionUpdateInput

Transaction fields to update.

Input Fields

`externalId` - `String`	Allows specifying a unique external ID associated with this transaction.
`description` - `String`	Description of the transaction.
`metadata` - `JSON`	Arbitrary structured data about this transaction.

UpdateClientInput

Input Fields

`policies` - `[PolicyInput]!`	Replaces the existing policies with this new set of policies.

UpdateGroupInput

Input Fields

name - String! A human-friendly name for the group, such as 'Admins' or 'DataAnalysts'.

description - String A brief description of the group's purpose, intended to provide additional context.

policy - String

A set of policies to apply to this group, formatted as a JSON list that define the permissions granted to users within this group.

Valid actions include db:Insert, db:Update, db:Delete, db:Select or wildcard *

Example:

policy: "[{\"actions\": [\"*\"],\"effect\": \"DENY\",\"resources\":[\"*\"],\"assertions\": {\"always false\": \"1 == 0\"}}]"

UpdateTenantInput

Input Fields

accountId - String!

A globally unique identifier representing an environment within the organization.

This accountId, when combined with an AWS region, is used to calculate the database tenant.

name - String A human-friendly name for the tenant, used for display purposes and easier identification.

description - String A brief description of the tenant, providing additional context about its purpose or characteristics.

UpdateUserInput

Input Fields

`groupIds` - `[UUID]`	A list of unique identifiers for the groups to which the user belongs. The user's permissions are determined by the combined policies of these groups.
`email` - `String!`	The user's email address, which serves as a unique identifier and primary means of contact.

WorkflowInput

Fields to execute a new workflow.

Input Fields

`workflowId` - `UUID!`	128-bit universally unique identifier (UUID). Used for most ID fields on records.
`executionId` - `UUID!`	128-bit universally unique identifier (UUID). Used for most ID fields on records.
`task` - `String!`	The `String` scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
`params` - `JSON`	JSON object.