GraphQL
Enum Types
Enum types define a set of predefined values that a field can take.
AccountIndex
Indexes for querying Accounts. To optimize query performance and apply desired filters, choose the appropriate index.
Values
ACCOUNT_ID | Index by accountId field. Must supply an accountId: { eq: <id> } filter to the where object. |
NAME | Index by name field. Use to apply query filters on the value of name . |
CODE | Index by code field. Use to apply query filters on the value of code . |
STATUS | Index by status field. Use to apply query filters on the value of status . |
EXTERNAL_ID | Index by externalId field. Must supply an externalId: { eq: <id> } filter to the where object. |
CUSTOM | Use a custom-defined index. Must supply a custom filter to the where object. |
SEARCH | Use eventually consisent search. Must supply a search filter to the where object. |
AccountSetIndex
Indexes for querying AccountSets. To optimize query performance and apply desired filters, choose the appropriate index.
Values
ACCOUNT_SET_ID | Index by accountSetId field. Must supply an accountSetId: { eq: <id> } filter to the where object. |
NAME | Index by name field. Use to apply query filters on the value of name . |
CUSTOM | Use a custom-defined index. Must supply a custom filter to the where object. |
SEARCH | Use eventually consisent search. Must supply a search filter to the where object. |
AccountSetMemberType
Account set members can be of type Account or AccountSet.
Values
ACCOUNT | |
ACCOUNT_SET |
AccountStatus
Account status determines whether the account is in active use or closed (locked). By default, all accounts are ACTIVE
.
When account is LOCKED
, it cannot be changed and any attempt to write a ledger entry to this account will raise an error.
Values
ACTIVE | ACTIVE = Account is open for posting. |
LOCKED | LOCKED = Account is locked and will block posting. |
BalanceIndex
Indexes for querying Balances. To optimize query performance and apply desired filters, choose the appropriate index.
Values
ACCOUNT_ID | Index by accountId field. Must supply an accountId: { eq: <id> } filter to the where object. |
CUSTOM | Use a custom-defined index. Must supply a custom filter to the where object. |
SEARCH | Use eventually consisent search. Must supply a search filter to the where object. |
CurrencyDisplay
Defines how to render the currency indicator.
Values
SYMBOL | Show the symbol for the currency. @example('$1.23') @example('€1.23') |
CODE | Show the currency code. @example('USD') @example('EUR') |
NONE | Don't show the code or symbol for the currency. |
CustomBalanceIndex
Values
CUSTOM_BALANCE_ID | Index by customBalanceId field. Must supply customBalanceId: { eq: <id> } filter to the where object. |
CODE | Index by code field. Must supply code: { eq: <id> } filter to the where object. |
STATUS | Index by status field. Must supply status: { eq: <id> } filter to the where object. |
DebitOrCredit
Debit or credit? Sometimes these are abbreviated to DR and CR.
Values
DEBIT | |
CREDIT |
EndpointIndex
Values
ENDPOINT_ID | Index by endpointId field. Must supply an endpointId: { eq: <id> } filter to the where object. |
STATUS | Index by status field. Must supply an status: { eq: <status> } filter to the where object. |
EndpointStatus
Values
ENABLED | |
DISABLED |
EndpointType
Values
WEBHOOK |
EntryIndex
Indexes for querying Entries. To optimize query performance and apply desired filters, choose the appropriate index.
Values
ENTRY_ID | Index by entryId field. Must supply an entryId: { eq: <id> } filter to the where object. |
TRANSACTION_ID | Index by transactionId field. Must supply an transactionId: { eq: <id> } filter to the where object. |
CUSTOM | Use a custom-defined index. Must supply a custom filter to the where object. |
SEARCH | Use eventually consisent search. Must supply a search filter to the where object. |
IndexOnEnum
Record types which support custom indexes.
Values
Account | |
AccountSet | |
Balance | |
Transaction | |
TranCode | |
Entry |
JobType
Values
SETTLE_WORKFLOW |
JournalIndex
Indexes for querying Journals. To optimize query performance and apply desired filters, choose the appropriate index.
Values
JOURNAL_ID | Index by JOURNAL_ID field. Must supply a journalId: { eq: <id> } filter to the where object. |
NAME | Index by name field. Use to apply query filters on the value of name . |
STATUS | Index by status field. Use to apply query filters on the value of status . |
CODE | Index by code field. Use to apply query filters on the value of code . |
Layer
The ledger can apply a entries to one of three layers: SETTLED, PENDING, and ENCUMBRANCE.
The SETTLED layer is what is actually fully settled.
The PENDING layer is what's settled but also includes holds and pending charges. This can be used to verify the account will have enough funds after the holds and pending transactions have cleared.
The ENCUMBRANCE layer allows us to add future transactions that are scheduled and also goals or budgeting tools to set money aside in the account.
Values
SETTLED | |
PENDING | |
ENCUMBRANCE |
ParamDataType
Data type of a parameter.
Values
STRING | |
INTEGER | |
DECIMAL | |
BOOLEAN | |
UUID | |
DATE | |
TIMESTAMP | |
JSON |
PolicyAction
Values
SELECT | |
INSERT | |
UPDATE | |
DELETE |
PolicyEffect
Values
ALLOW | |
DENY |
RoundingMode
Defines the rounding behavior when formatting units.
Values
HALF_DOWN | Rounds up if the next digit is > 5, otherwise rounds down. |
HALF_UP | Rounds up if the next digit is >= 5, otherwise rounds down. |
DOWN | Rounds towards 0, truncating extra digits. |
UP | Rounds away from 0. |
SortOrder
ASC
(ascending) or DESC
(descending).
Values
ASC | |
DESC |
Status
Record status. All records are ACTIVE
by default.
To avoid rewriting accounting history, most records are not deleted but simply marked LOCKED
, indicating that they should not be used.
Values
ACTIVE | |
LOCKED |
TranCodeIndex
Indexes for querying TranCodes. To optimize query performance and apply desired filters, choose the appropriate index.
Values
TRAN_CODE_ID | Index by tranCodeId field. Must supply a tranCodeId: { eq: <id> } filter to the where object. |
CODE | Index by code field. Use to apply query filters on the value of code . |
STATUS | Index by status field. Use to apply query filters on the value of status . |
CUSTOM | Use a custom-defined index. Must supply a custom filter to the where object. |
SEARCH | Use eventually consisent search. Must supply a search filter to the where object. |
TransactionIndex
Indexes for querying Transactions. To optimize query performance and apply desired filters, choose the appropriate index.
Values
TRANSACTION_ID | Index by TRANSACTION_ID field. Must supply a transactionId: { eq: <id> } filter to the where object. |
CORRELATION_ID | Index by CORRELATION_ID field. Must supply a correlationId: { eq: <id> } filter to the where object. |
EXTERNAL_ID | Index by EXTERNAL_ID field. Must supply an externalId: { eq: <id> } filter to the where object. |
CUSTOM | Use a custom-defined index. Must supply a custom filter to the where object. |
SEARCH | Use eventually consisent search. Must supply a search filter to the where object. |