Search Transactions

get

https://api.soldo.com/business/v2/transactions

Endpoint to find Transactions using filtering parameters.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Required scopes:

transaction_read

Fingerprint order:

type,publicId,customReferenceId,groupId,fromDate,toDate,dateType,category,status,tagId,metadataId,text,expenseType,expenseStatus,requiredInformation,token

Query Params

type

string

enum

The resource type to be used together with id.

Allowed:

hasAttachment

boolean

Looks whether or not a TransactionAttachment is present.

publicId

string

The ID of the type resource.

customreferenceId

string

The custom reference ID of the cardholder.

fromDate

object

The beginning of the period of the search fromDate included (i.e. greater than or equal to) (Formats: yyyy-MM-dd, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ssZ).

toDate

object

The end of the period of the search toDate included (i.e. less than) (Formats: yyyy-MM-dd, yyyy-MM-ddThh:mm:ss, yyyy-MM-ddThh:mm:ssZ).

dateType

string

enum

Defaults to TRANSACTION

It determines the date to be considered for fromDate and toDate parameters.

Allowed:

groupId

string

The ID of the Group of the transactions.

category

status

array of objects

It determines the filter by status of the transaction, multiple statuses can be included.

status

paymentMethod

array of objects

It determines the filter by payment method of the transaction, multiple payment methods can be included. OUT_OF_PLATFORM_COMPANY and OUT_OF_PLATFORM_PERSONAL are not included by default.

tagId

string

The ID of the Tag of the transaction.

metadataId

string

deprecated

The ID of the custom generated Metadata of the Transaction.

text

string

A simple text to search in the transaction data (merchant, merchant category, user notes, tag, list, masked pan, card name, tx amount, vehicle plate, vehicle description).

expenseType

array of objects

The type of the expense.

expenseType

Allowed:

expenseStatus

array of objects

The status of the expense.

expenseStatus

Allowed:

expenseCategoryId

array of strings

The ID of the Expense category of the transactions, multiple expense categories can be included.

expenseCategoryId

expenseReportId

array of strings

The ID of the ExpenseReport of the transactions, multiple expense reports can be included.

expenseReportId

exportStatus

string

enum

The export status of the expense.

Allowed:

taxRateId

array of strings

The ID of the VAT rate of the transactions, multiple VAT rates can be included.

taxRateId

requiredInformation

string

enum

To search transactions with (or without) required information. A transaction is COMPLETE when all details marked as mandatory in the Reminders section have been filled in for the transaction.

Allowed:

isSplit

boolean

Looks whether or not a transaction is split.

customExportedProduct

string

A product that exported list of Transaction

customExported

boolean

Looks whether or not a TransactionCustomExport is present.

int32

Defaults to 0

It indicates the specific page to display (the counter starts from zero).

int32

≤ 50

Defaults to 0

It indicates the number of items per page.

string

enum

It indicates how the pages are ordered.

Allowed:

props

array of strings

It indicates the sorting direction applied to the above parameters. To apply a sorting on multiple parameters, set as many times the props parameter in the request.

props

Headers

X-Soldo-Fingerprint

string

required

Defaults to {{fingerprint}}

Advanced authentication: SHA512SUM of the fingerprint values listed in the fingerprint order for this endpoint.

X-Soldo-Fingerprint-Signature

string

required

Defaults to {{fingerprint_signature}}

Advanced authentication: Signature of the X-Soldo-Fingerprint.

Responses

400

Your request has missing arguments or is malformed.

Required scopes:

Fingerprint order:

200The result array contains Transactions.