Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/speakeasy-sdks/formance-ts-sdk

A typescript SDK for accessing the Formance API
https://github.com/speakeasy-sdks/formance-ts-sdk
api formance ledger sdk typescript
Last synced: 1 day ago
JSON representation
A typescript SDK for accessing the Formance API
Host: GitHub
URL: https://github.com/speakeasy-sdks/formance-ts-sdk
Owner: speakeasy-sdks
Created: 2023-02-27T12:54:55.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-04-02T21:13:11.000Z (7 months ago)
Last Synced: 2024-10-06T16:48:06.588Z (about 1 month ago)
Topics: api, formance, ledger, sdk, typescript
Language: TypeScript
Homepage: https://docs.formance.com/
Size: 6.17 MB
Stars: 2
Watchers: 4
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        


    

        

        

    

   Formance Typescript SDK

   Open Source Ledger for money-moving platforms

   Build and track custom fit money flows on a scalable financial infrastructure.

   

   

  

  



## SDK Installation

### NPM

```bash

npm add @speakeasy-sdks/formance

```

### Yarn

```bash

yarn add @speakeasy-sdks/formance

```

## SDK Example Usage

```typescript

import { Formance } from "@speakeasy-sdks/formance";

import { GetVersionsResponse } from "@speakeasy-sdks/formance/dist/sdk/models/operations";

const sdk = new Formance({

  security: {

    authorization: "",

  },

});

sdk.getVersions().then((res: GetVersionsResponse) => {

  if (res.statusCode == 200) {

    // handle response

  }

});

```

## Available Resources and Operations

### [Formance SDK](docs/sdks/formance/README.md)

* [getVersions](docs/sdks/formance/README.md#getversions) - Show stack version information

### [accounts](docs/sdks/accounts/README.md)

* [addMetadataToAccount](docs/sdks/accounts/README.md#addmetadatatoaccount) - Add metadata to an account

* [countAccounts](docs/sdks/accounts/README.md#countaccounts) - Count the accounts from a ledger

* [getAccount](docs/sdks/accounts/README.md#getaccount) - Get account by its address

* [listAccounts](docs/sdks/accounts/README.md#listaccounts) - List accounts from a ledger

### [auth](docs/sdks/auth/README.md)

* [addScopeToClient](docs/sdks/auth/README.md#addscopetoclient) - Add scope to client

* [addTransientScope](docs/sdks/auth/README.md#addtransientscope) - Add a transient scope to a scope

* [createClient](docs/sdks/auth/README.md#createclient) - Create client

* [createScope](docs/sdks/auth/README.md#createscope) - Create scope

* [createSecret](docs/sdks/auth/README.md#createsecret) - Add a secret to a client

* [deleteClient](docs/sdks/auth/README.md#deleteclient) - Delete client

* [deleteScope](docs/sdks/auth/README.md#deletescope) - Delete scope

* [deleteScopeFromClient](docs/sdks/auth/README.md#deletescopefromclient) - Delete scope from client

* [deleteSecret](docs/sdks/auth/README.md#deletesecret) - Delete a secret from a client

* [deleteTransientScope](docs/sdks/auth/README.md#deletetransientscope) - Delete a transient scope from a scope

* [getServerInfo](docs/sdks/auth/README.md#getserverinfo) - Get server info

* [listClients](docs/sdks/auth/README.md#listclients) - List clients

* [listScopes](docs/sdks/auth/README.md#listscopes) - List scopes

* [listUsers](docs/sdks/auth/README.md#listusers) - List users

* [readClient](docs/sdks/auth/README.md#readclient) - Read client

* [readScope](docs/sdks/auth/README.md#readscope) - Read scope

* [readUser](docs/sdks/auth/README.md#readuser) - Read user

* [updateClient](docs/sdks/auth/README.md#updateclient) - Update client

* [updateScope](docs/sdks/auth/README.md#updatescope) - Update scope

### [balances](docs/sdks/balances/README.md)

* [getBalances](docs/sdks/balances/README.md#getbalances) - Get the balances from a ledger's account

* [getBalancesAggregated](docs/sdks/balances/README.md#getbalancesaggregated) - Get the aggregated balances from selected accounts

### [clients](docs/sdks/clients/README.md)

* [addScopeToClient](docs/sdks/clients/README.md#addscopetoclient) - Add scope to client

* [createClient](docs/sdks/clients/README.md#createclient) - Create client

* [createSecret](docs/sdks/clients/README.md#createsecret) - Add a secret to a client

* [deleteClient](docs/sdks/clients/README.md#deleteclient) - Delete client

* [deleteScopeFromClient](docs/sdks/clients/README.md#deletescopefromclient) - Delete scope from client

* [deleteSecret](docs/sdks/clients/README.md#deletesecret) - Delete a secret from a client

* [listClients](docs/sdks/clients/README.md#listclients) - List clients

* [readClient](docs/sdks/clients/README.md#readclient) - Read client

* [updateClient](docs/sdks/clients/README.md#updateclient) - Update client

### [ledger](docs/sdks/ledger/README.md)

* [addMetadataOnTransaction](docs/sdks/ledger/README.md#addmetadataontransaction) - Set the metadata of a transaction by its ID

* [addMetadataToAccount](docs/sdks/ledger/README.md#addmetadatatoaccount) - Add metadata to an account

* [countAccounts](docs/sdks/ledger/README.md#countaccounts) - Count the accounts from a ledger

* [countTransactions](docs/sdks/ledger/README.md#counttransactions) - Count the transactions from a ledger

* [createTransaction](docs/sdks/ledger/README.md#createtransaction) - Create a new transaction to a ledger

* [getAccount](docs/sdks/ledger/README.md#getaccount) - Get account by its address

* [getBalances](docs/sdks/ledger/README.md#getbalances) - Get the balances from a ledger's account

* [getBalancesAggregated](docs/sdks/ledger/README.md#getbalancesaggregated) - Get the aggregated balances from selected accounts

* [getInfo](docs/sdks/ledger/README.md#getinfo) - Show server information

* [getLedgerInfo](docs/sdks/ledger/README.md#getledgerinfo) - Get information about a ledger

* [getTransaction](docs/sdks/ledger/README.md#gettransaction) - Get transaction from a ledger by its ID

* [listAccounts](docs/sdks/ledger/README.md#listaccounts) - List accounts from a ledger

* [listLogs](docs/sdks/ledger/README.md#listlogs) - List the logs from a ledger

* [listTransactions](docs/sdks/ledger/README.md#listtransactions) - List transactions from a ledger

* [readStats](docs/sdks/ledger/README.md#readstats) - Get statistics from a ledger

* [revertTransaction](docs/sdks/ledger/README.md#reverttransaction) - Revert a ledger transaction by its ID

### [logs](docs/sdks/logs/README.md)

* [listLogs](docs/sdks/logs/README.md#listlogs) - List the logs from a ledger

### [orchestration](docs/sdks/orchestration/README.md)

* [cancelEvent](docs/sdks/orchestration/README.md#cancelevent) - Cancel a running workflow

* [createWorkflow](docs/sdks/orchestration/README.md#createworkflow) - Create workflow

* [getInstance](docs/sdks/orchestration/README.md#getinstance) - Get a workflow instance by id

* [getInstanceHistory](docs/sdks/orchestration/README.md#getinstancehistory) - Get a workflow instance history by id

* [getInstanceStageHistory](docs/sdks/orchestration/README.md#getinstancestagehistory) - Get a workflow instance stage history

* [getWorkflow](docs/sdks/orchestration/README.md#getworkflow) - Get a flow by id

* [listInstances](docs/sdks/orchestration/README.md#listinstances) - List instances of a workflow

* [listWorkflows](docs/sdks/orchestration/README.md#listworkflows) - List registered workflows

* [orchestrationgetServerInfo](docs/sdks/orchestration/README.md#orchestrationgetserverinfo) - Get server info

* [runWorkflow](docs/sdks/orchestration/README.md#runworkflow) - Run workflow

* [sendEvent](docs/sdks/orchestration/README.md#sendevent) - Send an event to a running workflow

### [payments](docs/sdks/payments/README.md)

* [connectorsStripeTransfer](docs/sdks/payments/README.md#connectorsstripetransfer) - Transfer funds between Stripe accounts

* [connectorsTransfer](docs/sdks/payments/README.md#connectorstransfer) - Transfer funds between Connector accounts

* [getConnectorTask](docs/sdks/payments/README.md#getconnectortask) - Read a specific task of the connector

* [getPayment](docs/sdks/payments/README.md#getpayment) - Get a payment

* [installConnector](docs/sdks/payments/README.md#installconnector) - Install a connector

* [listAllConnectors](docs/sdks/payments/README.md#listallconnectors) - List all installed connectors

* [listConfigsAvailableConnectors](docs/sdks/payments/README.md#listconfigsavailableconnectors) - List the configs of each available connector

* [listConnectorTasks](docs/sdks/payments/README.md#listconnectortasks) - List tasks from a connector

* [listConnectorsTransfers](docs/sdks/payments/README.md#listconnectorstransfers) - List transfers and their statuses

* [listPayments](docs/sdks/payments/README.md#listpayments) - List payments

* [paymentsgetServerInfo](docs/sdks/payments/README.md#paymentsgetserverinfo) - Get server info

* [paymentslistAccounts](docs/sdks/payments/README.md#paymentslistaccounts) - List accounts

* [readConnectorConfig](docs/sdks/payments/README.md#readconnectorconfig) - Read the config of a connector

* [resetConnector](docs/sdks/payments/README.md#resetconnector) - Reset a connector

* [uninstallConnector](docs/sdks/payments/README.md#uninstallconnector) - Uninstall a connector

* [updateMetadata](docs/sdks/payments/README.md#updatemetadata) - Update metadata

### [scopes](docs/sdks/scopes/README.md)

* [addTransientScope](docs/sdks/scopes/README.md#addtransientscope) - Add a transient scope to a scope

* [createScope](docs/sdks/scopes/README.md#createscope) - Create scope

* [deleteScope](docs/sdks/scopes/README.md#deletescope) - Delete scope

* [deleteTransientScope](docs/sdks/scopes/README.md#deletetransientscope) - Delete a transient scope from a scope

* [listScopes](docs/sdks/scopes/README.md#listscopes) - List scopes

* [readScope](docs/sdks/scopes/README.md#readscope) - Read scope

* [updateScope](docs/sdks/scopes/README.md#updatescope) - Update scope

### [search](docs/sdks/search/README.md)

* [search](docs/sdks/search/README.md#search) - Search

* [searchgetServerInfo](docs/sdks/search/README.md#searchgetserverinfo) - Get server info

### [server](docs/sdks/server/README.md)

* [getInfo](docs/sdks/server/README.md#getinfo) - Show server information

### [stats](docs/sdks/stats/README.md)

* [readStats](docs/sdks/stats/README.md#readstats) - Get statistics from a ledger

### [transactions](docs/sdks/transactions/README.md)

* [addMetadataOnTransaction](docs/sdks/transactions/README.md#addmetadataontransaction) - Set the metadata of a transaction by its ID

* [countTransactions](docs/sdks/transactions/README.md#counttransactions) - Count the transactions from a ledger

* [createTransaction](docs/sdks/transactions/README.md#createtransaction) - Create a new transaction to a ledger

* [getTransaction](docs/sdks/transactions/README.md#gettransaction) - Get transaction from a ledger by its ID

* [listTransactions](docs/sdks/transactions/README.md#listtransactions) - List transactions from a ledger

* [revertTransaction](docs/sdks/transactions/README.md#reverttransaction) - Revert a ledger transaction by its ID

### [users](docs/sdks/users/README.md)

* [listUsers](docs/sdks/users/README.md#listusers) - List users

* [readUser](docs/sdks/users/README.md#readuser) - Read user

### [wallets](docs/sdks/wallets/README.md)

* [confirmHold](docs/sdks/wallets/README.md#confirmhold) - Confirm a hold

* [createBalance](docs/sdks/wallets/README.md#createbalance) - Create a balance

* [createWallet](docs/sdks/wallets/README.md#createwallet) - Create a new wallet

* [creditWallet](docs/sdks/wallets/README.md#creditwallet) - Credit a wallet

* [debitWallet](docs/sdks/wallets/README.md#debitwallet) - Debit a wallet

* [getBalance](docs/sdks/wallets/README.md#getbalance) - Get detailed balance

* [getHold](docs/sdks/wallets/README.md#gethold) - Get a hold

* [getHolds](docs/sdks/wallets/README.md#getholds) - Get all holds for a wallet

* [getTransactions](docs/sdks/wallets/README.md#gettransactions)

* [getWallet](docs/sdks/wallets/README.md#getwallet) - Get a wallet

* [getWalletSummary](docs/sdks/wallets/README.md#getwalletsummary) - Get wallet summary

* [listBalances](docs/sdks/wallets/README.md#listbalances) - List balances of a wallet

* [listWallets](docs/sdks/wallets/README.md#listwallets) - List all wallets

* [updateWallet](docs/sdks/wallets/README.md#updatewallet) - Update a wallet

* [voidHold](docs/sdks/wallets/README.md#voidhold) - Cancel a hold

* [walletsgetServerInfo](docs/sdks/wallets/README.md#walletsgetserverinfo) - Get server info

### [webhooks](docs/sdks/webhooks/README.md)

* [activateConfig](docs/sdks/webhooks/README.md#activateconfig) - Activate one config

* [changeConfigSecret](docs/sdks/webhooks/README.md#changeconfigsecret) - Change the signing secret of a config

* [deactivateConfig](docs/sdks/webhooks/README.md#deactivateconfig) - Deactivate one config

* [deleteConfig](docs/sdks/webhooks/README.md#deleteconfig) - Delete one config

* [getManyConfigs](docs/sdks/webhooks/README.md#getmanyconfigs) - Get many configs

* [insertConfig](docs/sdks/webhooks/README.md#insertconfig) - Insert a new config

* [testConfig](docs/sdks/webhooks/README.md#testconfig) - Test one config

### SDK Generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)