Ledger Mutations | Fragment

C API Mutations#

Response

Query

mutation AddLedgerEntries($entries: [AddLedgerEntryInput!]!) {
  addLedgerEntries(entries: $entries) {
    ... on AddLedgerEntriesError {
      ...AddLedgerEntriesErrorFragment
    }
    ... on AddLedgerEntriesResult {
      ...AddLedgerEntriesResultFragment
    }
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
  }
}

Variables

{"entries": [AddLedgerEntryInput]}

Response

{"data": {"addLedgerEntries": AddLedgerEntriesError}}

Arguments

Name	Description
`entries`[AddLedgerEntryInput!]!	The Ledger Entries to post, each with its own Idempotency Key.

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

EXPERIMENTAL — subject to change.

Response

Returns a CreatePaymentResponse!

Query

mutation CreatePayment(
  $ik: SafeString!,
  $ledger: LedgerMatchInput!,
  $payment: CreatePaymentInput!
) {
  createPayment(
    ik: $ik,
    ledger: $ledger,
    payment: $payment
  ) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on CreatePaymentResult {
      ...CreatePaymentResultFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
  }
}

Variables

{
  "ik": "some-safe-string-ik",
  "ledger": LedgerMatchInput,
  "payment": CreatePaymentInput
}

Response

{"data": {"createPayment": BadRequestError}}

Arguments

Name	Description
`ik`SafeString!	The Idempotency Key. Can be up to 128 characters long.
`ledger`LedgerMatchInput!	The Ledger this Payment belongs to.
`payment`CreatePaymentInput!	The Payment to create.

Save a Payment Method for a User without charging it.

Response

Returns a CreatePaymentMethodSetupResponse!

Query

mutation CreatePaymentMethodSetup(
  $ik: SafeString!,
  $ledger: LedgerMatchInput!,
  $user: UserMatchInput!
) {
  createPaymentMethodSetup(
    ik: $ik,
    ledger: $ledger,
    user: $user
  ) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on CreatePaymentMethodSetupResult {
      ...CreatePaymentMethodSetupResultFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
  }
}

Variables

{
  "ik": "some-safe-string-ik",
  "ledger": LedgerMatchInput,
  "user": UserMatchInput
}

Response

{"data": {"createPaymentMethodSetup": BadRequestError}}

Arguments

Name	Description
`ik`SafeString!	The Idempotency Key for the Payment Method Setup. Can be up to 128 characters long. This is not the idempotency key for the saved Payment Method.
`ledger`LedgerMatchInput!	The Ledger the Payment Method is saved in.
`user`UserMatchInput!	The User whose payment method to save.

Delete Txs on a Custom Link. Once deleted, a Tx will not show up in listing queries, but can be resolved by if you lookup by its FRAGMENT ID.

Response

Returns a DeleteCustomTxsResponse!

Query

mutation DeleteCustomTxs($txs: [ID!]!) {
  deleteCustomTxs(txs: $txs) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on DeleteCustomTxsResult {
      ...DeleteCustomTxsResultFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
  }
}

Variables

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

Response

{"data": {"deleteCustomTxs": BadRequestError}}

Arguments

Name	Description
`txs`[ID!]!	The FRAGMENT IDs of the Txs to delete

Delete a Ledger.

Response

Returns a DeleteLedgerResponse!

Query

mutation DeleteLedger($ledger: LedgerMatchInput!) {
  deleteLedger(ledger: $ledger) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on DeleteLedgerResult {
      ...DeleteLedgerResultFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
  }
}

Variables

{"ledger": LedgerMatchInput}

Response

{"data": {"deleteLedger": BadRequestError}}

Arguments

Name	Description
`ledger`LedgerMatchInput!

Delete a Payment Method saved for a User.

Response

Returns a DeletePaymentMethodResponse!

Query

mutation DeletePaymentMethod($paymentMethod: PaymentMethodMatchInput!) {
  deletePaymentMethod(paymentMethod: $paymentMethod) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on DeletePaymentMethodResult {
      ...DeletePaymentMethodResultFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
  }
}

Variables

{"paymentMethod": PaymentMethodMatchInput}

Response

{"data": {"deletePaymentMethod": BadRequestError}}

Arguments

Name	Description
`paymentMethod`PaymentMethodMatchInput!	The Payment Method to delete.

Delete a Schema

Response

Returns a DeleteSchemaResponse!

Query

mutation DeleteSchema($schema: SchemaMatchInput!) {
  deleteSchema(schema: $schema) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on DeleteSchemaResult {
      ...DeleteSchemaResultFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
  }
}

Variables

{"schema": SchemaMatchInput}

Response

{"data": {"deleteSchema": BadRequestError}}

Arguments

Name	Description
`schema`SchemaMatchInput!

Instantiates a Ledger Account from a template in the Ledger's Schema before any Ledger Entry is posted to it. Creates any missing templated ancestors.

Response

Returns an InstantiateLedgerAccountResponse!

Query

mutation InstantiateLedgerAccount(
  $ledger: LedgerMatchInput!,
  $parameters: Parameters,
  $path: String!
) {
  instantiateLedgerAccount(
    ledger: $ledger,
    parameters: $parameters,
    path: $path
  ) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on InstantiateLedgerAccountResult {
      ...InstantiateLedgerAccountResultFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
  }
}

Variables

{
  "ledger": LedgerMatchInput,
  "parameters": {"bank_name": "bank-name", "deposit_amount": "10000"},
  "path": "abc123"
}

Response

{"data": {"instantiateLedgerAccount": BadRequestError}}

Arguments

Name	Description
`ledger`LedgerMatchInput!	The Ledger whose Schema defines the account.
`parameters`Parameters	Values for every parameter the account's template references: name, currency, and linked account fields.
`path`String!	The fully instantiated path of the account, e.g. assets/customer:cust-1. Must not contain placeholders.

Migrate an existing Ledger Entry to a new type and typeVersion.

Response

Returns a MigrateLedgerEntryResponse!

Query

mutation MigrateLedgerEntry($input: MigrateLedgerEntryInput!) {
  migrateLedgerEntry(input: $input) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
    ... on MigrateLedgerEntryResult {
      ...MigrateLedgerEntryResultFragment
    }
  }
}

Variables

{"input": MigrateLedgerEntryInput}

Response

{"data": {"migrateLedgerEntry": BadRequestError}}

Arguments

Name	Description
`input`MigrateLedgerEntryInput!

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.

Reverses a Ledger Entry

Response

Returns a ReverseLedgerEntryResponse!

Query

mutation ReverseLedgerEntry($id: ID!) {
  reverseLedgerEntry(id: $id) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
    ... on ReverseLedgerEntryResult {
      ...ReverseLedgerEntryResultFragment
    }
  }
}

Variables

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

Response

{"data": {"reverseLedgerEntry": BadRequestError}}

Arguments

Name	Description
`id`ID!	The FRAGMENT ID of the Ledger Entry to reverse

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 or creation IK 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 or creation IK of a Custom Link.
`txs`[CustomTxInput!]!	A list of external transactions to sync

Updates a Ledger. Currently, you can change only the Ledger 'name'.

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!	A payload of fields to update. Currently, you can change only the Ledger 'name'.

Update a ledger entry

Response

Returns an UpdateLedgerEntryResponse!

Query

mutation UpdateLedgerEntry(
  $ledgerEntry: LedgerEntryMatchInput!,
  $update: UpdateLedgerEntryInput!
) {
  updateLedgerEntry(
    ledgerEntry: $ledgerEntry,
    update: $update
  ) {
    ... on BadRequestError {
      ...BadRequestErrorFragment
    }
    ... on InternalError {
      ...InternalErrorFragment
    }
    ... on UpdateLedgerEntryResult {
      ...UpdateLedgerEntryResultFragment
    }
  }
}

Variables

{
  "ledgerEntry": LedgerEntryMatchInput,
  "update": UpdateLedgerEntryInput
}

Response

{"data": {"updateLedgerEntry": BadRequestError}}

Arguments

Name	Description
`ledgerEntry`LedgerEntryMatchInput!	The Ledger Entry that is being updated
`update`UpdateLedgerEntryInput!	The payload containing the fields to update. Only a Ledger Entry's tags and its Ledger Lines' tags can be updated.