GET
/
v1
curl --request GET \
  --url https://integration-api-cat2./%7B{environment}%7D.ext.%7B{realm}%7D.cia.enfuce.com/purchase-detail/v1/
[
  {
    "amount": {
      "amount": 3.14,
      "currency": "EUR"
    },
    "code": "<string>",
    "description": "<string>",
    "externalId": "<string>",
    "matchingAttributes": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "promptedData": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "quantity": 123,
    "transactionId": "<string>",
    "type": "FUEL",
    "unitPrice": 123,
    "VAT": {
      "percentage": 123,
      "amount": {
        "amount": 3.14,
        "currency": "EUR"
      }
    },
    "unit": "KG",
    "id": "<string>"
  }
]

Query Parameters

​
page
integer
default:0

Current page

​
size
integer
default:30

How many purchase details should be returned per page, default is 30. Cannot be more than 100.

Required range: 1 < x < 100
​
filter
string

The filter currently accepts two search fields; externalId and transactionId which you can match with the operator eq. Two logical operators; AND and OR are supported, which means that you can combine a filter Ex. ?filter=externalId eq 1234, ?filter=externalId eq 1234 AND transactionId eq 2222

​
auditUser
string
required

The audit user to log the request

Response

200
application/json
Successfully retrieved
​
amount
object

Purchase amount of given purchase detail.

​
code
string

Issuer defined code for purchase detail. Code can e.g. represent a product category like “newspapers”. Code is utilised if item is processed through repricing.

Maximum length: 64
​
description
string

Issuer defined description of purchase detail. The description is set when creating purchase details and is available when fetching purchase details via API and in the invoicing file.

Maximum length: 255
​
externalId
string

Issuer defined external id. Issuer can store an external id to each purchase detail as a common key between Enfuce and issuer systems.

Maximum length: 64
​
matchingAttributes
object[]

Attributes that enable Enfuce to link purchase detail to a financial transaction. The most suitable matching attributes are agreed with issuer during implementation.

​
promptedData
object[]

Prompted data linked to the purchase detail

​
quantity
number

The quantity purchased. This can be a number or in combination with unit define e.g. how many liters or kilograms have been purchased.

​
transactionId
string

Id of the financial transaction the purchase detail is linked to. The transactionId is updated by Enfuce after a match is found between financial transaction and purchase detail.

Maximum length: 64
​
type
enum<string>

The type of item

Available options:
FUEL,
OTHER
​
unitPrice
number

Price per unit

​
VAT
object

The applicable value-add tax of the purchase detail.

​
unit
enum<string>

Unit of measurement of quantity. Obsolete in cases where the purchase detail represents one item or a number of the same items.

Available options:
KG,
KWH,
LITRE,
GALLON
​
id
string

Unique id that represents this purchase detail