BP Open API Transactions API

openapi: 3.2.0
info:
  title: OpenAPI Endpoints Open API Transactions API
  version: v1.0
security:
- Bearer: []
tags:
- name: OpenApiTransactions
paths:
  /transactions:
    get:
      tags:
      - OpenApiTransactions
      responses:
        '200':
          content:
            Application/Json:
              schema:
                $ref: '#/components/schemas/OpenApiTransactionsResponse'
          description: Success
        '400':
          content:
            Application/Json:
              schema:
                $ref: '#/components/schemas/ResultEntity'
          description: Bad Request
        '500':
          content:
            Application/Json:
              schema:
                $ref: '#/components/schemas/ErrorDetailsEntity'
          description: Server Error
      parameters:
      - in: query
        name: AuthorityIds
        schema:
          type: array
          items:
            type: string
        description: Only search transactions with matching authorityIds - Multiple authorities can be added via authorityIds=A123,authorityIds=A345,...
      - in: query
        name: StartDateTime
        schema:
          type: string
        description: Start date time for search
      - in: query
        name: EndDateTime
        schema:
          type: string
        description: End date time for search
      - in: query
        name: PageSize
        schema:
          type: integer
          format: int32
        description: Max results to return - If set must be between 1 and 1000
      - in: query
        name: Page
        schema:
          type: integer
          format: int32
        description: Page Number
      - in: query
        name: ParentIds
        schema:
          type: array
          items:
            type: string
        description: Only search transactions with matching parentIds
      - in: header
        name: x-correlation-id
        schema:
          type: string
          format: uuid
        description: Correlation Id
      summary: Get transactions
      x-summary-source: derived
      operationId: getTransactions
      x-operation-id-source: derived
components:
  schemas:
    ErrorDetailsEntity:
      type: object
      properties:
        errorCode:
          type: integer
          format: int32
        errorMessage:
          type:
          - string
          - 'null'
      additionalProperties: false
    OpenApiTransactionsResponse:
      type: object
      properties:
        transactions:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/OpenApiTransactionResponse'
          description: Transaction records
        numberOfRecords:
          type: integer
          format: int32
          description: Nummber of records returned
        moreTransactionsAvailable:
          type: boolean
          description: true if there are more transactions matching the request params
      additionalProperties: false
    OpenApiTransactionResponse:
      type: object
      properties:
        brand:
          type:
          - string
          - 'null'
          description: Site brand. Brand for the site e.g. AR, BP
        siteId:
          type:
          - string
          - 'null'
          description: Site id.  Internal Id for fuel site.  Use this Id when retrieving site details
        isPriced:
          type:
          - string
          - 'null'
          description: Is priced.
        odometer:
          type:
          - integer
          - 'null'
          format: int32
          description: Odometer reading
        parentId:
          type:
          - string
          - 'null'
          description: Parent account number
        quantity:
          type:
          - number
          - 'null'
          format: double
          description: Quantity of commodity.  e.g. 1, 50.12
        siteName:
          type:
          - string
          - 'null'
          description: Site name.  Name of the site
        siteType:
          type:
          - integer
          - 'null'
          format: int32
          description: Site type.  Internal site type
        alertLevel:
          type:
          - string
          - 'null'
          description: Alert level
        driverName:
          type:
          - string
          - 'null'
          description: Driver name.  Name of the driver
        authorityId:
          type:
          - string
          - 'null'
          description: Customer account number
        co2Emission:
          type:
          - string
          - 'null'
          description: Co2 emissions
        invoiceDate:
          type:
          - string
          - 'null'
          description: Invoice date
        pricingType:
          type:
          - string
          - 'null'
          description: Pricing type.  Options are {LST, CTB, TVP, CTA}.
        productCode:
          type:
          - integer
          - 'null'
          format: int32
          description: Product code. Internal id. e.g. 39 (Diesel in Poland)
        productType:
          type:
          - string
          - 'null'
          description: Product type
        rcIndicator:
          type:
          - string
          - 'null'
          description: RC indicator.  yes if VatCode is RC.
        customerName:
          type:
          - string
          - 'null'
          description: Customer name.  Name of customer associated to the transaction
        issuerNumber:
          type:
          - integer
          - 'null'
          format: int32
          description: "Card issuer number. Based on issuing country. Germany Aral Komfort : 700669 Germany exc. ACK : 700674 \nUK Distributors : 700676 UK(exc. Dist) : 700676 Belgium : 700677 Austria : 700673 Netherlands : 700678 \nLuxembourg : 700685 Poland exc. Komfort : 700679 Poland Prepay(Komfort) : 700699 Portugal (exc. bonus) : 700684 \nPortugal Bonus Cards : 705684 Spain (exc. bonus) : 700680 Spain Bonus Cards : 705680"
        quantityUnit:
          type:
          - string
          - 'null'
          description: Quantity units.  e.g. L,KG,KW,UNIT
        invoiceNumber:
          type:
          - integer
          - 'null'
          format: int64
          description: Invoice number.
        oacResultCode:
          type:
          - string
          - 'null'
          description: OAC result code
        supplyCountry:
          type:
          - string
          - 'null'
          description: Supply country.  Iso code
        transactionId:
          type:
          - string
          - 'null'
          description: Transaction unique id
        vatPercentage:
          type:
          - string
          - 'null'
          description: VAT percentage.
        vehicleNumber:
          type:
          - integer
          - 'null'
          format: int32
          description: Vehicle number. Number of the vehicle
        cardHolderName:
          type:
          - string
          - 'null'
          description: Card holder name
        costCentreName:
          type:
          - string
          - 'null'
          description: Cost centre number
        creditDebitInd:
          type:
          - string
          - 'null'
        fullCardNumber:
          type:
          - string
          - 'null'
          description: Full card number - 700674999999123456
        invoiceCountry:
          type:
          - string
          - 'null'
          description: Invoice country.  Iso code of invoice country
        invoiceDueDate:
          type:
          - string
          - 'null'
          description: Invoice due date
        issuerCurrency:
          type:
          - string
          - 'null'
          description: Issuer currency.
        supplyCurrency:
          type:
          - string
          - 'null'
          description: Supply currency
        invoiceCurrency:
          type:
          - string
          - 'null'
          description: Invoice currency.
        secondSortLabel:
          type:
          - string
          - 'null'
          description: Second sort label
        transactionType:
          type:
          - string
          - 'null'
          description: Transaction Type
        alertDescription:
          type:
          - string
          - 'null'
          description: Alert description
        cardSerialNumber:
          type:
          - string
          - 'null'
          description: Six digits card serial number - 123456
        embossingLineOne:
          type:
          - string
          - 'null'
          description: 1st line embossed on the card
        embossingLineTwo:
          type:
          - string
          - 'null'
          description: 2nd line embossed on the card
        authorisationType:
          type:
          - string
          - 'null'
          description: Authorisation type
        recordCreatedDate:
          type:
          - string
          - 'null'
          description: Record created date.  The datetime that the transaction was created
        subCostCentreName:
          type:
          - string
          - 'null'
          description: Sub cost centre name
        transactionStatus:
          type:
          - string
          - 'null'
          description: Transaction status {Authorised, Declined, Invoiced, Uninvoiced}
        vehicleDriverCode:
          type:
          - string
          - 'null'
          description: Vehicle driver code.  Internal driver code
        appliedPricingType:
          type:
          - string
          - 'null'
          description: Applied pricing type.  Options are {LST, TVP}.
        changeableOdometer:
          type:
          - integer
          - 'null'
          format: int32
          description: Odometer reading override
        productDescription:
          type:
          - string
          - 'null'
          description: Product description
        recordModifiedDate:
          type:
          - string
          - 'null'
          description: Record modified date.  The datetime that the transaction was last updated
        siteTypeDescription:
          type:
          - string
          - 'null'
          description: Site type decription.  Description of the site type
        transactionDateTime:
          type:
          - string
          - 'null'
          description: Date of transaction. Date at which the transaction was initially authorise.
        transactionUniqueId:
          type:
          - string
          - 'null'
          description: Transacted product unique id
        summaryStatementDate:
          type:
          - string
          - 'null'
          description: Summary statement date.
        additionalInformation:
          type:
          - string
          - 'null'
          description: Additional information captured at pickup
        summaryStatementNumber:
          type:
          - integer
          - 'null'
          format: int64
          description: Invoice summary statement number
        netValueInSupplyCurrency:
          type:
          - string
          - 'null'
          description: Net value in supply currency
        transactionVoucherNumber:
          type:
          - string
          - 'null'
          description: Transaction voucher number
        vatValueinSupplyCurrency:
          type:
          - string
          - 'null'
          description: VAT value in supply currency
        vehicleRegistrationNumber:
          type:
          - string
          - 'null'
          description: Vehicle registration number
        grossValueInSupplyCurrency:
          type:
          - string
          - 'null'
          description: Gross value in supply currency
        netInvoiceValueInIssuerCurrency:
          type:
          - string
          - 'null'
          description: Net invoice value in issuer currency.
        vatInvoiceValueInIssuerCurrency:
          type:
          - string
          - 'null'
          description: VAT invoice value in issuer currency.
        netInvoiceValueInInvoiceCurrency:
          type:
          - string
          - 'null'
          description: Net invoice value in invoice currency.
        netUnitListPriceInSupplyCurrency:
          type:
          - string
          - 'null'
          description: Net unit list price in supply currency
        netUnitPumpPriceInSupplyCurrency:
          type:
          - string
          - 'null'
          description: Net unit pump price in supply currency
        vatInvoiceValueInInvoiceCurrency:
          type:
          - string
          - 'null'
          description: VAT invoice value in invoice currency.
        grossInvoiceValueInIssuerCurrency:
          type:
          - string
          - 'null'
          description: Gross invoice value in issuer currency.
        grossInvoiceValueInInvoiceCurrency:
          type:
          - string
          - 'null'
          description: Gross invoice value in invoice currency.
        originalGrossValueInIssuerCurrency:
          type:
          - string
          - 'null'
          description: Original gross value in issuer currency.
        originalGrossValueInSupplyCurrency:
          type:
          - string
          - 'null'
          description: Original gross value in supply currency
        grossUnrebatedValueInSupplyCurrency:
          type:
          - string
          - 'null'
          description: Gross unrebated value in supply currency
        originalGrossValueInInvoiceCurrency:
          type:
          - string
          - 'null'
          description: Original gross value in invoice currency.
        grossUnrebatedInvoiceValueInIssuerCurrency:
          type:
          - string
          - 'null'
          description: Gross unrebated invoice value in issuer currency.
        netInvoiceRebatedUnitPriceInIssuerCurrency:
          type:
          - string
          - 'null'
          description: Net invoice rebated unit price in issuer currency.
        grossUnrebatedInvoiceValueInInvoiceCurrency:
          type:
          - string
          - 'null'
          description: Net invoice unrebated invoice value in invoice currency.
        netInvoiceRebatedUnitPriceInInvoiceCurrency:
          type:
          - string
          - 'null'
          description: Net invoice rebated unit price in invoice currency.
      additionalProperties: false
    ResultEntity:
      type: object
      properties:
        message:
          type:
          - string
          - 'null'
        success:
          type: boolean
        errorDetails:
          $ref: '#/components/schemas/ErrorDetailsEntity'
        correlationId:
          type: string
          format: uuid
      additionalProperties: false
  securitySchemes:
    Bearer:
      in: header
      name: Authorization
      type: apiKey
      description: 'JWT Authorization header using the Bearer scheme (Example: ''Bearer 12345abcdef'')'