SOsoldo
Transactions

Search Transactions

Changed on

Endpoint to find Transactions using filtering parameters.

get/business/v2/transactions

Request

Query parameters

type'company' | 'employee' | 'wallet' | 'card' | 'subscription' | 'onlineAd' | 'purchase'

The resource type to be used together with the ID.

Example:card
hasAttachmentboolean

Whether or not a TransactionAttachment has to be present.

Example:true
publicIdstring

The ID of the type resource.

Example:7bf79328-a7ae-4222-aa54-091ff7f429a7
customreferenceIdstring

The custom reference ID of the cardholder.

Example:2d65bd5e-3fdf-4002-b166-bde7fb8863fa
fromDatestring date-time

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).

toDatestring date-time

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'TRANSACTION' | 'SETTLEMENT' | 'UPDATE' | 'REVIEW_TIME' | 'CUSTOM_EXPORT_TIME'

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

Example:TRANSACTION
groupIdstring

The ID of the Group to search Transactions by.

Example:c861cc24-6663-410f-8c78-73f886fff4ef
categorySearchTransactionCategory[]

The category to search Transactions by. Multiple categories can be included.

statusTransactionStatus[]

The status to search Transactions by. Multiple statuses can be included.

paymentMethodSearchTransactionPaymentMethod[]

The payment method to search Transactions by. Multiple payment methods can be included. OUT_OF_PLATFORM_COMPANY and OUT_OF_PLATFORM_PERSONAL are not included by default.

tagIdstring

The ID of the Tag to search Transactions by.

Example:6853e657-c797-4985-8d6b-5425d4e51df8
metadataIdstring

The ID of the custom generated Metadata of the Transaction.

Example:express
textstring

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).

Example:Amazon
expenseTypeExpenseType[]

The type of the expense to search Transactions by.

expenseStatusExpenseStatus[]

The status of the expense to search Transactions by.

expenseCategoryIdstring[]

The ID of the ExpenseCategory of the Transactions. Multiple ExpenseCategories can be included.

[
  "2d65bd5e-3fdf-4002-b166-bde7fb8863fa"
]
expenseReportIdstring[]

The ID of the ExpenseReport of the Transactions. Multiple ExpenseReports can be included.

[
  "c861cc24-6663-410f-8c78-73f886fff4ef"
]
exportStatus'EXPORTED' | 'NOT_EXPORTED'

The export status of the expense to search Transactions by.

Example:EXPORTED
taxRateIdstring[]

The ID of the VATRate to search Transactions by. Multiple VATRates can be included.

[
  "7bf79328-a7ae-4222-aa54-091ff7f429a7"
]
businessTripIdstring[]

The ID of the BusinessTrip to search Transactions by. Multiple BusinessTrips can be included.

[
  "7bf79328-a7ae-4222-aa54-091ff7f429a7"
]
requiredInformation'COMPLETE' | 'NOT_COMPLETE'

Whether 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.

Example:COMPLETE
isSplitboolean

Whether or not a Transaction has to be split.

Example:true
customExportedProductstring

A product that exported list of Transaction.

Example:SAP
customExportedboolean

Whether or not a TransactionCustomExport has to be present.

Example:true
pinteger

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

Example:3
sinteger

It indicates the number of items per page.

Example:25
d'ASC' | 'DESC'

It indicates how the pages are ordered.

Example:DESC
propsstring[]

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.

[
  "creationTime"
]

Headers

X-Soldo-Fingerprintstring required

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

Example:{{fingerprint}}
X-Soldo-Fingerprint-Signaturestring required

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

Example:{{fingerprint_signature}}

Response

The result array contains Transactions.

totalinteger

It represents the total number of available items in the list.

pagesinteger

It represents the total number of available pages.

page_sizeinteger

It represents the number of items per page.

current_pageinteger

It indicates the current page (the counter starts from zero).

results_sizeinteger

It indicates the size of the array results.

Example response

{
  "total": 168,
  "pages": 7,
  "page_size": 25,
  "results_size": 25,
  "results": [
    {
      "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "wallet_id": "6853e657-c797-4985-8d6b-5425d4e51df8",
      "wallet_name": "John Doe",
      "purchase_id": "6853e657-c797-4985-8d6b-5425d4e51df8",
      "amount": 10.25,
      "tx_amount": 10.25,
      "fee_amount": 10.25,
      "exchange_rate": 1,
      "auth_exchange_rate": 1,
      "expense_date": "2017-06-01T12:48:40Z",
      "expense_reviewer": "XMPL1234-000001",
      "expense_approved_amount": 10.25,
      "expense_report_id": "c861cc24-6663-410f-8c78-73f886fff4ef",
      "date": "2017-06-01T12:48:40Z",
      "settlement_date": "2017-06-01T12:48:40Z",
      "update_time": "2017-06-01T12:48:40Z",
      "merchant": {
        "name": "SHH HOTEL LONDON",
        "raw_name": "SHERLOCK HOLMES HOTEL  LONDON        GBR"
      },
      "merchant_category": {
        "description": "Travel",
        "mcc_description": "Lodging - Hotels, Motels, Resorts - not elsewhere classified",
        "code": "Lodging - Hotels, Motels, Resorts - not elsewhere classified",
        "sub_category": "Hotels"
      },
      "tags": [
        {
          "id": "2d65bd5e-3fdf-4002-b166-bde7fb8863fa",
          "dictionary_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
          "dictionary": "ExampleTagDictionary",
          "tag": "tx-label",
          "code": "CODE tag",
          "visible": true,
          "description": "Label to mark transactions"
        }
      ],
      "card_id": "6853e657-c797-4985-8d6b-5425d4e51df8",
      "masked_pan": "123456******1234",
      "owner_name": "John",
      "owner_surname": "Smith",
      "owner_id": "XMPL1234-000003",
      "custom_reference_id": "123456-user-1",
      "group_id": "2d65bd5e-3fdf-4002-b166-bde7fb8863fa",
      "trx_owner_id": "XMPL1234-000003",
      "metadata_ids": [
        "express"
      ],
      "fuel_details": {
        "vehicle_id": "6853e657-c797-4985-8d6b-5425d4e51df8",
        "plate": "AA000BB",
        "vat_deductibility_percentage": "40%",
        "mileage": 125000,
        "quantity": 80,
        "unit_price": 1.41,
        "invoice_id": 4421109,
        "invoice_number": "NVC112200987",
        "invoice_date": "2017-06-01T12:48:40Z",
        "invoice_total_amount": 10.25,
        "invoice_row": 4,
        "invoice_row_amount": 10.25,
        "dri": "DRI00099881"
      },
      "vat_percentage": 15,
      "vat_amount": 10.25,
      "flags": [
        "forUser"
      ],
      "payment_method_id": "6853e657-c797-4985-8d6b-5425d4e51df8",
      "expense_category": {
        "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
        "name": "category-one",
        "description": "An expense category",
        "tax_rate_id": "c861cc24-6663-410f-8c78-73f886fff4ef",
        "expense_type": "TRAVEL_AND_ENTERTAINMENT",
        "integration": "Netsuite",
        "creation_time": "2017-06-01T12:48:40Z",
        "last_update_time": "2017-06-01T12:48:40Z"
      },
      "tax_rate": {
        "id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
        "code": "code-vat-11",
        "name": "Tax 11",
        "description": "Number 11 of Tax code",
        "percentage": 15,
        "enabled": true,
        "integration": "something",
        "creation_time": "2017-06-01T12:48:40Z",
        "last_update_time": "2017-06-01T12:48:40Z"
      },
      "tx_id": "5-857211147-150603333585014265",
      "payment_trn_code": "1234567890123456789012345678IT",
      "invoice": {
        "number": "INV-2023-001",
        "date": "2023-01-23",
        "po_number": "PO-2023-001"
      },
      "source": {
        "name": "J. Doe",
        "destination_wallet_id": "de29bffb-7da2-40f1-934a-241170762d3e",
        "destination_wallet_name": "EURO VIBAN"
      },
      "custom_export": [
        {
          "product": "SAP",
          "export_date": "2017-06-01T12:48:40Z"
        }
      ],
      "out_spending_policy": {
        "approved_amount": {
          "amount": 10.25
        },
        "rejected_amount": {
          "amount": 10.25
        }
      },
      "split_transactions": [
        {
          "line_number": 1,
          "amount": {
            "amount": 10.25
          },
          "vat_amount": {
            "amount": 10.25
          },
          "employee": {
            "id": "6853e657-c797-4985-8d6b-5425d4e51df8"
          },
          "expense_category": {
            "id": "6853e657-c797-4985-8d6b-5425d4e51df8"
          },
          "tax_rate": {
            "id": "6853e657-c797-4985-8d6b-5425d4e51df8"
          },
          "tags": [
            {
              "id": "2d65bd5e-3fdf-4002-b166-bde7fb8863fa",
              "dictionary_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
              "dictionary": "ExampleTagDictionary",
              "tag": "tx-label",
              "code": "CODE tag",
              "visible": true,
              "description": "Label to mark transactions"
            }
          ],
          "approved_amount": {
            "amount": 10.25
          },
          "rejected_amount": {
            "amount": 10.25
          }
        }
      ]
    }
  ]
}

Changes

  • 23fc5d07b367Revision changes
    • info

      added the new optional query request parameter businessTripId

  • 7be21448a2b3Revision changes
    • warning

      added the new IATS enum value to the // response property for the response status

    • warning

      added the new InterAccountTransferDeposit enum value to the // response property for the response status

    • warning

      added the new InterAccountTransferDepositRecurringBilling enum value to the // response property for the response status

    • warning

      added the new InterAccountTransferWithdrawal enum value to the // response property for the response status

    • warning

      added the new InterAccountTransferWithdrawalRecurringBilling enum value to the // response property for the response status

    • warning

      added the new QZZ enum value to the /// response property for the response status

    • info

      added the enum value IATS to the property items/ of the query request parameter paymentMethod

    • info

      added the enum value InterAccountTransferDeposit to the property items/ of the query request parameter category

    • info

      added the enum value InterAccountTransferDepositRecurringBilling to the property items/ of the query request parameter category

    • info

      added the enum value InterAccountTransferWithdrawal to the property items/ of the query request parameter category

    • info

      added the enum value InterAccountTransferWithdrawalRecurringBilling to the property items/ of the query request parameter category

    • info

      for the query request parameter fromDate, the type was generalized from no type to string, and format from no format to date-time

    • info

      for the query request parameter toDate, the type was generalized from no type to string, and format from no format to date-time

    • info

      added the optional property // to the response with the status