Sign in

v1

latestOpenAPI 3.0.32026-07-26208618579.9 KB
Create purchase details

Create a list of purchase details

This operation will save the list of purchase details

post/v1/

Query parameters

auditUserstring required

The audit user to log the request

Request body

codestring

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.

descriptionstring

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.

externalIdstring

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

quantitynumber

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

transactionIdstring

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.

type'FUEL' | 'OTHER'

The type of item

unitPricenumber

Price per unit

unit'KG' | 'KWH' | 'LITRE' | 'GALLON'

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

Example request

[
  {
    "amount": {
      "amount": 3.14,
      "currency": "EUR"
    },
    "VAT": {
      "amount": {
        "amount": 3.14,
        "currency": "EUR"
      }
    }
  }
]

Response

Successfully saved

descriptionstring

Short description of the result of the action