\TransactionsApi

All URIs are relative to https://.o.numary.cloud/ledger

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

AddMetadataOnTransaction(ctx, ledger, txid).RequestBody(requestBody).Execute()

Set the metadata of a transaction by its ID.

Example

package main

import (
    "context"
    "fmt"
    "os"
    client "github.com/numary/numary-go"
)

func main() {
    ledger := "ledger001" // string | Name of the ledger.
    txid := int32(1234) // int32 | Transaction ID.
    requestBody := map[string]interface{}{"key": interface{}(123)} // map[string]interface{} | metadata (optional)

    configuration := client.NewConfiguration()
    api_client := client.NewAPIClient(configuration)
    resp, r, err := api_client.TransactionsApi.AddMetadataOnTransaction(context.Background(), ledger, txid).RequestBody(requestBody).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TransactionsApi.AddMetadataOnTransaction``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ledger	string	Name of the ledger.
txid	int32	Transaction ID.

Other Parameters

Other parameters are passed through a pointer to a apiAddMetadataOnTransactionRequest struct via the builder pattern

Name	Type	Description	Notes

requestBody | map[string]interface{} | metadata |

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

CountTransactions

CountTransactions(ctx, ledger).Reference(reference).Account(account).Source(source).Destination(destination).Metadata(metadata).Execute()

Count the transactions from a ledger.

Example

package main

import (
    "context"
    "fmt"
    "os"
    client "github.com/numary/numary-go"
)

func main() {
    ledger := "ledger001" // string | Name of the ledger.
    reference := "ref:001" // string | Filter transactions by reference field. (optional)
    account := "users:001" // string | Filter transactions with postings involving given account, either as source or destination (regular expression placed between ^ and $). (optional)
    source := "users:001" // string | Filter transactions with postings involving given account at source (regular expression placed between ^ and $). (optional)
    destination := "users:001" // string | Filter transactions with postings involving given account at destination (regular expression placed between ^ and $). (optional)
    metadata := map[string]interface{}{"key": map[string]interface{}(123)} // map[string]interface{} | Filter transactions by metadata key value pairs. Nested objects can be used as seen in the example below. (optional)

    configuration := client.NewConfiguration()
    api_client := client.NewAPIClient(configuration)
    resp, r, err := api_client.TransactionsApi.CountTransactions(context.Background(), ledger).Reference(reference).Account(account).Source(source).Destination(destination).Metadata(metadata).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TransactionsApi.CountTransactions``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ledger	string	Name of the ledger.

Other Parameters

Other parameters are passed through a pointer to a apiCountTransactionsRequest struct via the builder pattern

Name	Type	Description	Notes

reference | string | Filter transactions by reference field. | account | string | Filter transactions with postings involving given account, either as source or destination (regular expression placed between ^ and $). | source | string | Filter transactions with postings involving given account at source (regular expression placed between ^ and $). | destination | string | Filter transactions with postings involving given account at destination (regular expression placed between ^ and $). | metadata | map[string]interface{} | Filter transactions by metadata key value pairs. Nested objects can be used as seen in the example below. |

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

CreateTransaction

TransactionsResponse CreateTransaction(ctx, ledger).TransactionData(transactionData).Preview(preview).Execute()

Create a new transaction to a ledger.

Example

package main

import (
    "context"
    "fmt"
    "os"
    client "github.com/numary/numary-go"
)

func main() {
    ledger := "ledger001" // string | Name of the ledger.
    transactionData := *client.NewTransactionData([]client.Posting{*client.NewPosting(int32(100), "COIN", "users:002", "users:001")}) // TransactionData | 
    preview := true // bool | Set the preview mode. Preview mode doesn't add the logs to the database or publish a message to the message broker. (optional)

    configuration := client.NewConfiguration()
    api_client := client.NewAPIClient(configuration)
    resp, r, err := api_client.TransactionsApi.CreateTransaction(context.Background(), ledger).TransactionData(transactionData).Preview(preview).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TransactionsApi.CreateTransaction``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateTransaction`: TransactionsResponse
    fmt.Fprintf(os.Stdout, "Response from `TransactionsApi.CreateTransaction`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ledger	string	Name of the ledger.

Other Parameters

Other parameters are passed through a pointer to a apiCreateTransactionRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

TransactionsResponse

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

CreateTransactions

TransactionsResponse CreateTransactions(ctx, ledger).Transactions(transactions).Execute()

Create a new batch of transactions to a ledger.

Example

package main

import (
    "context"
    "fmt"
    "os"
    client "github.com/numary/numary-go"
)

func main() {
    ledger := "ledger001" // string | Name of the ledger.
    transactions := *client.NewTransactions([]client.TransactionData{*client.NewTransactionData([]client.Posting{*client.NewPosting(int32(100), "COIN", "users:002", "users:001")})}) // Transactions | 

    configuration := client.NewConfiguration()
    api_client := client.NewAPIClient(configuration)
    resp, r, err := api_client.TransactionsApi.CreateTransactions(context.Background(), ledger).Transactions(transactions).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TransactionsApi.CreateTransactions``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateTransactions`: TransactionsResponse
    fmt.Fprintf(os.Stdout, "Response from `TransactionsApi.CreateTransactions`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ledger	string	Name of the ledger.

Other Parameters

Other parameters are passed through a pointer to a apiCreateTransactionsRequest struct via the builder pattern

Name	Type	Description	Notes

transactions | Transactions | |

Return type

TransactionsResponse

Authorization

basicAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

GetTransaction

TransactionResponse GetTransaction(ctx, ledger, txid).Execute()

Get transaction from a ledger by its ID.

Example

package main

import (
    "context"
    "fmt"
    "os"
    client "github.com/numary/numary-go"
)

func main() {
    ledger := "ledger001" // string | Name of the ledger.
    txid := int32(1234) // int32 | Transaction ID.

    configuration := client.NewConfiguration()
    api_client := client.NewAPIClient(configuration)
    resp, r, err := api_client.TransactionsApi.GetTransaction(context.Background(), ledger, txid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TransactionsApi.GetTransaction``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetTransaction`: TransactionResponse
    fmt.Fprintf(os.Stdout, "Response from `TransactionsApi.GetTransaction`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ledger	string	Name of the ledger.
txid	int32	Transaction ID.

Other Parameters

Other parameters are passed through a pointer to a apiGetTransactionRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

TransactionResponse

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListTransactions

ListTransactions200Response ListTransactions(ctx, ledger).PageSize(pageSize).After(after).Reference(reference).Account(account).Source(source).Destination(destination).StartTime(startTime).EndTime(endTime).PaginationToken(paginationToken).Metadata(metadata).Execute()

List transactions from a ledger.

Example

package main

import (
    "context"
    "fmt"
    "os"
    client "github.com/numary/numary-go"
)

func main() {
    ledger := "ledger001" // string | Name of the ledger.
    pageSize := int32(100) // int32 | The maximum number of results to return per page (optional) (default to 15)
    after := "1234" // string | Pagination cursor, will return transactions after given txid (in descending order). (optional)
    reference := "ref:001" // string | Find transactions by reference field. (optional)
    account := "users:001" // string | Find transactions with postings involving given account, either as source or destination. (optional)
    source := "users:001" // string | Find transactions with postings involving given account at source. (optional)
    destination := "users:001" // string | Find transactions with postings involving given account at destination. (optional)
    startTime := "startTime_example" // string | Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, 12:00:01 includes the first second of the minute).  (optional)
    endTime := "endTime_example" // string | Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, 12:00:01 excludes the first second of the minute).  (optional)
    paginationToken := "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 the pagination token is set.  (optional)
    metadata := map[string]interface{}{"key": map[string]interface{}(123)} // map[string]interface{} | Filter transactions by metadata key value pairs. Nested objects can be used as seen in the example below. (optional)

    configuration := client.NewConfiguration()
    api_client := client.NewAPIClient(configuration)
    resp, r, err := api_client.TransactionsApi.ListTransactions(context.Background(), ledger).PageSize(pageSize).After(after).Reference(reference).Account(account).Source(source).Destination(destination).StartTime(startTime).EndTime(endTime).PaginationToken(paginationToken).Metadata(metadata).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TransactionsApi.ListTransactions``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListTransactions`: ListTransactions200Response
    fmt.Fprintf(os.Stdout, "Response from `TransactionsApi.ListTransactions`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ledger	string	Name of the ledger.

Other Parameters

Other parameters are passed through a pointer to a apiListTransactionsRequest struct via the builder pattern

Name	Type	Description	Notes

pageSize | int32 | The maximum number of results to return per page | [default to 15] after | string | Pagination cursor, will return transactions after given txid (in descending order). | reference | string | Find transactions by reference field. | account | string | Find transactions with postings involving given account, either as source or destination. | source | string | Find transactions with postings involving given account at source. | destination | string | Find transactions with postings involving given account at destination. | startTime | string | Filter transactions that occurred after this timestamp. The format is RFC3339 and is inclusive (for example, 12:00:01 includes the first second of the minute). | endTime | string | Filter transactions that occurred before this timestamp. The format is RFC3339 and is exclusive (for example, 12:00:01 excludes the first second of the minute). | 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 the pagination token is set. | metadata | map[string]interface{} | Filter transactions by metadata key value pairs. Nested objects can be used as seen in the example below. |

Return type

ListTransactions200Response

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

RevertTransaction

TransactionResponse RevertTransaction(ctx, ledger, txid).Execute()

Revert a ledger transaction by its ID.

Example

package main

import (
    "context"
    "fmt"
    "os"
    client "github.com/numary/numary-go"
)

func main() {
    ledger := "ledger001" // string | Name of the ledger.
    txid := int32(1234) // int32 | Transaction ID.

    configuration := client.NewConfiguration()
    api_client := client.NewAPIClient(configuration)
    resp, r, err := api_client.TransactionsApi.RevertTransaction(context.Background(), ledger, txid).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `TransactionsApi.RevertTransaction``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `RevertTransaction`: TransactionResponse
    fmt.Fprintf(os.Stdout, "Response from `TransactionsApi.RevertTransaction`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
ledger	string	Name of the ledger.
txid	int32	Transaction ID.

Other Parameters

Other parameters are passed through a pointer to a apiRevertTransactionRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

TransactionResponse

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[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

\TransactionsApi

AddMetadataOnTransaction

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CountTransactions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateTransaction

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateTransactions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetTransaction

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListTransactions

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

RevertTransaction

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers