SOsoldo
Refueling Transactions

Search Refueling Transactions

Changed on

Endpoint to search Refueling resources using filtering parameters.

get/business/v2/refueling

Request

Query parameters

type'transaction' | 'vehicle' | 'card'

The resource type to be used together with the ID.

Example:card
idstring

The ID of the type resource.

Example:2d65bd5e-3fdf-4002-b166-bde7fb8863fa
publicIdstring

The ID of the type resource. Deprecated in favor of id.

Example:2d65bd5e-3fdf-4002-b166-bde7fb8863fa

The ID of the type resource.

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'

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

Example:TRANSACTION
txCountry'ASC' | 'AND' | 'ARE' | 'AFG' | 'ATG' | 'AIA' | 'ALB' | 'ARM' | 'ANT' | 'AGO' | 'ATA' | 'ARG' | 'ASM' | 'AUT' | 'AUS' | 'ABW' | 'ALA' | 'AZE' | 'BIH' | 'BRB' | 'BGD' | 'BEL' | 'BFA' | 'BGR' | 'BHR' | 'BDI' | 'BEN' | 'BLM' | 'BMU' | 'BRN' | 'BOL' | 'BES' | 'BRA' | 'BHS' | 'BTN' | 'BUR' | 'BVT' | 'BWA' | 'BLR' | 'BLZ' | 'CAN' | 'CCK' | 'COD' | 'CAF' | 'COG' | 'CHE' | 'CIV' | 'COK' | 'CHL' | 'CMR' | 'CHN' | 'COL' | 'CPT' | 'CRI' | 'CSXX' | 'CUB' | 'CPV' | 'CUW' | 'CXR' | 'CYP' | 'CZE' | 'DEU' | 'DGA' | 'DJI' | 'DNK' | 'DMA' | 'DOM' | 'DZA' | 'ECU' | 'EST' | 'EGY' | 'ESH' | 'ERI' | 'ESP' | 'ETH' | 'FIN' | 'FJI' | 'FLK' | 'FSM' | 'FRO' | 'FRA' | 'FXX' | 'GAB' | 'GBR' | 'GRD' | 'GEO' | 'GUF' | 'GGY' | 'GHA' | 'GIB' | 'GRL' | 'GMB' | 'GIN' | 'GLP' | 'GNQ' | 'GRC' | 'SGS' | 'GTM' | 'GUM' | 'GNB' | 'GUY' | 'HKG' | 'HMD' | 'HND' | 'HRV' | 'HTI' | 'HUN' | 'IDN' | 'IRL' | 'ISR' | 'IMN' | 'IND' | 'IOT' | 'IRQ' | 'IRN' | 'ISL' | 'ITA' | 'JEY' | 'JAM' | 'JOR' | 'JPN' | 'KEN' | 'KGZ' | 'KHM' | 'KIR' | 'COM' | 'KNA' | 'PRK' | 'KOR' | 'KWT' | 'CYM' | 'KAZ' | 'LAO' | 'LBN' | 'LCA' | 'LIE' | 'LKA' | 'LBR' | 'LSO' | 'LTU' | 'LUX' | 'LVA' | 'LBY' | 'MAR' | 'MCO' | 'MDA' | 'MNE' | 'MAF' | 'MDG' | 'MHL' | 'MKD' | 'MLI' | 'MMR' | 'MNG' | 'MAC' | 'MNP' | 'MTQ' | 'MRT' | 'MSR' | 'MLT' | 'MUS' | 'MDV' | 'MWI' | 'MEX' | 'MYS' | 'MOZ' | 'NAM' | 'NCL' | 'NER' | 'NFK' | 'NGA' | 'NIC' | 'NLD' | 'NOR' | 'NPL' | 'NRU' | 'NTZ' | 'NIU' | 'NZL' | 'OMN' | 'PAN' | 'PER' | 'PYF' | 'PNG' | 'PHL' | 'PAK' | 'POL' | 'SPM' | 'PCN' | 'PRI' | 'PSE' | 'PRT' | 'PLW' | 'PRY' | 'QAT' | 'REU' | 'ROU' | 'ROM' | 'SRB' | 'RUS' | 'RWA' | 'SAU' | 'SLB' | 'SYC' | 'SDN' | 'SWE' | 'SGP' | 'SHN' | 'SVN' | 'SJM' | 'SVK' | 'SLE' | 'SMR' | 'SEN' | 'SOM' | 'SUR' | 'SSD' | 'STP' | 'SUN' | 'SLV' | 'SXM' | 'SYR' | 'SWZ' | 'TAA' | 'TCA' | 'TCD' | 'ATF' | 'TGO' | 'THA' | 'TJK' | 'TKL' | 'TLS' | 'TKM' | 'TUN' | 'TON' | 'TUR' | 'TTO' | 'TUV' | 'TWN' | 'TZA' | 'UKR' | 'UGA' | 'UMI' | 'USA' | 'URY' | 'UZB' | 'VAT' | 'VCT' | 'VEN' | 'VGB' | 'VIR' | 'VNM' | 'VUT' | 'WLF' | 'WSM' | 'XKX' | 'XXK' | 'QZZ' | 'YEM' | 'MYT' | 'YUCS' | 'ZAF' | 'ZMB' | 'ZRCD' | 'ZWE'

The ISO 3166-1 alpha-3 code of the country where the Transaction was made.

txStatusTransactionStatus[]

A list of statuses the searched Transactions should be in.

txFuelType'PETROL' | 'DIESEL' | 'METHANE' | 'LPG' | 'LNG' | 'ELECTRIC' | 'UNKNOWN'

The fuel type specified on the Transaction.

showFuelDetailsboolean

It determines whether to show further Fuel Details of the Transaction.

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 is an array of Refueling resources.

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",
      "public_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "transaction_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "card_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "tx_amount": 10.25,
      "tx_date": "2017-06-01T12:48:40Z",
      "tx_settlement_date": "2017-06-01T12:48:40Z",
      "update_time": "2017-06-01T12:48:40Z",
      "tx_vat_amount": 10.25,
      "vehicle_id": "7bf79328-a7ae-4222-aa54-091ff7f429a7",
      "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,
      "supplier_vat_id": "VT09138461",
      "dri": "DRI00099881",
      "to_be_ignored": true
    }
  ]
}

Changes

  • 4c2f28426f74Revision changes
    • info

      added the new optional query request parameter id

    • info

      query request parameter publicId was deprecated

    • info

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

    • info

      response property results/items/public_id deprecated

  • 7be21448a2b3Revision changes
    • warning

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

    • info

      added the new enum value QZZ to the query request parameter txCountry

    • 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