ledger.TransactionsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
addMetadataOnTransaction	POST /{ledger}/transactions/{txid}/metadata	Set the metadata of a transaction by its ID
countTransactions	HEAD /{ledger}/transactions	Count the transactions from a ledger
createTransaction	POST /{ledger}/transactions	Create a new transaction to a ledger
createTransactions	POST /{ledger}/transactions/batch	Create a new batch of transactions to a ledger
getTransaction	GET /{ledger}/transactions/{txid}	Get transaction from a ledger by its ID
listTransactions	GET /{ledger}/transactions	List transactions from a ledger
revertTransaction	POST /{ledger}/transactions/{txid}/revert	Revert a ledger transaction by its ID

addMetadataOnTransaction

void addMetadataOnTransaction()

Example

import { ledger } from '@numaryhq/ledger-nodejs';
import * as fs from 'fs';

const configuration = ledger.createConfiguration();
const apiInstance = new ledger.TransactionsApi(configuration);

let body:ledger.TransactionsApiAddMetadataOnTransactionRequest = {
  // string | Name of the ledger.
  ledger: "ledger001",
  // number | Transaction ID.
  txid: 1234,
  // { [key: string]: any; } | metadata (optional)
  requestBody: {
    "key": null,
  },
};

apiInstance.addMetadataOnTransaction(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
requestBody	{ [key: string]: any; }	metadata
ledger	[string]	Name of the ledger.	defaults to undefined
txid	[number]	Transaction ID.	defaults to undefined

Return type

void

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
204	No Content	-
0	Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

countTransactions

void countTransactions()

Example

import { ledger } from '@numaryhq/ledger-nodejs';
import * as fs from 'fs';

const configuration = ledger.createConfiguration();
const apiInstance = new ledger.TransactionsApi(configuration);

let body:ledger.TransactionsApiCountTransactionsRequest = {
  // string | Name of the ledger.
  ledger: "ledger001",
  // string | Filter transactions by reference field. (optional)
  reference: "ref:001",
  // string | Filter transactions with postings involving given account, either as source or destination (regular expression placed between ^ and $). (optional)
  account: "users:001",
  // string | Filter transactions with postings involving given account at source (regular expression placed between ^ and $). (optional)
  source: "users:001",
  // string | Filter transactions with postings involving given account at destination (regular expression placed between ^ and $). (optional)
  destination: "users:001",
  // Date | Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, \"2023-01-02T15:04:01Z\" includes the first second of 4th minute).  (optional)
  startTime: new Date('1970-01-01T00:00:00.00Z'),
  // Date | Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, \"2023-01-02T15:04:01Z\" includes the first second of 4th minute). Deprecated, please use `startTime` instead.  (optional)
  startTime2: new Date('1970-01-01T00:00:00.00Z'),
  // Date | Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, \"2023-01-02T15:04:01Z\" excludes the first second of 4th minute).  (optional)
  endTime: new Date('1970-01-01T00:00:00.00Z'),
  // Date | Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, \"2023-01-02T15:04:01Z\" excludes the first second of 4th minute). Deprecated, please use `endTime` instead.  (optional)
  endTime2: new Date('1970-01-01T00:00:00.00Z'),
  // any | Filter transactions by metadata key value pairs. Nested objects can be used as seen in the example below. (optional)
  metadata: {},
};

apiInstance.countTransactions(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
ledger	[string]	Name of the ledger.	defaults to undefined
reference	[string]	Filter transactions by reference field.	(optional) defaults to undefined
account	[string]	Filter transactions with postings involving given account, either as source or destination (regular expression placed between ^ and $).	(optional) defaults to undefined
source	[string]	Filter transactions with postings involving given account at source (regular expression placed between ^ and $).	(optional) defaults to undefined
destination	[string]	Filter transactions with postings involving given account at destination (regular expression placed between ^ and $).	(optional) defaults to undefined
startTime	[Date]	Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, "2023-01-02T15:04:01Z" includes the first second of 4th minute).	(optional) defaults to undefined
startTime2	[Date]	Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, "2023-01-02T15:04:01Z" includes the first second of 4th minute). Deprecated, please use `startTime` instead.	(optional) defaults to undefined
endTime	[Date]	Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, "2023-01-02T15:04:01Z" excludes the first second of 4th minute).	(optional) defaults to undefined
endTime2	[Date]	Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, "2023-01-02T15:04:01Z" excludes the first second of 4th minute). Deprecated, please use `endTime` instead.	(optional) defaults to undefined
metadata	any	Filter transactions by metadata key value pairs. Nested objects can be used as seen in the example below.	(optional) defaults to undefined

Return type

void

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	OK	* Count -
0	Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createTransaction

TransactionsResponse createTransaction(postTransaction)

Example

import { ledger } from '@numaryhq/ledger-nodejs';
import * as fs from 'fs';

const configuration = ledger.createConfiguration();
const apiInstance = new ledger.TransactionsApi(configuration);

let body:ledger.TransactionsApiCreateTransactionRequest = {
  // string | Name of the ledger.
  ledger: "ledger001",
  // PostTransaction | The request body must contain at least one of the following objects:   - `postings`: suitable for simple transactions   - `script`: enabling more complex transactions with Numscript 
  postTransaction: {
    timestamp: new Date('1970-01-01T00:00:00.00Z'),
    postings: [
      {
        amount: 100,
        asset: "COIN",
        destination: "users:002",
        source: "users:001",
      },
    ],
    script: {
      plain: `vars {
account $user
}
send [COIN 10] (
	source = @world
	destination = $user
)
`,
      vars: {},
    },
    reference: "ref:001",
    metadata: {
      "key": null,
    },
  },
  // boolean | Set the preview mode. Preview mode doesn't add the logs to the database or publish a message to the message broker. (optional)
  preview: true,
};

apiInstance.createTransaction(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
postTransaction	PostTransaction	The request body must contain at least one of the following objects: - `postings`: suitable for simple transactions - `script`: enabling more complex transactions with Numscript
ledger	[string]	Name of the ledger.	defaults to undefined
preview	[boolean]	Set the preview mode. Preview mode doesn't add the logs to the database or publish a message to the message broker.	(optional) defaults to undefined

Return type

TransactionsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createTransactions

TransactionsResponse createTransactions(transactions)

Example

import { ledger } from '@numaryhq/ledger-nodejs';
import * as fs from 'fs';

const configuration = ledger.createConfiguration();
const apiInstance = new ledger.TransactionsApi(configuration);

let body:ledger.TransactionsApiCreateTransactionsRequest = {
  // string | Name of the ledger.
  ledger: "ledger001",
  // Transactions
  transactions: {
    transactions: [
      {
        postings: [
          {
            amount: 100,
            asset: "COIN",
            destination: "users:002",
            source: "users:001",
          },
        ],
        reference: "ref:001",
        metadata: {
          "key": null,
        },
        timestamp: new Date('1970-01-01T00:00:00.00Z'),
      },
    ],
  },
};

apiInstance.createTransactions(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
transactions	Transactions
ledger	[string]	Name of the ledger.	defaults to undefined

Return type

TransactionsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTransaction

TransactionResponse getTransaction()

Example

import { ledger } from '@numaryhq/ledger-nodejs';
import * as fs from 'fs';

const configuration = ledger.createConfiguration();
const apiInstance = new ledger.TransactionsApi(configuration);

let body:ledger.TransactionsApiGetTransactionRequest = {
  // string | Name of the ledger.
  ledger: "ledger001",
  // number | Transaction ID.
  txid: 1234,
};

apiInstance.getTransaction(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
ledger	[string]	Name of the ledger.	defaults to undefined
txid	[number]	Transaction ID.	defaults to undefined

Return type

TransactionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listTransactions

TransactionsCursorResponse listTransactions()

List transactions from a ledger, sorted by txid in descending order.

Example

import { ledger } from '@numaryhq/ledger-nodejs';
import * as fs from 'fs';

const configuration = ledger.createConfiguration();
const apiInstance = new ledger.TransactionsApi(configuration);

let body:ledger.TransactionsApiListTransactionsRequest = {
  // string | Name of the ledger.
  ledger: "ledger001",
  // number | The maximum number of results to return per page.  (optional)
  pageSize: 100,
  // number | The maximum number of results to return per page. Deprecated, please use `pageSize` instead.  (optional)
  pageSize2: 100,
  // string | Pagination cursor, will return transactions after given txid (in descending order). (optional)
  after: "1234",
  // string | Find transactions by reference field. (optional)
  reference: "ref:001",
  // string | Filter transactions with postings involving given account, either as source or destination (regular expression placed between ^ and $). (optional)
  account: "users:001",
  // string | Filter transactions with postings involving given account at source (regular expression placed between ^ and $). (optional)
  source: "users:001",
  // string | Filter transactions with postings involving given account at destination (regular expression placed between ^ and $). (optional)
  destination: "users:001",
  // Date | Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, \"2023-01-02T15:04:01Z\" includes the first second of 4th minute).  (optional)
  startTime: new Date('1970-01-01T00:00:00.00Z'),
  // Date | Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, \"2023-01-02T15:04:01Z\" includes the first second of 4th minute). Deprecated, please use `startTime` instead.  (optional)
  startTime2: new Date('1970-01-01T00:00:00.00Z'),
  // Date | Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, \"2023-01-02T15:04:01Z\" excludes the first second of 4th minute).  (optional)
  endTime: new Date('1970-01-01T00:00:00.00Z'),
  // Date | Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, \"2023-01-02T15:04:01Z\" excludes the first second of 4th minute). Deprecated, please use `endTime` instead.  (optional)
  endTime2: new Date('1970-01-01T00:00:00.00Z'),
  // string | Parameter used in pagination requests. Maximum page size is set to 15. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.  (optional)
  cursor: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
  // string | Parameter used in pagination requests. Maximum page size is set to 15. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set. Deprecated, please use `cursor` instead.  (optional)
  paginationToken: "aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==",
  // any | Filter transactions by metadata key value pairs. Nested objects can be used as seen in the example below. (optional)
  metadata: {},
};

apiInstance.listTransactions(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
ledger	[string]	Name of the ledger.	defaults to undefined
pageSize	[number]	The maximum number of results to return per page.	(optional) defaults to 15
pageSize2	[number]	The maximum number of results to return per page. Deprecated, please use `pageSize` instead.	(optional) defaults to 15
after	[string]	Pagination cursor, will return transactions after given txid (in descending order).	(optional) defaults to undefined
reference	[string]	Find transactions by reference field.	(optional) defaults to undefined
account	[string]	Filter transactions with postings involving given account, either as source or destination (regular expression placed between ^ and $).	(optional) defaults to undefined
source	[string]	Filter transactions with postings involving given account at source (regular expression placed between ^ and $).	(optional) defaults to undefined
destination	[string]	Filter transactions with postings involving given account at destination (regular expression placed between ^ and $).	(optional) defaults to undefined
startTime	[Date]	Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, "2023-01-02T15:04:01Z" includes the first second of 4th minute).	(optional) defaults to undefined
startTime2	[Date]	Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, "2023-01-02T15:04:01Z" includes the first second of 4th minute). Deprecated, please use `startTime` instead.	(optional) defaults to undefined
endTime	[Date]	Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, "2023-01-02T15:04:01Z" excludes the first second of 4th minute).	(optional) defaults to undefined
endTime2	[Date]	Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, "2023-01-02T15:04:01Z" excludes the first second of 4th minute). Deprecated, please use `endTime` instead.	(optional) defaults to undefined
cursor	[string]	Parameter used in pagination requests. Maximum page size is set to 15. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.	(optional) defaults to undefined
paginationToken	[string]	Parameter used in pagination requests. Maximum page size is set to 15. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set. Deprecated, please use `cursor` instead.	(optional) defaults to undefined
metadata	any	Filter transactions by metadata key value pairs. Nested objects can be used as seen in the example below.	(optional) defaults to undefined

Return type

TransactionsCursorResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

revertTransaction

TransactionResponse revertTransaction()

Example

import { ledger } from '@numaryhq/ledger-nodejs';
import * as fs from 'fs';

const configuration = ledger.createConfiguration();
const apiInstance = new ledger.TransactionsApi(configuration);

let body:ledger.TransactionsApiRevertTransactionRequest = {
  // string | Name of the ledger.
  ledger: "ledger001",
  // number | Transaction ID.
  txid: 1234,
};

apiInstance.revertTransaction(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
ledger	[string]	Name of the ledger.	defaults to undefined
txid	[number]	Transaction ID.	defaults to undefined

Return type

TransactionResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8

HTTP response details

Status code	Description	Response headers
200	OK	-
0	Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

TransactionsApi.md

Latest commit

History

TransactionsApi.md

File metadata and controls

ledger.TransactionsApi

addMetadataOnTransaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

countTransactions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createTransaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createTransactions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getTransaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

listTransactions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

revertTransaction

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details