API Reference

A Queries#

Query Custom Currencies in the workspace

Response

Query

query CustomCurrencies(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  customCurrencies(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    nodes {
      ...CurrencyFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}

Variables

{"after": "abc123", "before": "abc123", "first": 2277, "last": 2277}

Response

{
  "data": {
    "customCurrencies": {
      "nodes": [Currency],
      "pageInfo": PageInfo
    }
  }
}

Arguments

Name	Description
after - String	Where to start paginating from, when paginating forwards. Send endCursor from a response to get its next page. Learn more about pagination .
before - String	Where to start paginating from, when paginating backwards. Send startCursor from a response to get the previous page. Learn more about pagination .
first - Int	The number of currencies to return per page, when paginating forwards. Defaults to 20, maximum is 200.
last - Int	The number of currencies to return per page, when paginating backwards. Defaults to 20, maximum is 200.

Get a Ledger by ID

Response

Returns a Ledger

Query

query Ledger($ledger: LedgerMatchInput!) {
  ledger(ledger: $ledger) {
    balanceUTCOffset
    created
    id
    ik
    ledgerAccounts {
      ...LedgerAccountsConnectionFragment
    }
    ledgerEntries {
      ...LedgerEntriesConnectionFragment
    }
    migrations {
      ...LedgerMigrationConnectionFragment
    }
    name
    schema {
      ...SchemaFragment
    }
    type
    workspaceId
  }
}

Variables

{"ledger": LedgerMatchInput}

Response

{
  "data": {
    "ledger": {
      "balanceUTCOffset": "-08:00",
      "created": "2007-12-03T10:15:30Z",
      "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "ik": "some-safe-string-ik",
      "ledgerAccounts": LedgerAccountsConnection,
      "ledgerEntries": LedgerEntriesConnection,
      "migrations": LedgerMigrationConnection,
      "name": "abc123",
      "schema": Schema,
      "type": "double",
      "workspaceId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"
    }
  }
}

Arguments

Name	Description
ledger - LedgerMatchInput!	An object specifying the ID of the ledger you want to query

Get a Ledger Account by ID

Response

Returns a LedgerAccount

Query

query LedgerAccount($ledgerAccount: LedgerAccountMatchInput!) {
  ledgerAccount(ledgerAccount: $ledgerAccount) {
    balance
    balanceChange
    balanceChanges {
      ...CurrencyAmountConnectionFragment
    }
    balances {
      ...CurrencyAmountConnectionFragment
    }
    childBalance
    childBalanceChange
    childBalanceChanges {
      ...CurrencyAmountConnectionFragment
    }
    childBalances {
      ...CurrencyAmountConnectionFragment
    }
    consistencyConfig {
      ...LedgerAccountConsistencyConfigFragment
    }
    created
    currency {
      ...CurrencyFragment
    }
    currencyMode
    id
    ik
    ledger {
      ...LedgerFragment
    }
    ledgerId
    lines {
      ...LedgerLinesConnectionFragment
    }
    link {
      ...LinkFragment
    }
    linkedAccount {
      ...ExternalAccountFragment
    }
    name
    ownBalance
    ownBalanceChange
    ownBalances {
      ...CurrencyAmountConnectionFragment
    }
    parentLedgerAccount {
      ...LedgerAccountFragment
    }
    parentLedgerAccountId
    path
    type
    unreconciledTxs {
      ...TxsConnectionFragment
    }
    workspaceId
  }
}

Variables

{"ledgerAccount": LedgerAccountMatchInput}

Response

{
  "data": {
    "ledgerAccount": {
      "balance": "999999999999",
      "balanceChange": "999999999999",
      "balanceChanges": CurrencyAmountConnection,
      "balances": CurrencyAmountConnection,
      "childBalance": "999999999999",
      "childBalanceChange": "999999999999",
      "childBalanceChanges": CurrencyAmountConnection,
      "childBalances": CurrencyAmountConnection,
      "consistencyConfig": LedgerAccountConsistencyConfig,
      "created": "2007-12-03T10:15:30Z",
      "currency": Currency,
      "currencyMode": "multi",
      "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "ik": "abc123",
      "ledger": Ledger,
      "ledgerId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "lines": LedgerLinesConnection,
      "link": Link,
      "linkedAccount": ExternalAccount,
      "name": "abc123",
      "ownBalance": "999999999999",
      "ownBalanceChange": "999999999999",
      "ownBalances": CurrencyAmountConnection,
      "parentLedgerAccount": LedgerAccount,
      "parentLedgerAccountId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "path": "abc123",
      "type": "asset",
      "unreconciledTxs": TxsConnection,
      "workspaceId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"
    }
  }
}

Arguments

Name	Description
ledgerAccount - LedgerAccountMatchInput!	An object specifying the ID of the ledger account you want to query

Get Ledger Entry by ID.

Response

Returns a LedgerEntry

Query

query LedgerEntry($ledgerEntry: LedgerEntryMatchInput!) {
  ledgerEntry(ledgerEntry: $ledgerEntry) {
    conditions {
      ...LedgerEntryConditionFragment
    }
    created
    date
    description
    id
    ik
    ledger {
      ...LedgerFragment
    }
    ledgerId
    lines {
      ...LedgerLinesConnectionFragment
    }
    posted
    type
    workspaceId
  }
}

Variables

{"ledgerEntry": LedgerEntryMatchInput}

Response

{
  "data": {
    "ledgerEntry": {
      "conditions": [LedgerEntryCondition],
      "created": "2007-12-03T10:15:30Z",
      "date": "2022-03-28",
      "description": "abc123",
      "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "ik": "abc123",
      "ledger": Ledger,
      "ledgerId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "lines": LedgerLinesConnection,
      "posted": "2007-12-03T10:15:30Z",
      "type": "some-safe-string-ik",
      "workspaceId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"
    }
  }
}

Arguments

Name	Description
ledgerEntry - LedgerEntryMatchInput!	An object specifying the ID of the Ledger Entry you want to query.

Get Ledger Line by ID

Response

Returns a LedgerLine

Query

query LedgerLine($ledgerLine: LedgerLineMatchInput!) {
  ledgerLine(ledgerLine: $ledgerLine) {
    account {
      ...LedgerAccountFragment
    }
    accountId
    amount
    created
    currency {
      ...CurrencyFragment
    }
    date
    description
    externalTransferId
    externalTransferType
    externalTxId
    id
    key
    ledger {
      ...LedgerFragment
    }
    ledgerEntry {
      ...LedgerEntryFragment
    }
    ledgerEntryId
    ledgerId
    otherTxExternalAccountExternalId
    otherTxExternalAccountId
    otherTxExternalId
    otherTxId
    posted
    txId
    type
    workspaceId
  }
}

Variables

{"ledgerLine": LedgerLineMatchInput}

Response

{
  "data": {
    "ledgerLine": {
      "account": LedgerAccount,
      "accountId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "amount": "999999999999",
      "created": "2007-12-03T10:15:30Z",
      "currency": Currency,
      "date": "2022-03-28",
      "description": "abc123",
      "externalTransferId": "abc123",
      "externalTransferType": "ach",
      "externalTxId": "abc123",
      "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "key": "abc123",
      "ledger": Ledger,
      "ledgerEntry": LedgerEntry,
      "ledgerEntryId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "ledgerId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "otherTxExternalAccountExternalId": "abc123",
      "otherTxExternalAccountId": "abc123",
      "otherTxExternalId": "abc123",
      "otherTxId": "abc123",
      "posted": "2007-12-03T10:15:30Z",
      "txId": "abc123",
      "type": "credit",
      "workspaceId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"
    }
  }
}

Arguments

Name	Description
ledgerLine - LedgerLineMatchInput!	An object specifying the ID of the ledger line you want to query

Query Ledgers in workspace. Ledgers are paginated and returned in reverse-chronological order by their created date.

Response

Returns a LedgersConnection

Query

query Ledgers(
  $after: String,
  $before: String,
  $filter: LedgersFilterSet,
  $first: Int,
  $last: Int
) {
  ledgers(
    after: $after,
    before: $before,
    filter: $filter,
    first: $first,
    last: $last
  ) {
    nodes {
      ...LedgerFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}

Variables

{
  "after": "abc123",
  "before": "abc123",
  "filter": LedgersFilterSet,
  "first": 2277,
  "last": 2277
}

Response

{
  "data": {
    "ledgers": {
      "nodes": [Ledger],
      "pageInfo": PageInfo
    }
  }
}

Arguments

Name	Description
after - String	Where to start paginating from, when paginating forwards. Send endCursor from a response to get its next page. Learn more about pagination .
before - String	Where to start paginating from, when paginating backwards. Send startCursor from a response to get the previous page. Learn more about pagination .
filter - LedgersFilterSet	Filter the Ledgers returned. Learn more about filtering .
first - Int	The number of Ledgers to return per page, when paginating forwards (reverse-chronological order by created date). Once you start paginating, the page size can't be changed. Defaults to 20, maximum is 200.
last - Int	The number of Ledgers to return per page, when paginating backwards (chronological order by created date). Once you start paginating, the page size can't be changed. Defaults to 20, maximum is 200.

Get a Schema by key.

Response

Returns a Schema

Query

query Schema($schema: SchemaMatchInput!) {
  schema(schema: $schema) {
    key
    ledgers {
      ...LedgersConnectionFragment
    }
    name
    version {
      ...SchemaVersionFragment
    }
    versions {
      ...SchemaVersionConnectionFragment
    }
  }
}

Variables

{"schema": SchemaMatchInput}

Response

{
  "data": {
    "schema": {
      "key": "some-safe-string-ik",
      "ledgers": LedgersConnection,
      "name": "abc123",
      "version": SchemaVersion,
      "versions": SchemaVersionConnection
    }
  }
}

Arguments

Name	Description
schema - SchemaMatchInput!	This contains the key of the Schema you want to retrieve.

Retrieve all of the Schemas in the workspace.

Response

Returns a SchemaConnection

Query

query Schemas(
  $after: String,
  $before: String,
  $first: Int,
  $last: Int
) {
  schemas(
    after: $after,
    before: $before,
    first: $first,
    last: $last
  ) {
    nodes {
      ...SchemaFragment
    }
    pageInfo {
      ...PageInfoFragment
    }
  }
}

Variables

{"after": "abc123", "before": "abc123", "first": 2277, "last": 2277}

Response

{
  "data": {
    "schemas": {
      "nodes": [Schema],
      "pageInfo": PageInfo
    }
  }
}

Arguments

Name	Description
after - String	Where to start paginating from, when paginating forwards. Send endCursor from a response to get its next page. Learn more about pagination .
before - String	Where to start paginating from, when paginating backwards. Send startCursor from a response to get the previous page. Learn more about pagination .
first - Int	The number of schemas to return per page, when paginating forwards. Defaults to 20, maximum is 200.
last - Int	The number of schemas to return per page, when paginating backwards. Defaults to 20, maximum is 200.

Get a Tx by ID

Response

Returns a Tx

Query

query Tx($tx: TxMatchInput!) {
  tx(tx: $tx) {
    accountId
    amount
    currency {
      ...CurrencyFragment
    }
    date
    description
    externalAccountId
    externalId
    id
    ledgerEntries {
      ...LedgerEntriesConnectionFragment
    }
    ledgerEntryIds
    ledgerLineIds
    ledgerLines {
      ...LedgerLinesConnectionFragment
    }
    linkId
    posted
    workspaceId
  }
}

Variables

{"tx": TxMatchInput}

Response

{
  "data": {
    "tx": {
      "accountId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "amount": "999999999999",
      "currency": Currency,
      "date": "2022-03-28",
      "description": "abc123",
      "externalAccountId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "externalId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "ledgerEntries": LedgerEntriesConnection,
      "ledgerEntryIds": ["3116551f-5efc-4c9e-84ac-5a36a51b09c1"],
      "ledgerLineIds": ["3116551f-5efc-4c9e-84ac-5a36a51b09c1"],
      "ledgerLines": LedgerLinesConnection,
      "linkId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
      "posted": "2007-12-03T10:15:30Z",
      "workspaceId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"
    }
  }
}

Arguments

Name	Description
tx - TxMatchInput!	The transaction you're querying. You can specify either: * The FRAGMENT ID of the transaction (id) * The external system's transaction ID (externalId) and FRAGMENT ID of the external account (accountId) * The external system's transaction ID (externalId), the external system's account ID (externalAccountId) and FRAGMENT ID of the Link (linkId)

B Mutations#

Adds a Ledger Entry to a Ledger. This Ledger Entry cannot be into a Linked Ledger Account. For that, use reconcileTx

Response

Returns an AddLedgerEntryResponse!

Query

mutation AddLedgerEntry(
  $entry: LedgerEntryInput!,
  $ik: SafeString!
) {
  addLedgerEntry(
    entry: $entry,
    ik: $ik
  ) {
    ... on AddLedgerEntryResult {
      ...AddLedgerEntryResultFragment
    }
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
  }
}

Variables

{"entry": LedgerEntryInput, "ik": "some-safe-string-ik"}

Response

{"data": {"addLedgerEntry": AddLedgerEntryResult}}

Arguments

Name	Description
entry - LedgerEntryInput!	An object containing the Ledger Lines as well as an optional description and posted timestamp.
ik - SafeString!	The Idempotency Key

Creates a custom currency.

Response

Returns a CreateCustomCurrencyResponse!

Query

mutation CreateCustomCurrency($customCurrency: CreateCustomCurrencyInput!) {
  createCustomCurrency(customCurrency: $customCurrency) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on CreateCustomCurrencyResult {
      ...CreateCustomCurrencyResultFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
  }
}

Variables

{"customCurrency": CreateCustomCurrencyInput}

Response

{"data": {"createCustomCurrency": BadRequestError}}

Arguments

Name	Description
customCurrency - CreateCustomCurrencyInput!	The custom currency to be created.

Custom Links let you integrate external systems that don't have native support. See Custom Links

Response

Returns a CreateCustomLinkResponse!

Query

mutation CreateCustomLink(
  $ik: SafeString!,
  $name: String!
) {
  createCustomLink(
    ik: $ik,
    name: $name
  ) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on CreateCustomLinkResult {
      ...CreateCustomLinkResultFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
  }
}

Variables

{"ik": "some-safe-string-ik", "name": "abc123"}

Response

{"data": {"createCustomLink": BadRequestError}}

Arguments

Name	Description
ik - SafeString!	The Idempotency Key
name - String!	The name of your custom link

Creates a Ledger.

Response

Returns a CreateLedgerResponse!

Query

mutation CreateLedger(
  $ik: SafeString!,
  $ledger: CreateLedgerInput!,
  $schema: SchemaMatchInput
) {
  createLedger(
    ik: $ik,
    ledger: $ledger,
    schema: $schema
  ) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on CreateLedgerResult {
      ...CreateLedgerResultFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
  }
}

Variables

{
  "ik": "some-safe-string-ik",
  "ledger": CreateLedgerInput,
  "schema": SchemaMatchInput
}

Response

{"data": {"createLedger": BadRequestError}}

Arguments

Name	Description
ik - SafeString!	The Idempotency Key
ledger - CreateLedgerInput!	The payload representing the Ledger to be created
schema - SchemaMatchInput	The Schema to create this Ledger with

This mutation is used to reconcile transactions from an external system into a Ledger Entry. This mutation does not require an idempotency key since a transaction can only be reconciled once per Linked Ledger Account. If you are reconciling a transfer between two Link Accounts which are both linked to the same Ledger, use a transit account in between to split the transfer into two reconcileTx calls.

Response

Returns a ReconcileTxResponse!

Query

mutation ReconcileTx($entry: LedgerEntryInput!) {
  reconcileTx(entry: $entry) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
    ... on ReconcileTxResult {
      ...ReconcileTxResultFragment
    }
  }
}

Variables

{"entry": LedgerEntryInput}

Response

{"data": {"reconcileTx": BadRequestError}}

Arguments

Name	Description
entry - LedgerEntryInput!	The ledger entry containing lines that specify the transaction from a linked ledger account to reconcile, as well as the ledger account with which to offset the external transaction.

Stores a Schema in your workspace. If no Schema with the same key exists in your worksapce, a new Schema is created. Else, the Schema is updated, and every Ledger associated with it is migrated to the latest version.

Response

Returns a StoreSchemaResponse!

Query

mutation StoreSchema($schema: SchemaInput!) {
  storeSchema(schema: $schema) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
    ... on StoreSchemaResult {
      ...StoreSchemaResultFragment
    }
  }
}

Variables

{"schema": SchemaInput}

Response

{"data": {"storeSchema": BadRequestError}}

Arguments

Name	Description
schema - SchemaInput!	The Schema to store.

Once you've created a Custom Link, create accounts under it using this mutation. Each Custom Account is an immutable, single-entry view of all the transactions in the external account. You can sync up to 100 Custom Accounts in one API call.

Response

Returns a SyncCustomAccountsResponse!

Query

mutation SyncCustomAccounts(
  $accounts: [CustomAccountInput!]!,
  $link: LinkMatchInput!
) {
  syncCustomAccounts(
    accounts: $accounts,
    link: $link
  ) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
    ... on SyncCustomAccountsResult {
      ...SyncCustomAccountsResultFragment
    }
  }
}

Variables

{
  "accounts": [CustomAccountInput],
  "link": LinkMatchInput
}

Response

{"data": {"syncCustomAccounts": BadRequestError}}

Arguments

Name	Description
accounts - [CustomAccountInput!]!	A list of external accounts to sync
link - LinkMatchInput!	An object containing the ID of a Custom Link.

You can create transactions under a Custom Account in a Custom Link using this mutation. Once you've imported transactions, you can use the reconcileTx mutation to add them to a Ledger via the Linked Ledger Account. You can sync up to 100 Custom Transactions in one API call.

Response

Returns a SyncCustomTxsResponse!

Query

mutation SyncCustomTxs(
  $link: LinkMatchInput!,
  $txs: [CustomTxInput!]!
) {
  syncCustomTxs(
    link: $link,
    txs: $txs
  ) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
    ... on SyncCustomTxsResult {
      ...SyncCustomTxsResultFragment
    }
  }
}

Variables

{
  "link": LinkMatchInput,
  "txs": [CustomTxInput]
}

Response

{"data": {"syncCustomTxs": BadRequestError}}

Arguments

Name	Description
link - LinkMatchInput!	An object containing the ID of a Custom Link.
txs - [CustomTxInput!]!	A list of external transactions to sync

Updates a ledger. Only supports name right now.

Response

Returns an UpdateLedgerResponse!

Query

mutation UpdateLedger(
  $ledger: LedgerMatchInput!,
  $update: UpdateLedgerInput!
) {
  updateLedger(
    ledger: $ledger,
    update: $update
  ) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
    ... on UpdateLedgerResult {
      ...UpdateLedgerResultFragment
    }
  }
}

Variables

{
  "ledger": LedgerMatchInput,
  "update": UpdateLedgerInput
}

Response

{"data": {"updateLedger": BadRequestError}}

Arguments

Name	Description
ledger - LedgerMatchInput!	An object containing the ID of the ledger to update
update - UpdateLedgerInput!	The payload containing the fields to update. Currency, only the name can be updated.

C Types#

Example

AddLedgerEntryResult

Union Types
AddLedgerEntryResult
BadRequestError
InternalError

Example

{
  "entry": LedgerEntry,
  "isIkReplay": true,
  "lines": [LedgerLine]
}

Field Name	Description
entry - LedgerEntry!	The ledger entry that was posted
isIkReplay - Boolean!	True if this request successfully completed before and the previous response is being returned
lines - [LedgerLine!]!	The ledger lines that were created in that entry

Equivalent to an HTTP 400 - request either has missing or incorrect data

Example

{"code": "abc123", "message": "abc123", "retryable": true}

Field Name	Description
code - String!	The HTTP status code corresponding to the error
message - String!	The error message
retryable - Boolean!	Whether or not the operation is retryable

Used to configure the write-consistency of a Ledger Account's balance. See Consistency.

Example

"eventual"

Enum Value	Description
eventual	Eventually consistent balance updates.
strong	Strongly consistent balance updates.

The Boolean scalar type represents true or false.

Example

true

The input for your Chart of Accounts in a Schema.

Example

{
  "accounts": [SchemaLedgerAccountInput],
  "defaultConsistencyConfig": LedgerAccountConsistencyConfigInput,
  "defaultCurrency": CurrencyMatchInput,
  "defaultCurrencyMode": "multi"
}

Input Field	Description
accounts - [SchemaLedgerAccountInput!]!	The Ledger Accounts modeled by your Schema.
defaultConsistencyConfig - LedgerAccountConsistencyConfigInput	The consistency configuration for this Ledger Account. This defines how updates to this Ledger Account's ownBalance are handled.
defaultCurrency - CurrencyMatchInput	The default currency of each Ledger Account in the Chart Of Accounts. It must be provided if defaultCurrencyMode is set to single . Additionally, defaultCurrency must be omitted if defaultCurrencyMode is set to multi .
defaultCurrencyMode - CurrencyMode	The default currency mode of each Ledger Account in the Chart Of Accounts.

Example

{
  "customCode": "abc123",
  "customCurrencyId": "some-safe-string-ik",
  "name": "abc123",
  "precision": 2277
}

Input Field	Description
customCode - String!	The currency code for custom currencies. It can be up to 5 characters long. This is used for display purposes.
customCurrencyId - SafeString!	The ID for a custom currency. This is specified when creating the custom currency using the createCustomCurrency mutation.
name - String!	A human readable name for the currency (e.g. United States Dollar). This is used for display purposes.
precision - Int!	The number of decimal places this currency goes to. For example, United States Dollars have a precision of 2 (i.e. 100 cents in a dollar), whereas the Jordanian Dinar has a precision of 3. This is used for display purposes.

Example

BadRequestError

Union Types
BadRequestError
CreateCustomCurrencyResult
InternalError

Example

{"customCurrency": Currency}

Field Name	Description
customCurrency - Currency!	The Currency that was created.

Example

BadRequestError

Union Types
BadRequestError
CreateCustomLinkResult
InternalError

Example

{"isIkReplay": true, "link": Link}

Field Name	Description
isIkReplay - Boolean!
link - Link!	The custom link that was created. Represents an instance of an external system.

Example

{
  "consistencyConfig": LedgerAccountConsistencyConfigInput,
  "currency": CurrencyMatchInput,
  "currencyMode": "multi",
  "linkedAccount": ExternalAccountMatchInput,
  "name": "abc123",
  "parent": LedgerAccountMatchInput,
  "type": "asset"
}

Input Field	Description
consistencyConfig - LedgerAccountConsistencyConfigInput	The consistency configuration for this Ledger Account. This defines how updates to this Ledger Account's balance are handled.
currency - CurrencyMatchInput	The currency of this Ledger Account. If this is not set, and currencyMode is not set to multi , the workspace-level default is used.
currencyMode - CurrencyMode	If set to multi , creates a multi-currency Ledger Account. If set to single , creates a single-currency Ledger Account.
linkedAccount - ExternalAccountMatchInput	The External Account to link to this Ledger Account.
name - String!	The human-readable name of this Ledger Account.
parent - LedgerAccountMatchInput	The parent of this Ledger Account.
type - LedgerAccountTypes	The type of ledger account to create. Required if this is a top-level Ledger Account. If not provided, the type will be inferred from the parent.

Example

BadRequestError

Union Types
BadRequestError
CreateLedgerAccountResult
InternalError

Example

{"isIkReplay": true, "ledgerAccount": LedgerAccount}

Field Name	Description
isIkReplay - Boolean!	true if a previous request successfully created this ledger account
ledgerAccount - LedgerAccount!	The ledger account that was created

Example

{
  "childLedgerAccounts": [CreateLedgerAccountsInput],
  "consistencyConfig": LedgerAccountConsistencyConfigInput,
  "currency": CurrencyMatchInput,
  "currencyMode": "multi",
  "ik": "some-safe-string-ik",
  "linkedAccount": ExternalAccountMatchInput,
  "name": "abc123",
  "parent": LedgerAccountMatchInput,
  "type": "asset"
}

Input Field	Description
childLedgerAccounts - [CreateLedgerAccountsInput!]	Ledger Accounts to create as children of this Ledger Account.
consistencyConfig - LedgerAccountConsistencyConfigInput	The consistency configuration for this ledger account. This defines how updates to this ledger account's balance are handled.
currency - CurrencyMatchInput	The currency of this Ledger Account. If this is not set, the workspace level default is used.
currencyMode - CurrencyMode	The currency mode of this Ledger Account. If this is not set, the workspace level default is used.
ik - SafeString!	The idempotency key for creating this Ledger Account.
linkedAccount - ExternalAccountMatchInput	The External Account to link to this Ledger Account. This can only be specified on leaf Ledger Accounts. See Reconcilation .
name - String!	The name of the Ledger Account.
parent - LedgerAccountMatchInput	The parent of this Ledger Account. This is only valid on the top level Ledger Account in the payload.
type - LedgerAccountTypes	The type of this Ledger Account. This field is only required if this is a root Ledger Account. Otherwise, the type will get inherited from its parent.

Example

BadRequestError

Union Types
BadRequestError
CreateLedgerAccountsResult
InternalError

Example

{
  "ikReplays": [IkReplay],
  "ledgerAccounts": [LedgerAccount]
}

Field Name	Description
ikReplays - [IkReplay!]!	Whether the ledger accounts were successfully created by a previous request
ledgerAccounts - [LedgerAccount!]!	The ledger accounts that were created

Example

{"balanceUTCOffset": "-08:00", "name": "abc123", "type": "double"}

Input Field	Description
balanceUTCOffset - UTCOffset	Use this field to specify a timezone for queries to your Ledger. When aggregating balances, all transactions within a 24 hour period starting at midnight UTC are included in each day. You can specify a different starting hour for balances. For example, use "-08:00" to align balances with Pacific Standard Time. Balance queries would then consider the start of each local day to be at 8am UTC the next day in UTC. The default timezone is UTC.
name - String!
type - LedgerTypes

Example

BadRequestError

Union Types
BadRequestError
CreateLedgerResult
InternalError

Example

{"isIkReplay": true, "ledger": Ledger}

Field Name	Description
isIkReplay - Boolean!	true if this request successfully completed before and the previous response is being returned
ledger - Ledger!	The Ledger that was created

Example

{
  "code": "AAVE",
  "customCode": "abc123",
  "customCurrencyId": "some-safe-string-ik",
  "name": "abc123",
  "precision": 2277
}

Field Name	Description
code - CurrencyCode!	The currency code. This is an enum type .
customCode - String	The currency code for custom currencies. This is only set if 'currency' is set to CUSTOM. It can be up to 32 characters long.
customCurrencyId - SafeString	The ID for a custom currency. This is specified when creating the custom currency using the createCustomCurrency mutation.
name - String!	A human readable name for the currency (e.g. United States Dollar). This is used for display purposes.
precision - Int!	The number of decimal places this currency goes to. For example, United States Dollars have a precision of 2 (i.e. 100 cents in a dollar), whereas the Jordanian Dinar has a precision of 3. This is used for display purposes.

A single amount accompanied by its currency

Example

{"amount": "999999999999", "currency": Currency}

Field Name	Description
amount - Int96!	Numerical integer value, serialized as a string
currency - Currency!	The currency this amount is in

A paginated list of amounts with their currencies

Example

{
  "nodes": [CurrencyAmount],
  "pageInfo": PageInfo
}

Field Name	Description
nodes - [CurrencyAmount!]	The current page of results
pageInfo - PageInfo!	The pagination info for this list

Example

"AAVE"

Enum Value	Description
AAVE
ADA
AED
AFN
ALL
AMD
ANG
AOA
ARS
AUD
AWG
AZN
BAM
BBD
BCH
BDT
BGN
BHD
BIF
BMD
BND
BOB
BRL
BSD
BTC
BTN
BWP
BYR
BZD
CAD
CDF
CHF
CLP
CNY
COP
CRC
CUC
CUP
CUSTOM
CVE
CZK
DAI
DJF
DKK
DOP
DZD
EGP
ERN
ETB
ETH
EUR
FJD
FKP
GBP
GEL
GGP
GHS
GIP
GMD
GNF
GTQ
GYD
HKD
HNL
HRK
HTG
HUF
IDR
ILS
IMP
INR
IQD
IRR
ISK
JMD
JOD
JPY
KES
KGS
KHR
KMF
KPW
KRW
KWD
KYD
KZT
LAK
LBP
LINK
LKR
LOGICAL
LRD
LSL
LTC
LYD
MAD
MATIC
MDL
MGA
MKD
MMK
MNT
MOP
MUR
MVR
MWK
MXN
MYR
MZN
NAD
NGN
NIO
NOK
NPR
NZD
OMR
PAB
PEN
PGK
PHP
PKR
PLN
PYG
QAR
RON
RSD
RUB
RWF
SAR
SBD
SCR
SDG
SEK
SGD
SHP
SLL
SOL
SOS
SPL
SRD
STN
SVC
SYP
SZL
THB
TJS
TMT
TND
TOP
TRY
TTD
TVD
TWD
TZS
UAH
UGX
UNI
USD
USDC
USDT
UYU
UZS
VEF
VND
VUV
WST
XAF
XCD
XLM
XOF
XPF
YER
ZAR
ZMW

Example

{"code": "AAVE", "customCurrencyId": "some-safe-string-ik"}

Input Field	Description
code - CurrencyCode!	The currency code. This is an enum type .
customCurrencyId - SafeString	The ID for a custom currency. This is specified when creating the custom currency using the createCustomCurrency mutation.

Defines the currency handling of a LedgerAccount, which can either be restricted to a single currency or allow multiple currencies.

Example

"multi"

Enum Value	Description
multi
single

Example

{
  "currency": CurrencyMatchInput,
  "currencyMode": "multi",
  "externalId": "some-safe-string-ik",
  "name": "abc123"
}

Input Field	Description
currency - CurrencyMatchInput	The currency of this external account. If this is not set, the workspace level default is used. 'currency' cannot be set if 'currencyMode' is 'multi'.
currencyMode - CurrencyMode	The currency mode of this external account. If set to multi, creates a multi-currency account.
externalId - SafeString!	The ID of this account at the external system. This is used as the idempotency key, within the scope of its Custom Link.
name - String!	The name of the account at the external system.

A paginated list of Custom Currencies

Example

{
  "nodes": [Currency],
  "pageInfo": PageInfo
}

Field Name	Description
nodes - [Currency!]!	The current page of results
pageInfo - PageInfo!	The pagination info for this list

Example

{
  "created": "abc123",
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "name": "abc123"
}

Field Name	Description
created - String!
id - ID!
name - String!

Example

{
  "account": ExternalAccountMatchInput,
  "amount": "999999999999",
  "currency": CurrencyMatchInput,
  "description": "abc123",
  "externalId": "some-safe-string-ik",
  "posted": "2007-12-03T10:15:30Z"
}

Input Field	Description
account - ExternalAccountMatchInput!
amount - Int96!
currency - CurrencyMatchInput	The currency of this tx. Should be set for multi-currency accounts.
description - String!
externalId - SafeString!	The ID of this tx at the external system. This is used as the idempotency key, within the scope of its Custom Account.
posted - DateTime!

ISO 8601 Date e.g. 1969-07-21

Example

"2022-03-28"

Example

{"equalTo": "2022-03-28", "in": ["2022-03-28"]}

Input Field	Description
equalTo - Date
in - [Date!]

ISO 8601 DateTime e.g. 1969-07-16T13:32:00.000Z. You can also provide a date e.g. 1969-01-01 and it will be converted to 1969-01-01T00:00:00.000Z

Example

"2007-12-03T10:15:30Z"

Filters a timestamp field between two moments in time

Example

{"after": "2007-12-03T10:15:30Z", "before": "2007-12-03T10:15:30Z"}

Input Field	Description
after - DateTime	The timestamp value must be after this moment. Specified in ISO 8601 format e.g "1968-01-01T16:45:00Z"
before - DateTime	The timestamp value must be before this moment. Specified in ISO 8601 format e.g "1968-01-01T16:45:00Z"

Base error interface

Example

{"code": "abc123", "message": "abc123", "retryable": true}

Field Name	Description
code - String!	The HTTP status code corresponding to the error
message - String!	The error message
retryable - Boolean!	Whether or not the operation is retryable

Example

{
  "currency": Currency,
  "currencyMode": "multi",
  "externalId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "linkId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "name": "abc123"
}

Field Name	Description
currency - Currency	The currency of this external account.
currencyMode - CurrencyMode!	Indicates if the account allows multiple currencies or is restricted to a single currency
externalId - ID!	ID used for the external account
id - ID!	FRAGMENT ID of External Account
linkId - ID!	FRAGMENT ID of this transaction's external link
name - String!

Example

{
  "equalTo": ExternalAccountMatchInput,
  "in": [ExternalAccountMatchInput]
}

Input Field	Description
equalTo - ExternalAccountMatchInput	Ledger account must linked to the the specified external account
in - [ExternalAccountMatchInput!]	Ledger account can be linked to any of the specified external accounts

Specify an External Account by using id, or linkId and externalId.

Example

{
  "externalId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "linkId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"
}

Input Field	Description
externalId - ID	The external system's ID of the External Account. If this is specified, linkId is required. id is optional, but will be validated if provided.
id - ID	The FRAGMENT ID of the External Account. If this is specified, both linkId and externalId are optional, but will be validated if provided.
linkId - ID	The FRAGMENT ID of the Link the External Account is in. If this is specified, externalId is required. id is optional, but will be validated if provided.

Example

"ach"

Enum Value	Description
ach
card
check
internal
wire

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

"3116551f-5efc-4c9e-84ac-5a36a51b09c1"

Example

{"ik": "some-safe-string-ik", "isIkReplay": true}

Field Name	Description
ik - SafeString!
isIkReplay - Boolean!

Example

"production"

Enum Value	Description
production
sandbox

Example

{
  "created": "abc123",
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "increaseEnv": "production",
  "name": "abc123"
}

Field Name	Description
created - String!
id - ID!
increaseEnv - IncreaseEnv!
name - String!

Example

{"wire": IncreaseWirePaymentDetailsInput}

Input Field	Description
wire - IncreaseWirePaymentDetailsInput

Example

{
  "beneficiaryAddressLine1": "abc123",
  "beneficiaryAddressLine2": "abc123",
  "beneficiaryAddressLine3": "abc123",
  "beneficiaryName": "abc123"
}

Input Field	Description
beneficiaryAddressLine1 - String
beneficiaryAddressLine2 - String
beneficiaryAddressLine3 - String
beneficiaryName - String!

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

A string representing integers as big as 2^96-1. The number is signed so the range is from -79,228,162,514,264,337,593,543,950,336 to 79,228,162,514,264,337,593,543,950,336.

Example

"999999999999"

A condition that must be met on an Int96 field.

Example

{"eq": "999999999999", "gte": "999999999999", "lte": "999999999999"}

Field Name	Description
eq - Int96	Amount must exactly match this value. You may not specify this alongside gte or lte .
gte - Int96	Amount must be greater than or equal to this value.
lte - Int96	Amount must be less than or equal to this value.

A condition that must be met on an Int96 field.

Example

{"eq": "999999999999", "gte": "999999999999", "lte": "999999999999"}

Input Field	Description
eq - Int96	Amount must exactly match this value. You may not specify this alongside gte or lte .
gte - Int96	Amount must be greater than or equal to this value.
lte - Int96	Amount must be less than or equal to this value.

Equivalent to an HTTP 5XX - something went wrong with our API.

Example

{"code": "abc123", "message": "abc123", "retryable": true}

Field Name	Description
code - String!	The HTTP status code corresponding to the error
message - String!	The error message
retryable - Boolean!	Whether or not the operation is retryable

The JSON scalar type represents JSON values as specified by ECMA-404.

Example

"{"key":"value"}"

The last moment of a specific year, month or day or hour e.g. 1969 or 1969-12 or 1969-12-31 or 1969-12-31T23. All of the previous examples are equivalent to 1969-12-31T23:59:59.999.

Example

"2021-07"

Ledgers are databases designed for managing money

Example

{
  "balanceUTCOffset": "-08:00",
  "created": "2007-12-03T10:15:30Z",
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "ik": "some-safe-string-ik",
  "ledgerAccounts": LedgerAccountsConnection,
  "ledgerEntries": LedgerEntriesConnection,
  "migrations": LedgerMigrationConnection,
  "name": "abc123",
  "schema": Schema,
  "type": "double",
  "workspaceId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"
}

Field Name	Description
balanceUTCOffset - UTCOffset!	When aggregating balances, all transactions within a 24 hour period starting at midnight UTC plus this offset are included in each day.
created - DateTime!
id - ID!
ik - SafeString!	The IK passed into the createLedger mutation. This is treated as a unique identifier for this ledger.
ledgerAccounts - LedgerAccountsConnection	Query LedgerAccounts in Ledger. Ledgers are paginated and returned in reverse-chronological order by their created date.
Arguments after - String Where to start paginating from, when paginating forwards. Send endCursor from a response to get its next page. Learn more about pagination. before - String Where to start paginating from, when paginating backwards. Send startCursor from a response to get the previous page. Learn more about pagination. filter - LedgerAccountsFilterSet Filter the Ledger Accounts returned. Learn more about filtering. first - Int How many ledger accounts to return per page, when paginating forwards (reverse-chronological order by their created date). Once you start paginating, the page size can't be changed. Defaults to 20, maximum is 200. last - Int How many ledger accounts to return per page, when paginating backwards (chronological order by their created date). Once you start paginating, the page size can't be changed. Defaults to 20, maximum is 200.
ledgerEntries - LedgerEntriesConnection	Query Ledger Entries in a Ledger. Ledger Entries are paginated and sorted in reverse-chronological order by posted date.
Arguments after - String Where to start paginating from, when paginating forwards. Send endCursor from a response to get its next page. Learn more about pagination. before - String Where to start paginating from, when paginating backwards. Send startCursor from a response to get the previous page. Learn more about pagination. filter - LedgerEntriesFilterSet Filter the Ledger Entries returned. Learn more about filtering. first - Int How many Ledger Entries to return per page, when paginating forwards (reverse chronological order by posted date). Once you start paginating, the page size can't be changed. Defaults to 20, maximum is 200. last - Int How many Ledger Entries to return per page, when paginating backwards (chronological order by posted date). Once you start paginating, the page size can't be changed. Defaults to 20, maximum is 200.
migrations - LedgerMigrationConnection	Schema migrations affecting this ledger.
name - String!	The name of the ledger. Can be updated with the updateLedger mutation.
schema - Schema	Schema key associated with this ledger.
type - LedgerTypes!
workspaceId - ID!	Callers should not need to query or store this value.

A ledger account is a container for money

Example

{
  "balance": "999999999999",
  "balanceChange": "999999999999",
  "balanceChanges": CurrencyAmountConnection,
  "balances": CurrencyAmountConnection,
  "childBalance": "999999999999",
  "childBalanceChange": "999999999999",
  "childBalanceChanges": CurrencyAmountConnection,
  "childBalances": CurrencyAmountConnection,
  "consistencyConfig": LedgerAccountConsistencyConfig,
  "created": "2007-12-03T10:15:30Z",
  "currency": Currency,
  "currencyMode": "multi",
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "ik": "abc123",
  "ledger": Ledger,
  "ledgerId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "lines": LedgerLinesConnection,
  "link": Link,
  "linkedAccount": ExternalAccount,
  "name": "abc123",
  "ownBalance": "999999999999",
  "ownBalanceChange": "999999999999",
  "ownBalances": CurrencyAmountConnection,
  "parentLedgerAccount": LedgerAccount,
  "parentLedgerAccountId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "path": "abc123",
  "type": "asset",
  "unreconciledTxs": TxsConnection,
  "workspaceId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"
}

Field Name	Description
balance - Int96!	Total of all lines in this ledger account and child ledger accounts of the same currency as this ledger account
Arguments at - LastMoment Provide a timestamp to get this balance at a specific logical time. If not specified, the latest value will be returned e.g. 1969 or 1969-07 or 1969-07-03 or 1969-07-21T02 currency - CurrencyMatchInput The currency of the balance to query. Required if the account is a multi-currency Ledger Account or if the the Ledger Account has child Ledger Accounts with different currencies.
balanceChange - Int96!	How much did the this ledger account's balance change during the specified period. This query will include all child accounts in the same currency as this ledger account.
Arguments currency - CurrencyMatchInput The currency of the balance change to query. Required if the account is a multi-currency Ledger Account or if the the Ledger Account has child Ledger Accounts with different currencies. period - Period! Specifies the period of time over which this query will calculate the balance difference e.g. 1969 or 1969-Q3 or 1969-07 or 1969-07-21 or 1969-07-21T02
balanceChanges - CurrencyAmountConnection!	How much did the this ledger account's balances change during the specified period. This query will include all child accounts of all currencies
Arguments period - Period! Specifies the period of time over which this query will calculate the balance difference e.g. 1969 or 1969-Q3 or 1969-07 or 1969-07-21 or 1969-07-21T02
balances - CurrencyAmountConnection!	Total of all lines in this ledger account and child ledger accounts in all currencies
Arguments at - LastMoment Provide a timestamp to get this balance at a specific logical time. If not specified, the latest value will be returned e.g. 1969 or 1969-07 or 1969-07-21 or 1969-07-21T02
childBalance - Int96!	Total of all lines in child ledger accounts of the same currency as this ledger account
Arguments at - LastMoment Provide a timestamp to get this balance at a specific logical time. If not specified, the latest value will be returned e.g. 1969 or 1969-07 or 1969-07-21 or 1969-07-21T02 currency - CurrencyMatchInput The currency of the balance to query. Required if the Ledger Account has child Ledger Accounts with different currencies.
childBalanceChange - Int96!	How much did the this ledger account's childBalance change during the specified period. This query will only include child accounts which are in the same currency as this one. See childBalanceChanges to include children of different currencies.
Arguments currency - CurrencyMatchInput The currency of the balance change to query. Required if the Ledger Account has child Ledger Accounts with different currencies. period - Period! Specifies the period of time over which this query will calculate the balance difference e.g. 1969 or 1969-Q3 or 1969-07 or 1969-07-21 or 1969-07-21T02
childBalanceChanges - CurrencyAmountConnection!	How much did the this ledger account's child accounts' balances change during the specified period. This query will include all child accounts of all currencies
Arguments period - Period! Specifies the period of time over which this query will calculate the balance difference e.g. 1969 or 1969-Q3 or 1969-07 or 1969-07-21 or 1969-07-21T02
childBalances - CurrencyAmountConnection!	Total of all lines in child ledger accounts of this ledger in all currencies
Arguments at - LastMoment Provide a timestamp to get this balance at a specific logical time. If not specified, the latest value will be returned e.g. 1969 or 1969-07 or 1969-07-21 or 1969-07-21T02
consistencyConfig - LedgerAccountConsistencyConfig!	The consistency configuration for this Ledger Account. This defines how updates to this Ledger Account's ownBalance are handled.
created - DateTime!
currency - Currency	Currency of this ledger account
currencyMode - CurrencyMode!	Indicates if the account allows multiple currencies or is restricted to a single currency
id - ID!
ik - String!	The idempotency key used to create this account
ledger - Ledger!	Ledger this account is in
ledgerId - ID!	ID of the ledger this account is in
lines - LedgerLinesConnection!	List Ledger Lines in this account, sorted by posted in reverse chronological order. Does not include Ledger Lines from child Ledger Accounts.
Arguments after - String Where to start paginating from, when paginating forwards. Send endCursor from a response to get its next page. Learn more about pagination. before - String Where to start paginating from, when paginating backwards. Send startCursor from a response to get the previous page. Learn more about pagination. filter - LedgerLinesFilterSet Filter the Ledger Lines returned. Learn more about filtering. first - Int How many Ledger Lines to return per page, when paginating forwards (reverse-chronological order by posted date). Once you start paginating, the page size can't be changed. Defaults to 20, maximum is 200. last - Int How many Ledger Lines to return per page, when paginating backwards (chronological order by posted date). Once you start paginating, the page size can't be changed. Defaults to 20, maximum is 200.
link - Link	The Link for the External Account that is linked to this ledger account
linkedAccount - ExternalAccount	External Account that is linked to this ledger account
name - String	The name of your Ledger Account
ownBalance - Int96!	Total of all lines in this ledger account, excluding all child ledger accounts
Arguments at - LastMoment Provide a timestamp to get this balance at a specific logical time. If not specified, the latest value will be returned e.g. 1969 or 1969-07 or 1969-07-21 or 1969-07-21T02 consistencyMode - ReadBalanceConsistencyMode * eventual: Returns an eventually consistent balance, even if the Ledger Account's ownBalanceUpdates in its consistencyConfig is strong (default). * strong: Returns a strongly consistent balance or an error if the Ledger Account's ownBalanceUpdates in its consistencyConfig is eventual. * use_account: Returns a strongly consistent balance if the Ledger Account's ownBalanceUpdates in its consistencyConfig is strong and an eventually consistent balance otherwise. currency - CurrencyMatchInput The currency of the balance to query. Required if the account is a multi-currency Ledger Account.
ownBalanceChange - Int96!	How much did the this ledger account's ownBalance change during the specified period. This query will exclude all child accounts.
Arguments currency - CurrencyMatchInput The currency of the balance change to query. Required if the account is a multi-currency Ledger Account. period - Period! Specifies the period of time over which this query will calculate the balance difference e.g. 1969 or 1969-Q3 or 1969-07 or 1969-07-21 or 1969-07-21T02
ownBalances - CurrencyAmountConnection!	Total of all lines across all currencies in this ledger account, excluding all child ledger accounts
Arguments at - LastMoment Provide a timestamp to get this balance at a specific logical time. If not specified, the latest value will be returned e.g. 1969 or 1969-07 or 1969-07-21 or 1969-07-21T02 consistencyMode - ReadBalanceConsistencyMode * eventual: Returns an eventually consistent balance, even if the Ledger Account's ownBalanceUpdates in its consistencyConfig is strong (default). * strong: Returns a strongly consistent balance or an error if the Ledger Account's ownBalanceUpdates in its consistencyConfig is eventual. * use_account: Returns a strongly consistent balance if the Ledger Account's ownBalanceUpdates in its consistencyConfig is strong and an eventually consistent balance otherwise.
parentLedgerAccount - LedgerAccount	The parent ledger account of this ledger account
parentLedgerAccountId - ID	ID of the parent ledger account of this ledger account
path - String!	The unique Path of the ledger account. This is a slash-delimited string containing the location of an account in its chart of accounts. For accounts created with a schema, this will be composed of account keys. Else, for accounts created with the createLedgerAccounts API, this will be composed of the IKs of an account and its ancestors.
type - LedgerAccountTypes!
unreconciledTxs - TxsConnection	A list of external account transactions that haven't been reconciled to this ledger account yet. Only populated for linked ledger accounts. Transactions are sorted in reverse chronological order by posted date.
Arguments after - String Where to start paginating from, when paginating forwards. Send endCursor from a response to get its next page. Learn more about pagination. before - String Where to start paginating from, when paginating backwards. Send startCursor from a response to get the previous page. Learn more about pagination. first - Int How many unreconciled transactions to return per page, when paginating forwards (reverse-chronological order by posted date). Once you start paginating, the page size can't be changed. Defaults to 20, maximum is 200. last - Int How many unreconciled transactions to return per page, when paginating backwards (chronological order by posted date). Once you start paginating, the page size can't be changed. Defaults to 20, maximum is 200.
workspaceId - ID!	Callers should not need to query or store this value.

A set of conditions that a Ledger Account must meet for an operation to succeed.

Example

{"ownBalance": Int96Condition}

Field Name	Description
ownBalance - Int96Condition	A condition that the ownBalance field must satisfy. Note that this condition always applies to the latest balance, not to balances at a specific date or time. See balances for more on the different types of Ledger Account balances.

A set of conditions that a Ledger Account must meet for an operation to succeed.

Example

{"ownBalance": Int96ConditionInput}

Input Field	Description
ownBalance - Int96ConditionInput!	A condition that the ownBalance field must satisfy. Note that this condition always applies to the latest balance, not to balances at a specific date or time. See balances for more on the different types of Ledger Account balances.

The consistency configuration of a Ledger Account's balance updates. See Consistency.

Example

{"ownBalanceUpdates": "eventual"}

Field Name	Description
ownBalanceUpdates - BalanceUpdateConsistencyMode!	If set to strong, then a Ledger Account's ownBalance updates will be strongly consistent with the API response. This Ledger Account's balance will be updated and available for strongly consistent reads once you receive an API response. Otherwise if not set or set to eventual, ownBalance updates are applied asynchronously and may not be immediately reflected in queries. See Consistency.

The payload configuring the consistency of a Ledger Account's balance updates. See Consistency.

Example

{"ownBalanceUpdates": "eventual"}

Input Field	Description
ownBalanceUpdates - BalanceUpdateConsistencyMode	If set to strong, then a Ledger Account's ownBalance updates will be strongly consistent with the API response. This Ledger Account's balance will be updated and available for strongly consistent reads before you receive an API response. Otherwise if unset or set to eventual, ownBalance updates are applied asynchronously and may not be immediately reflected queries. See Consistency.

Example

{
  "equalTo": LedgerAccountMatchInput,
  "in": [LedgerAccountMatchInput]
}

Input Field	Description
equalTo - LedgerAccountMatchInput	Result must be the specified ledger account
in - [LedgerAccountMatchInput!]	Results can be any of specified ledger accounts

Specify a Ledger Account by using id or path.

Example

{
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "ledger": LedgerMatchInput,
  "path": "abc123"
}

Input Field	Description
id - ID	The FRAGMENT ID of the ledger account
ledger - LedgerMatchInput	The Ledger to which this Ledger Account belongs. This is required if you are specifying the Ledger Account by path .
path - String	The unique path of the ledger account. This is a slash-delimited string containing the keys of an account and all its direct ancestors.

Example

{"equalTo": "asset", "in": ["asset"]}

Input Field	Description
equalTo - LedgerAccountTypes	Results must have the specified ledger account type
in - [LedgerAccountTypes!]	Results can have any of the specified ledger account types

Example

"asset"

Enum Value	Description
asset
expense
income
liability

A paginated list of Ledger Accounts

Example

{
  "nodes": [LedgerAccount],
  "pageInfo": PageInfo
}

Field Name	Description
nodes - [LedgerAccount!]	The current page of results
pageInfo - PageInfo!	The pagination info for this list

Example

{
  "hasParentLedgerAccount": true,
  "isLinkedAccount": true,
  "ledgerAccount": LedgerAccountFilter,
  "linkedAccount": ExternalAccountFilter,
  "parentLedgerAccount": LedgerAccountFilter,
  "type": LedgerAccountTypeFilter
}

Input Field	Description
hasParentLedgerAccount - Boolean	Use to filter ledger accounts by their parent status
isLinkedAccount - Boolean	Use to filter ledger accounts by their linked status
ledgerAccount - LedgerAccountFilter	Use to filter ledger accounts by their IDs
linkedAccount - ExternalAccountFilter	Use to filter ledger accounts by their external linked account ID
parentLedgerAccount - LedgerAccountFilter	Use to filter ledger accounts by their parent account IDs
type - LedgerAccountTypeFilter	Use to filter ledger accounts by their type

A paginated list of Ledger Entries

Example

{
  "nodes": [LedgerEntry],
  "pageInfo": PageInfo
}

Field Name	Description
nodes - [LedgerEntry!]	The current page of results
pageInfo - PageInfo!	The pagination info for this list

Example

{
  "date": DateFilter,
  "posted": DateTimeFilter,
  "type": StringFilter
}

Input Field	Description
date - DateFilter
posted - DateTimeFilter
type - StringFilter	Use this to filter Ledger Entries by type. Ledger Entry types are defined in Schemas.

Example

{
  "conditions": [LedgerEntryCondition],
  "created": "2007-12-03T10:15:30Z",
  "date": "2022-03-28",
  "description": "abc123",
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "ik": "abc123",
  "ledger": Ledger,
  "ledgerId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "lines": LedgerLinesConnection,
  "posted": "2007-12-03T10:15:30Z",
  "type": "some-safe-string-ik",
  "workspaceId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"
}

Field Name	Description
conditions - [LedgerEntryCondition!]!	A list of conditions that were satisfied by this Ledger Entry when it was posted.
created - DateTime!	ISO-8601 timestamp this LedgerEntry was created in Fragment.
date - Date!	Date this LedgerEntry posted to its Ledger e.g. "2021-01-01".
description - String	Description posted for this Ledger Entry.
id - ID!	The ID of this LedgerEntry.
ik - String!	The idempotency key used to post this ledger entry
ledger - Ledger!	The Ledger that this Ledger Entry is posted to.
ledgerId - ID!	The ID of the Ledger this Ledger Entry is posted to.
lines - LedgerLinesConnection!	Lines posted in this Ledger Entry.
posted - DateTime!	ISO-8601 timestamp this LedgerEntry posted to its Ledger.
type - SafeString	The type of the Ledger Entry.
workspaceId - ID!	Callers should not need to query or store this value.

A set of pre-conditions and post-conditions that a Ledger Account must have satisfied. Each LedgerEntryCondition has at least one of precondition or postcondition.

Example

{
  "account": LedgerAccount,
  "currency": Currency,
  "postcondition": LedgerAccountCondition,
  "precondition": LedgerAccountCondition
}

Field Name	Description
account - LedgerAccount!	The Ledger Account that must satisfied the provided conditions.
currency - Currency!	The currency of the balance associated with this LedgerEntryCondition .
postcondition - LedgerAccountCondition	The conditions that must be satisfied after the operation.
precondition - LedgerAccountCondition	The conditions that must be satisfied prior to the operation.

A set of pre-conditions and post-conditions that a Ledger Account balance must meet for an operation to succeed. You must specify at least one of precondition or postcondition for each condition.

Example

{
  "account": LedgerAccountMatchInput,
  "currency": CurrencyMatchInput,
  "postcondition": LedgerAccountConditionInput,
  "precondition": LedgerAccountConditionInput
}

Input Field	Description
account - LedgerAccountMatchInput!	The Ledger Account that must satisfy the provided conditions.
currency - CurrencyMatchInput	For Ledger Accounts in the multi currency mode, you must specify the currency of the balance affected by the condition. You only need to specify this field for multi-currency accounts.
postcondition - LedgerAccountConditionInput	The conditions that must hold after the operation.
precondition - LedgerAccountConditionInput	The conditions that must hold prior to the operation.

Ledger Entries are limited to 40 units, where units are calculated with the following formula: '3 base units + 1 unit per Ledger Line + 2 units per Ledger Account' So a basic Ledger Entry with two Ledger Lines on two different accounts would be: '3 base + 2 for Ledger Lines + 4 for accounts = 9 units' If you're only affecting two Ledger Accounts, you can include 33 Ledger Lines, but if every Ledger Line is for a different Ledger Account, you can send only 12 Ledger Lines.

Example

{
  "conditions": [LedgerEntryConditionInput],
  "description": "abc123",
  "ledger": LedgerMatchInput,
  "lines": [LedgerLineInput],
  "parameters": "{"key":"value"}",
  "posted": "2007-12-03T10:15:30Z",
  "type": "abc123"
}

Input Field	Description
conditions - [LedgerEntryConditionInput!]	Conditions that must be satisfied to post this Ledger Entry. The Ledger Entry will reject with a BadRequestError if any condition is not met. You can only add a condition on a Ledger Account containing a Line in this Ledger Entry.
description - String	If specified, will also be used as the description for LedgerLines, payments and transfers unless they specify their own description
ledger - LedgerMatchInput	The Ledger to which to post this Ledger Entry. Must be linked to a Schema that defines the provided Ledger Entry type.
lines - [LedgerLineInput!]	The Ledger Lines to create as part of this Ledger Entry. This cannot be used with Ledger Entries that have a 'type' i.e. Ledger Entries defined in the Schema. This can be useful during non-routine operations such as an incident. It is not recommended to use 'lines' during routine operations.
parameters - JSON	Parameters to be included in a templated Ledger Entry. All provided parameters must be present in the typed Ledger Entry within the Schema linked to the provided Ledger.
posted - DateTime	ISO 8601 timestamp to post this Ledger Entry e.g. "2021-01-01" or "2021-01-01T16:45:00Z". Will error out if supplied to reconcileTx or createOrder since the transaction timestamp will be used instead
type - String	The type of the Ledger Entry. Must be defined in the Schema linked to the Ledger specified below.

Specify a Ledger Entry by using id.

Example

{"id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"}

Input Field	Description
id - ID!	The FRAGMENT ID of the Ledger Entry

Example

{
  "account": LedgerAccount,
  "accountId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "amount": "999999999999",
  "created": "2007-12-03T10:15:30Z",
  "currency": Currency,
  "date": "2022-03-28",
  "description": "abc123",
  "externalTransferId": "abc123",
  "externalTransferType": "ach",
  "externalTxId": "abc123",
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "key": "abc123",
  "ledger": Ledger,
  "ledgerEntry": LedgerEntry,
  "ledgerEntryId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "ledgerId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "otherTxExternalAccountExternalId": "abc123",
  "otherTxExternalAccountId": "abc123",
  "otherTxExternalId": "abc123",
  "otherTxId": "abc123",
  "posted": "2007-12-03T10:15:30Z",
  "txId": "abc123",
  "type": "credit",
  "workspaceId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"
}

Field Name	Description
account - LedgerAccount!	LedgerAccount that contains this line
accountId - ID!
amount - Int96!	How much this line's LedgerAccount's balance changed in integer cents (i.e. in USD 100 is 1 dollar, 100 cents)
Arguments absolute - Boolean If the absolute flag is passed, amount will always a positive integer in cents. Refer to type to see if this LedgerLine increased or decreased it's LedgerAccount's balance
created - DateTime	ISO-8601 timestamp this LedgerLine was created in Fragment
currency - Currency	Currency of this line
date - Date	Date this LedgerLine posted to its LedgerAccount e.g. "2021-01-01"
description - String
externalTransferId - String	ID in the external system of the payment or transfer that created the transaction linked to this LedgerLine
externalTransferType - ExternalTransferType	Whether the transaction linked to this LedgerLine was a payment or transfer
externalTxId - String	ID in the external system of the transaction linked to this line
id - ID!
key - String
ledger - Ledger!
ledgerEntry - LedgerEntry	Ledger Entry that contains this line
ledgerEntryId - ID	ID of the Ledger Entry that contains this line
ledgerId - ID!	Ledger that contains this line
otherTxExternalAccountExternalId - String	ID in the external system of destination or source bank account for an internal bank transfer. Only for internal bank transfers - see otherTxId
otherTxExternalAccountId - String	FRAGMENT ID of destination or source bank account. Only for internal bank transfers - see otherTxId
otherTxExternalId - String	ID in the external system of transaction in the destination or source bank account. Only for internal bank transfers - see otherTxId
otherTxId - String	FRAGMENT ID of the transaction in the destination account (if sending money from this account) or source account (if pulling money into this account). Only applicable if this line is linked to a transaction created through an internal transfer
posted - DateTime	ISO-8601 timestamp this LedgerLine posted to its LedgerAccount
txId - String	FRAGMENT ID of the transaction linked to this line
type - TxType!	credit or debit
workspaceId - ID!	Callers should not need to query or store this value.

Example

{
  "account": LedgerAccountMatchInput,
  "amount": "999999999999",
  "currency": CurrencyMatchInput,
  "description": "abc123",
  "key": "abc123",
  "payment": PaymentInput,
  "tx": TxMatchInput
}

Input Field	Description
account - LedgerAccountMatchInput!	The LedgerAccount this line is being added to
amount - Int96	A positive amount increases the balance of its LedgerAccount, a negative amount reduces the balance of its LedgerAccount
currency - CurrencyMatchInput	The currency the ledger line is in
description - String	If not specified the description from the parent LedgerEntryInput will be used
key - String	Optional identifier for Ledger Line. You can filter lines by key using LedgerLinesFilterSet .
payment - PaymentInput	Required for createOrder if adding a line to a linked ledger account
tx - TxMatchInput	Required for reconcileTx to specify the transaction being reconciled, you can specify either the FRAGMENT ID or external ID of the transaction

Specify a Ledger Line by using id.

Example

{"id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"}

Input Field	Description
id - ID!	The FRAGMENT ID of the ledger line

A paginated list of Ledger Lines

Example

{
  "nodes": [LedgerLine],
  "pageInfo": PageInfo
}

Field Name	Description
nodes - [LedgerLine!]	The current page of results
pageInfo - PageInfo!	The pagination info for this list

Example

{
  "date": DateFilter,
  "key": StringFilter,
  "posted": DateTimeFilter,
  "type": TxTypeFilter
}

Input Field	Description
date - DateFilter
key - StringFilter	Use this to filter Ledger Lines by key. Ledger Line keys are defined in Schemas.
posted - DateTimeFilter
type - TxTypeFilter

Specify a Ledger by using id or ik.

Example

{"id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1", "ik": "some-safe-string-ik"}

Input Field	Description
id - ID	The FRAGMENT ID of the ledger
ik - SafeString	The IK passed into the createLedger mutation. This is treated as a second unique identifier for this ledger.

Represents a Schema being applied to a Ledger. It contains metadata about the Ledger, the Schema, and the status of the migration.

Example

{
  "ledger": Ledger,
  "schemaVersion": SchemaVersion,
  "status": "completed"
}

Field Name	Description
ledger - Ledger!	The Ledger that the migration is run on.
schemaVersion - SchemaVersion!
status - LedgerMigrationStatus!	The status of the Ledger Migration.

A paginated list of Ledger Migrations

Example

{
  "nodes": [LedgerMigration],
  "pageInfo": PageInfo
}

Field Name	Description
nodes - [LedgerMigration!]!	The current page of results
pageInfo - PageInfo!	Pagination info for this list.

The status of a ledger migration.

Example

"completed"

Enum Value	Description
completed	The Ledger Migration has been successfully completed. This is a terminal state.
failed	The Ledger Migration has failed. This can happen either due to an invalid schema or an internal error. This is a terminal state.
queued	The Ledger Migration has been queued.
skipped	The Ledger Migration has been skipped because a newer version is available. This is a terminal state.
started	The Ledger Migration has been started.

Example

{"equalTo": "double", "in": ["double"]}

Input Field	Description
equalTo - LedgerTypes
in - [LedgerTypes!]

Example

"double"

Enum Value	Description
double

A paginated list of Ledgers

Example

{
  "nodes": [Ledger],
  "pageInfo": PageInfo
}

Field Name	Description
nodes - [Ledger!]	The current page of results
pageInfo - PageInfo!	The pagination info for this list

Example

{"type": LedgerTypeFilter}

Input Field	Description
type - LedgerTypeFilter

Example

{
  "created": "abc123",
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "name": "abc123"
}

Field Name	Description
created - String!
id - ID!
name - String!

Example

{"id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"}

Input Field	Description
id - ID!

An object containing pagination details.

Example

{
  "endCursor": "abc123",
  "hasNextPage": true,
  "hasPreviousPage": true,
  "startCursor": "abc123"
}

Field Name	Description
endCursor - String
hasNextPage - Boolean!
hasPreviousPage - Boolean!
startCursor - String

A string that can contain parameterized values via handlebars syntax. ex: "Hello from {{country}}".

Example

"assets/bank:{{bank_name}}"

Example

{
  "accountNumber": "abc123",
  "externalAccount": ExternalAccountMatchInput,
  "routingNumber": "abc123"
}

Input Field	Description
accountNumber - String
externalAccount - ExternalAccountMatchInput
routingNumber - String

Example

{"increase": IncreasePaymentDetailsInput}

Input Field	Description
increase - IncreasePaymentDetailsInput

Example

{
  "description": "abc123",
  "destination": PayeeInput,
  "details": PaymentDetailsInput,
  "source": PayeeInput,
  "type": "ach"
}

Input Field	Description
description - String	If specified will override the payment description sent, otherwise the line description will be used
destination - PayeeInput	Should only be supplied if amount is negative
details - PaymentDetailsInput	Should be used to specify additional integration-specific information
source - PayeeInput	Should only be supplied if amount is positive and type is ACH
type - PaymentType!	Currently only ach, wire or is supported

Example

"ach"

Enum Value	Description
ach
internal
wire

A specific year ("2021"), quarter ("2021-Q1"), month ("2021-02"), day ("2021-02-03") or hour ("2021-02-03T04")

Example

"2022-Q3"

The consistency configuration of a Ledger Account's balance queries. If not provided as an argument to a balance query, the default behavior is to read eventually consistent balances. See Consistency.

Example

"eventual"

Enum Value	Description
eventual	Balance queries will read eventually consistent balances. This is the default behavior if ReadBalanceConsistencyMode is not provided as an argument to the balance field. Both Ledger Accounts configured with strongly and eventually consistent balance updates support this enum.
strong	Balance queries will read strongly consistent balances. This is only allowed if the Ledger Account's ownBalanceUpdates in its consistencyConfig is strong .
use_account	Balance queries will use the value from the Ledger Account's ownBalanceUpdates in its consistencyConfig .

Example

BadRequestError

Union Types
BadRequestError
InternalError
ReconcileTxResult

Example

{
  "entry": LedgerEntry,
  "isIkReplay": true,
  "lines": [LedgerLine]
}

Field Name	Description
entry - LedgerEntry!	The ledger entry that was posted
isIkReplay - Boolean!	True if this request successfully completed before and the previous response is being returned
lines - [LedgerLine!]!	The ledger lines that were created in that entry

A string with delimiter characters /, #, and : disallowed, as well as parameters in {{handlebar}} syntax.

Example

"some-safe-string-ik"

Example

{
  "key": "some-safe-string-ik",
  "ledgers": LedgersConnection,
  "name": "abc123",
  "version": SchemaVersion,
  "versions": SchemaVersionConnection
}

Field Name	Description
key - SafeString!	The identifier for a Schema. key is unique to a Workspace.
ledgers - LedgersConnection	The paginated list of ledgers the Schema has been applied to.
name - String!	The name of a Schema. It defaults to the key if not provided in your SchemaInput.
version - SchemaVersion!	The metadata for a specific SchemaVersion.
Arguments version - Int The version of the schema to retrieve. If this is not provided, the latest version will be returned.
versions - SchemaVersionConnection!	A paginated list of SchemaVersions.
Arguments after - String Where to start paginating from, when paginating forwards. Send endCursor from a response to get its next page. Learn more about pagination. before - String Where to start paginating from, when paginating backwards. Send startCursor from a response to get the previous page. Learn more about pagination. first - Int The number of schema versions to return per page, when paginating forwards. Defaults to 20, maximum is 200. last - Int The number of schema versions to return per page, when paginating backwards. Defaults to 20, maximum is 200.

A condition that must be met on a Ledger Account balance. The condition can be either a precondition or postcondition.

Example

{"ownBalance": SchemaInt96ConditionInput}

Input Field	Description
ownBalance - SchemaInt96ConditionInput	A condition on the ownBalance of the Ledger Account.

A paginated list of Schemas in a Workspace.

Example

{
  "nodes": [Schema],
  "pageInfo": PageInfo
}

Field Name	Description
nodes - [Schema!]!	The current page of results
pageInfo - PageInfo!	Pagination info for this list.

Matches a Currency. Can be a built-in CurrencyCode, custom Currency, or a parameterized string. If you supply a parameterized string, you must pass in a valid CurrencyCode as a parameter when posting a Ledger Entry.

Example

{
  "code": "assets/bank:{{bank_name}}",
  "customCurrencyId": "assets/bank:{{bank_name}}"
}

Input Field	Description
code - ParameterizedString!	The currency code. This must either be a CurrencyCode or a parameterized string that resolves to a CurrencyCode .
customCurrencyId - ParameterizedString	The ID for a custom currency. This is specified when creating the custom currency using the createCustomCurrency mutation.

Example

{
  "externalId": "assets/bank:{{bank_name}}",
  "id": "assets/bank:{{bank_name}}",
  "linkId": "assets/bank:{{bank_name}}"
}

Input Field	Description
externalId - ParameterizedString	The External systems's ID of the account
id - ParameterizedString	The FRAGMENT ID of the external account
linkId - ParameterizedString	The FRAGMENT ID of the link

Example

{"wire": SchemaIncreaseWirePaymentDetailsInput}

Input Field	Description
wire - SchemaIncreaseWirePaymentDetailsInput

Example

{
  "beneficiaryAddressLine1": "assets/bank:{{bank_name}}",
  "beneficiaryAddressLine2": "assets/bank:{{bank_name}}",
  "beneficiaryAddressLine3": "assets/bank:{{bank_name}}",
  "beneficiaryName": "assets/bank:{{bank_name}}"
}

Input Field	Description
beneficiaryAddressLine1 - ParameterizedString
beneficiaryAddressLine2 - ParameterizedString
beneficiaryAddressLine3 - ParameterizedString
beneficiaryName - ParameterizedString

Input to the API for creating a Schema.

Example

{
  "chartOfAccounts": ChartOfAccountsInput,
  "key": "some-safe-string-ik",
  "ledgerEntries": SchemaLedgerEntriesInput,
  "name": "assets/bank:{{bank_name}}"
}

Input Field	Description
chartOfAccounts - ChartOfAccountsInput!	The Chart of Accounts for the Schema.
key - SafeString!	The key of the Schema. This is a stable, unique identifier for the Schema. Uniqueness is enforced at the Workspace level.
ledgerEntries - SchemaLedgerEntriesInput	The Ledger Entries to add to the Schema.
name - ParameterizedString	The human-readable name of the Schema.

A condition that must be met on a field.

Example

{
  "eq": "assets/bank:{{bank_name}}",
  "gte": "assets/bank:{{bank_name}}",
  "lte": "assets/bank:{{bank_name}}"
}

Input Field	Description
eq - ParameterizedString	Amount must be exactly equal to this value. You may not specify this alongside gte or lte .
gte - ParameterizedString	Amount must be greater than or equal to this value.
lte - ParameterizedString	Amount must be less than or equal to this value.

Models a Ledger Account in a Schema. Upon succesfully storing a Schema, a LedgerAccount will be created for each corresponding non-templated SchemaLedgerAccountInput in your Chart of Accounts.

Example

{
  "children": [SchemaLedgerAccountInput],
  "consistencyConfig": LedgerAccountConsistencyConfigInput,
  "currency": SchemaCurrencyMatchInput,
  "currencyMode": "multi",
  "key": "some-safe-string-ik",
  "linkedAccount": SchemaExternalAccountMatchInput,
  "name": "assets/bank:{{bank_name}}",
  "template": true,
  "type": "asset"
}

Input Field	Description
children - [SchemaLedgerAccountInput!]	Ledger Accounts to create as children of this Ledger Account.
consistencyConfig - LedgerAccountConsistencyConfigInput	The consistency configuration for this Ledger Account. This defines how updates to this Ledger Account's ownBalance are handled.
currency - SchemaCurrencyMatchInput	The currency of this Ledger Account. If this is not set, and currencyMode is not set to multi , it is derived from the Chart of Accounts' default.
currencyMode - CurrencyMode	If set to multi , creates a multi-currency Ledger Account. If set to single , creates a single-currency Ledger Account.
key - SafeString!	The key of this Ledger Account. Keys are used to formulate the unique path of the Ledger Account in your Chart of Accounts. Siblings must have unique keys.
linkedAccount - SchemaExternalAccountMatchInput	The External Account to link to this Ledger Account. It must be provided of linked is true.
name - ParameterizedString	The human-readable name of this Ledger Account.
template - Boolean	Whether or not this Ledger Account should be templated.
type - LedgerAccountTypes	The type of ledger account to create. Required if this is a top-level Ledger Account. If not provided, the type will be inferred from the parent.

Matches a Ledger Account in a Schema.

Example

{"path": "assets/bank:{{bank_name}}"}

Input Field	Description
path - ParameterizedString!	The unique path of the Ledger Account in the Schema. This is a slash-delimited string containing the keys of a Ledger Account and all its direct ancestors. ex: expense-root/subscriptions/netflix For Templated Ledger Accounts, you must supply a parameter in the path that will be used to name an instance of the template. ex: "expense-root/subscriptions/vendor:{{vendor_name}}"

The Ledger Entries in your Schema.

Example

{"types": [SchemaLedgerEntryInput]}

Input Field	Description
types - [SchemaLedgerEntryInput!]!	A list of Ledger Entry definitions.

A condition that must be met on a Ledger Account when a Ledger Entry is posted.

Example

{
  "account": SchemaLedgerAccountMatchInput,
  "currency": SchemaCurrencyMatchInput,
  "postcondition": SchemaConditionInput,
  "precondition": SchemaConditionInput
}

Input Field	Description
account - SchemaLedgerAccountMatchInput!	The Ledger Account to apply the condition to.
currency - SchemaCurrencyMatchInput	The currency of the balance to apply the condition to. Required if the Ledger Account matched is a multi-currency Ledger Account. Otherwise, this field is defaults to the Ledger Account's currency.
postcondition - SchemaConditionInput	A postcondition must be met after the Ledger Entry updates are applied.
precondition - SchemaConditionInput	A precondition must be met before any Ledger Entry updates are applied.

A Ledger Entry in a Schema. All Ledger Entries defined in a Schema must have a unique type.

Example

{
  "conditions": [SchemaLedgerEntryConditionInput],
  "description": "assets/bank:{{bank_name}}",
  "lines": [SchemaLedgerLineInput],
  "type": "some-safe-string-ik"
}

Input Field	Description
conditions - [SchemaLedgerEntryConditionInput!]	Conditions that must be satisfied to post this Ledger Entry. The Ledger Entry will reject with a BadRequestError if any condition is not met. You can only add a condition on a Ledger Account containing a Line in this Ledger Entry.
description - ParameterizedString	Human-readable description of the Ledger Entry.
lines - [SchemaLedgerLineInput!]	The Ledger Lines in the Ledger Entry. If provided, when posting a Typed Entry, a LedgerEntry will be posted containing LedgerLines corresponding to the values you provide here. If your lines contain parameters, you must supply values for those parameters that balance out the Ledger Entry. If not provided, lines will be required when posting a Typed Entry.
type - SafeString!	The type of this Ledger Entry. This is a stable, unique identifier for this entry. Uniqueness is enforced at the Schema level. You can filter on this field when querying for Ledger Entries. See the docs on LedgerEntryFilterSet

A Ledger Line in a Ledger Entry.

Example

{
  "account": SchemaLedgerAccountMatchInput,
  "amount": "assets/bank:{{bank_name}}",
  "currency": SchemaCurrencyMatchInput,
  "description": "assets/bank:{{bank_name}}",
  "key": "some-safe-string-ik",
  "payment": SchemaPaymentInput,
  "tx": SchemaTxMatchInput
}

Input Field	Description
account - SchemaLedgerAccountMatchInput!	The Ledger Account this Ledger Line will be posted to. It supports parameters in its attributes via handlebars syntax.
amount - ParameterizedString	The amount of the Ledger Line. It supports parameters via the handlebars syntax and addition (+) and subtraction (-).
currency - SchemaCurrencyMatchInput	The currency of the Ledger Line. This is required if the Ledger Account has currencyMode multi. It supports parameters in its attributes via handlebars syntax.
description - ParameterizedString	Human-readable description of the line.
key - SafeString!	The key for the Ledger Line. Ledger Line keys must be unique within a Ledger Entry. Key can be filtered on as part of the LedgerLinesFilterSet.
payment - SchemaPaymentInput
tx - SchemaTxMatchInput	The external transaction to reconcile. This field is required if the Ledger Account being posted to is a Linked Ledger Acccount. Otherwise, this field is disallowed. It supports parameters in its attributes via handlebars syntax. See the docs on reconciliation and Linked Ledger Accounts.

An object used to retrieve a Schema.

Example

{"key": "some-safe-string-ik", "version": 2277}

Input Field	Description
key - SafeString!	The key to retrieve a Schema by. key is unique to a Workspace.
version - Int	Optional parameter to specify version of requested Schema. If not provided, it defaults to 0, representing the latest available version for the provided Schema key.

Example

{
  "accountNumber": "assets/bank:{{bank_name}}",
  "externalAccount": SchemaExternalAccountMatchInput,
  "routingNumber": "assets/bank:{{bank_name}}"
}

Input Field	Description
accountNumber - ParameterizedString
externalAccount - SchemaExternalAccountMatchInput
routingNumber - ParameterizedString

Example

{"increase": SchemaIncreasePaymentDetailsInput}

Input Field	Description
increase - SchemaIncreasePaymentDetailsInput

This is used to specify a payment being created for a Linked Ledger Account.

Example

{
  "description": "assets/bank:{{bank_name}}",
  "destination": SchemaPayeeInput,
  "details": SchemaPaymentDetailsInput,
  "source": SchemaPayeeInput,
  "type": "ach"
}

Input Field	Description
description - ParameterizedString
destination - SchemaPayeeInput
details - SchemaPaymentDetailsInput
source - SchemaPayeeInput
type - SchemaPaymentType!	The external system's ID for the transaction.

Example

"ach"

Enum Value	Description
ach
internal
wire

Matches a transaction at an external system. This is used to specify the transaction being reconciled into a Linked Ledger Account

Example

{"externalId": "assets/bank:{{bank_name}}", "id": "assets/bank:{{bank_name}}"}

Input Field	Description
externalId - ParameterizedString	The external system's ID for the transaction.
id - ParameterizedString	The FRAGMENT ID for the transaction.

An instance of a Schema stored in a Workspace. A new SchemaVersion is created each time a Schema is stored. It stores the Chart of Accounts and list of Ledger Entries as well as a history of its Ledger migrations.

Example

{
  "created": "2007-12-03T10:15:30Z",
  "json": "{"key":"value"}",
  "migrations": LedgerMigrationConnection,
  "version": 2277
}

Field Name	Description
created - DateTime!
json - JSON!
migrations - LedgerMigrationConnection
version - Int!	The version of the schema.

A paginated list of SchemaVersions for a given Schema.

Example

{
  "nodes": [SchemaVersion],
  "pageInfo": PageInfo
}

Field Name	Description
nodes - [SchemaVersion!]!	The current page of results
pageInfo - PageInfo!	Pagination info for this list.

Returned by the storeSchema mutation.

Example

BadRequestError

Union Types
BadRequestError
InternalError
StoreSchemaResult

StoreSchemaResult represents a successful execution of storeSchema.

Example

{"schema": Schema}

Field Name	Description
schema - Schema!	The Schema that was stored as a result of calling storeSchema .

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.

Example

"abc123"

Example

{"equalTo": "abc123", "in": ["abc123"]}

Input Field	Description
equalTo - String
in - [String!]

Example

BadRequestError

Union Types
BadRequestError
InternalError
SyncCustomAccountsResult

Example

{"accounts": [ExternalAccount]}

Field Name	Description
accounts - [ExternalAccount!]!	The external accounts that were synced.

Example

BadRequestError

Union Types
BadRequestError
InternalError
SyncCustomTxsResult

Example

{"txs": [Tx]}

Field Name	Description
txs - [Tx!]!

Example

{
  "accountId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "amount": "999999999999",
  "currency": Currency,
  "date": "2022-03-28",
  "description": "abc123",
  "externalAccountId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "externalId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "ledgerEntries": LedgerEntriesConnection,
  "ledgerEntryIds": ["3116551f-5efc-4c9e-84ac-5a36a51b09c1"],
  "ledgerLineIds": ["3116551f-5efc-4c9e-84ac-5a36a51b09c1"],
  "ledgerLines": LedgerLinesConnection,
  "linkId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "posted": "2007-12-03T10:15:30Z",
  "workspaceId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"
}

Field Name	Description
accountId - ID!	FRAGMENT ID of this transaction's external account
amount - Int96!	Integer amount in cents. Positive indicates money entering the external account, negative indicates money leaving
currency - Currency	Currency of this Tx
date - Date!	Date this Tx posted to the external account
description - String!	Description at the external account (can be overridden within the Fragment Dashboard)
externalAccountId - ID!	ID in the external system of this transaction's external account
externalId - ID!	ID of this transaction in the external system
id - ID!
ledgerEntries - LedgerEntriesConnection	Returns ledger entries that are linked to this transaction. You can link the same external account to multiple ledgers, so there could be multipe entries associated with one transaction - one for each linked ledger account this transaction has been reconciled with
ledgerEntryIds - [ID!]	Same as ledgerEntries, but returns an array of IDs instead
ledgerLineIds - [ID!]	Same as ledgerLines, but returns an array of IDs instead
ledgerLines - LedgerLinesConnection	Returns ledger lines that are linked to this transaction. You can link the same external account to multiple ledgers, so there could be multipe lines associated with one transaction - one for each linked ledger account this transaction has been reconciled with
linkId - ID!	FRAGMENT ID of this transaction's Link
posted - DateTime!	ISO-8601 timestamp this Tx posted to the external account
workspaceId - ID!	Callers should not need to query or store this value.

Specify a Tx by using id or externalId, the Link it belongs to by linkId, and the External Account it is a part of by accountId or externalAccountId.

Example

{
  "accountId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "externalAccountId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "externalId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "linkId": "3116551f-5efc-4c9e-84ac-5a36a51b09c1"
}

Input Field	Description
accountId - ID	The FRAGMENT ID of the external account
externalAccountId - ID	The external system's ID for the account
externalId - ID	The external system's ID for the transaction
id - ID	The FRAGMENT ID of the transaction
linkId - ID	The FRAGMENT ID of the link

Example

"credit"

Enum Value	Description
credit
debit

Example

{"equalTo": "credit", "in": ["credit"]}

Input Field	Description
equalTo - TxType
in - [TxType!]

A paginated list of Txs

Example

{
  "nodes": [Tx],
  "pageInfo": PageInfo
}

Field Name	Description
nodes - [Tx!]	The current page of results
pageInfo - PageInfo!	The pagination info for this list

All hour-aligned offsets from -11:00 to +12:00 are supported, e.g. "-08:00" (PT), "-05:00" (ET), "+00:00" (UTC)

Example

"-08:00"

Example

"production"

Enum Value	Description
production
sandbox

Example

{
  "created": "abc123",
  "id": "3116551f-5efc-4c9e-84ac-5a36a51b09c1",
  "name": "abc123",
  "unitEnv": "production"
}

Field Name	Description
created - String!
id - ID!
name - String!
unitEnv - UnitEnv!

Example

{
  "consistencyConfig": LedgerAccountConsistencyConfigInput,
  "name": "abc123"
}

Input Field	Description
consistencyConfig - LedgerAccountConsistencyConfigInput	The consistency configuration for this ledger account. This defines how updates to this ledger account's balance are handled.
name - String	The name to update the ledger account to

Example

BadRequestError

Union Types
BadRequestError
InternalError
UpdateLedgerAccountResult

Example

{"ledgerAccount": LedgerAccount}

Field Name	Description
ledgerAccount - LedgerAccount!	The ledger account that was updated

Example

{"name": "abc123"}

Input Field	Description
name - String	The name to update the ledger account to

Example

BadRequestError

Union Types
BadRequestError
InternalError
UpdateLedgerResult

Example

{"ledger": Ledger}

Field Name	Description
ledger - Ledger!	The ledger that was updated

API Reference

customCurrencies

ledger

ledgerAccount

ledgerEntry

ledgerLine

ledgers

schema

schemas

tx

addLedgerEntry

createCustomCurrency

createCustomLink

createLedger

reconcileTx

storeSchema

syncCustomAccounts

syncCustomTxs

updateLedger

AddLedgerEntryResponse

AddLedgerEntryResult

BadRequestError

BalanceUpdateConsistencyMode

Boolean

ChartOfAccountsInput

CreateCustomCurrencyInput

CreateCustomCurrencyResponse

CreateCustomCurrencyResult

CreateCustomLinkResponse

CreateCustomLinkResult

CreateLedgerAccountInput

CreateLedgerAccountResponse

CreateLedgerAccountResult

CreateLedgerAccountsInput

CreateLedgerAccountsResponse

CreateLedgerAccountsResult

CreateLedgerInput

CreateLedgerResponse

CreateLedgerResult

Currency

CurrencyAmount

CurrencyAmountConnection

CurrencyCode

CurrencyMatchInput

CurrencyMode

CustomAccountInput

CustomCurrenciesConnection

CustomLink

CustomTxInput

Date

DateFilter

DateTime

DateTimeFilter

Error

ExternalAccount

ExternalAccountFilter

ExternalAccountMatchInput

ExternalTransferType

ID

IkReplay

IncreaseEnv

IncreaseLink

IncreasePaymentDetailsInput

IncreaseWirePaymentDetailsInput

Int

Int96

Int96Condition

Int96ConditionInput

InternalError

JSON

LastMoment

Ledger

LedgerAccount

LedgerAccountCondition

LedgerAccountConditionInput

LedgerAccountConsistencyConfig

LedgerAccountConsistencyConfigInput

LedgerAccountFilter

LedgerAccountMatchInput

LedgerAccountTypeFilter