openapi: 3.0.0
x-stoplight:
  id: a4iat346skpcb
info:
  description: |-
    The Shell Card Transaction Data API is REST-based and employs Basic authentication in Version 1 and Oauth authentication in Version 2 end points. The API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes. 

    All resources are located in the Shell Card Platform.  The Shell Card Platform is the overall platform that encompasses all the internal Shell systems used to manage resources. The internal workings of the platform are not important when interacting with the API. However, it is worth noting that the platform uses a microservice architecture to communicate with various backend systems and some API calls are processed asynchronously.

    All endpoints use the `POST` verb for retrieving, updating, creating and deleting resources in the Shell Card Platform. The endpoints that retrieve resources from the Shell Card Platform allow flexible search parameters in the API request body.
  version: 2.3.4
  x-date: '2026-02-16'
  title: B2B Mobility Card Transaction Data
  termsOfService: 'https://developer.shell.com/terms-of-use'
  contact:
    name: Shell Technical Support (API)
    url: 'https://developer.shell.com/support'
    email: api@shell.com
  x-postman-collection-id: 48252800-c579669d-b7c9-4cbf-957e-998cb0ccdfe9
externalDocs:
  description: Go to the Shell Developer Portal
  url: 'https://developer.shell.com'
security:
  - BasicAuth: []
  - Test: []
  - Prod: []

servers:
  - url: 'https://api.shell.com'
    description: Production
  - url: 'https://api-test.shell.com/test'
    description: Test
paths:
  /fleetmanagement/v1/transaction/pricedtransactions:
    post:
      tags:
        - Transaction
      summary: Get priced transaction details (sales item and fees)
      operationId: pricedtransactions
      description: "This API allows querying transaction data (i.e. Priced, Billed and Unbilled sales items). It provides a flexible search criteria and supports paging. \n\nTransactions that are posted but not yet priced, billed or that are in error will not be returned by this API. The API also supports returning Fee Items.\n\n#### Supported operations\n  * Get sales items and fee transactions\n    * Search by invoice status\n    * Search by fixed date period\n    * Search by date range\n    * Search by account\n    * Search by card\n  * Get sales items only\n    * Search by transaction Id or location\n    * Search by transaction posting date\n    * Search by invoice number or date\n    * Search by driver name or vehicle registration number\n    * Search by card group\n    * Search by fuel only transactions\n    * Search by product\n  \n This API fetches transactions for a period based on the below parameters and priority order:\n1.\tInvoiceNumber\n 2.\tInvoiceDate\n 3.\tFromDate, ToDate\n4.\tPostingFromDate, PostingToDate (Can be used only when IncludeFees = false)\n 5.\tInvoiceDateFrom, InvoiceDateTo\n 6.\tPeriod\n\n This API considers only one of the above set of parameters at a time. For example, if InvoiceNumber and Period are provided in the input then Period is ignored and transactions associated to the given invoice number are returned.\n\nIf none of the above parameters are provided then last 7 days transactions will be fetched.\n\nThis operation can fetch transactions that are old up to 24 (configurable) months. However, the date range between any of the ‘From’ and ‘To’ dates in the above combination cannot be more than 210 (configurable) days.\n"
      responses:
        '200':
          description: The http status code 200 and the Error.Code "0000" in the response body would indicate the API call is successful. The http status code 200 with Error Code other than "0000" in the response body would indicate there is a failure in the API call.
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/PricedTransactionResponse'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '500':
          $ref: '#/components/responses/500InternalServerError'
      parameters:
        - $ref: '#/components/parameters/AuthorizationParameter'
        - $ref: '#/components/parameters/ApikeyParameter'
        - $ref: '#/components/parameters/ContentTypeParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PricedTransactionRequest'
      x-stoplight:
        id: zedo3hc4malb1
    parameters: []
  /transaction-data/v1/priced:
    post:
      summary: Get priced transaction details including EV transactions
      operationId: pricedtransactionsV2
      description: |-
        This API allows querying transaction data (i.e. Priced, Billed and Unbilled sales items). It provides a flexible search criteria and supports paging. 
        The version 2 is an enhancement to the version 1 where EV transactions and their details are added in the response. 

        Transactions that are posted but not yet priced, billed or that are in error will not be returned by this API. The API also supports returning Fee Items.

        #### Supported operations
          * Get sales items and fee transactions
            * Search by invoice status
            * Search by fixed date period
            * Search by date range
            * Search by account
            * Search by card
          * Get sales items only
            * Search by transaction Id or location
            * Search by transaction posting date
            * Search by invoice number or date
            * Search by driver name or vehicle registration number
            * Search by card group
            * Search by fuel only transactions
            * Search by product
         * EV transaction details - Below are EV specific parameters
            * EVOperator
            * EVSerialId
            * EVChargePointSerial
            * EVChargePointConnectorType
            * EVChargePointConnectorTypeDescription
            * EVChargeDuration
            * EVChargeStartDate
            * EVChargeStartTime
            * EVChargeEndDate
            * EVChargeEndTime
          
      responses:
        '200':
          description: The http status code 200 and the Error.Code "0000" in the response body would indicate the API call is successful. The http status code 200 with Error Code other than "0000" in the response body would indicate there is a failure in the API call.
          content:
            application/json:
              schema:
                type: object
                properties:
                  RequestId:
                    type: string
                    description: Mandatory UUID (according to RFC 4122 standards) for requests and responses. This will be played back in the response from the req
                  Status:
                    type: string
                    description: Indicates overall status of the request
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PricedResponseDataV2'
                  Page:
                    type: integer
                    description: Current page
                  PageSize:
                    type: integer
                    description: Number of records returned in the response
                  TotalPages:
                    type: integer
                    description: Total number of pages available for the requested data
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Data:
                      - AccountName: Blue Colour Ltd
                        AccountId: 29484
                        AccountNumber: DE26667080
                        AccountShortName: Mathew
                        Additional1: GBALLEGO0002452
                        Additional2: GBALLEGO0002452
                        Additional3: GBALLEGO0002452
                        Additional4: GBALLEGO0002452
                        AllowClearing: 'Null'
                        AuthorisationCode: 300796
                        TransactionStatus: 'Y'
                        DriverName: SATTY BHAMRA
                        CardExpiryPeriod: 2204
                        CardExpiry: '20220101'
                        CardGroupId: 40000
                        CardGroupName: 006240 FIRE BRIGHT SOLUTIONS
                        IssuerCode: 7002
                        CardPAN: '7002053465789891000'
                        ReleaseCode: 9
                        CardSequenceNumber: 617
                        CardType: GB STD FLT NAT SINGLE R9
                        ColCoCode: '014'
                        UnitDiscountInvoiceCurrency: -0.0051
                        ColCoExchangeRate: 0.851858
                        InvoiceCurrencySymbol: GBP
                        CorrectionFlag: true
                        CRMNumber: 10
                        CustomerCountry: United Kingdom
                        CustomerCurrencyCode: GBP
                        CustomerCurrencySymbol: £
                        RebateonNetAmountInCustomerCurrency: 0
                        EffectiveDiscountInCustomerCurrency: -0.22
                        EffectiveUnitDiscountInCustomerCurrency: -0.0051
                        UnitPriceInInvoiceCurrency: 1.1024
                        InvoiceTax: 0
                        InvoiceGrossAmount: 57.25
                        InvoiceNetAmount: 47.71
                        VATonNetAmountInCustomerCurrency: 9.54
                        CustomerRetailPriceUnitGross: 0
                        CustomerRetailValueTotalGross: 57.52
                        CustomerRetailValueTotalNet: 47.93
                        TransactionTypeDescription: 9.59
                        RebateonNetAmountInTransactionCurrency: -0.22
                        EffectiveDiscountInTrxCurrency: -0.22
                        DelCoToColCoExchangeRate: 0
                        Cards:
                          - 275549
                        UnitDiscountTransactionCurrency: -0.005
                        TransactionGrossAmount: 57.25
                        TransactionNetAmount: 47.71
                        TransactionTax: 9.54
                        VATonNetAmount: 9.54
                        DelcoListPriceUnitNet: 0
                        DelcoRetailPriceUnitGross: 1.32888
                        UnitPriceInTransactionCurrency: 1.1074
                        DelcoRetailPriceUnitNet: 1.1074
                        DelcoRetailValueTotalGross: 57.52
                        DelcoRetailValueTotalNet: 47.93
                        TransactionCurrencySymbol: $
                        DiscountType: 1
                        DisputeStatus: false
                        IsShellSite: false
                        FleetIdInput: YG67OUM
                        IncomingProductCode: 23
                        PostingDate: '20210802'
                        PostingTime: '14:15:22'
                        ProductCode: 30
                        ProductName: Unleaded - Medium octane
                        ProductGroupId: 22
                        IncomingCurrencyCode: GBP
                        IncomingSiteDescription: Shell Broadway Ring
                        Location: Shell Broadway Ring
                        SiteName: Shell Broadway Ring
                        SiteCode: 32
                        IncomingSiteNumber: 15
                        InvoiceCurrencyCode: GBP
                        InvoiceDate: '20210802'
                        InvoiceNumber: 3201016193
                        FuelProduct: true
                        VATApplicable: 'Y'
                        PayerName: Colours Services Ltd
                        PayerNumber: GB12121212
                        ParentCustomerNumber: GB12121212
                        PayerGroup: H312066
                        PayerGroupName: 12162566 - FUEL CARD SERVICE
                        CheckDigit: 6
                        NetInvoiceIndicator: 'Y'
                        DelcoCode: 5
                        NetworkCode: 3
                        PurchasedInCountry: United Kingdom
                        SiteCountry: United Kingdom
                        VATCountry: United Kingdom
                        DelcoName: Shell U.K. Oil Products Limited
                        Network: Shell
                        OdometerInput: 0
                        OriginalSalesItemId: 'Null'
                        FleetIDDescription: YG67OUM
                        ParentCustomerId: 6494
                        PINIndicator: 'Y, N'
                        ProductGroupName: Fees
                        PurchasedInCountryCode: GB
                        Quantity: 43.28
                        RebateRate: 0.0022
                        ReceiptNumber: 6803
                        RefundFlag: 'Y'
                        SiteGroupId: 202
                        SiteGroupName: CZ 9100 ECONOMY NETWORK
                        Latitude: 53.83606
                        Longitude: -1.61854
                        DelCoExchangeRate: 0.851858
                        EuroRebateAmount: -0.258259
                        NetEuroAmount: 56.01
                        EuroVATAmount: 11.2
                        ParentCustomerName: FUEL CARD SERVICES LTD
                        IsInvoiced: false
                        TransactionCurrencyCode: GBP
                        CreditDebitCode: D or C
                        TransactionDate: '20210801'
                        TransactionTime: '12:16:58'
                        TransactionItemId: H305908971030
                        TrnIdentifier: H305908971030
                        Type: SALE
                        TransactionLine: 1
                        TransactionType: Purchase
                        UTCOffset: Europe/London
                        VATCategory: United Kingdom Standard VAT Rate
                        VATRate: 0.2
                        VehicleRegistration: YG67OUM
                        IsCancelled: 'Y'
                        ColCoGrossAmount: 57.25
                        ColCoNetAmount: 47.71
                        ColCoVATAmount: 9.54
                        OriginalCurrencySymbol: $
                        OriginalCurrencyCode: $
                        OriginalVATAmount: 0
                        EmbossText: PARKLANE PROPERTIES LTD
                        OriginalExchangeRate: 0
                        OriginalTransactionItemInvoiceDate: '20220202'
                        FeeTypeId: 1
                        LineItemDescription: true
                        FeeRuleDescription: Simple Fee
                        Frequency: 1
                        FeeRuleId: 1
                        SystemEntryDate: '20210828'
                        SystemEntryTime: '20:21:08'
                        IsManual: 'Y'
                        OriginalTransactionItemId: 'Y'
                        OriginalTransactionItemInvoiceNumber: 6750802
                        OriginalTransactionItemInvoiceId: 234
                        PayerShortName: FUEL CARD SERVICES LTD
                        ReverseCharge: 'Y'
                        OriginalGrossAmount: 57.25
                        OriginalNetAmount: 57.25
                        UnitOfMeasure: L
                        RoadType: National Road
                        CustomerCountryIsoCode: DE
                        EVOperator: Shell Recharge
                        EVSerialId: GBALLEGO0002452
                        EVChargePointSerial: GBALLEGO0002452
                        EVChargePointConnectorType: 5
                        EVChargePointConnectorTypeDescription: DC 50 kW
                        EVChargeDuration: PT3205S
                        EVChargeStartDate: '2021-08-01'
                        EVChargeStartTime: '20:08:01'
                        EVChargeEndDate: '2022-08-01'
                        EVChargeEndTime: '20:08:01'
                        HostingCollectingCompanyNumber: 0
                        TransactionId: 0
                        FuelOnly: true
                        EVPrintedNumber: ZZ2WJ53ZZ5
                        IsRFID: true
                    Page: 3
                    PageSize: 30
                    TotalPages: 5
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}
      parameters:
        - schema:
            type: string
          in: header
          name: Authorization
          description: OAuth 2.0 Token with Bearer Prefix
          required: true
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Page:
                  type: integer
                  description: Specify the page of results to be returned.
                PageSize:
                  type: integer
                  description: Specify the number of records to returned; Max 100
                Filters:
                  $ref: '#/components/schemas/PricedRequestDataV2'
            examples:
              Example 1:
                value:
                  PageSize: 1
                  Page: 1
                  Filters:
                    ColCoCode: '032'
                    ColCoId: 32
                    InvoiceStatus: A
                    PayerNumber: DE26685263
                    AccountId: 29484
                    AccountNumber: DE26667080
                    DriverName: HH NX 508
                    CardId: 12354
                    CardGroupId: 40000
                    CardPAN: '7002051006629890645'
                    ProductCode: '10'
                    ProductName: Diesel AGO
                    SiteCode: '05000100'
                    IncomingSiteNumber: '100021'
                    InvoiceDate: '2021-01-01'
                    InvoiceNumber: '3201016193'
                    PurchasedInCountryCode: GB
                    PurchasedInCountry: United Kingdom
                    SiteGroupId: 202
                    VehicleRegistrationNumber: 4K46801
                    FeeTypeId: 275549
                    LineItemDescription: ABC3
                    Cards:
                      - 0
                    SortOrder: '5'
                    FromDate: '2022-01-01 00:00:00'
                    ToDate: '2022-01-01 00:00:00'
                    Period: 3
                    PostingDateFrom: '2022-01-01 00:00:00'
                    PostingDateTo: '2022-01-01 00:00:00'
                    TransactionItemId: '1208176398'
                    FuelOnly: false
                    IncludeFees: true
                    IsMultipayer: true
                    ValidInvoiceDateOnly: false
                    InvoiceFromDate: '2022-01-01 00:00:00'
                    InvoiceToDate: '2022-01-01 00:00:00'
                    HostingCollectingCompanyNumber: '032'
                    Search: 2K89909
                    TransactionId: io9KVXk1UkW57XWKyeaHHg
      tags:
        - Transaction - New
  /transaction-data/v1/pricedtransaction:
    post:
      summary: Get fuel transaction details (sales item and fees)
      description: "This API allows querying transaction data (i.e. Priced, Billed and Unbilled sales items). It provides a flexible search criteria and supports paging. \n\nTransactions that are posted but not yet priced, billed or that are in error will not be returned by this API. The API also supports returning Fee Items.\n\n#### Supported operations\n  * Get sales items and fee transactions\n    * Search by invoice status\n    * Search by fixed date period\n    * Search by date range\n    * Search by account\n    * Search by card\n  * Get sales items only\n    * Search by transaction Id or location\n    * Search by transaction posting date\n    * Search by invoice number or date\n    * Search by driver name or vehicle registration number\n    * Search by card group\n    * Search by fuel only transactions\n    * Search by product\n  \n This API fetches transactions for a period based on the below parameters and priority order:\n1.\tInvoiceNumber\n 2.\tInvoiceDate\n 3.\tFromDate, ToDate\n4.\tPostingFromDate, PostingToDate (Can be used only when IncludeFees = false)\n 5.\tInvoiceDateFrom, InvoiceDateTo\n 6.\tPeriod\n\n This API considers only one of the above set of parameters at a time. For example, if InvoiceNumber and Period are provided in the input then Period is ignored and transactions associated to the given invoice number are returned.\n\nIf none of the above parameters are provided then last 7 days transactions will be fetched.\n\nThis operation can fetch transactions that are old up to 24 (configurable) months. However, the date range between any of the ‘From’ and ‘To’ dates in the above combination cannot be more than 210 (configurable) days.\n"
      operationId: Prict-transaction-PricedTransactions
      responses:
        '200':
          description: The http status code 200 and the Error.Code "0000" in the response body would indicate the API call is successful. The http status code 200 with Error Code other than "0000" in the response body would indicate there is a failure in the API call.
          content:
            application/json:
              schema:
                 $ref: '#/components/schemas/ResponsePricedTransaction'

        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}
      parameters:
        - schema:
            type: string
          in: header
          name: Authorization
          description: OAuth 2.0 Token with Bearer Prefix
          required: true
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Filters:
                  $ref: '#/components/schemas/RequestPricedTransaction'
                Page:
                  type: integer
                  description: Specify the page of results to be returned.
                  example: 1
                PageSize:
                  type: integer
                  description: Specify the number of records to returned; Max 100
                  example: 1

      tags:
        - Transaction - New
  /transaction-data/v1/pricedtransactionssummary:
    post:
      summary: Get priced transaction summary data for Fuel and NFR (sales item and fees)
      operationId: pricedtransactionssummaryNew
      description: "This API returns the transaction summary data (i.e. Priced, Billed and Unbilled sales items). It provides a flexible search criteria. \nThe API also supports returning Fee Items. Transactions posted for fee items that are in error are not included in the summary.\n\nThe endpoint supports the exact same search criteria as the endpoint */transaction/prciedtransactions*.\n\n#### Supported operations\n  * Get sales items and fee transactions\n    * Search by invoice status\n    * Search by fixed date period\n    * Search by date range\n    * Search by account\n    * Search by card\n  * Get sales items only\n    * Search by transaction Id or location\n    * Search by transaction posting date\n    * Search by invoice number or date\n    * Search by driver name or vehicle registration number\n    * Search by card group\n    * Search by fuel only transactions\n    * Search by product\n  \n This API fetches transactions for a period based on the below parameters and priority order:\n1.\tInvoiceNumber\n 2.\tInvoiceDate\n 3.\tFromDate, ToDate\n4.\tPostingFromDate, PostingToDate (Can be used only when IncludeFees = false)\n 5.\tInvoiceDateFrom, InvoiceDateTo\n 6.\tPeriod\n\n This API considers only one of the above set of parameters at a time. For example, if InvoiceNumber and Period are provided in the input then Period is ignored and transactions associated to the given invoice number are returned.\n\nIf none of the above parameters are provided then last 7 days transactions will be fetched."
      responses:
        '200':
          description: The http status code 200 and the Error.Code "0000" in the response body would indicate the API call is successful. The http status code 200 with Error Code other than "0000" in the response body would indicate there is a failure in the API call.
          content:
            application/json:
              schema:
                 $ref: '#/components/schemas/Responsepricedtransactionssummary'

        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}
      parameters:
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Filters:
                  $ref: '#/components/schemas/pricedtransactionssummary'

      tags:
        - Transaction - New
  /transaction-data/v1/volumebasedbonus:
    post:

      summary: Provides the details of the bonus and association bonus rules setup for the given payer
      description: >-
        This API retrieves the active bonus and association bonus rules for the specified payer as of the current date. Additionally, it provides a detailed monthly breakdown of the current period's consumption and includes information on previously calculated bonuses and consumption for the relevant payers.
        
      operationId: Prict-transaction-VolumeBasedBonus
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                 $ref: '#/components/schemas/ResponseVolumeBasedBonus'

        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}
      parameters:
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Filters:
                  $ref: '#/components/schemas/VolumeBasedBonus'

      tags:
        - Transaction - New
  /transaction-data/v1/volumebasedpricing:
    post:


      summary: Provides the details of the In Arrears fee rules setup for the given payer 
      description: >-

        This API retrieves the details of the in-arrear fee rule applied to the payer, including information on locations, products, and tiers. It also provides historical and current volume consumption data, along with the applicable tier for the following month.
      operationId: Prict-transaction-VolumeBasedPricing
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                 $ref: '#/components/schemas/ResponseVolumeBasedPricing'

        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}
      parameters:
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Filters:
                  $ref: '#/components/schemas/VolumeBasedPricing'

      tags:
        - Transaction - New
  /transaction-data/v1/feessummary:
    post:


      summary: Provides the details of the fee items summary data for the given payer
      description: >-
        This API enables clients to retrieve a summary of fee items, aggregated by the configured fee group, fee type, product group, and individual products.
      operationId: TransactionFeeSummary
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                 $ref: '#/components/schemas/ResponseFeesSummary'

        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}
      parameters:
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Filters:
                  $ref: '#/components/schemas/FeesSummary'


      tags:
        - Transaction - New
  /transaction-data/v1/exceptions:
    post:


      summary: Provides the details of the Cards or Transaction related exceptions
      description: >-
        This API endpoint provides the details of the Cards or Transaction related exceptions based on the given conditions for the Requested period.
        This API will return the Transactions related exceptions when the OutputType input parameter is passed as ‘Transaction’ else will return the Cards related exceptions.
      operationId: TransactionExceptions
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                 $ref: '#/components/schemas/ResponseExceptions'

        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}
      parameters:
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Filters:
                  $ref: '#/components/schemas/Exceptions'


      tags:
        - Transaction - New
  /transaction-data/v1/cardusagesummary:
    post:


      summary: Provides the details of expenditure analysis for a card
      description: >-
        This API provides the expenditure analysis for a card for the past 7 months in customer currency.
        The response contains a daily summary of the transactions (billed & unbilled) from 1st of the last 7 months for the requested card grouped by card, site-group, and product.
      operationId: CardUsageSummary
      responses:
        '200':
          description: ok
          content:
            application/json:
              schema:
                 $ref: '#/components/schemas/ResponseCardUsageSummary'

        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}
      parameters:
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                Filters:
                  $ref: '#/components/schemas/CardUsageSummary'


      tags:
        - Transaction - New
  /fleetmanagement/v1/transaction/multipayerspricedtransactions:
    post:
      tags:
        - Transaction
      summary: Get priced transaction details for multiple payers (sales item and fees)
      operationId: multipricedtransactions
      description: "This API allows querying transaction data (i.e. Priced, Billed and Unbilled sales items) for multiple payers. It provides a flexible search criteria and supports paging. \n\nTransactions that are posted but not yet priced, billed or that are in error will not be returned by this API. The API also supports returning Fee Items.\n\nAt least one payer should be provided. Multiple payers must belong to the same payer group.\n\n#### Supported operations\n  * Get sales items and fee transactions for multiple payers\n    * Search by invoice status\n    * Search by fixed date period\n    * Search by date range\n  * Get sales items only for multiple payers\n    * Search by transaction location\n    * Search by transaction posting date\n    * Search by invoice number or date\n    * Search by fuel only transactions\n \n This API fetches transactions for a period based on the below parameters and priority order:\n1.\tInvoiceNumber\n 2.\tInvoiceDate\n 3.\tFromDate, ToDate\n4.\tPostingFromDate, PostingToDate (Can be used only when IncludeFees = false)\n 5.\tInvoiceDateFrom, InvoiceDateTo\n 6.\tPeriod\n\n This API considers only one of the above set of parameters at a time. For example, if InvoiceNumber and Period are provided in the input then Period is ignored and transactions associated to the given invoice number are returned.\n\nIf none of the above parameters are provided then last 7 days transactions will be fetched."
      responses:
        '200':
          description: The http status code 200 and the Error.Code "0000" in the response body would indicate the API call is successful. The http status code 200 with Error Code other than "0000" in the response body would indicate there is a failure in the API call.
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/MultiPricedTransactionResponse'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '500':
          $ref: '#/components/responses/500InternalServerError'
      parameters:
        - $ref: '#/components/parameters/AuthorizationParameter'
        - $ref: '#/components/parameters/ApikeyParameter'
        - $ref: '#/components/parameters/ContentTypeParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MultiPricedTransactionRequest'
      x-stoplight:
        id: kkcuudcj6s8fn
    parameters: []
  /fleetmanagement/v1/transaction/pricedtransactionssummary:
    post:
      tags:
        - Transaction
      summary: Get priced transaction summary data
      operationId: pricedtransactionssummary
      description: "This API returns the transaction summary data (i.e. Priced, Billed and Unbilled sales items). It provides a flexible search criteria. \nThe API also supports returning Fee Items. Transactions posted for fee items that are in error are not included in the summary.\n\nThe endpoint supports the exact same search criteria as the endpoint */transaction/prciedtransactions*.\n\n#### Supported operations\n  * Get sales items and fee transactions\n    * Search by invoice status\n    * Search by fixed date period\n    * Search by date range\n    * Search by account\n    * Search by card\n  * Get sales items only\n    * Search by transaction Id or location\n    * Search by transaction posting date\n    * Search by invoice number or date\n    * Search by driver name or vehicle registration number\n    * Search by card group\n    * Search by fuel only transactions\n    * Search by product\n  \n This API fetches transactions for a period based on the below parameters and priority order:\n1.\tInvoiceNumber\n 2.\tInvoiceDate\n 3.\tFromDate, ToDate\n4.\tPostingFromDate, PostingToDate (Can be used only when IncludeFees = false)\n 5.\tInvoiceDateFrom, InvoiceDateTo\n 6.\tPeriod\n\n This API considers only one of the above set of parameters at a time. For example, if InvoiceNumber and Period are provided in the input then Period is ignored and transactions associated to the given invoice number are returned.\n\nIf none of the above parameters are provided then last 7 days transactions will be fetched."
      responses:
        '200':
          description: The http status code 200 and the Error.Code "0000" in the response body would indicate the API call is successful. The http status code 200 with Error Code other than "0000" in the response body would indicate there is a failure in the API call.
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/PricedTransactionSummaryResponse'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '500':
          $ref: '#/components/responses/500InternalServerError'
      parameters:
        - $ref: '#/components/parameters/AuthorizationParameter'
        - $ref: '#/components/parameters/ApikeyParameter'
        - $ref: '#/components/parameters/ContentTypeParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PricedTransactionSummaryRequest'
      x-stoplight:
        id: esxuebp4wtp2w
    parameters: []
  /transaction-data/v1/pricedsummary:
    post:
      summary: Get priced transaction summary data including EV Transactions
      operationId: pricedsummary
      description: |-
        This API returns the transaction summary data (i.e. Priced, Billed and Unbilled sales items). It provides a flexible search criteria. 
        The API also supports returning Fee Items. Transactions posted for fee items that are in error are not included in the summary.

        #### Supported operations
          * Get sales items and fee transactions
            * Search by invoice status
            * Search by fixed date period
            * Search by Year List
            * Search by account
            * Search by card
            * Search by Site Code
            * Search by Product
      responses:
        '200':
          description: The http status code 200 and the Error.Code "0000" in the response body would indicate the API call is successful. The http status code 200 with Error Code other than "0000" in the response body would indicate there is a failure in the API call.
          content:
            application/json:
              schema:
                type: object
                properties:
                  RequestId:
                    type: string
                    description: Mandatory UUID (according to RFC 4122 standards) for requests and responses. This will be played back in the response from the request.
                    example: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                  Status:
                    type: string
                    description: Indicates overall status of the request
                    example: SUCCESS
                  Data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PricedSummaryResponseData'
                  Page:
                    type: integer
                    description: Current page
                  PageSize:
                    type: integer
                    description: Number of Records in current page
                  TotalPages:
                    type: integer
                    description: Total number of pages avaiable
                required:
                  - RequestId
                  - Status
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Data:
                      - AccountId: 11
                        AccountName: Blue Colour Ltd
                        AccountNumber: GB78907890
                        CustomerCountry: Germany
                        ColCoCode: '032'
                        TransactionDate: '2022-01-01'
                        CustomerCurrencyCode: EUR
                        CustomerCountryIsoCode: GB
                        CustomerCurrencySymbol: £
                        FuelProduct: false
                        TransactionType: Sales
                        DelcoCode: '014'
                        DelcoName: SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV
                        TransactionCurrencyCode: GBP
                        TransactionCurrencySymbol: £
                        RebateonNetAmountInCustomerCurrency: ' -0.735'
                        InvoiceNetAmount: 22055942.83
                        AggregateLevel1Name: Payer
                        AggregateLevel2Name: Global Product Group
                        Month:
                          - 1
                        Year:
                          - 2022
                        CardGroupId: 7012736
                        CardGroupName: ' 006240 FIRE BRIGHT SOLUTIONS'
                        CardPAN: 700*******890645
                        Cards:
                          - 24573
                        PayerGroup: H312066
                        PayerGroupName: 12119008 - SHELL GROUP OF COMPANIES
                        PayerName: Colours Services Ltd
                        PayerNumber: GB12121212
                        TransactionStatus: 'Y'
                        RoadType: string
                        PurchasedInCountry: United Kingdom
                        SiteCountry: Netherlands
                        PurchasedInCountryCode: GB
                        ProductName: Unleaded - Medium octane
                        ProductCode: 22
                        ProductGroupId: 22
                        ProductGroupName: Fees
                        SiteCode: 050001 - CHARNOCK RICHARD NTHBOUND MWSA 0755
                        SiteName: 050001 - CHARNOCK RICHARD NTHBOUND MWSA 0755
                        SiteGroupId: 231
                        SiteGroupName: ' CZ 9100 ECONOMY NETWORK'
                        ProductId: 3
                        CustomerRetailValueTotalGross: 22755917.12
                        CustomerRetailValueTotalNet: 22755917.12
                        DelcoRetailValueTotalGross: 0
                        DelcoRetailValueTotalNet: 22755917.12
                        EffectiveDiscountInCustomerCurrency: -320351.04
                        EffectiveDiscountInTrxCurrency: 0
                        EuroRebateAmount: -320351.04
                        EuroVATAmount: 4227443.61
                        InvoiceGrossAmount: 26663029.43
                        InvoiceTax: 22435590.46
                        NetEuroAmount: 22435612.62
                        Quantity: 16423757.16
                        RebateonNetAmountInTransactionCurrency: -320351.04
                        TransactionGrossAmount: 0
                        TransactionNetAmount: 0
                        TransactionTax: 0
                        VATonNetAmount: 434487.32
                        VATonNetAmountInCustomerCurrency: 4155727.09
                        ColCoNetAmount: 22055942.83
                        ColCoVATAmount: 4155727.09
                        ColCoGrossAmount: 26211669.92
                        Uom: L
                        StartDate: '2021-04-01'
                        EndDate: '2021-04-01'
                        RowCount: 2
                    Page: 4
                    PageSize: 30
                    TotalPages: 5
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}
      parameters:
        - schema:
            type: string
          in: header
          name: Authorization
          description: OAuth 2.0 Token with Bearer Prefix
          required: true
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                PageSize:
                  type: integer
                  description: Specify the number of records to returned; Max 1000
                Page:
                  type: integer
                  description: Specify the page of results to be returned.
                Filters:
                  $ref: '#/components/schemas/PricedSummaryRequest'
            examples:
              Example 1:
                value:
                  PageSize: 0
                  Page: 0
                  Filters:
                    ColCoCode: '085'
                    PayerNumber: GB000000123
                    PayerGroupName: 12119008 - SHELL GROUP OF COMPANIES
                    Period: 1
                    AccountNumber: GB00000123
                    DelcoCode: '048'
                    MonthList:
                      - 9
                    YearList:
                      - 1900
                    ProductCode: '10'
                    ProductGroupName: Motor gasoline
                    ProductGroupId: 3
                    Products:
                      - '006240'
                    CardPAN:
                      - '7002051006629890645'
                    Cards:
                      - 275549
                    InvoiceStatus: I
                    SiteCode: '050001'
                    SiteGroupId: 202
                    DelcoName: SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV
                    RoadType: National Road
                    ProductId: 25
                    FuelOnly: false
                    IncludeFees: false
      tags:
        - Transaction - New
      x-stoplight:
        id: kogab8krzk8h8
    parameters: []
  /fleetmanagement/v1/transaction/fees:
    post:
      tags:
        - Transaction
      summary: Get fee item details
      operationId: fees
      description: |-
        This API returns the fee/charges levied from a  customer's account in a billing period or date range. The API returns both billed and unbilled fee items.  

        To get the summary of charges, the endpoint */transaction/feessummary* should be called with the same input criteria.

        #### Supported operations
          * Get fees by invoice status
          * Get fees by date period
          * Get fees by account
          * Get fees by card Id or PAN
          * Get fees by fee type charges
          * Get fees including cancelled items
          * Get fees by line item description
          * Get fees by product
      responses:
        '200':
          description: The http status code 200 and the Error.Code "0000" in the response body would indicate the API call is successful. The http status code 200 with Error Code other than "0000" in the response body would indicate there is a failure in the API call.
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/FeesResponse'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '500':
          $ref: '#/components/responses/500InternalServerError'
      parameters:
        - $ref: '#/components/parameters/AuthorizationParameter'
        - $ref: '#/components/parameters/ApikeyParameter'
        - $ref: '#/components/parameters/ContentTypeParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeesRequest'
      x-stoplight:
        id: ia5yjjkxuj9he
    parameters: []
  /fleetmanagement/v1/transaction/feessummary:
    post:
      tags:
        - Transaction
      summary: Get fee item summary data
      operationId: FeeSummaryResponse
      description: |-
        This API returns the summary data of the fee/charges levied from a customer's account in a billing period or date range. The API returns both billed and unbilled fee items. 

        The endpoint supports the exact same search criteria as the endpoint */transaction/feessummary*.

        #### Supported operations
          * Get fees by invoice status
          * Get fees by date period
          * Get fees by account
          * Get fees by card Id or PAN
          * Get fees by fee type charges
          * Get fees including cancelled items
          * Get fees by line item description
          * Get fees by product      
      responses:
        '200':
          description: The http status code 200 and the Error.Code "0000" in the response body would indicate the API call is successful. The http status code 200 with Error Code other than "0000" in the response body would indicate there is a failure in the API call.
          content:
            application/json; charset=utf-8:
              schema:
                $ref: '#/components/schemas/FeeSummaryResponse'
        '400':
          $ref: '#/components/responses/400BadRequest'
        '401':
          $ref: '#/components/responses/401Unauthorized'
        '403':
          $ref: '#/components/responses/403Forbidden'
        '404':
          $ref: '#/components/responses/404NotFound'
        '500':
          $ref: '#/components/responses/500InternalServerError'
      parameters:
        - $ref: '#/components/parameters/AuthorizationParameter'
        - $ref: '#/components/parameters/ApikeyParameter'
        - $ref: '#/components/parameters/ContentTypeParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeesSummaryRequest'
    parameters: []
  /transaction-data/v1/multipayerspricedtransactions:
    post:
      tags:
      - Transaction - New
      summary: MultipricedTransactions
      description: "This API allows querying transaction data (i.e. Priced, Billed and Unbilled sales items) for multiple payers. It provides a flexible search criteria and supports paging. \r\n\r\nTransactions that are posted but not yet priced, billed or that are in error will not be returned by this API. The API also supports returning Fee Items.\r\n\r\nAt least one payer should be provided. Multiple payers must belong to the same payer group.\r\n\r\n#### Supported operations\r\n  * Get sales items and fee transactions for multiple payers\r\n    * Search by invoice status\r\n    * Search by fixed date period\r\n    * Search by date range\r\n  * Get sales items only for multiple payers\r\n    * Search by transaction location\r\n    * Search by transaction posting date\r\n    * Search by invoice number or date\r\n    * Search by fuel only transactions\r\n \r\n This API fetches transactions for a period based on the below parameters and priority order:\r\n 1.    InvoiceNumber\r\n 2.    InvoiceDate\r\n 3.    FromDate, ToDate\r\n 4.    PostingFromDate, PostingToDate (Can be used only when IncludeFees = false)\r\n 5.    InvoiceDateFrom, InvoiceDateTo\r\n 6.    Period\r\n\r\n This API considers only one of the above set of parameters at a time. For example, if InvoiceNumber and Period are provided in the input then Period is ignored and transactions associated to the given invoice number are returned.\r\n\r\nIf none of the above parameters are provided then last 7 days transactions will be fetched."
      operationId: MultipricedTransactions
      parameters:
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        description: MultiPayer RequestBody
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/MultiPricedTransactionReq'
              - description: MultiPayer RequestBody
              - example:
                  Filters:
                    ColCoId: 101
                    ColCoCode: 44
                    Accounts:
                    - PayerId: 987654
                      PayerNumber: GB987654321
                    - PayerId: 987767
                      PayerNumber: GB987654322
                    InvoiceStatus: Processed
                    PurchasedInCountry: United Kingdom
                    FromDate: '20210814'
                    ToDate: '20210814'
                    Period: 1
                    PostingDateFrom: '20210325 06:46:07'
                    PostingDateTo: '20210325 06:46:07'
                    InvoiceDate: '20210325'
                    InvoiceNumber: 8716711
                    ValidInvoiceDateOnly: true
                    InvoiceFromDate: '20210325'
                    InvoiceToDate: '20210325'
                    FuelOnly: true
                    IncludeFees: true
                    SortOrder: Date,Amount
                    CurrentPage: 1
                    PageSize: 50
                  Page: 1
                  PageSize: 100


      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/MultiPricedTransactionRes'
                - example:
                    RequestId: eb621f45-a543-4d9a-a934-2f223b263c42
                    Status: SUCCESS
                    Data:
                    - Transactions:
                      - Type: SalesItem
                      CardId: 275549
                      CardPAN: '7002051006629891000'
                      CardExpiry: '20250812'
                      TransactionDate: '20250812'
                      TransactionTime: '14:30:45'
                      UTCOffset: '+01:00:00'
                      FleetIdInput: XYZ1234
                      OdometerInput: 12345
                      DriverName: ANDREW GILBERRY
                      VehicleRegistration: MV65YLH
                      InvoiceCurrencyCode: GBP
                      InvoiceCurrencySymbol: £
                      TransactionCurrencyCode: GBP
                      TransactionCurrencySymbol: £
                      TransactionNetAmount: 47.71
                      TransactionTax: 9.54
                      TransactionGrossAmount: 57.25
                      InvoiceNetAmount: 47.71
                      InvoiceTax: 9.54
                      InvoiceGrossAmount: 57.25
                      PurchasedInCountry: Germany
                      AccountId: 29484
                      AccountNumber: GB99215176
                      AccountName: MATTHEW ALGIE & COMPANY LIMITED
                      AccountShortName: MATTHEW
                      Quantity: 43.28
                      FuelProduct: true
                      UnitPriceInTransactionCurrency: 1.1074
                      UnitPriceInInvoiceCurrency: 1.1024
                      UnitDiscountTransactionCurrency: -0.005
                      UnitDiscountInvoiceCurrency: -0.0051
                      IsInvoiced: true
                      InvoiceNumber: S04500493
                      InvoiceDate: '20250815 09:30:00'
                      SiteCode: '050001'
                      SiteName: CHARNOCK RICHARD NTHBOUND MWSA 0755
                      SiteCountry: Germany
                      Location:
                        Latitude: '53.83606'
                        Longitude: '-1.61854'
                      CardGroupName: 006240 FIRE BRIGHT SOLUTIONS
                      ReceiptNumber: '6803'
                      ProductCode: '10'
                      ProductName: Unleaded - High octane
                      ProductGroupId: 2
                      ProductGroupName: All Fuels
                      DelCoExchangeRate: 0.851858
                      ColCoExchangeRate: 0.851858
                      IsShellSite: true
                      Network: SHELL
                      SiteGroupId: 202
                      SiteGroupName: CZ 9100 ECONOMY NETWORK
                      PostingDate: '20250812 14:30:45'
                      IssuerCode: '7002'
                      PurchasedInCountryCode: DE
                      CustomerCountryCode: NL
                      CustomerCountry: Netherlands
                      ReleaseCode: '8'
                      CardGroupId: '40000'
                      CardSequenceNumber: '617'
                      CheckDigit: '6'
                      FleetIDDescription: YG67OUM
                      VATRate: 0.2
                      VATCategory: 1-Standard Rate
                      VATonNetAmount: 9.54
                      VATCountry: Netherlands
                      EffectiveDiscountInTrxCurrency: -0.22
                      TransactionType: Purchase
                      PINIndicator: PIN Used
                      VATApplicable: 'Y'
                      NetInvoiceIndicator: 'N'
                      CustomerCurrencyCode: GBP
                      CustomerCurrencySymbol: £
                      EffectiveUnitDiscountInCustomerCurrency: -0.0051
                      EffectiveDiscountInCustomerCurrency: -0.22
                      VATonNetAmountInCustomerCurrency: 9.54
                      DiscountType: 2-Pence per unit
                      TransactionStatus: I
                      SalesItemId: 18315958002
                      PayerGroup: H312066
                      PayerGroupName: 12119008 - SHELL GROUP OF COMPANIES
                      RefundFlag: 'N'
                      OriginalSalesItemId: null
                      DelcoName: SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV
                      DelcoCode: '014'
                      PayerNumber: GB987654322
                      PayerName: V.M. LE COMTE
                      CardExpiryPeriod: '2504'
                      AuthorisationCode: '011256'
                      TransactionId: io9KVXk1UkW57XWKyeaHHg
                      TransactionLine: '1'
                      AllowClearing: 'Y'
                      CRMNumber: null
                      DisputeStatus: No Dispute
                      RebateRate: 28.279
                      DelCoToColCoExchangeRate: 1.0
                      NetEuroAmount: 56.01
                      EuroVATAmount: 11.2
                      ParentCustomerNumber: GB12121212
                      ParentCustomerName: FUEL CARD SERVICES LTD
                      ParentCustomerId: 6494
                      IncomingSiteNumber: '100021'
                      IncomingSiteDescription: HN3 INTI_02-82.02
                      IncomingCurrencyCode: GBP
                      IncomingProductCode: '30'
                      CreditDebitCode: D
                      CorrectionFlag: 'N'
                      Additional1: GBALLEGO0002452
                      Additional2: null
                      Additional3: null
                      Additional4: null
                      RebateonNetAmountInCustomerCurrency: -0.735
                      RebateonNetAmountInTransactionCurrency: -0.735
                      TrnIdentifier: H305908971030
                      CardType: GB STD FLT NAT SINGLE R9
                      DelcoListPriceUnitNet: 30.5
                      DelcoRetailPriceUnitNet: 1.1074
                      DelcoRetailPriceUnitGross: 1.32888
                      DelcoRetailValueTotalNet: 47.93
                      DelcoRetailValueTotalGross: 57.52
                      CustomerRetailPriceUnitGross: 1.32888
                      CustomerRetailValueTotalNet: 47.93
                      EVPrintedNumber: '3792'
                      IsRFID: true
                      TokenTypeDescription: Fleet Card               
                    Page: 1
                    PageSize: 20
                    TotalPages: 15
                    TotalRecords: 300
                    Warnings:
                    - Type: System Outage
                      Message: System is down for upgradation.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}
  /transaction-data/v1/fuelconsumption:
    post:
      tags:
      - Transaction - New
      summary: FuelConsumption
      description: "- This API returns the customer an overview of how many transactions, how much fuel volume used over a given period and the total volume used by a card \r\n- This operation response will contains card & transaction details for given period aggregated by payer, account, cardGroup, PAN, DriverName and VRN\r\n"
      operationId: FuelConsumption
      parameters:
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        description: FuelConsumption RequestBody
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/FuelConsumptionReq'
              - description: FuelConsumption RequestBody
              - example:
                  Filters:
                    ColcoID: 14
                    PayerNumber: DE00000009
                    FromDate: "20230501"
                    ToDate: "20230530"


        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/FuelConsumptionResponse'
                - description: FuelConsumption Response
                - example:
                    RequestId: 5f1bded6-416d-4478-ab7f-33905d7b5d4b
                    Status: SUCCESS
                    Data:
                      - AccountName: Hubert Blaine Wolfeschlegelsteinhausenbergerdorff Sr.
                        AccountNumber: DE00000009
                        PayerName: Hubert Blaine Wolfeschlegelsteinhausenbergerdorff Sr.
                        PayerNumber: DE00000009
                        CardNumber: "7002141005592540023"
                        CardGroupId: 101
                        CardGroupName: Premium Fleet Cards
                        DriverName: CSSTEST B
                        LicenseNumber: "123456"
                        InitialOdometer: 15000.0
                        LastOdometer: 15850.0
                        Distance: 850.0
                        FuelConsumptions: 85.0
                        FuelNetAmount: 3953.53
                        Discount: 50.0
                        FuelTax: 1271.02
                        FuelVolume: 910.0
                        GrossNonFuelExpenses: 4433.27
                        CO2Produced: 173.87
                        TransactionCount: 64
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}
  /transaction-data/v1/updateodometer:
    post:
      tags:
      - Transaction - New
      summary: UpdateOdometer
      description: "- This API allows the users to update the odometer readings on the sales items (transaction data) \r\n- This is an asynchronous operation. If opted, the user will be notified on completion of processing."
      operationId: UpdateOdometer
      parameters:
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        description: updateOdometer RequestBody
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateOdometerRequest'
              - description: updateOdometer RequestBody
              - example:
                  UpdateOdometer:
                    - SalesItemId: S123456
                      NewOdometerValue: 60234
                  NotifyCaller: true
                  ColCoId: 37
                  ColCoCode: 101
                  Payerid: '3'
                  PayerNumber: DE00000003
                  Accountid: 3
                  AccountNumber: DE00000003
                  Caller: NextGenUI

        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/UpdateOdometerResp'
                - description: updateOdometer Response
                - example:
                    RequestId: 45519501-f156-4507-fdd6-7e9e46728d7d
                    Status: SUCCESS
                    Data:
                      - ServiceReference: 709887
                        UpdateOdometerReferences:
                          - SalesItemId: 123222
                            UpdateOdometerReferenceId: 1629
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}
  /transaction-data/v1/fees:
    post:
      tags:
      - Transaction - New
      summary: Fee Transactions
      description: "This API returns the fee/charges levied from a  customer's account in a billing period or date range. The API returns both billed and unbilled fee items.  \r\n\r\nTo get the summary of charges, the endpoint *transaction/feessummary* should be called with the same input criteria.\r\n\r\n#### Supported operations\r\n  * Get fees by invoice status\r\n  * Get fees by date period\r\n  * Get fees by account\r\n  * Get fees by card Id or PAN\r\n  * Get fees by fee type charges\r\n  * Get fees including cancelled items\r\n  * Get fees by line item description\r\n  * Get fees by product"
      operationId: Fees
      parameters:
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/RequestId'
      requestBody:
        description: Transaction Fees RequestBody
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/TransactionFeesReq'
              - description: Transaction Fees RequestBody
              - example:
                  Filters:
                    ColCoCode: 14
                    PayerId: 12
                    InvoiceStatus: I
                    Period: 4

        required: false
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/TransactionFeesRes'
                - description: Transaction Fees Response
                - example:
                    Page: 1
                    TotalRecords: 248
                    TotalPages: 5
                    PageSize: 50
                    Data:
                    - AccountId: 12
                      AccountNumber: DE00000011
                      AccountShortName: Green Transport
                      CardGroupId: 1001
                      CardGroupName: Fleet Cards
                      CardId: 2001
                      CardPAN: '1234567890123456'
                      ColCoGrossAmount: 11.6
                      ColCoNetAmount: 10.0
                      ColCoVATAmount: 1.6
                      CustomerCurrencyCode: EUR
                      CustomerCurrencySymbol: €
                      CustomerExchangeRate: 1.0
                      DriverName: John Doe
                      EmbossText: Green Transport Card
                      FeeItemCardLevelBreakup: Breakup details
                      FeeItemDate: '20250331'
                      FeeItemId: 3204151
                      FeeItemTime: 00:00:00
                      FeeRuleDescription: Monthly card fee rule
                      FeeRuleId: 501
                      FeeRuleTiers:
                      - DateEffective: '20250101'
                        DateTerminated: '20251231'
                        FeeRuleBasisDescription: Fixed monthly fee
                        FeeRuleBasisID: 1
                        TierMax: 100
                        TierMin: 1
                        TierValue: 5.0
                      FeeType: Monthly Card Fee
                      FeeTypeGroup: Card charges
                      FeeTypeId: 49
                      Frequency: Monthly
                      InterimInvoiceId: 10001
                      InterimInvoiceNumber: INV10001
                      InvoiceAccountId: 12
                      InvoiceAccountNumber: DE00000011
                      InvoiceAccountShortName: Green Transport
                      InvoiceDate: '20250430'
                      InvoiceGrossAmount: 11.6
                      InvoiceId: 22477
                      InvoiceNetAmount: 10.0
                      InvoiceNumber: INV22477
                      InvoiceVATAmount: 1.6
                      IsCancelled: false
                      IsInvoiced: true
                      IsManual: false
                      LegislativeRegionId: 14
                      LegislativeRegionName: Germany BB & NBB
                      LineItemDescription: Monthly card fee for April
                      OriginalCurrencyCode: EUR
                      OriginalCurrencySymbol: €
                      OriginalExchangeRate: 1.0
                      OriginalFeeItemId: 3204150
                      OriginalFeeItemInvoiceDate: '20250331'
                      OriginalFeeItemInvoiceId: 22476
                      OriginalFeeItemInvoiceNumber: INV22476
                      OriginalGrossAmount: 11.6
                      OriginalLegislativeRegionId: 14
                      OriginalLegislativeRegionName: Germany BB & NBB
                      OriginalNetAmount: 10.0
                      OriginalUnitPrice: 5.0
                      OriginalVATAmount: 1.6
                      PayerId: 12
                      PayerNumber: DE00000011
                      PayerShortName: Green Transport
                      ProductCode: '2'
                      ProductGroupId: 22
                      ProductGroupName: Card related fees
                      ProductId: 100
                      ProductName: Service fee
                      Quantity: 2.0
                      ReverseCharge: false
                      SystemEntryDate: '20250331'
                      SystemEntryTime: 00:00:00
                      VATCategoryDescription: Germany Standard VAT Rate
                      VATCategoryID: 111
                      VATCountryCode: DE
                      VATCountryName: Germany
                      VATPercentage: 0.16
                      VRN: DE123456789
                    RequestId: 399c15fb-518f-4b5b-86ca-da5e54ae1c91
                    Status: SUCCESS
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0001
                        Title: Bad Request
                        Detail: Unsupported payload format
                        AdditionaIlnfo: {}
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0003
                        Title: Unauthorized
                        Detail: Invalid Credentials
                        AdditionalInfo: {}
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0005
                        Title: Not Found
                        Detail: 'Target endpoint is not available '
                        AdditionalInfo: {}
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0007
                        Title: Method not allowed
                        Detail: Requested endpoint or method is not available
                        AdditionalInfo: {}
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0008
                        Title: Too many request
                        Detail: Number is requests received per minute is more than the allowed/configured policy
                        AdditionalInfo: {}
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0002
                        Title: Unknown Error
                        Detail: Unhandled exceptions
                        AdditionalInfo: {}
        '503':
          description: Service Unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorObject'
              examples:
                Example 1:
                  value:
                    RequestId: 9d2dee33-7803-485a-a2b1-2c7538e597ee
                    Status: SUCCESS
                    Error:
                      - Code: E0012
                        Title: Connectivity Error
                        Detail: Connectivity failure is encountered
                        AdditionalInfo: {}

components:
  securitySchemes:
    Test:
      type: oauth2
      description: 'OAuth2 works based on client credentials and grand_type. The user needs to pass in the header base64 entryped <client_id+:+client secret> and in the body grand_type as ''client_credentials'' to get OAUTH token.'
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: 'https://api-test.shell.com/v2/oauth/token'
    Prod:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: 'https://api.shell.com/v2/oauth/token'
          scopes: {}
      description: 'OAuth2 works based on client credentials and grand_type. The user needs to pass in the header base64 entryped <client_id+:+client secret> and in the body grand_type as ''client_credentials'' to get OAUTH token.'
    BasicAuth:
      type: http
      scheme: basic
  parameters:
    AuthorizationParameter:
      in: header
      name: Authorization
      description: Uses Basic Authorization Scheme Passing base64 encoded ConsumerKey + Secret as Authorization.
      required: true
      schema:
        type: string
    ApikeyParameter:
      in: header
      name: apikey
      description: This is the API key of the specific environment which needs to be passed by the API client.
      required: true
      schema:
        type: string
    ContentTypeParameter:
      in: header
      name: Content-Type
      description: Content Type of the body i.e. application/json for  JSON.
      required: true
      schema:
        type: string
    RequestId:
      name: RequestId
      in: header
      required: true
      schema:
        type: string
        pattern: '^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$'
        minLength: 36
        maxLength: 36
        example: 2b0cbe11-f109-4c43-9201-49af0370df1c
      description: Mandatory UUID (according to RFC 4122 standards) for requests and responses. This will be played back in the response from the request.
    Authorization:
      name: Authorization
      in: header
      description: A valid bearer token from the oAuth2 endpoint response.
      required: true
      schema:
        type: string
        example: Bearer uEdpGgXJqEIr4Wm2BkhpaomWghUu
  responses:
    200OK:
      description: |
        The http status code 200 and the Error.Code "0000" in the response body would indicate the API call is successful. The http status code 200 with Error Code other than "0000" in the response body would indicate there is a failure in the API call.
    400BadRequest:
      description: |
        The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
      content:
        application/json:
          schema:
            type: object
            description: |
              An error response.
            properties:
              fault:
                type: object
                properties:
                  faultstring:
                    type: string
                    example: Bad Request
                    description: |
                      The description of the error.
                  detail:
                    type: object
                    properties:
                      errorcode:
                        type: string
                        description: |
                          The error code.
                        example: The request contains bad syntax or cannot be fulfilled
    401Unauthorized:
      description: |
        The request has not been applied because it lacks valid  authentication credentials for the target resource.
      content:
        application/json:
          schema:
            type: object
            description: |
              An error response.
            properties:
              fault:
                type: object
                properties:
                  faultstring:
                    type: string
                    example: Invalid ApiKey
                    description: |
                      The description of the error.
                  detail:
                    type: object
                    properties:
                      errorcode:
                        type: string
                        description: |
                          The error code.
                        example: oauth.v2.InvalidApiKey
    403Forbidden:
      description: |
        The server understood the request but refuses to authorize it.
      content:
        application/json:
          schema:
            type: object
            description: |
              An error response.
            properties:
              Error:
                type: object
                properties:
                  ErrorCode:
                    type: string
                    example: '0002'
                    description: |
                      The Code of the error.
                  Description:
                    type: string
                    example: User does not have access to one or more payers and/or accounts
                    description: |
                      The description of the error.
    404NotFound:
      description: |
        The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.
      content:
        application/json:
          schema:
            type: object
            description: |
              404 error response
            properties:
              Message:
                type: string
                example: No HTTP resource was found that matches the request URI.
    500InternalServerError:
      description: |
        The server encountered an unexpected condition the prevented it from fulfilling the request.
      content:
        application/json:
          schema:
            type: object
            description: |
              An error response.
            properties:
              Error:
                type: object
                properties:
                  ErrorCode:
                    type: string
                    example: '0010'
                    description: |
                      The Code of the error.
                  Description:
                    type: string
                    example: 'ed557f02-c7d7-4c01-b3e5-11bf3239c8ed :Internal Error'
                    description: |
                      The description of the error.
  schemas:
    RequestBase:
      type: object
      description: Base request body of all API endpoints
      properties:
        RequestId:
          type: string
          description: 'A unique request id in GUID format. The value is written to the Shell API Platform audit log for end to end traceability of a request. If a value is not provided by an API client, then a GUID is automatically populated by the Shell API Platform and returned in the API response.'
          example: ed557f02-c7d7-4c01-b3e5-11bf3239c8ed
      x-stoplight:
        id: f8l7vwtn5uvgx
    ResponseBase:
      type: object
      description: Base response body of all API endpoints.
      properties:
        Error:
          $ref: '#/components/schemas/Error'
        RequestId:
          type: string
          description: Unique request id in GUID format passed in the request by either the API client or the Shell API Platform.
          example: ed557f02-c7d7-4c01-b3e5-11bf3239c8ed
      required:
        - Error
      x-stoplight:
        id: y9a3sh238s7mm
    PagingRequestBase:
      allOf:
        - type: object
          description: Base request body of all API endpoints that support paging.
          properties:
            CurrentPage:
              type: integer
              nullable: true
              description: Page Number from total number of pages.
              example: 1
              default: 1
            PageSize:
              type: integer
              nullable: true
              description: Page Size - Number of records to show on a page. Return all rows if -1 is supplied as page size.
              example: 50
              default: 50
        - $ref: '#/components/schemas/RequestBase'
      x-stoplight:
        id: fo9c66zt57rof
    PagingResponseBase:
      allOf:
        - type: object
          description: Base response body of all API endpoints  that support paging.
          properties:
            CurrentPage:
              type: integer
              description: Current page number.
              example: 10
            RowCount:
              type: integer
              description: Total row count matched for the given input criteria.
              example: 100
            TotalPages:
              type: integer
              description: Calculated page count based on page size from the incoming API request and total number of rows matched for the given input criteria. Return 1 if the page size is -1 as all records are returned.
              example: 10
          required:
            - CurrentPage
            - RowCount
            - TotalPages
        - $ref: '#/components/schemas/ResponseBase'
      x-stoplight:
        id: aet0s1k98doub
    Error:
      type: object
      description: Base error details returned for all API calls
      properties:
        Description:
          type: string
          example: Success
          description: Provides a description of the error.
        Code:
          type: string
          example: '0000'
          description: |-
            Provides a code associated with the error. Error Codes:
              * `0000` - Success
              * `0001` - Invalid User Token
              * `0002` - User does not have access to one or more payers and/or accounts
              * `0003` - Microservices host is not available
              * `0004` - Partial data returned
              * `0005` - No data found for the input criteria.
              * `0006` - Requested data not found.
              * `0007` - Invalid parameter value [ParameterName]
              * `0008` - Invalid API Key.
              * `0009` - The request Body/Content/Uri/Method/Resource is inappropriate for the Service
              * `0010` - User token has expired.
              * `0013` - User do not have access to the ColCos.
              * `0015` - ColCo and/or Payer input parameters are mandatory for Shell Administrators and Service Accounts.
              * `9000` - Card does not support PIN.
              * `9001` - Duplicate active cards found for the PAN.
              * `9002` - Duplicate request. A request is already submitted in last [X] hours for the card.
              * `9003` - Card cannot be moved to the requested account and/or card group
              * `9004` - Duplicate request. Only one request allowed for a card per day.
              * `9005` - Not all requests are submitted. See further errors for more details.
              * `9006` - Request failed. See further errors for more details.
              * `9007` - Card not found for the input criteria.
              * `9008` - Duplicate active cards found for the requested PAN and Expiry Date.
              * `9009` - Card cannot be changed to requested status.
              * `9010` - Card is not Active.
              * `9011` - Update card status request already submitted - [UpdateStatusReference] [UpdateCardReference]  [SubmittedDate]
              * `9012` - Number of request exceeds the allowed limit 'X'
              * `9013` - Duplicate cards found for the PAN.
              * `9014` - Duplicate cards found for the requested PAN and Expiry Date.
              * `9016` - The reissue indicator will be only updated for the Cards in Status (Active/ Temporary Block(Shell)/Temporay Block(Customer)/Pending Renewal) only.
          enum:
            - '0000'
            - '0001'
            - '0002'
            - '0003'
            - '0004'
            - '0005'
            - '0006'
            - '0007'
            - '0008'
            - '0009'
            - '0010'
            - '0013'
            - '0015'
            - '9000'
            - '9001'
            - '9002'
            - '9003'
            - '9004'
            - '9005'
            - '9006'
            - '9007'
            - '9008'
            - '9009'
            - '9010'
            - '9011'
            - '9012'
            - '9013'
            - '9014'
            - '9016'
      required:
        - Code
        - Description
      x-stoplight:
        id: piqtwasvu6bc3
    PricedTransactionRequest:
      description: Request object for endpoint */transaction/pricedtransactions*
      allOf:
        - $ref: '#/components/schemas/PricedTransactionCriteria'
        - $ref: '#/components/schemas/RequestBase'
        - $ref: '#/components/schemas/PagingRequestBase'
      required:
        - InvoiceStatus
      x-stoplight:
        id: fxkw708vop23w
    PricedTransactionResponse:
      description: Response object for endpoint */transaction/pricedtransactions*
      allOf:
        - type: object
          properties:
            Transactions:
              type: array
              description: List of transaction records
              uniqueItems: true
              items:
                $ref: '#/components/schemas/PricedTransaction'
        - $ref: '#/components/schemas/ResponseBase'
        - $ref: '#/components/schemas/PagingResponseBase'
      x-stoplight:
        id: 0pc9pk4zsl1r0
    MultiPricedTransactionRequest:
      description: Request object for endpoint - Multipayerspricedtransactions
      allOf:
        - type: object
          properties:
            ColCoId:
              type: integer
              description: 'The Collecting Company Id in the Shell Card Platform. Optional if ColCo Code is passed, else mandatory.  For example, 1 = Philippines and 5 = UK.'
              example: 1
            ColCoCode:
              type: integer
              description: 'The Collecting Company Code (i.e. Shell Code) of the selected payer. Optional if ColCo Id is passed, else mandatory.  For example, 86 = Philippines and 5 = UK. '
              example: 86
            Accounts:
              type: array
              description: List of Payers/Accounts entity. Mandatory. Note-  At least one payer should be present. Accounts information are optional.
              uniqueItems: true
              items:
                type: object
                minProperties: 1
                maxProperties: 10
                properties:
                  PayerId:
                    type: integer
                    description: 'The Payer Id of the selected payment customer in the Shell Card Platform. Optional if Payer Number is passed, else mandatory.  Providing the Payer Id is recommended instead of the Payer Number for a better performing API call. '
                    example: 123456
                  PayerNumber:
                    type: string
                    description: 'Payer Number of the selected payer. Optional if PayerId is passed else Mandatory. Providing the Payer Id is recommended instead of the Payer Number for a better performing API call. '
                    example: GB000000123
                  AccountId:
                    type: integer
                    description: 'Account Id of the customer in the Shell Card Platform. When both Account Id and Account number are not present on request, the response will have transactions of all accounts under the selected payer. '
                    example: 123456
                  AccountNumber:
                    type: string
                    description: 'Account Number of the customer. When both Account Id and Account number are not present on request, the response will have transactions of all accounts under the selected payer.'
                    example: GB000000123
            InvoiceStatus:
              type: string
              description: |-
                Invoice status of the transactions. Mandatory. Possible options-
                  - I - Invoiced 
                  - U - Un-Invoiced 
                  - A - All
              enum:
                - I
                - U
                - A
              example: I
            PurchasedInCountry:
              type: string
              description: ISO 3166-1 Alpha-2 Country Code of where the transaction took place. Note- If IncludeFees is true then this filter will be ignored
              example: UK
            FromDate:
              type: string
              format: yyyyMMdd
              description: "Transactions from Date/Time  Should be with in last 7 months \r\nRefer the API description for the priority and sequence of different date and invoice number filters that are conditionally applied."
              example: '20210814'
            ToDate:
              type: string
              format: yyyyMMdd
              description: "Transactions to Date/Time When blank and FromDate is provided on the input, all transactions that took place after the given from date/time will be returned.\r\nRefer the API description for the priority and sequence of different date and invoice number filters that are conditionally applied."
              example: '20210814'
            Period:
              type: integer
              description: |-
                Transactions Period. This is ignored when FromDate/Todate is supplied on the request.  
                  - 1. Last 7 Days 
                  - 2. Last 30 Days 
                  - 3. Last 90 Days

                  Refer the API decription for the priority and sequence of different date and invoice number filters that are conditionally applied.
              example: 1
            PostingDateFrom:
              type: string
              format: 'yyyyMMdd HH:mm:ss'
              description: 'Transaction Posting Date/time in the Cards Platform - From Date/time When the value of both PostingDateFrom and PostingDateTo are present in the request, then the value of PostingDateFrom must be less than PostingDateTo Note- If IncludeFees is true then this filter will be ignored'
              example: '20210325 06:46:07'
            PostingDateTo:
              type: string
              format: 'yyyyMMdd HH:mm:ss'
              description: 'Transaction Posting Date/time in the Cards Platform  To Date/time When the value of both PostingDateFrom and PostingDateTo are present in the request, then the value of PostingDateFrom must be less than PostingDateTo Note- If IncludeFees is true then this filter will be ignored'
              example: '20210325 06:46:07'
            InvoiceDate:
              type: string
              format: yyyyMMdd
              description: 'If invoice date is provided, then `InvoiceStatus` will be ignored and billed transaction for the given invoice date is returned. Note- If IncludeFees is true then this filter will be ignored'
              example: '20210325'
            InvoiceNumber:
              type: string
              description: 'If invoice number is provided, then `InvoiceStatus` will be ignored and billed transaction for the given invoice date is returned. Note- If IncludeFees is true then this filter will be ignored'
              example: '8716711'
            ValidInvoiceDateOnly:
              type: boolean
              description: 'If passed as True, the transaction records with report date not equal to 9999-12-30 will be returned. When passed as False the above condition will not be checked. Note- If IncludeFees is true then this filter will be ignored'
              example: true
            InvoiceFromDate:
              type: string
              format: yyyyMMdd
              description: 'Filter invoiced transactions from the date provided. The date value should be within last 13 months. Maximum of 90 days duration allowed per search When InvoiceToDate is provided and InvoiceFromDate is null, then InvoiceFromDate will be calculated as (InvoiceToDate  90 days) or (CurrentDate  13 months) whichever is greater. Note- If IncludeFees is true then this filter will be ignored'
              example: '20210325'
            InvoiceToDate:
              type: string
              format: yyyyMMdd
              description: 'Filter invoiced transactions up until the date provided. When InvoiceFromDate is provided and InvoiceToDate is null, then InvoiceToDate will be calculated as (InvoiceFromDate + 90 days) or (CurrentDate) whichever is lesser. Note- If IncludeFees is true then this filter will be ignored'
              example: '20210325'
            FuelOnly:
              type: boolean
              description: When passed as True Only returned records with Fuel transactions. When passed as False the above condition will not be checked. Note- If IncludeFees is true then this filter will be ignored
              example: true
            IncludeFees:
              type: boolean
              description: When passed as True then sales item specific filters are ignored.  The response will include sales items along with fees.
              example: true
            SortOrder:
              type: string
              description: |-
                Allowed Sorting Options- 
                  - 1. TransactionDateAscending 
                  - 2. TransactionDateDescending 
                  - 3. GrossAmountDescending 
                  - 4. GrossAmountAscending 
                  - 5. NetAmountAscending 
                  - 6. NetAmountDescensding 
                  - Example value to be passed- 1,3,6 
                  - Note- If IncludeFees is true then this filter will be ignored
              example: '1,3,6'
          required:
            - Accounts
            - InvoiceStatus
        - $ref: '#/components/schemas/RequestBase'
        - $ref: '#/components/schemas/PagingRequestBase'
      x-stoplight:
        id: sxg68j3t91c3z
    MultiPricedTransactionResponse:
      description: Response object for endpoint */transaction/multipayerspricedtransactions*
      allOf:
        - type: object
          properties:
            Transactions:
              type: array
              description: List of transaction records
              uniqueItems: true
              items:
                $ref: '#/components/schemas/PricedTransaction'
        - $ref: '#/components/schemas/ResponseBase'
        - $ref: '#/components/schemas/PagingResponseBase'
      x-stoplight:
        id: q93ucbdq3poty
    PricedTransactionSummaryRequest:
      description: Request object for endpoint - Pricedtransactions
      allOf:
        - $ref: '#/components/schemas/PricedTransactionCriteria'
        - $ref: '#/components/schemas/RequestBase'
      required:
        - InvoiceStatus
      x-stoplight:
        id: log8mr2ira5yu
    PricedTransactionSummaryResponse:
      description: Response object for Pricedtransactionssummary
      allOf:
        - type: object
          properties:
            TransactionsSummary:
              type: array
              description: List of Transaction Summary records i.e. TransactionSummary Entity
              uniqueItems: true
              items:
                $ref: '#/components/schemas/TransactionSummary'
        - $ref: '#/components/schemas/ResponseBase'
      x-stoplight:
        id: wwhud2w3ki6ti
    FeesRequest:
      description: Request object for Transaction fees
      allOf:
        - $ref: '#/components/schemas/FeeCriteria'
        - $ref: '#/components/schemas/RequestBase'
        - $ref: '#/components/schemas/PagingRequestBase'
      required:
        - InvoiceStatus
      x-stoplight:
        id: e3xriyg6g01u1
    FeesResponse:
      description: Response object for endpoint */transaction/fees*
      allOf:
        - type: object
          properties:
            FeeItems:
              type: array
              description: List of Fee items i.e. Fee Item Entity
              uniqueItems: true
              items:
                $ref: '#/components/schemas/FeeItem'
        - $ref: '#/components/schemas/ResponseBase'
        - $ref: '#/components/schemas/PagingResponseBase'
      x-stoplight:
        id: 9zwu84btahu6y
    FeesSummaryRequest:
      description: Request object for endpoint */transaction/feessummary*
      allOf:
        - $ref: '#/components/schemas/FeeCriteria'
        - $ref: '#/components/schemas/RequestBase'
      required:
        - InvoiceStatus
      x-stoplight:
        id: 4luplko66c1qc
    FeeSummaryResponse:
      description: Response object for endpoint */transaction/feessummary*
      allOf:
        - type: object
          properties:
            FeeItemsSummary:
              type: array
              description: List of Fee Item Summary records i.e. FeeItemSummary Entity
              uniqueItems: true
              items:
                $ref: '#/components/schemas/FeeItemSummary'
        - $ref: '#/components/schemas/RequestBase'
      x-stoplight:
        id: t7cn5eqw1v72c
    PricedTransactionCriteria:
      description: This entity is created to be inherited into *PricedTransactionRequest* and *PricedTransactionSummaryRequest*
      allOf:
        - properties:
            ColCoId:
              type: integer
              description: 'The Collecting Company Id in the Shell Card Platform. Optional if ColCo Code is passed, else mandatory.  For example, 1 = Philippines and 5 = UK.'
              example: 1
            ColCoCode:
              type: integer
              description: 'The Collecting Company Code (i.e. Shell Code) of the selected payer. Optional if ColCo Id is passed, else mandatory.  For example, 86 = Philippines and 5 = UK. '
              example: 86
            PayerId:
              type: integer
              description: 'The Payer Id of the selected payment customer in the Shell Card Platform. Optional if Payer Number is passed, else mandatory.  Providing the Payer Id is recommended instead of the Payer Number for a better performing API call. '
              example: 123456
            PayerNumber:
              type: string
              description: 'Payer Number of the selected payer. Optional if PayerId is passed else Mandatory. Providing the Payer Id is recommended instead of the Payer Number for a better performing API call. '
              example: GB000000123
            AccountId:
              type: integer
              description: 'Account Id of the customer in the Shell Card Platform. When both Account Id and Account number are not present on request, the response will have transactions of all accounts under the selected payer. '
              example: 123456
            AccountNumber:
              type: string
              description: 'Account Number of the customer. When both Account Id and Account number are not present on request, the response will have transactions of all accounts under the selected payer.'
              example: GB000000123
            CardId:
              type: integer
              description: "Unique Card Id in the Shell Card Platform\r\nWhen both Card Id and Card PAN are not present on request, the response will have transactions of all cards under the selected payer or account.\r\n"
              example: 275549
            CardPAN:
              type: string
              description: "Card PAN. In the response body the PAN will be masked if the setting is enabled in the Shell Card Platform. \r\nWhen both Card Id and Card PAN are not present on request, the response will have transactions of all cards under the selected payer or account."
              example: '7002051006629890645'
            DriverName:
              type: string
              description: Driver Name of the card. Minimum of 4 characters should be provided else the value is not considered. Transactions with cards matching any part of the driver name value will be returned.  Note- If IncludeFees is true then this filter will be ignored
              example: MICHAEL
            VehicleRegistrationNumber:
              type: string
              description: Vehicle Registration (of Card record) Minimum of 4 characters should be provided else not considered Transactions with cards matching any part of the VRN value will be returned. Note- If IncludeFees is true then this filter will be ignored"
              example: A144
            InvoiceStatus:
              type: string
              description: |-
                Invoice status of the transactions. Mandatory. Possible options-
                  - I - Invoiced 
                  - U - Un-Invoiced 
                  - A - All
              enum:
                - I
                - U
                - A
              example: I
            ProductId:
              type: integer
              description: 'Product Id Note- If IncludeFees is true then this filter will be ignored '
              example: 21
            ProductCode:
              type: string
              description: Product Code Note- If IncludeFees is true then this filter will be ignored
              example: '10'
            PurchasedInCountry:
              type: string
              description: ISO 3166-1 Alpha-2 Country Code of where the transaction took place. Note- If IncludeFees is true then this filter will be ignored
              example: UK
            CardGroupId:
              type: integer
              description: Card Group Identifier. pass -1 for cards without card group. Note- If IncludeFees is true then this filter will be ignored
              example: 5
            SortOrder:
              type: string
              description: |-
                Allowed Sorting Options-
                  - 1 - TransactionDateAscending 
                  - 2 - TransactionDateDescending 
                  - 3 - GrossAmountDescending 
                  - 4 -  GrossAmountAscending 
                  - 5 -  DriverNameAscending (if Driver Name is null then VRN value will be considered) 
                  - 6 -  DriverNameDescending (if Driver Name is null then VRN value will be considered) 
                  - 7 -  VRNAscending (if VRN is null then Driver Name value will be considered) 
                  - 8 -  VRNDescending(if VRN is null then Driver Name value will be considered) 
                  - 9 -  NetAmountAscending 
                  - 10 -  NetAmountDescensding 
                  - Example value to be passed - 1,3,7 
                  - Note- If IncludeFees is true then this filter will be ignored
              enum:
                - '1'
                - '2'
                - '3'
                - '4'
                - '5'
                - '6'
                - '7'
                - '8'
                - '9'
                - '10'
              example: '1'
            FromDate:
              type: string
              format: yyyyMMdd
              description: Transactions from Date/Time  Should be with in last 7 months. Mandatory unless Period is provided.
              example: '20210718'
            ToDate:
              type: string
              format: yyyyMMdd
              description: 'Transactions to Date/Time When blank and FromDate is provided on the input, all transactions that took place after the given from date/time will be returned.'
              example: '20210818'
            Period:
              type: integer
              description: |-
                Transactions Period. This is ignored when FromDate/Todate is supplied on the request.  
                  - 1. Last 7 Days 
                  - 2. Last 30 Days 
                  - 3. Last 90 Days
              enum:
                - 1
                - 2
                - 3
              example: 1
            SiteCode:
              type: string
              description: 'Site Code Note- If IncludeFees is true then this filter will be ignored  '
              example: '050001'
            SiteGroupId:
              type: integer
              description: Site Group Id. Note- If IncludeFees is true then this filter will be ignored
              example: 202
            PostingDateFrom:
              type: string
              format: 'yyyyMMdd HH:mm:ss'
              description: 'Transaction Posting Date/time in the Cards Platform - From Date/time When the value of both PostingDateFrom and PostingDateTo are present in the request, then the value of PostingDateFrom must be less than PostingDateTo. Note- If IncludeFees is true then this filter will be ignored'
              example: '20210820 13:23:55'
            PostingDateTo:
              type: string
              format: 'yyyyMMdd HH:mm:ss'
              description: 'Transaction Posting Date/time in the Cards Platform  To Date/time When the value of both PostingDateFrom and PostingDateTo are present in the request, then the value of PostingDateFrom must be less than PostingDateTo. Note- If IncludeFees is true then this filter will be ignored'
              example: '20210821 13:23:55'
            SalesItemId:
              type: integer
              format: int64
              description: Unique Sales Item Identifier (Either Billed on Unblilled). Note- If IncludeFees is true then this filter will be ignored
              example: 18315958002
            TransactionId:
              type: string
              description: Unique Transaction Identifier. Note- If IncludeFees is true then this filter will be ignored
              example: XXyUwr03Ek20s3LD_890UY
            InvoiceDate:
              type: string
              format: yyyyMMdd
              description: "If invoice date is provided, then `InvoiceStatus` will be ignored and billed transaction for the given invoice date is returned. Note- If IncludeFees is true then this filter will be ignored\r\nRefer the API description for the execution sequence"
              example: '20210821'
            InvoiceNumber:
              type: string
              description: "If invoice number is provided, then `InvoiceStatus` will be ignored and billed transaction for the given invoice date is returned. Note- If IncludeFees is true then this filter will be ignored\r\nRefer the API description for the execution sequence"
              example: AT5456
            ValidInvoiceDateOnly:
              type: boolean
              description: 'If passed as True, the transaction records with report date not equal to 9999-12-30 will be returned. When passed as False the above condition will not be checked. Note- If IncludeFees is true then this filter will be ignored'
              example: true
            InvoiceFromDate:
              type: string
              format: yyyyMMdd
              description: "Filter invoiced transactions from the date provided. The date value should be within last 13 months. Maximum of 90 days duration allowed per search When InvoiceToDate is provided and InvoiceFromDate is null, then InvoiceFromDate will be calculated as (InvoiceToDate 90 days) or (CurrentDate 13 months) whichever is greater. Note- If IncludeFees is true then this filter will be ignored\r\nRefer the API description for the execution sequence"
              example: '20210821'
            InvoiceToDate:
              type: string
              format: yyyyMMdd
              description: "Filter invoiced transactions up until the date provided. When InvoiceFromDate is provided and InvoiceToDate is null, then InvoiceToDate will be calculated as (InvoiceFromDate + 90 days) or (CurrentDate) whichever is lesser. Note- If IncludeFees is true then this filter will be ignored\r\nRefer the API description for the execution sequence"
              example: '20210921'
            FuelOnly:
              type: boolean
              description: When passed as True Only returned records with Fuel transactions. When passed as False the above condition will not be checked. Note- If IncludeFees is true then this filter will be ignored
              example: true
            IncludeFees:
              type: boolean
              description: When passed as True then sales item specific filters are ignored.  The response will include sales items along with fees.
              example: true
            UseFieldId:
              type: boolean
              description: |-
                When set to True, the property names in the output will be replaced by Field IDs.
                  Optional
                 Default value â€“ False.
              example: true
              nullable: true
      x-stoplight:
        id: rzt4iqr97nkup
      type: object
    PricedTransaction:
      allOf:
        - type: object
          properties:
            Type:
              type: string
              description: The type of transaction. Either SalesItem or FeeItem.
              example: SalesItem
            CardId:
              type: integer
              description: 'Unique Card Identifier '
              example: 275549
            CardPAN:
              type: string
              description: 'Card PAN. The PAN will be masked if the setting is enabled in the Shell Card Platform. '
              example: '7002051006629890645'
            CardExpiry:
              type: string
              format: yyyyMMdd
              description: Card Expiry Date
              example: '20210921'
            TransactionDate:
              type: string
              format: yyyyMMdd
              description: 'Local transaction date where the transaction took place. For a fee item, this parameter will be populated with fee date.'
              example: '20210921'
            TransactionTime:
              type: string
              format: 'HH:mm:ss'
              description: 'Local transaction time where the transaction took place in 24-hour format. For a fee item, this parameter will be populated with fee date.'
              example: '04:26:34'
            UTCOffset:
              type: string
              description: 'UTC Offset extracted from Sales Date time Format HH mm ss (24 hours format) '
              example: '+08:00:00'
            FleetIdInput:
              type: string
              description: 'Fleet Id Input as entered by the drivers at the time of transaction '
              example: XYZ1234
            OdometerInput:
              type: integer
              description: 'Odometer Input as entered by the drivers at the time of transaction '
              example: 12345
            DriverName:
              type: string
              description: 'Driver Name embossed on the card '
              example: ANDREW GILBERRY
            VehicleRegistration:
              type: string
              description: 'Vehicle Registration Number embossed on the card '
              example: MV65YLH
            InvoiceCurrencyCode:
              type: string
              description: 'ISO 4217 currency code of the country '
              example: GBP
            InvoiceCurrencySymbol:
              type: string
              description: 'Currency symbol of the Invoice Currency Code  '
              example: Ã‚Â£
            TransactionCurrencyCode:
              type: string
              description: 'ISO 4217 currency code of the country '
              example: GBP
            TransactionCurrencySymbol:
              type: string
              description: 'Currency symbol of the Transaction Currency Code '
              example: Ã‚Â£
            TransactionNetAmount:
              type: number
              description: Net Amount
              example: 674
            TransactionTax:
              type: number
              description: Tax Amount
            TransactionGrossAmount:
              type: number
              description: Gross Amount
            InvoiceNetAmount:
              type: number
              description: 'Invoiced Net Amount. For a fee item, this parameter will be populated with fee InvoiceNetAmount.'
            InvoiceTax:
              type: number
              description: Invoiced Tax Amount
            InvoiceGrossAmount:
              type: number
              description: 'Invoice Gross Amount Note- For a fee item, this parameter will be populated with fee InvoiceGrossAmount.'
            PurchasedInCountry:
              type: string
              description: 'Country of Purchase  '
              example: 'France, Germany'
            AccountId:
              type: integer
              description: 'Account Id '
              example: 29484
            AccountNumber:
              type: string
              description: 'Account Number '
              example: GB99215176
            AccountName:
              type: string
              description: 'Account Name '
              example: MA LIMITED
            AccountShortName:
              type: string
              description: Account Short Name
              example: MAL
            Quantity:
              type: number
              description: Quantity/Volume
              example: 1
            FuelProduct:
              type: boolean
              description: True if the product on transaction is listed as a fuel product else return false
              example: true
            UnitPriceInTransactionCurrency:
              type: number
              description: Product Unit Price in transaction currency
              example: 12
            UnitPriceInInvoiceCurrency:
              type: number
              description: Product Unit Price in invoice currency
              example: 13
            UnitDiscountTransactionCurrency:
              type: number
              description: Unit Discount in transaction currency
              example: 1
            UnitDiscountInvoiceCurrency:
              type: number
              description: Unit Discount in invoice currency
              example: 2
            IsInvoiced:
              type: boolean
              description: 'True when the transaction is already invoiced, else return False'
              example: true
            InvoiceNumber:
              type: string
              description: Invoice Number if invoiced
              example: S04500493
            InvoiceDate:
              type: string
              format: 'yyyyMMdd HH:mm:ss'
              description: 'Invoice Date '
              example: '20211001 13:23:55'
            SiteCode:
              type: string
              description: 'Site Code '
              example: '050001'
            SiteName:
              type: string
              description: 'Site Name '
              example: CHARNOCK RICHARD NTHBOUND MWSA 0755
            SiteCountry:
              type: string
              description: 'Site Country '
              example: France
            Location:
              description: Geography Location entity for Site Location
              type: array
              items:
                type: object
                properties:
                  Latitude:
                    type: string
                    description: Latitude for the Site Geographic Location
                  Longitude:
                    type: string
                    description: Longitude for the Site Geographic Location
              example:
                - Latitude: '37.4224764'
                  Longitude: '-122.0842499'
              minItems: 0
              maxItems: 1
            CardGroupName:
              type: string
              description: 'Card Group Name '
              example: 006240 FIRE BRIGHT SOLUTIONS
            ReceiptNumber:
              type: string
              description: 'Receipt Number '
              example: '01234'
            ProductCode:
              type: string
              description: 'Product Code '
              example: '10'
            ProductName:
              type: string
              description: Product Name
              example: TMF Charges
            ProductGroupId:
              type: integer
              description: 'Product Group Id '
              example: 2
            ProductGroupName:
              type: string
              description: 'Product Group Name '
              example: All Fuels
            DelCoExchangeRate:
              type: number
              format: decimal
              description: Exchange rate from transaction currency to customer currency.
              example: 2.23
            ColCoExchangeRate:
              type: number
              description: ColCo Exchange Rate (Customer exchange rate)
              example: 2
            IsShellSite:
              type: boolean
              description: True when transaction occurred at a Shell site else return False
              example: true
            Network:
              type: string
              description: Network as configured in the Shell Card Platform
              example: 100016  ESSO BE
            SiteGroupId:
              type: integer
              description: Site Group Id
              example: 202
            SiteGroupName:
              type: string
              description: Site GroupName
              example: CZ 9100 ECONOMY NETWORK
            PostingDate:
              type: string
              format: yyyyMMdd HHmmss
              description: Transaction Posting Date
              example: '20181001 13:23:55'
            IssuerCode:
              type: string
              description: First digits of the Card PAN  7002 = Fleet   7077 = CRT The value could be null/blank for fees item.
              example: '7002'
            PurchasedInCountryCode:
              type: string
              description: ISO 3166-1 Alpha-2 code of the country where the transaction took place
              example: NL
            CustomerCountryCode:
              type: string
              description: ISO 3166-1 Alpha-2 code of the Customer Country
              example: NL
            CustomerCountry:
              type: string
              description: Name of the Customer Country
              example: Netherlands
            ReleaseCode:
              type: string
              description: 'Release code, 7th Digit of the Card PAN E.g.: 8 for 7002188'
              example: '8'
            CardGroupId:
              type: string
              description: Card group Identifier
              example: A12
            CardSequenceNumber:
              type: string
              description: '3 digits, Card sequence number and Check digit (Digit 16,17 and 18 on the card pan)'
              example: '002'
            CheckDigit:
              type: string
              description: 'Check digit, Last number of the card pan'
              example: '2'
            FleetIDDescription:
              type: string
              description: FleetId/CRN description in Card Platform configured at the account level
              example: A51617HAGH
            VATRate:
              type: number
              format: decimal
              nullable: true
              description: VAT Percentage 0.20 for 20%
              example: 0.2
            VATCategory:
              type: string
              description: 'VAT Category '
              example: '1'
            VATCountry:
              type: string
              description: VAT Country
              example: Netherlands
            EffectiveDiscountInTrxCurrency:
              type: number
              format: decimal
              nullable: true
              description: 'Effective Discount (excluding VAT, in transaction currency 4 digits'
              example: 0.2
            TransactionType:
              type: string
              description: Transaction Type E.g. Purchase when Card is Present else Blank
              example: ODP
            PINIndicator:
              type: string
              description: 'Pin Indicator (Indicates whether PIN used or not used at the time of transaction) E.g.: PIN Used or No PIN or Unknown.  The value could be null/blank for fees item.'
              example: 'Y'
            VATApplicable:
              type: string
              description: 'Is VAT Applicable for this transaction E.g.: Y or N'
              example: 'Y'
            NetInvoiceIndicator:
              type: string
              description: 'Net Invoice Indicator. Will the customer receive an invoice without VAT? E.g.: Y or N. The value could be null/blank for fees item.'
              example: 'N'
            CustomerCurrencyCode:
              type: string
              description: Customer currency code
              example: GBP
            CustomerCurrencySymbol:
              type: string
              description: Customer currency Symbol
              example: $
            EffectiveUnitDiscountInCustomerCurrency:
              type: number
              description: Effective Unit Discount (excluding VAT in Customer currency)
              example: 23
            EffectiveDiscountInCustomerCurrency:
              type: number
              description: Effective Discount (excluding VAT in Customer currency)
              example: 32
            VATonNetAmountInCustomerCurrency:
              type: number
              description: VAT on Net Amount (in Customer currency)
              example: 12
            DiscountType:
              type: string
              description: 'Discount Type E.g.: 1-None 2-Pence per unit 3-Percentage"'
              example: '1'
            TransactionStatus:
              type: string
              description: Transaction status "U"-  Uninvoiced or "I" - Invoiced
              example: U
            SalesItemId:
              type: integer
              format: int64
              description: 'Unique Sales Item Identifier For a fee item, this parameter will be populated with SalesItemId.'
              example: 18315958002
            PayerGroup:
              type: string
              description: Payer Group applicable for the Large Customer NL+8 digit code
              example: '12119008'
            PayerGroupName:
              type: string
              description: Payer Group Name
              example: SHELL GROUP OF COMPANIES
            RefundFlag:
              type: string
              description: 'Refund Flag N for Not Refunded and Y for Refunded. '
              example: 'N'
            OriginalSalesItemId:
              type: string
              description: Shows Sales Item Id of the original item that was refunded
              example: A1256
            DelcoName:
              type: string
              description: Delco Name
              example: SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV
            DelcoCode:
              type: string
              description: 'Delco Code '
              example: '014'
            PayerNumber:
              type: string
              description: Payer number of the selected payer
              example: PH50000843
            PayerName:
              type: string
              description: Payer name of the selected payer
              example: PARKLEY & CO
            CardExpiryPeriod:
              type: string
              description: Year/Month of the Card Expiry captured on the transaction
              example: '1901'
            AuthorisationCode:
              type: string
              description: Authorisation code of the transaction
              example: '011256'
            TransactionId:
              type: string
              description: Unique id of the transaction that may include one or more salesitems
              example: io9KVXk1UkW57XWKyeaHHg
            TransactionLine:
              type: string
              description: Transaction line item number
              example: '1'
            AllowClearing:
              type: string
              description: 'Is the Sales Item allowed for clearing? i.e. not written off E.g.: Y or N The value could be null/blank for fees item.'
              example: 'Y'
            CRMNumber:
              type: string
              description: CRM Case number if the sales item is in dispute
              example: CR1234
            DisputeStatus:
              type: string
              description: |-
                Sales Item Dispute Status if disputed 
                  - 0 - No Dispute 
                  - 1 - In Dispute 
                  - 2 - Re-Instated 
                  - 3 - Adjusted 
                  - 4 - Written Off by Colco 
                  - 5 - Written Off by Delco 
                  - 6 - Charged Back to Site
              example: '4'
            RebateRate:
              type: number
              format: decimal
              description: Unit discount in customer currency.
              example: 28.279
            DelCoToColCoExchangeRate:
              type: number
              description: Exchange rate from transaction currency to customer currency.
              example: 1
            NetEuroAmount:
              type: number
              format: decimal
              description: Net euro amount.
              example: 37.93
            EuroRebateAmount:
              type: number
              description: Euro rebate amount.
              example: 0
            EuroVATAmount:
              type: number
              format: decimal
              description: Euro VAT amount.
              example: 7.96
            ParentCustomerNumber:
              type: string
              description: Parent customer number
              example: '12121'
            ParentCustomerName:
              type: string
              description: Parent customer name.
              example: MICHAEL
            ParentCustomerId:
              type: integer
              description: Parent customer id.
              example: 7121121
            IncomingSiteNumber:
              type: string
              description: 'Incoming Site Number '
              example: '100021'
            IncomingSiteDescription:
              type: string
              description: 'Incoming Site Description '
              example: HN3 INTI_02-82.02
            IncomingCurrencyCode:
              type: string
              description: 'Incoming Currency Code '
              example: GBP
            IncomingProductCode:
              type: string
              description: 'Incoming Product Code '
              example: '30'
            CreditDebitCode:
              type: string
              description: 'Credit Debit Code. D or C. The value could be null/blank for fees item. '
              example: D
            CorrectionFlag:
              type: string
              description: Correction Flag. Y or N The value could be null/blank for fees item.
              example: 'N'
            Additional1:
              type: string
              description: Additional1
              example: Additional Data
            Additional2:
              type: string
              description: Additional2
              example: Additional Data
            Additional3:
              type: string
              description: Additional3
              example: Additional Data
            Additional4:
              type: string
              description: Additional4
              example: Additional Data
            RebateonNetAmountInCustomerCurrency:
              type: number
              format: decimal
              description: 'Rebate on Net Amount in Customer Currency '
              example: 0.735
            RebateonNetAmountInTransactionCurrency:
              type: number
              format: decimal
              description: 'Rebate on Net Amount in Transaction Currency '
              example: 0.735
            NetworkCode:
              type: string
              description: 'Network Code '
              example: AVEE PTUAZONW CUBFAO COSFS
            TrnIdentifier:
              type: string
              description: Transaction Identifier
              example: A1234
            CardType:
              type: string
              description: Card Type
              example: A1234
            DelcoListPriceUnitNet:
              type: number
              format: decimal
              description: 'Delco List Price Unit Net '
              example: 30.5
            DelcoRetailPriceUnitNet:
              type: number
              format: decimal
              description: 'Retail Net Price (or pump net price) per Unit in transaction currency '
              example: 1.921
            DelcoRetailPriceUnitGross:
              type: number
              format: decimal
              description: Retail gross price (or pump gross price) per unit in transaction currency
              example: 1.921
            DelcoRetailValueTotalNet:
              type: number
              format: decimal
              description: Retail net price (or net pump price) in transaction currency
              example: 1.921
            DelcoRetailValueTotalGross:
              type: number
              format: decimal
              description: Retail gross price (or gross pump price) in transaction currencya
              example: 1.921
            CustomerRetailPriceUnitGross:
              type: number
              format: decimal
              description: Retail gross price (or pump gross price) per unit in customer currency
              example: 1.921
            CustomerRetailValueTotalGross:
              type: number
              format: decimal
              description: Retail gross price (or gross pump price) in customer currency
              example: 1.921
            CustomerRetailValueTotalNet:
              type: number
              format: decimal
              description: Retail net price (or net pump price) in customer currency
              example: 1.921
            TransactionTypeDescription:
              type: string
              description: Transaction Type Description
              example: A12
      x-stoplight:
        id: siyqtog622cqo
    TransactionSummary:
      allOf:
        - type: object
          properties:
            ProductId:
              type: integer
              description: Product Id
            ProductCode:
              type: string
              description: Product Code
              example: '10'
            ProductName:
              type: string
              description: Product Name
              example: Unleaded - High octane
            ProductGroupId:
              type: integer
              description: 'Product Group Id '
              example: 2
            ProductGroupName:
              type: string
              description: 'Product Group Name '
              example: All Fuels
            SiteGroupId:
              type: integer
              description: Site Group Id configured in Shell Card Platform
              example: 202
            SiteGroupName:
              type: string
              description: Site Group Name
              example: CZ 9100 ECONOMY NETWORK
            TotalFuelQuantity:
              type: number
              format: decimal
              description: Total Fuel Quantity (of Fuel products only)
            TotalNetAmount:
              type: number
              format: decimal
              description: Total Net amount in invoice currency
            TotalGrossAmount:
              type: number
              format: decimal
              description: Total Gross amount in invoice currency
            InvoiceCurrencyCode:
              type: string
              description: 'ISO 4217 currency code of the country '
              example: GBP
            InvoiceCurrencySymbol:
              type: string
              description: 'Currency symbol of the Invoice Currency Code  '
              example: $
            CustomerRetailValueTotalNet:
              type: number
              format: decimal
              description: Sum of the retail net price (or net pump price) in customer currency.
              example: 21.9
            CustomerRetailValueTotalGross:
              type: number
              format: decimal
              description: Sum of the retail gross price (or gross pump price) in customer currency.
              example: 23.5
      x-stoplight:
        id: nskf7rmkbblwh
    FeeCriteria:
      description: This entity is created to be inherited into *FeesRequest* and *FeesSummaryRequest*
      allOf:
        - properties:
            ColCoId:
              type: integer
              description: 'The Collecting Company Id in the Shell Card Platform. Optional if ColCo Code is passed, else mandatory.  For example, 1 = Philippines and 5 = UK.'
              example: 1
            ColCoCode:
              type: integer
              description: 'The Collecting Company Code (i.e. Shell Code) of the selected payer. Optional if ColCo Id is passed, else mandatory.  For example, 86 = Philippines and 5 = UK. '
              example: 86
            PayerId:
              type: integer
              description: 'The Payer Id of the selected payment customer in the Shell Card Platform. Optional if Payer Number is passed, else mandatory.  Providing the Payer Id is recommended instead of the Payer Number for a better performing API call. '
              example: 123456
            PayerNumber:
              type: string
              description: 'Payer Number of the selected payer. Optional if PayerId is passed else Mandatory. Providing the Payer Id is recommended instead of the Payer Number for a better performing API call. '
              example: GB000000123
            AccountId:
              type: integer
              description: 'Account Id of the customer in the Shell Card Platform. When both Account Id and Account number are not present on request, the response will have fee items of all accounts under the selected payer. '
              example: 123456
            AccountNumber:
              type: string
              description: 'Account Number of the customer. When both Account Id and Account number are not present on request, the response will have fee items of all accounts under the selected payer.'
              example: GB000000123
            CardId:
              type: integer
              description: "Unique Card Id in the Shell Card Platform\r\n\r\nWhen both Card Id and Card PAN are not present on request, the response will have all the fee items under the selected payer or account."
              example: 275549
            CardPAN:
              type: string
              description: "Card PAN. In the response body the PAN will be masked if the setting is enabled in the Shell Card Platform. \r\nWhen both Card Id and Card PAN are not present on request, the response will have all the fee items under the selected payer or account or card group."
              example: '7002051006629890645'
            InvoiceStatus:
              type: string
              description: |-
                Invoice status of the transactions. Mandatory. Possible options-
                  - I - Invoiced 
                  - U  Un-Invoiced 
                  - A  All
              enum:
                - I
                - U
                - A
              example: I
            FeeTypeGroup:
              type: string
              description: |-
                Fee type group in under which the Fee item is generated. Allowed values - 
                  - Account Charges 
                  - Card Charges 
                  - Other Charges
              example: Account Charges
            FeeTypeId:
              type: integer
              description: |-
                Fee Type Identifier
                  - 1 - Simple Fee 
                  - 3 - Card Event Fee 
                  - 4 - Customer Event Fee
              enum:
                - 1
                - 3
                - 4
              example: 1
            FromDate:
              type: string
              description: Fee Item From Date/Time should be within the last 6 months. Maximum of 60 days duration allowed per search.
              format: yyyyMMdd
              example: '20210823'
            ToDate:
              type: string
              description: 'Fee Item To Date/Time. When blank and FromDate is provided on the input, all fee items that took place after the given from date/time should be returned. Note that the search is allowed for the maximum of 60 days. Hence if the FromDate is older than 60 days from current date, then the fee items for 60 days from FromDate will be returned.  '
              format: yyyyMMdd
              example: '20210823'
            Period:
              type: integer
              description: |-
                Fee items Period. This is ignored when FromDate/ToDate is supplied in the request.  
                  - 1. Last 7 Days 
                  - 2.  Last 30 Days 
                  - 3.  Last 90 Days 
                  - 4.  Last 180 Days 
              enum:
                - 1
                - 2
                - 3
                - 4
              example: 1
            IncludeCancelledItems:
              type: boolean
              description: 'When True, cancelled fee items are included in the  API response.'
              example: true
            ProductId:
              type: integer
              description: |-
                Product Id. Allowed values
                  - 100 - Service Fee
                  - 102 - Invoice Production Fee 
                  - 103 - Account Fee
                  - 104 - Transaction Fee
                  - 105 - Card Membership Fee 
              enum:
                - 100
                - 102
                - 103
                - 104
                - 105
              example: 100
            ProductCode:
              type: string
              description: Product Code
              example: '102'
            LineItemDescription:
              type: string
              description: Line item description. Minimum of 4 characters should be provided else not considered. Those fee items that have the entered value at any part of the line item description will be returned.
              minLength: 4
            SortOrder:
              type: string
              description: |-
                Allowed Sorting Options- 
                  - 1. FeeDateAscending 
                  - 2. FeeDateDescending 
                  - 3. NetAmountAscending 
                  - 4. NetAmountDescending              
              example: '1'
      x-stoplight:
        id: 21xjusqiy8vjq
      type: object
    FeeItem:
      description: This is a response object.
      allOf:
        - type: object
          properties:
            FeeItemId:
              type: integer
              description: Fee Item unique identifier in the Shell Card Platform
              example: 1234
            AccountId:
              type: integer
              description: Account Id
              example: 29484
            AccountNumber:
              type: string
              description: Account Number
              example: GB99215176
            AccountShortName:
              type: string
              description: Account short name
              example: GB123
            InvoiceAccountId:
              type: integer
              description: Invoice Account Id (i.e. Customer Id in Cards Platform).
              example: 123456
            InvoiceAccountNumber:
              type: string
              description: Invoice Account Number of the selected payer.
              example: GB0000013
            InvoiceAccountShortName:
              type: string
              description: Invoice Account short name
              example: GB123
            PayerId:
              type: integer
              description: Payer Id
              example: 29484
            PayerNumber:
              type: string
              description: Payer Number
              example: GB99215176
            PayerShortName:
              type: string
              description: Payer short name
              example: PARKLEY
            CardId:
              type: integer
              description: Unique Card Id in the Shell Card Platform
              example: 275549
            CardPAN:
              type: string
              description: 'Card PAN. In the response body the PAN will be masked if the setting is enabled in the Shell Card Platform. '
              example: '7002051006629890645'
            CardGroupId:
              type: integer
              description: Card Group Id
              example: 5
            CardGroupName:
              type: string
              description: Card Group Name
              example: 006240 FIRE BRIGHT SOLUTIONS
            FeeTypeId:
              type: integer
              description: Fee type identifier.
              example: 3
            FeeType:
              type: string
              description: Fee type description
              example: '89'
            FeeTypeGroup:
              type: string
              description: 'Fee type group in under which the Fee item is generated. '
              enum:
                - Account
                - Card
                - Others
              example: Account
            FeeRuleId:
              type: integer
              description: Fee rule identifier
              example: 12345
            FeeRuleDescription:
              type: string
              description: Fee rule description
              example: NL/GAGO/D018
            FeeRuleTiers:
              type: array
              description: List of FeeRuleTier entity. The attributes of the FeeRuleTier entity are described in the below rows.
              uniqueItems: true
              items:
                type: object
                properties:
                  TierMin:
                    type: integer
                    description: Tier Minimum value
                    example: 123
                  TierMax:
                    type: integer
                    description: Tier Maximum value
                    example: 321
                  DateEffective:
                    type: string
                    description: '"Date effective. '
                    format: yyyyMMdd
                    example: '20180131'
                  DateTerminated:
                    type: string
                    description: Date Terminated
                    format: yyyyMMdd
                    example: '20180907'
                  TierValue:
                    type: number
                    format: decimal
                    description: Tier value/ Fees to apply
                    example: 12.23
                  FeeRuleBasisID:
                    type: integer
                    description: Fee Rule Basis ID
                    example: 1
                  FeeRuleBasisDescription:
                    type: string
                    description: 'Fee Rule Basis Description '
                    example: Currency Per Unit
            FeeItemDate:
              type: string
              description: Local Fee Item Date of when the transaction took place Format yyyyMMdd
              format: yyyyMMdd
              example: '20180604'
            FeeItemTime:
              type: string
              description: 'Local Fee Item Time of where the transaction took place Format HH:mm:ss (24 hours format)'
              example: '121018'
            IsManual:
              type: boolean
              description: True/False.Is manual
              example: true
            IsCancelled:
              type: boolean
              description: True/False.Is cancelled
              example: true
            CustomerCurrencyCode:
              type: string
              description: 'ISO 4217 currency code of the country '
              example: GBP
            CustomerCurrencySymbol:
              type: string
              description: 'Currency symbol of the Currency Code '
              example: $
            ProductId:
              type: integer
              description: Product Id
              example: 102
            ProductCode:
              type: string
              description: Product Code
              example: '2'
            ProductName:
              type: string
              description: Product Name
              example: Service fee
            ProductGroupId:
              type: integer
              description: 'Product Group Id '
              example: 22
            ProductGroupName:
              type: string
              description: 'Product Name '
              example: Card related fees
            LineItemDescription:
              type: string
              description: Line Item Description generally the quantity as printed on Invoice or the manually keyed in description for manual fees
              example: charge
            Quantity:
              type: integer
              description: Quantity
              example: 1
            IsInvoiced:
              type: boolean
              description: True/False. Is fee item invoiced
              example: true
            VATCountryCode:
              type: string
              description: VAT country ISO code
              example: QWER
            VATCountryName:
              type: string
              description: VAT country name
              example: QWER
            VATPercentage:
              type: number
              description: VAT percentage
              format: decimal
              example: 0.1
            VATCategoryID:
              type: integer
              description: VVAT Category identifier
              example: 1
            VATCategoryDescription:
              type: string
              description: VVAT Category description
              example: QWER
            LegislativeRegionId:
              type: integer
              description: Legislative region id
              example: 2
            LegislativeRegionName:
              type: string
              description: Legislative region name
              example: qwert
            SystemEntryDate:
              type: string
              description: System entry date
              format: yyyyMMdd
              example: '20170912'
            SystemEntryTime:
              type: string
              description: System entry time
              example: '10:20'
            ColCoNetAmount:
              type: number
              format: decimal
              description: ColCo net amount
              example: 100.9
            ColCoVATAmount:
              type: number
              format: decimal
              description: ColCo vat amount
              example: 104.5
            ColCoGrossAmount:
              type: number
              format: decimal
              description: ColCo gross amount
              example: 101.7
            InterimInvoiceId:
              type: integer
              description: Interim Invoice Id
              example: 1010191
            InterimInvoiceNumber:
              type: string
              description: Interim invoice number
              example: G1010191
            InvoiceId:
              type: integer
              description: Invoice id
              example: 10101
            InvoiceNumber:
              type: string
              description: Interim Invoice Id
              example: '10209'
            InvoiceDate:
              type: string
              description: Invoice date
              format: yyyyMMdd
              example: '20180807'
            CustomerExchangeRate:
              type: number
              format: decimal
              description: Customer exchange rate
              example: 10.34
            InvoiceNetAmount:
              type: number
              format: decimal
              description: Invoice net amount
              example: 19.34
            InvoiceGrossAmount:
              type: number
              format: decimal
              description: Invoice gross amount
              example: 50.23
            InvoiceVATAmount:
              type: number
              format: decimal
              description: Invoice VAT amount
              example: 10.2
            ReverseCharge:
              type: boolean
              description: Reverse charge
              example: true
            OriginalFeeItemId:
              type: integer
              description: Original Fee Item id
              example: 12345
            OriginalCurrencyCode:
              type: string
              description: Original CurrencyCode
              example: GBP
            OriginalCurrencySymbol:
              type: string
              description: Original CurrencySymbol
              example: $
            OriginalUnitPrice:
              type: number
              format: decimal
              description: Original UnitPrice
              example: 1.2
            OriginalNetAmount:
              type: number
              format: decimal
              description: Original NetAmount
              example: 13.8
            OriginalVATAmount:
              type: number
              format: decimal
              description: Original VATAmount
              example: 17.23
            OriginalGrossAmount:
              type: number
              format: decimal
              description: Original GrossAmount
              example: 18.9
            OriginalExchangeRate:
              type: number
              format: decimal
              description: Original FeeItem exchange rate
              example: 156.2
            OriginalLegislativeRegionId:
              type: integer
              description: Original legislative region id
              example: 1234
            OriginalLegislativeRegionName:
              type: string
              description: Original legislative region name
              example: '190'
            Frequency:
              type: string
              description: Fee frequency derived from Fee rules if applicable
              example: 1- Daily (all days)
            FeeItemCardLevelBreakup:
              type: string
              description: Fee breakup at card level for Fee Items where applicable Concatenated with | character
              example: PAN|CardId
            OriginalFeeItemInvoiceId:
              type: integer
              description: Invoice Id/ Billing Document Id of the original fee item (when not null)
              example: 1
            OriginalFeeItemInvoiceNumber:
              type: string
              description: Invoice Number of the original fee item (when not null)
              example: QW1
            OriginalFeeItemInvoiceDate:
              type: string
              description: Invoice Date of the original fee item (when not null).
              format: yyyyMMdd
              example: '101219'
            DriverName:
              type: string
              description: Driver name embossed on the Card
              example: ANDREW GILBERRY
            EmbossText:
              type: string
              description: Text embossed on the Card
              example: ANDREW
            VRN:
              type: string
              description: Reg. Number embossed on the Card
              example: MV65YLH
      x-stoplight:
        id: jav05g53k42dd
    FeeItemSummary:
      description: This is a response object.
      allOf:
        - type: object
          properties:
            FeeTypeGroup:
              type: string
              description: 'Fee type group in under which the Fee item is generated. '
              example: Account
            FeeTypeId:
              type: string
              description: 'Fee Type Id ID  Description '
              example: '1'
            ProductId:
              type: integer
              description: 'Product Id  '
              example: 102
            ProductCode:
              type: string
              description: 'Product Code  '
              example: Invoice production fee
            ProductName:
              type: string
              description: 'Product Name '
              example: Invoice production fee
            ProductGroupId:
              type: integer
              description: 'Product Group Id '
              example: 22
            ProductGroupName:
              type: string
              description: 'Product Group Name '
              example: Card related fees
            TotalQuantity:
              type: number
              format: decimal
              description: Total Quantity
              example: 2
            TotalInvoiceNetAmount:
              type: number
              format: decimal
              description: Total Net amount in invoice currency
              example: 22.23
            TotalInvoiceGrossAmount:
              type: number
              format: decimal
              description: Total Gross amount in invoice currency
              example: 28.92
            TotalInvoiceVATAmount:
              type: number
              format: decimal
              description: Total VAT amount in invoice currency
              example: 10.02
            InvoiceCurrencyCode:
              type: string
              description: 'ISO 4217 currency code of the country '
              example: GBP
            InvoiceCurrencySymbol:
              type: string
              description: 'Currency symbol of the Invoice Currency Code  '
              example: Ã‚Â£
      x-stoplight:
        id: 2gkipgteeoxgx
    ErrorObject:
      title: ErrorObject
      type: object
      properties:
        RequestId:
          type: string
          description: 'Unique request identifier passed from end user. This identifier helps in tracing a transaction '
        Status:
          type: string
          description: 'Indicates overall status of the request. Allowed values: SUCCES, FAILED, PARTIAL_SUCCESS'
        Errors:
          $ref: '#/components/schemas/ErrorDetails'
      x-stoplight:
        id: k85s7z59wsovf
    ErrorDetails:
      title: ErrorDetails
      type: object
      properties:
        Code:
          type: string
          description: Error code representing the error encountered
        Title:
          type: string
          description: Error type description
        Detail:
          type: string
          description: Detailed inforamtion about the error
        AdditionalInfo:
          type: object
          description: Applicable when more details related to error to be returned
      x-stoplight:
        id: wdtagrsiet57a
    PricedRequestDataV2:
      title: PricedRequestData
      type: object
      description: 'This endpoint allows querying the transaction data (i.e. Priced, Billed and Unbilled sales items) from SFSBI. It provides a flexible search criteria and supports paging'
      properties:
        ColCoCode:
          type: string
          example: '032'
          description: Collecting Company Code (Shell Code) of the selected payer.
        ColCoId:
          type: integer
          example: 32
          description: The Collecting Company Id in the Shell Card Platform.
        InvoiceStatus:
          type: string
          description: 'Invoice status of the transactions. Mandatory Possible options:I - Invoiced, U – Un-Invoiced, A – All'
          minLength: 1
          maxLength: 1
          example: A
          enum:
            - I
            - U
            - A
        PayerNumber:
          type: string
          example: DE26685263
          description: Payer Number of the selected payer.
          minLength: 1
        AccountId:
          type: integer
          example: 29484
          description: Account Id (customer id)
        AccountNumber:
          type: string
          example: DE26667080
          description: Account Number of the selected account.
        DriverName:
          type: string
          description: Driver Name (of Card record)
          minLength: 4
          maxLength: 40
          example: HH NX 508
        CardId:
          type: integer
          example: 12435
          description: Unique Card Id in the Shell Card Platform
        CardGroupId:
          type: integer
          description: Card Group Id
          example: 40000
        CardPAN:
          type: string
          description: Full Card PAN
          example: '7002051006629890645'
        ProductCode:
          type: string
          description: Product Code – As Per Global configuration
          minLength: 1
          maxLength: 8
          example: '10'
        ProductName:
          type: string
          description: Product Name – As Per Global configuration
          example: Diesel AGO
          maxLength: 128
          minLength: 1
        SiteCode:
          type: string
          description: Site Code where the transaction occured
          example: '05000100'
          minLength: 8
          maxLength: 87
        IncomingSiteNumber:
          type: string
          description: Site number for the transaction
          example: '100021'
          minLength: 4
          maxLength: 10
        InvoiceDate:
          type: string
          example: '2022-01-01 00:00:00'
          description: Returns the billed transaction for the given invoice date
        InvoiceNumber:
          type: string
          example: '3201016193'
          minLength: 10
          maxLength: 10
          description: Returns the billed transaction for the given invoice number
        PurchasedInCountryCode:
          type: string
          description: Purchased InCountryCode, ISO Code
          example: GB
          minLength: 2
          maxLength: 2
        PurchasedInCountry:
          type: string
          example: United Kingdom
          description: "\t\nNetwork Delco PurchasedCountryName"
        SiteGroupId:
          type: integer
          description: Site Group Id
          example: 202
        VehicleRegistrationNumber:
          type: string
          description: Vehicle Registration (of Card record)
          minLength: 4
          maxLength: 128
        FeeTypeId:
          type: integer
          description: Card Id (i.e. Unique Card Id)
          example: 275549
        LineItemDescription:
          type: string
          description: Item identifier in the transaction.
          maxLength: 128
          minLength: 4
          example: ABC3
        Cards:
          type: array
          description: |-
            This entity accepts the list of CardId to filter in the response.
            Note: The number of cardId allowed to be passed in the request is configurable to a maximum of 500 cards.
          minItems: 1
          maxItems: 500
          items:
            type: integer
        SortOrder:
          type: string
          description: "Allowed Sorting Options\n1.\tTransactionDateAscending\n2.\tTransactionDateDescending\n3.\tGrossAmountDescending\n4.\tGrossAmountAscending\n5.\tNetAmountAscending\n6.\tNetAmountDescensding"
          example: '5'
          minLength: 1
          enum:
            - '1'
            - '2'
            - '3'
            - '4'
            - '5'
            - '6'
          maxLength: 1
        FromDate:
          type: string
          example: '2022-01-01 00:00:00'
          minLength: 10
          maxLength: 19
          description: From transaction delivery date
        ToDate:
          type: string
          example: '2022-01-01 00:00:00'
          minLength: 10
          maxLength: 19
          description: To transaction delivery date
        Period:
          type: integer
          description: |-
            Pass below one of the value as per the required transaction period
            1. Last 7 Days
            2. Last 30 Days
            3. Last 90 Days
          example: 3
          enum:
            - 1
            - 2
            - 3
        PostingDateFrom:
          type: string
          example: '2022-01-01 00:00:00'
          minLength: 10
          maxLength: 19
          description: 'Transaction posting start date and time '
        PostingDateTo:
          type: string
          example: '2022-01-01 00:00:00'
          minLength: 10
          maxLength: 19
          description: Transaction posting end date and time
        TransactionItemId:
          type: string
          description: Unique id of the transaction that may include one or more salesitems
          example: io9KVXk1UkW57XWKyeaHHg
        FuelOnly:
          type: boolean
          description: Is FuelOnly indicator
          default: false
        IncludeFees:
          type: boolean
          description: |-
            When passed as ‘true’ then all sales items along with fees will be included in the response and the follwoing filteres will be ignored
            * InvoiceNumber
            * InvoiceDate
            * PostingDateFrom
            * PostingDateTo
        IsMultipayer:
          type: boolean
          description: If true then returns all the data linked tothe payer group of the provided PayerNumberin the request
        ValidInvoiceDateOnly:
          type: boolean
          description: When passed as ‘True’ the transactions records with report date not equal to 9999-12-30 will be returned. When passed as ‘False’ the above condition will not be checked.
          default: false
        InvoiceFromDate:
          type: string
          example: '2022-01-01 00:00:00'
          minLength: 10
          maxLength: 19
          description: 'Invoice From Date, this is a search criterion to filter invoiced transactions with invoice date from this date.'
        InvoiceToDate:
          type: string
          example: '2022-01-01 00:00:00'
          minLength: 10
          maxLength: 19
          description: 'Invoice To Date, this is a search criterion to filter invoiced transactions with invoice date until this date.'
        HostingCollectingCompanyNumber:
          type: string
          description: 'Hosting Collecting Company Number of the selected payer. '
          example: '032'
        Search:
          type: string
          description: Search based on DriverName or VRN
          example: 2K89909
        TransactionId:
          type: string
          description: Unique id of the transaction that may include one or more salesitems
          example: io9KVXk1UkW57XWKyeaHHg
      required:
        - ColCoCode
        - InvoiceStatus
        - PayerNumber
      x-stoplight:
        id: a5nvoie8cj27a
    PricedResponseDataV2:
      title: PricedResponseData
      type: object
      properties:
        AccountName:
          type: string
          example: Blue Colour Ltd
          minLength: 5
          maxLength: 36
          description: Name of the account
        AccountId:
          type: integer
          example: 29484
          description: Account Id (i.e. Customer Id of the Sub Account) of the selected account.
        AccountNumber:
          type: string
          description: AccountNumber of the selected account.
          example: DE26667080
        AccountShortName:
          type: string
          minLength: 5
          maxLength: 25
          description: Short name of the account
          example: Mathew
        Additional1:
          type: string
          example: GBALLEGO0002452
          minLength: 14
          maxLength: 20
          description: Additional data
        Additional2:
          type: string
          example: GBALLEGO0002452
          description: Additional data
          minLength: 14
          maxLength: 20
        Additional3:
          type: string
          minLength: 14
          maxLength: 20
          description: Additional data
          example: GBALLEGO0002452
        Additional4:
          type: string
          description: Additional data
          minLength: 14
          maxLength: 20
          example: GBALLEGO0002452
        AllowClearing: 
          type: string
          minLength: 4
          maxLength: 25
          example: 'Null'
          description: Is the Sales Item allowed for clearing? i.e. not written off
        AuthorisationCode:
          type: integer
          example: 300796
          format: int32
          minimum: 1
          maximum: 999999
          description: Autorization code
        TransactionStatus:
          type: string
          example: 'Y'
          minLength: 1
          maxLength: 1
          description: Status of the transaction
        DriverName:
          type: string
          description: Driver Name of Card record
          example: SATTY BHAMRA
          minLength: 5
          maxLength: 25
        CardExpiryPeriod:
          type: integer
          format: int32
          example: 2204
          minimum: 1
          maximum: 9999
          description: Year/Month of the Card Expiry captured on the Card
        CardExpiry:
          type: string
          example: '20220101'
          description: Card Expiry Date
        CardGroupId:
          type: integer
          description: Card group ID (auto generated by Cards Platform)
          example: 40000
          minimum: 1
          maximum: 99999
          format: int32
        CardGroupName:
          type: string
          description: Group nmae of the card
          example: 006240 FIRE BRIGHT SOLUTIONS
        IssuerCode:
          type: integer
          example: 7002
          minimum: 1
          maximum: 9999
          description: First 4 digits of the Card PAN 
        CardPAN:
          type: string
          example: '7002053465789891000'
          description: Mask PAN if enabled at configuration (Mask all digits except the Last 6 digits of the PAN)
          minLength: 19
          maxLength: 19
        ReleaseCode:
          type: integer
          minimum: 1
          maximum: 10
          example: 9
          format: int32
          description: Release code, 7th Digit of the Card PAN
        CardSequenceNumber:
          type: integer
          example: 617
          minimum: 1
          maximum: 999
          format: int32
          description: 3 digits, Card sequence number and Check digit (Digit 16,17 and 18 on the card pan)
        CardType:
          type: string
          example: GB STD FLT NAT SINGLE R9
          minLength: 1
          maxLength: 50
          description: Type of card
        ColCoCode:
          type: string
          description: Collecting Company Code (Shell Code) of the selected payer.
          example: '014'
          format: int32
          minLength: 3
          maxLength: 3
        UnitDiscountInvoiceCurrency:
          type: number
          example: -0.0051
          description: Unit discount Invoice currency
        ColCoExchangeRate:
          type: number
          example: 0.851858
          description: Colco exchange rate
        InvoiceCurrencySymbol:
          type: string
          example: GBP
          minLength: 3
          maxLength: 3
          description: Currency symbol on which the invoice was raised
        CorrectionFlag:
          type: boolean
          description: Is there any correction
        CRMNumber:
          type: number
          minimum: 10
          maximum: 10
          description: CRM Case number if the sales item is in dispute
        CustomerCountry:
          type: string
          example: United Kingdom
          minLength: 5
          maxLength: 30
          description: Customer country
        CustomerCurrencyCode:
          type: string
          example: GBP
          minLength: 3
          maxLength: 3
          description: Curreny which customer uses to transact.
        CustomerCurrencySymbol:
          type: string
          minLength: 1
          maxLength: 1
          example: £
          description: Custome currency symbol
        RebateonNetAmountInCustomerCurrency:
          type: number
          format: float
          description: Rebate on net amount in customer currency
        EffectiveDiscountInCustomerCurrency:
          type: number
          example: -0.22
          format: float
          description: Effective discount in customers currency
        EffectiveUnitDiscountInCustomerCurrency:
          type: number
          format: float
          example: -0.0051
          description: effectiive unit discount in customers currency
        UnitPriceInInvoiceCurrency:
          type: number
          example: 1.1024
          format: float
          description: Product Unit Price in invoice currency
        InvoiceTax:
          type: number
          example: 0
          description: Invoiced Tax Amount
        InvoiceGrossAmount:
          type: number
          example: 57.25
          description: Invoice amount befor tax
        InvoiceNetAmount:
          type: number
          example: 47.71
          description: Invoice amount after tax
        VATonNetAmountInCustomerCurrency:
          type: number
          example: 9.54
          description: Vat on net amount in customer currency
        CustomerRetailPriceUnitGross:
          type: number
          example: 0
          description: Customer retail unit price before tax
        CustomerRetailValueTotalGross:
          type: number
          example: 57.52
          description: Total Customer retail value before tax
        CustomerRetailValueTotalNet:
          type: number
          example: 47.93
          description: Total customer retail value after tax
        TransactionTypeDescription:
          type: number
          example: 9.59
          description: Trasaction type description
        RebateonNetAmountInTransactionCurrency:
          type: number
          example: -0.22
          description: Rebate give to net amountin transaction currency that is used
        EffectiveDiscountInTrxCurrency:
          type: number
          example: -0.22
          description: Currency used to giveEffective discount on transactions
        DelCoToColCoExchangeRate:
          type: integer
          format: int32
          description: Exchange rate between Delco and Colco
        Cards:
          type: array
          minItems: 1
          maxItems: 500
          description: List of CardId
          items:
            type: integer
            example: 275549
        UnitDiscountTransactionCurrency:
          type: number
          format: float
          example: -0.005
          description: Currency used for to provide unit Transaction discount
        TransactionGrossAmount:
          type: number
          example: 57.25
          description: Transactional amount before tax
        TransactionNetAmount:
          type: number
          example: 47.71
          description: Transaction net amount after tax
        TransactionTax:
          type: number
          example: 9.54
          description: Transaction tax Amount
        VATonNetAmount:
          type: number
          example: 9.54
          description: VAT on Net Amount (in transaction currency) 2 decimals
        DelcoListPriceUnitNet:
          type: number
          description: Delco List Price per unit
          example: 0
        DelcoRetailPriceUnitGross:
          type: number
          example: 1.32888
          description: Delco retail price per unit before tax
        UnitPriceInTransactionCurrency:
          type: number
          example: 1.1074
          description: Delco retail price per unit after tax
        DelcoRetailPriceUnitNet:
          type: number
          example: 1.1074
          description: Delco retail price per unit
        DelcoRetailValueTotalGross:
          type: number
          example: 57.52
          description: Delco retail price before tax
        DelcoRetailValueTotalNet:
          type: number
          example: 47.93
          description: Delco per unit price after tax
        TransactionCurrencySymbol:
          type: string
          description: Currency used for transaction.
          example: $
        DiscountType:
          type: string
          description: Type of discount available <br> 1-None <br> 2-Pence per unit <br> 3-Percentage
          example: 1
        DisputeStatus:
          type: boolean
          description: Is there any dispute status?True or False
          default: false
        IsShellSite:
          type: boolean
          description: Is the transaction occured at shell sites?True or False
          default: false
        FleetIdInput:
          type: string
          example: YG67OUM
          description: Fleet identifier
        IncomingProductCode:
          type: integer
          example: 23
          description: In coming product code
        PostingDate:
          type: string
          example: '20210802'
          description: Transaction posting date
        PostingTime:
          type: string
          description: Transaction posting time
        ProductCode:
          type: integer
          description: 'Product Code - 21 Unleaded - High octane,22 Unleaded - Medium octane,23 Unleaded - Low octane,24 Unleaded Environmental'
          example: 30
        ProductName:
          type: string
          description: Name of the product
          example: Unleaded - Medium octane
          minLength: 8
          maxLength: 30
        ProductGroupId:
          type: integer
          description: Id of the product to which group it belongs
          example: 22
        IncomingCurrencyCode:
          type: string
          description: Incoming currecncy code
          example: GBP
          minLength: 3
          maxLength: 3
        IncomingSiteDescription:
          type: string
          example: Shell Broadway Ring
          description: In coming Site description
        Location:
          type: string
          example: Shell Broadway Ring
          minLength: 5
          maxLength: 50
          description: Geography Location entity for Site Location
        SiteName:
          type: string
          description: Shell site name
          example: Shell Broadway Ring
          minLength: 5
          maxLength: 50
        SiteCode:
          type: integer
          format: int32
          example: 32
          description: Shell site code
        IncomingSiteNumber:
          type: integer
          description: In coming site number
          format: int32
          example: 15
        InvoiceCurrencyCode:
          type: string
          example: GBP
          minLength: 3
          maxLength: 3
          description: Currency code on which the invoice is raised
        InvoiceDate:
          type: string
          example: '20210802'
          description: Date on which the invoice was raised
        InvoiceNumber:
          type: number
          example: 3201016193
          format: float
          description: Invoice number
        FuelProduct:
          type: boolean
          description: Is it a fuel product? True or False
        VATApplicable:
          type: string
          example: 'Y'
          minLength: 1
          maxLength: 1
          description: Is VAT Applicable for this transaction
        PayerName:
          type: string
          description: Name of the payer
          example: Colours Services Ltd
          minLength: 20
          maxLength: 50
        PayerNumber:
          type: string
          description: Payer account number
          example: GB12121212
          minLength: 10
          maxLength: 15
        ParentCustomerNumber:
          type: string
          description: Parent account number of the payer
          example: GB12121212
          minLength: 10
          maxLength: 15
        PayerGroup:
          type: string
          description: The group which the payer belongs to
          example: H312066
        PayerGroupName:
          type: string
          description: Name of the group to which the payer belongs to.
          example: 12162566 - FUEL CARD SERVICE
          minLength: 5
          maxLength: 50
        CheckDigit:
          type: integer
          format: int32
          example: 6
          description: Check digit, Last number of the card pan
        NetInvoiceIndicator:
          type: string
          example: 'Y'
          description: Net Invoice Indicator, Will the customer receive an invoice without VAT?
        DelcoCode:
          type: integer
          example: 5
          description: Delivery company code
        NetworkCode:
          type: integer
          minimum: 3
          maximum: 3
          example: 3
          description: Network  code of the payer
        PurchasedInCountry:
          type: string
          description: Country of purchase
          example: United Kingdom
          minLength: 5
          maxLength: 50
        SiteCountry:
          type: string
          example: United Kingdom
          minLength: 5
          maxLength: 50
          description: Country where the site exists
        VATCountry:
          type: string
          description: Country where VAT is applicable
          example: United Kingdom
          minLength: 5
          maxLength: 50
        DelcoName:
          type: string
          example: Shell U.K. Oil Products Limited
          minLength: 5
          maxLength: 50
          description: Name of the delivery company
        Network:
          type: string
          description: Network of the Delivery company
          example: Shell
          minLength: 5
          maxLength: 25
        OdometerInput:
          type: integer
          example: 0
          description: Odometer Input as entered by the drivers at the time of transaction.
        OriginalSalesItemId:
          type: string
          minLength: 4
          maxLength: 25
          example: 'Null'
          description: Shows Sales Item Id of the original item that was refunded or corrected
        FleetIDDescription:
          type: string
          example: YG67OUM
          description: FleetId/CRN description in Card Platform configured at the account level
        ParentCustomerId:
          type: integer
          example: 6494
          description: Identifier of parent customer
        PINIndicator:
          type: string
          example: 'Y, N'
          description: Pin Indicator (Indicates whether PIN used or not used at the time of transaction)
        ProductGroupName:
          type: string
          example: Fees
          description: Name og the group the product belongs to
        PurchasedInCountryCode:
          type: string
          description: The countroy code where the purchase was made
          example: GB
        Quantity:
          type: number
          example: 43.28
          description: Total Fuel Quantity (of Fuel products only)
        RebateRate:
          type: number
          example: 0.0022
          description: Unit discount in customer currency.
        ReceiptNumber:
          type: integer
          example: 6803
          description: Reciept number
        RefundFlag:
          type: string
          example: 'Y'
          minLength: 1
          maxLength: 1
          description: Flag to check if there is any refund
          enum:
            - 'Y'
            - 'N'
        SiteGroupId:
          type: integer
          description: Group identifier for the site
          format: int32
          example: 202
        SiteGroupName:
          type: string
          description: Name of the Site group
          example: CZ 9100 ECONOMY NETWORK
        Latitude:
          type: number
          description: Latitude of the site
          example: 53.83606
        Longitude:
          type: number
          description: Longitude of the site
          example: -1.61854
        DelCoExchangeRate:
          type: number
          example: 0.851858
          description: Delivery company exchange rate
        EuroRebateAmount:
          type: number
          description: Rebate amount in Euros
          example: -0.258259
        NetEuroAmount:
          type: number
          description: Net amount in Euros
          example: 56.01
        EuroVATAmount:
          type: number
          description: Vat amount in Euros
          example: 11.2
        ParentCustomerName:
          type: string
          example: FUEL CARD SERVICES LTD
          minLength: 5
          maxLength: 50
          description: Customers parent name
        IsInvoiced:
          type: boolean
          description: Is invoice raised
          default: false
        TransactionCurrencyCode:
          type: string
          description: Transaction currency code
          example: GBP
        CreditDebitCode:
          type: string
          description: Is it Credit or debit C for credit D for Debit
          example: D or C
        TransactionDate:
          type: string
          example: '20210801'
          description: Date of transaction
        TransactionTime:
          type: string
          description: Time of transaction
          example: '12:16:58'
        TransactionItemId:
          type: string
          description: Identifier of the Iem in transaction
          example: H305908971030
        TrnIdentifier:
          type: string
          example: H305908971030
          description: Transaction identifier
        Type:
          type: string
          example: SALE
          description: Transaction type for Delco
        TransactionLine:
          type: integer
          example: 1
        TransactionType:
          type: string
          description: Transaction type Colco
          example: Purchase
        UTCOffset:
          type: string
          description: Leaving country
          example: Europe/London
        VATCategory:
          type: string
          description: To which category and counry does the  VAT come under
          example: United Kingdom Standard VAT Rate
        VATRate:
          type: number
          example: 0.2
          description: VAT rate
        VehicleRegistration:
          type: string
          description: Vehicle Registration Number embossed on the card
          example: YG67OUM
        IsCancelled:
          type: string
          minLength: 1
          maxLength: 1
          example: 'Y'
          description: Check if the pruchase is cancelled
        ColCoGrossAmount:
          type: number
          example: 57.25
          description: Gross amount from Colco
        ColCoNetAmount:
          type: number
          example: 47.71
          description: Net amount from Colco
        ColCoVATAmount:
          type: number
          example: 9.54
          description: 'Colco VAT amount '
        OriginalCurrencySymbol:
          type: string
          example: $
          minLength: 1
          maxLength: 1
          description: Original currency code
        OriginalCurrencyCode:
          type: string
          example: $
          minLength: 1
          maxLength: 1
          description: Original currency code
        OriginalVATAmount:
          type: number
          example: 0
          description: Original VAT amount
        EmbossText:
          type: string
          example: PARKLANE PROPERTIES LTD
          minLength: 5
          maxLength: 50
          description: Comapany name embosses in text
        OriginalExchangeRate:
          type: number
          example: 0
          description: 'Orginal exchange rate '
        OriginalTransactionItemInvoiceDate:
          type: string
          format: date
          example: '2022-02-02'
          description: Original treansaction date
        FeeTypeId:
          type: integer
          example: 1
          minimum: 1
          maximum: 1
          description: Fee type identifier <br>1 - Simple fee <br>2 - Card Event fee <br> 3 - Customer Event Fee
        LineItemDescription:
          type: boolean
          example: true
          description: Line Item Description generally the quantity as printed on Invoice or the manually keyed in description for manual fees
          default: false
        FeeRuleDescription:
          type: string
          description: Pricing or association pricing configuration description that is associated to the payer.
          example: Simple Fee
          minLength: 8
          maxLength: 25
        Frequency:
          type: integer
          description: Frequency of transaction <br> 1- Daily (all days) <br>2-Daily (only working days) <br> 3-Weekly ( Monday ) <br> 4-Weekly ( Tuesday)
          example: 1
          minimum: 1
          maximum: 1
        FeeRuleId:
          type: integer
          example: 1
          minimum: 1
          maximum: 1
          description: Bonus or association bonus configuration identifier (in the Cards Platform) that is associated to the payer.
        SystemEntryDate:
          type: string
          example: '20210828'
          description: Entry date in the system
        SystemEntryTime:
          type: string
          example: '20:21:08'
          description: Entry time in the system
        IsManual:
          type: string
          example: 'Y'
          minLength: 1
          maxLength: 1
          description: Checking if its manual
        OriginalTransactionItemId:
          type: string
          description: Transaction item identifier 
          minLength: 1
          maxLength: 1
          example: 'Y'
        OriginalTransactionItemInvoiceNumber:
          type: integer
          description: Original invoice transaction number
          example: 6750802
        OriginalTransactionItemInvoiceId:
          type: integer
          example: 234
          description: Original Invoice transaction Identifier
        PayerShortName:
          type: string
          description: Payers short name
          example: FUEL CARD SERVICES LTD
          minLength: 5
          maxLength: 50
        ReverseCharge:
          type: string
          description: Is reverse charge applicable for this Trasaction?
          minLength: 1
          maxLength: 1
          example: 'Y'
        OriginalGrossAmount:
          type: number
          example: 57.25
          description: Original gross amount
        OriginalNetAmount:
          type: number
          example: 57.25
          description: Original Net amount
        UnitOfMeasure:
          type: string
          example: L
          minLength: 1
          maxLength: 1
          description: Salem item Unit of measure
        RoadType:
          type: string
          example: National Road
          minLength: 5
          maxLength: 50
          description: Type of road
        CustomerCountryIsoCode:
          type: string
          example: DE
          minLength: 2
          maxLength: 2
          description: Customer country ISO Code
        EVOperator:
          type: string
          example: Shell Recharge
          minLength: 5
          maxLength: 20
          description: EvOperator Name
        EVSerialId:
          type: string
          example: GBALLEGO0002452
          minLength: 5
          maxLength: 50
          description: Ev Operator identifier
        EVChargePointSerial:
          type: string
          example: GBALLEGO0002452
          minLength: 5
          maxLength: 50
          description: EV Charging point iserial identifier
        EVChargePointConnectorType:
          type: integer
          example: 5
          format: int32
          description: Ev chariging connector type
        EVChargePointConnectorTypeDescription:
          type: string
          example: DC 50 kW
          description: EV charging point connector type description
        EVChargeDuration:
          type: string
          example: PT3205S
          description: Ev charging Duration
        EVChargeStartDate:
          type: string
          example: '2021-08-01'
          description: EvCharging start Date
        EVChargeStartTime:
          type: string
          example: '20:08:01'
          description: EvCharging start time
        EVChargeEndDate:
          type: string
          example: '2022-08-01'
          description: EvCharging End Date
        EVChargeEndTime:
          type: string
          example: '20:08:01'
          description: EvCharging End time
        HostingCollectingCompanyNumber:
          type: integer
        TransactionId:
          type: number
        FuelOnly:
          type: boolean
        EVPrintedNumber:
          type: string
          description: EV Printed Number
          example: 3792
        IsRFID:
          type: boolean
          nullable: true
          description: Whether the card used for the transaction is enabled for RFID (Radio Frequency Identification)
      x-stoplight:
        id: ay8fl78gl3cwq
    PricedSummaryRequest:
      title: PricedSummaryRequest
      type: object
      description: This endpoint provides the transaction summary (i.e. Summary of billed and unbilled sales items) aggregated by product group configuration and product.
      properties:
        ColCoCode:
          type: string
          example: '085'
          description: Collecting Company Code (Shell Code) of the selected payer.
          minLength: 3
          maxLength: 3
        PayerNumber:
          type: string
          example: GB000000123
          description: Shell customer Identifier.
          maxLength: 12
        PayerGroupName:
          type: string
          example: 12119008 - SHELL GROUP OF COMPANIES
          description: 'Payer Group Name '
          maxLength: 128
          minLength: 0
        Period:
          type: integer
          minimum: 1
          example: 1
          description: |-
            Transactions Period
            Pass 1 for Last 7 days transactions
            1. Last 7 Days
            2. Last 30 Days
            3. Last 90 Days
          enum:
            - 1
            - 2
            - 3
          maximum: 1
        AccountNumber:
          type: string
          description: Account Number of the selected account.
          example: GB00000123
          minLength: 0
          maxLength: 12
        DelcoCode:
          type: string
          description: Network Delco Code
          example: '048'
        MonthList:
          type: array
          minItems: 1
          maxItems: 31
          items:
            type: integer
            example: 9
            enum:
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
              - 11
              - 12
        YearList:
          type: array
          minItems: 1
          maxItems: 1000
          items:
            type: integer
            example: 1900
        ProductCode:
          type: string
          description: Product Code
          example: '10'
          minLength: 1
          maxLength: 8
        ProductGroupName:
          type: string
          description: Product Group Name
          example: Motor gasoline
          maxLength: 128
          minLength: 0
        ProductGroupId:
          type: integer
          description: Product Group Id
          example: 3
        Products:
          type: array
          description: List of Products configured in SFSBI Platform to be included on summary.
          items:
            type: string
            example: '006240'
        CardPAN:
          type: array
          description: |-
            Full Card PAN
            Note: The number of CardPAN allowed to be passed in the request is configurable to a maximum of 50 card
          example:
            - '7002051006629890645'
          items:
            type: string
            example: '7077323818918620937'
            minLength: 16
            maxLength: 19
        Cards:
          type: array
          description: |-
            This entity accepts the list of CardId to filter in the response.
            Note: The number of carIds allowed to be passed in the request is configurable to a maximum of 500 cards.
          minItems: 1
          maxItems: 500
          items:
            type: integer
            example: 275549
        InvoiceStatus:
          type: string
          description: |-
            Invoice status of the transactions
            Mandatory
            Possible options:
            * I - Invoiced,
            * U – Un-Invoiced,
            * A – All
          example: I
          minLength: 1
          maxLength: 1
          enum:
            - I
            - U
            - A
        SiteCode:
          type: string
          description: Site Code
          example: '050001'
          minLength: 6
          maxLength: 6
        SiteGroupId:
          type: integer
          description: Site Group Id
          example: 202
        DelcoName:
          type: string
          description: Delco Name
          example: SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV
        RoadType:
          type: string
          description: Type of Raod
          example: National Road
        ProductId:
          type: integer
          description: ProductId as Configured in SFSBI Card Platform for populating Summary
          example: 25
        FuelOnly:
          type: boolean
          description: Is FuelOnly indicator
          default: false
        IncludeFees:
          type: boolean
          description: |-
            When passed as ‘true’ then all sales items along with fees will be included in the response and the follwoing filteres will be ignored
            * InvoiceNumber
            * InvoiceDate
            * PostingDateFrom
            * PostingDateTo
          default: false
      required:
        - ColCoCode
        - PayerNumber
      x-stoplight:
        id: gcyd1fpsc7a2y
    PricedSummaryResponseData:
      title: PricedSummaryResponseData
      type: object
      properties:
        AccountId:
          type: integer
          format: int32
          example: 11
          description: Account identifier
        AccountName:
          type: string
          description: Account name
          example: Blue Colour Ltd
          minLength: 5
          maxLength: 50
        AccountNumber:
          type: string
          format: int32
          description: Account number
          example: GB78907890
          minLength: 10
          maxLength: 10
        CustomerCountry:
          type: string
          example: Germany
          description: Customer country
        ColCoCode:
          type: string
          format: int32
          example: '032'
          description: Colcocode in that country
        TransactionDate:
          type: string
          description: Currency the customer is using
          format: date
          example: '2022-01-01'
          minLength: 10
          maxLength: 10
        CustomerCurrencyCode:
          type: string
          example: EUR
          minLength: 3
          maxLength: 3
        CustomerCountryIsoCode:
          type: string
          example: GB
        CustomerCurrencySymbol:
          type: string
          minLength: 1
          maxLength: 1
          example: £
          description: Sumbol of the currency which the customer is using
        FuelProduct:
          type: boolean
          description: True if the product on transaction is listed as a fuel product else return false
          default: false
        TransactionType:
          type: string
          example: Sales
          description: Type of Transaction-Sales/FeeItem
          enum:
            - Sales
            - FeeItem
        DelcoCode:
          type: string
          format: int32
          example: '014'
          description: Delco Code
          minLength: 3
          maxLength: 3
        DelcoName:
          type: string
          example: SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV
          description: Delco name
        TransactionCurrencyCode:
          type: string
          example: GBP
          minLength: 3
          maxLength: 3
          description: transaction currency code used
        TransactionCurrencySymbol:
          type: string
          minLength: 1
          maxLength: 1
          example: £
          description: Transaction currency symbol
        RebateonNetAmountInCustomerCurrency:
          type: string
          example: ' -0.735'
          description: Rebate on Net Amount In Customer Currency
        InvoiceNetAmount:
          type: number
          example: 22055942.83
          description: Invoice net amount(after tax)
        AggregateLevel1Name:
          type: string
          example: Payer
          description: Level 1 aggregate name
        AggregateLevel2Name:
          type: string
          example: Global Product Group
          description: Level 2 aggregate name
        Month:
          type: array
          description: Month list
          items:
            type: integer
            example: 1
            maximum: 12
            minimum: 1
        Year:
          type: array
          description: Year list
          items:
            type: integer
            example: 2022
        CardGroupId:
          type: integer
          description: Card group ID (auto generated by Cards Platform)
          example: 7012736
        CardGroupName:
          type: string
          description: Card Group Name
          example: ' 006240 FIRE BRIGHT SOLUTIONS'
        CardPAN:
          type: string
          description: Mask PAN
          example: 700*******890645
        Cards:
          type: array
          items:
            type: integer
        PayerGroup:
          type: string
          example: H312066
          description: Payer group
          minLength: 7
          maxLength: 7
        PayerGroupName:
          type: string
          example: 12119008 - SHELL GROUP OF COMPANIES
          description: 'Payer Group Name '
        PayerName:
          type: string
          example: Colours Services Ltd
          minLength: 20
          maxLength: 35
          description: Payer's name
        PayerNumber:
          type: string
          example: GB12121212
          minLength: 10
          maxLength: 10
          description: Payers number
        TransactionStatus:
          type: string
          minLength: 1
          maxLength: 1
          example: 'Y'
          description: Transaction status
        RoadType:
          type: string
          description: Type of Road
        PurchasedInCountry:
          type: string
          example: United Kingdom
          description: Country of purchase
        SiteCountry:
          type: string
          example: Netherlands
          description: Site Country
        PurchasedInCountryCode:
          type: string
          example: GB
          maxLength: 2
          description: Purchase of country code
          minLength: 2
        ProductName:
          type: string
          example: Unleaded - Medium octane
          minLength: 5
          maxLength: 50
          description: Product name
        ProductCode:
          type: integer
          example: 22
          format: int32
          description: Product code
        ProductGroupId:
          type: integer
          format: int32
          example: 22
          description: Product group identifier
        ProductGroupName:
          type: string
          example: Fees
          minLength: 4
          maxLength: 10
          description: Product grop name
        SiteCode:
          type: string
          description: Site Code as configured
          example: 050001 - CHARNOCK RICHARD NTHBOUND MWSA 0755
        SiteName:
          type: string
          description: Incoming Site Name
          example: 050001 - CHARNOCK RICHARD NTHBOUND MWSA 0755
        SiteGroupId:
          type: integer
          format: int32
          description: Shell site group identifier
          example: 231
        SiteGroupName:
          type: string
          example: ' CZ 9100 ECONOMY NETWORK'
          description: Shell site group name
        ProductId:
          type: integer
          format: int32
          description: ProductId as Configured in SFSBI Card Platform for populating Summary for the requested product id.
          example: 3
        CustomerRetailValueTotalGross:
          type: number
          example: 22755917.12
          description: Retail gross price (or gross pump price) in transaction currency
        CustomerRetailValueTotalNet:
          type: number
          example: 22755917.12
          description: Retail net price (or net pump price) in customer currency
        DelcoRetailValueTotalGross:
          type: number
          example: 0
          description: Gross total retail value of Delco
        DelcoRetailValueTotalNet:
          type: number
          description: Retail net price (or net pump price) in transaction currency
          example: 22755917.12
        EffectiveDiscountInCustomerCurrency:
          type: number
          example: -320351.04
          description: 'Effective Discount (excluding VAT, in transaction currency)'
        EffectiveDiscountInTrxCurrency:
          type: number
          example: 0
          description: Effective discount given in transaction to customer currency
        EuroRebateAmount:
          type: number
          example: -320351.04
          description: Euro rebate amount.
        EuroVATAmount:
          type: number
          example: 4227443.61
          format: float
          description: Euro VAT amount
        InvoiceGrossAmount:
          type: number
          example: 26663029.43
          description: Customer Invoice Total Gross Amount
        InvoiceTax:
          type: number
          example: 22435590.46
          description: Invoiced Tax AmountTax on invoice
        NetEuroAmount:
          type: number
          example: 22435612.62
          description: Net euro amount.
        Quantity:
          type: number
          example: 16423757.16
        RebateonNetAmountInTransactionCurrency:
          type: number
          example: -320351.04
          description: Rebate on Net Amount In Transaction Currency
        TransactionGrossAmount:
          type: number
          example: 0
          description: Transaction gross amount(Before Tax)
        TransactionNetAmount:
          type: number
          example: 0
          description: Transaction netamount(AfterTax)
        TransactionTax:
          type: number
          description: Transaction Tax Amount
        VATonNetAmount:
          type: number
          example: 434487.32
          description: VAT on transaction net amount
        VATonNetAmountInCustomerCurrency:
          type: number
          example: 4155727.09
          description: VAT on transaction net amount given in customer's currency
        ColCoNetAmount:
          type: number
          example: 22055942.83
          description: Colco net amount(after tax)
        ColCoVATAmount:
          type: number
          example: 4155727.09
          description: Colco VAT amount
        ColCoGrossAmount:
          type: number
          example: 26211669.92
          description: Colco gross amount(before tax)
        Uom:
          type: string
          description: Unit of Measure
          example: L
          minLength: 1
          maxLength: 1
        StartDate:
          type: string
          example: '2021-04-01'
          format: date
          description: Start date
        EndDate:
          type: string
          format: date
          example: '2021-04-01'
          minLength: 10
          maxLength: 10
          description: End date
        RowCount:
          type: integer
          description: Number of rows
          example: 2
      x-stoplight:
        id: e7wawsgxcf20v
    ResponsePricedTransaction:
      type: object
      required:
        - RequestId
        - Status
        - Data
      properties:
        RequestId:
          type: string
          description: "A unique request id in GUID format. The value is written to the Shell API Platform audit log for end to end traceability of a request.\r\n\r\n"
          pattern: '^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$'
          minLength: 36
          maxLength: 36
          example: eb621f45-a543-4d9a-a934-2f223b263c42
          format: uuid
        Status:
          description: Status of the response.
          example: SUCCESS
          enum:
            - SUCCESS
            - FAILED
            - PARTIAL_SUCCESS
        Data:
          type: array
          items:
            type: object
            properties:
              Transactions:
                type: array
                description: List of Transaction records. <br>
                items:
                  type: object
                  properties:
                    Type:
                      type: string
                      description: TransactionType is the type of transaction.
                      example: SalesItem /FeeItem
                    CardId:
                      type: integer
                      nullable: true
                      description: Unique Card Id
                    CardPAN:
                      type: string
                      description: Card PAN. Mask PAN if enabled at configuration (Mask all digits except the Last 6 digits of the PAN)
                      example: 7002051006629890645
                    CardExpiry:
                      type: string
                      nullable: true
                      description: Card Expiry Date. <br> Note - Clients to convert this to appropriate DateTime type.
                      format: date
                      pattern: '^\d{4}\d{2}\d{2}$'
                    TransactionDate:
                      type: string
                      nullable: true
                      description: Local Transaction Date  of where the transaction took place. <br> <br. Note - <br> Clients to convert this to appropriate DateTime type. <br> For a fee item, this parameter will be populated with fee date.
                      format: date
                      pattern: '^\d{4}\d{2}\d{2}$'
                    TransactionTime :
                      type: string
                      nullable: true
                      description: Local Transaction Time of where the transaction took place. <br> <br> Note - <br> Clients to convert this to appropriate DateTime type. <br> For a fee item, this parameter will be populated with fee date.
                      format: time
                    UTCOffset :
                      type: string
                      nullable: true
                      description: UTC Offset extracted from Sales Date time. <br><br> Note - <br> This may not be accurate for all TPN transactions. <br> The value could be null/blank for fees item.
                      format: time
                    FleetIdInput:
                      type: string
                      nullable: true
                      description: Fleet Id Input as entered by the drivers at the time of transaction. <br><br> Note - <br> The value could be null/blank for fees item.
                      example: XYZ1234
                    OdometerInput:
                      type: integer
                      nullable: true
                      description: Odometer Input as entered by the drivers at the time of transaction. <br><br> Note - <br> The value could be null/blank for fees item.
                      example: 12345
                    DriverName :
                      type: string
                      description: Driver Name embossed on the card
                      example: ANDREW GILBERRY
                    VehicleRegistration:
                      type: string
                      description: Vehicle Registration Number embossed on the card
                      example: MV65YLH
                    InvoiceCurrencyCode:
                      type: string
                      nullable: true
                      description: ISO currency code. 
                      example: GBP
                    InvoiceCurrencySymbol:
                      type: string
                      nullable: true
                      description: Currency symbol of the Invoice Currency Code 
                      example:  $
                    TransactionCurrencyCode:
                      type: string
                      description: ISO currency code
                      example:  GBP
                    TransactionCurrencySymbol :
                      type: string
                      description: Currency symbol of the Transaction Currency Code
                      example: $
                    TransactionNetAmount :
                      type: number
                      nullable: true
                      description: Net Amount
                    TransactionTax:
                      type: number
                      nullable: true
                      description: Tax Amount
                    TransactionGrossAmount:
                      type: number
                      nullable: true
                      description: Gross Amount
                    InvoiceNetAmount :
                      type: number
                      nullable: true
                      description: Invoiced Net Amount. <br><br> Note - <br> For a fee item, this parameter will be populated with fee InvoiceNetAmount.
                    InvoiceTax:
                      type: number
                      nullable: true
                      description: Invoiced Tax Amount
                    InvoiceGrossAmount:
                      type: number
                      nullable: true
                      description: Invoice Gross Amount. <br><br> Note - <br> For a fee item, this parameter will be populated with fee InvoiceGrossAmount.
                    PurchasedInCountry:
                      type: string
                      nullable: true
                      description: Country of Purchase. <br><br> Note - <br> The value could be null/blank for fees item.
                      example: Germany
                    AccountId:
                      type: integer
                      description: Account Id (customer id)
                      example: 29484
                    AccountNumber:
                      type: string
                      description: Account Number
                      example: GB99215176
                    AccountName:
                      type: string
                      description: Account Name
                      example: MATTHEW ALGIE & COMPANY LIMITED
                    AccountShortName:
                      type: string
                      description: Account Short Name
                    Quantity :
                      type: number
                      description: Quantity/Volume
                    FuelProduct:
                      type: boolean
                      nullable: true
                      description: True if the product on transaction is listed as a fuel product else return false  
                    UnitPriceInTransactionCurrency:
                      type: number
                      nullable: true
                      description: 'Product Unit Price in transaction currency. <br><br> Note - The value could be null/blank for fees item.'
                    UnitPriceInInvoiceCurrency:
                      type: number
                      nullable: true
                      description: Product Unit Price in invoice currency. <br><br> Note - The value could be null/blank for fees item.
                    UnitDiscountTransactionCurrency:
                      type: number
                      nullable: true
                      description: Unit Discount in transaction currency. <br> <br> Note - The value could be null/blank for fees item.
                    UnitDiscountInvoiceCurrency:
                      type: number 
                      nullable: true 
                      description: Unit Discount in invoice currenc. <br><br> Note - The value could be null/blank for fees item.
                    IsInvoiced :
                      type: boolean
                      nullable: true
                      description: True when the transaction is already invoice, else return False
                    InvoiceNumber :
                      type: string
                      description: Invoice Number if invoiced
                      example: S04500493
                    InvoiceDate :
                      type: string
                      nullable: true
                      format: DateTime
                      description: Invoice Date. <br> Note - Clients to convert this to appropriate DateTime type.
                    SiteCode:
                      type: string
                      nullable: true 
                      description: Site Code. <br><br> Note - The value could be null/blank for fees item.
                      example: 050001 -	CHARNOCK RICHARD NTHBOUND MWSA 0755
                    SiteName:
                      type: string
                      nullable: true
                      description: Site Name. <br><br> Note - The value could be null/blank for fees item.
                      example: 050001 -	CHARNOCK RICHARD NTHBOUND MWSA 0755
                    SiteCountry:
                      type: string
                      nullable: true
                      description: Site Country. <br><br> Note - The value could be null/blank for fees item.
                      example: Germany
                    Location:
                      type: object
                      nullable: true
                      description: Geography Location entity for Site Location. <br> Note - The value could be null/blank for fees item.
                      properties:
                          Latitude:
                            type: string
                            nullable: true
                            description: Latitude for the Site Geographic Location. Note - The value could be null/blank for fees item.
                            example: 37.4224764
                          Longitude:
                            type: string
                            nullable: true
                            description: Longitude for the Site Geographic Location. <br> Note - The value could be null/blank for fees item.
                            example: 122.0842499
                    CardGroupName:
                      type: string
                      description: Card Group Name
                      example: 006240 FIRE BRIGHT SOLUTIONS
                    ReceiptNumber:
                      type: string
                      description: Receipt Number
                      example: 01234
                    ProductCode:
                      type: string
                      description: Product Code
                      example: 10 - TMF Charges
                    ProductName:
                      type: string
                      description: Product Name
                      example: Unleaded - High octane
                    ProductGroupId:
                      type: integer
                      description: Product Group Id
                      example: 1
                    ProductGroupName:
                      type: string
                      description: Product Group Name
                      example: Parent Product Group
                    DelCoExchangeRate:
                      type: number
                      format: float
                      nullable: true
                      description: DelCo Exchange Rate (Site exchange rate). <br><br> Note -The value could be null/blank for fees item.
                    ColCoExchangeRate:
                      type: number
                      format: float
                      description: ColCo Exchange Rate (Customer exchange rate)
                    IsShellSite:
                      type: boolean
                      nullable: true
                      description: True when transaction occurred at a Shell site else return False. <br><br> Note - The value could be null/blank for fees item.
                    Network:
                      type: string
                      nullable: true
                      description: Network as configured (Shell PH, ESSO, etc.,). <br><br> Note - The value could be null/blank for fees item.
                      example: 100013	STEINDORFER
                    SiteGroupId:
                      type: integer
                      nullable: true
                      description: Site Group Id. <br><br> Note - The value could be null/blank for fees item.
                      example: 202
                    SiteGroupName: 
                      type: string
                      nullable: true
                      description: Site Group Name. <br><br> Note - The value could be null/blank for fees item.
                      example: CZ 9100 ECONOMY NETWORK
                    PostingDate:
                      type: string
                      nullable: true
                      description: Transaction Posting Date. <br><br> Note - Clients to convert this to appropriate DateTime type.
                    IssuerCode:
                      type: string
                      description: First digits of the Card PAN
                      example: 7002
                    PurchasedInCountryCode:
                      type: string
                      nullable: true
                      description: ISO code of the country where the transaction took place. <br><br> Note - The value could be null/blank for fees item.
                      example: NL
                    CustomerCountryCode:
                      type: string
                      description: ISO code of the  Customer Country
                      example: NL                      
                    CustomerCountry:
                      type: string
                      description: Name of the Customer Country
                      example: Netherlands                         
                    ReleaseCode:
                      type: string
                      nullable: true
                      description: Release code, 7th Digit of the Card PAN
                      example: 8                              
                    CardGroupId:
                      type: string
                      description: Card group ID (auto generated by Cards Platform)
                    CardSequenceNumber:
                      type: string
                      description: 3 digits, Card sequence number and Check digit (Digit 16,17 and 18 on the card pan)
                      example: 002
                    CheckDigit:
                      type: string
                      description: Check digit, Last number of the card pan
                    FleetIDDescription:
                      type: string
                      description:  FleetId/CRN description in Card Platform configured at the account level
                    VATRate:
                      type: number
                      nullable: true
                      description: VAT Percentage. <br><br> Note- This parameter will be populated in the response for both SalesItem and FeeItem.
                      format: double
                      example: 0.20 for 20%
                    VATCategory:
                      type: string
                      description: VAT Category Id-Description
                      example: 1-Zero Rated
                    VATonNetAmount:
                      type: number
                      format: double
                      description: VAT on Net Amount (in transaction currency) 2 decimals
                    VATCountry:
                      type: string
                      description: VAT Country
                      example:  Netherlands
                    EffectiveDiscountInTrxCurrency:
                      type: number
                      format: double
                      nullable: true
                      description: Effective Discount (excluding VAT, in transaction currency) 4 digits. <br><br> Note - The value could be null/blank for fees item.
                      example: 0.0000
                    TransactionType:
                      type: string
                      description: Transaction Type. <br><br> Note  - The value could be null/blank for fees item.
                      example: Purchase when Card is Present else Blank
                    PINIndicator:
                      type: string
                      description: Pin Indicator (Indicates whether PIN used or not used at the time of transaction). <br><br> Note - The value could be null/blank for fees item.
                      example:  “PIN Used” 
                    VATApplicable:
                      type: string
                      description: Is VAT Applicable for this transaction
                      example: Y
                    NetInvoiceIndicator:
                      type: string
                      description: Net Invoice Indicator, Will the customer receive an invoice without VAT?. <br><br> Note - The value could be null/blank for fees item.
                      example:  Y
                    CustomerCurrencyCode:
                      type: string
                      description: Customer currency code
                      example: GBP
                    CustomerCurrencySymbol:
                      type: string
                      description: Customer currency Symbol
                      example: £
                    EffectiveUnitDiscountInCustomerCurrency:
                      type: number
                      format: decimals
                      nullable: true
                      description: Effective Unit Discount (excluding VAT in Customer currency). <br><br> Note - The value could be null/blank for fees item.
                    EffectiveDiscountInCustomerCurrency:
                      type: number
                      format: decimals
                      nullable: true
                      description: Effective Discount (excluding VAT in Customer currency). <br><br> Note - The value could be null/blank for fees item.
                    VATonNetAmountInCustomerCurrency:
                      type: number
                      format: decimals
                      nullable: true
                      description: VAT on Net Amount (in Customer currency)
                    DiscountType:
                      type: string
                      description: Discount Type <br><br> Note - The value could be null/blank for fees item
                      example:  2-Pence per unit
                    TransactionStatus:
                      type: string
                      description: Transaction status "U" or "I". <br><br> “U” stands for Uninvoiced. <br><br> “I” stands for Invoiced
                      example: U
                    SalesItemId:
                      type: number
                      format: int64
                      description: Unique Sales Item Identifier. <br><br> Note - For a fee item, this parameter will be populated with SalesItemId.
                      example:  18315958002
                    PayerGroup:
                      type: string
                      description: Payer Group applicable for the Large Customer NL+8 digit code
                    PayerGroupName:
                      type: string
                      description: Payer Group Name 
                      example:  12119008 - SHELL GROUP OF COMPANIES
                    RefundFlag:
                      type: string
                      description: Refund Flag “N” for Not Refunded and “Y” for Refunded. <br><br> Note - The value could be null/blank for fees item.
                    OriginalSalesItemId:
                      type: string
                      description: Shows Sales Item Id of the original item that was refunded
                    DelcoName:
                      type: string
                      description: Delco Name
                      example: SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV 
                    DelcoCode:
                      type: string
                      description: Delco Code
                      example: 014
                    PayerNumber:
                      type: string
                      description: Payer number (Country code+8 digits)
                      example: NL10042616
                    PayerName:
                      type: string
                      description: Payer name
                      example:  V.M. LE COMTE  
                    CardExpiryPeriod:
                      type: string
                      description: Year/Month of the Card Expiry captured on the transaction
                      example:  1901 
                    AuthorisationCode:
                      type: string
                      description: Authorisation code of the transaction. <br><br> Note - The value could be null/blank for fees item
                      example:  1011256
                    TransactionId:
                      type: string
                      description: Unique id of the transaction that may include one or more salesitems. <br><br> Note - The value could be null/blank for fees item
                      example:  io9KVXk1UkW57XWKyeaHHg
                    TransactionLine:
                      type: string
                      nullable: true
                      description: Transaction line item number <br><br> Note - The value could be null/blank for fees item.
                      example: 1
                    AllowClearing :
                      type: string
                      nullable: true
                      description: Is the Sales Item allowed for clearing? i.e. not written off <br><br> Note - The value could be null/blank for fees item.
                      example:  Y
                    CRMNumber:
                      type: string
                      nullable: true
                      description: CRM Case number if the sales item is in dispute. <br><br> Note - The value could be null/blank for fees item.
                    DisputeStatus:
                      type: string
                      description: Sales Item Dispute Status if disputed. <br><br> Note - The value could be null/blank for fees item.
                      example: No Dispute
                    RebateRate:
                      type: number
                      format: float
                      nullable: true
                      description: Unit discount in customer currency. <br><br> Note - The value could be null/blank for fees item
                      example:  28.279000
                    DelCoToColCoExchangeRate:
                      type: number
                      format: float
                      nullable: true
                      description: Exchange rate from transaction currency to customer currency. <br><br> Note - The value could be null/blank for fees item
                      example: 1
                    NetEuroAmount:
                      type: number 
                      format: float
                      nullable: true
                      description: Euro rebate amount. <br><br> Note - The value could be null/blank for fees item
                      example: 0
                    EuroVATAmount:
                      type: number
                      format: decimals
                      nullable: true
                      description: Euro VAT amount. <br><br> Note - The value could be null/blank for fees item
                    ParentCustomerNumber:
                      type: string
                      description: Parent customer number
                    ParentCustomerName:
                      type: string
                      description: Parent customer name.
                    ParentCustomerId:
                      type: integer
                      nullable: true
                      description: Parent customer id.
                    IncomingSiteNumber:
                      type: string
                      description: Incoming Site Number.  <br><br> Note - The value could be null/blank for fees item
                      example:  100021
                    IncomingSiteDescription:
                      type: string
                      description: Incoming Site Description.  <br><br> Note - The value could be null/blank for fees item.
                      example:  HN3 INTI_02-82.02        
                    IncomingCurrencyCode:
                      type: string
                      nullable: true
                      description: Incoming Currency Code. <br><br> Note - The value could be null/blank for fees item.
                      example:  GBP
                    IncomingProductCode:
                      type: string
                      nullable: true
                      description: Incoming Product Code
                      example:  30
                    CreditDebitCode:
                      type: string
                      description: Credit Debit Code.  <br><br> The value could be null/blank for fees item.
                      example:  D
                    CorrectionFlag:
                      type: string
                      description: Correction Flag. <br><br> The value could be null/blank for fees item.
                      example: Y
                    Additional1 :
                      type: string
                      nullable: true
                      description: Additional data
                    Additional2 :
                      type: string
                      nullable: true
                      description: Additional data
                    Additional3 :
                      type: string
                      nullable: true
                      description: Additional data
                    Additional4 :
                      type: string
                      nullable: true
                      description: Additional data 
                    RebateonNetAmountInCustomerCurrency:
                      type: number
                      format: decimals
                      nullable: true
                      description: Rebate on Net Amount In Customer Currency. <br><br> Note - The value could be null/blank for fees item.
                      example: -0.735000000000
                    RebateonNetAmountInTransactionCurrency:
                      type: string
                      nullable: true
                      description: Network Code. <br><br> Note - The value could be null/blank for fees item
                      example: AVEE PTUAZONW CUBFAO COSFS
                    TrnIdentifier:
                      type: string
                      description: Transaction Identifier
                    CardType:
                      type: string
                      description: Card Type
                    DelcoListPriceUnitNet:
                      type: number 
                      format: decimals
                      nullable: true
                      description: Delco List Price Unit Net
                      example: 30.500000
                    DelcoRetailPriceUnitNet:
                      type: number
                      format: decimals
                      nullable: true
                      description: Retail Net Price (or pump net price) per Unit in transaction currency
                      example: 1.921000
                    DelcoRetailPriceUnitGross:
                      type: number
                      format: decimals
                      nullable: true
                      description: Retail gross price (or pump gross price) per unit in transaction currency
                    DelcoRetailValueTotalNet:
                      type: number
                      format: decimals
                      nullable: true
                      description: Retail net price (or net pump price) in transaction currency
                    DelcoRetailValueTotalGross:
                      type: number
                      format: decimals
                      nullable: true
                      description: Retail gross price (or gross pump price) in transaction currency
                    CustomerRetailPriceUnitGross:
                      type: number
                      format: decimals
                      nullable: true
                      description: Retail gross price (or gross pump price) in customer currency
                    CustomerRetailValueTotalNet:
                      type: number
                      description: Transaction Type Description.  <br><br> Note - The value could be null/blank for fees item
                    EVPrintedNumber:
                      type: string
                      description: EV Printed Number
                      example: 3792
                    IsRFID:
                      type: boolean
                      nullable: true
                      description: Whether the card used for the transaction is enabled for RFID (Radio Frequency Identification)
                    TokenTypeDescription:
                      type: string
                      description: Card Token Type Description
        CurrentPage:
          type: integer
          nullable: true
          description: Current Page
          example: 1
        RowCount:
          type: integer
          description: Total row count matched for the given input criteria
          example: 20
        TotalPages:
          type: integer
          nullable: true
          description: Calculated page count based on page size from the incoming API request and total number of rows matched for the given input criteria. Return 1 if the page size is -1 as all records are returned.
          example: 15
        Warnings:
          type: array
          nullable: true
          uniqueItems: true
          items:
            type: object
            properties:
              Type:
                type: string
                description: Type of warning.
                example: System Outage
              Message:
                type: string
                description: A custom message giving the detailed outage information. The message will contain the duration and the reason for the outage.
                example: 'System is down for upgradation.'
    RequestPricedTransaction:
      type: object
      properties:
        ColCoId:
          type: integer
          description: Collecting Company Id of the selected payer. <br><br> Optional if ColCoCode is passed else Mandatory.
          nullable: true
          example: 1
        ColCoCode:
          type: integer
          description: 'Collecting Company Code of the selected payer. <br><br>  Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.'
          nullable: true
          example: 86
        PayerId:
          type: integer
          description: 'Payer id of the selected customer. Optional if PayerNumber is passed, else Mandatory.'
          nullable: true
          example: 123456
        PayerNumber:
          type: string
          description: 'Payer Number of the selected payer.Optional if PayerId is passed else Mandatory'
          example: GB000000123
        CardId:
          type: integer
          description: 'Card Id (i.e. Unique Card Id) <br> When both Card Id and Card PAN are not present on request, the response will have transactions of all cards under the selected payer or account.'
          nullable: true
          example: 275549
        CardPAN:
          type: string
          description: 'Full Card PAN. <br> When both Card Id and Card PAN are not present on request, the response will have transactions of all cards under the selected payer or account.'
          example: 7002051006629890645
        DriverName:
          type: string
          description: 'Driver Name (of Card record). <br> Minimum of 4 characters should be provided else not considered. <br> Transactions of the card having the entered value at any part of the Driver Name will be returned'
          maxLength: 40
          minLength: 4
          example: 7002051006629890645      
        VehicleRegistrationNumber:
          type: string
          description: 'Vehicle Registration (of Card record). <br>  Minimum of 4 characters should be provided else not considered. <br> Transactions of the card having the entered value at any part of the VRN will be returned.'
          minLength: 4
          example: 12345                
        InvoiceStatus:
          type: string
          description: 'Invoice status of the transactions. <br> Possible options: <br> I - Invoiced. <br> U – Un-Invoiced. <br> A – All.'
          maxLength: 1
          example: I
        ProductId:
          type: integer
          description: Product Id. <br> possible values <br> 21 - Unleaded - High octane <br> 22 - Unleaded - Medium octane <br> 23 - Unleaded - Low octane <br> 24 - Unleaded Environmental.'
          nullable: true
          example: 21
        ProductCode:
          type: string
          description: Product Code 
          maxLength: 8
          example: 10 - TMF Charges
        PurchasedInCountry: 
          type: string
          description: ISO Country Code. <br> <br>  Note - If IncludeFees is true then this filter will be ignored
          maxLength: 2
          example: UK
        CardGroupId:
          type: integer
          nullable: true
          description: Card Group
          example: 40000
        FromDate:
          type: string
          nullable: true
          description: Transactions from Date/Time. <br> Optional – When provided, it should be with in last 24 months. <br> Refer introduction section of this operation for the priority and sequence of different date and invoice number filters that are conditionally applied.
          format: date
          example: 20240225
        ToDate:
          type: string
          nullable: true
          description: Transactions to Date/Time. <br> Optional- Refer introduction section of this operation for the priority and sequence of different date and invoice number filters that are conditionally applied. <br> Note - <br> 1) When the value is blank and FromDate is provided on the input, all transactions took place  210(Configurable) days after the given FromDate is returned. <br> 2) Difference between FromDate and ToDate cannot be more than 210 (Configurable) days.
          format: date
          example: 20240225
        Period: 
          type: integer
          nullable: true
          description: Transactions Period. <br> Possible Values - <br> 1. Last 7 Days. <br> 2.	Last 30 Days <br> 3. Last 90 Days <br> Optional - Refer introduction section of this operation for the priority and sequence of different date and invoice number filters that are conditionally applied.
          example: 1
        SiteCode:
          type: string
          description: Site Code as configured. <br> Note - If IncludeFees is true then this filter will be ignored
          example: 050001 -	CHARNOCK RICHARD NTHBOUND MWSA 0755
        SiteGroupId: 
          type: integer
          nullable: true
          description: Site Group Id. <br> Note - If IncludeFees is true then this filter will be ignored. 
          example: 202
        PostingDateFrom:
          type: string
          nullable: true
          description: Transaction Posting Date/time in the Cards Platform - From Date/time. <br> Optional - Refer introduction section of this operation for the priority and sequence of different date and invoice number filters that are conditionally applied. <br> Note - <br> 1) When the value of both PostingDateFrom and PostingDateTo are present in the request then the value of PostingDateFrom must be less than PostingDateTo. <br> 2) If IncludeFees is true then this filter will be ignored
          format: date-time
          example: "2018-03-20T09:12:28Z"
        PostingDateTo:
          type: string
          nullable: true
          description: Transaction Posting Date/time in the Cards Platform – To Date/time. <br> Optional - Refer introduction section of this operation for the priority and sequence of different date and invoice number filters that are conditionally applied. <br> note - <br> 1) If IncludeFees is true then this filter will be ignored. <br> 2) When the value of both PostingDateFrom and PostingDateTo are present in the request then the value of PostingDateFrom must be less than PostingDateTo.
          format: date-time
          example: "2018-03-20T09:12:28Z"
        SalesItemId:
          type: integer
          format: int64
          nullable: true
          description: Unique SalesItemId (Either Billed on Unbilled). <br> Note - If IncludeFees is true then this filter will be ignored.'
          example: 21
        TransactionId: 
          type: string
          description: Unique Transaction Id. <br> Note - If IncludeFees is true then this filter will be ignored
          example: A12345
        InvoiceDate:
          type: string
          nullable: true
          description: Invoice Date. <br> Note - <br> 1) If value is not blank then the system will ignore the InvoiceStatus parameter and it will return all the billed transactions for the given invoice date. <br> 2) Refer introduction section of this operation for the priority and sequence of different date and invoice number filters that are conditionally applied.
          format: date
          pattern: '^\d{4}\d{2}\d{2}$'
          example: 20240225
        InvoiceNumber:
          type: string
          nullable: true
          description: Invoice Number. <br> Note - <br> 1) If value is not blank then the system will ignore the InvoiceStatus parameter and it will return all the billed transactions for the given invoice date. <br> 2) Refer introduction section of this operation for the priority and sequence of different date and invoice number filters that are conditionally applied.
          example: A123456
        ValidInvoiceDateOnly:
          type: boolean
          nullable: true
          description: True/False. <br> When passed as ‘True’ the transactions records with report date not equal to 9999-12-30 will be returned. <br> When passed as ‘False’ the above condition will not be checked.
          default: true
          example: true 
        InvoiceFromDate:
          type: string
          nullable: true
          description: Start date for transaction search by invoice date. <br> Note - <br> 1) Refer introduction section of this operation for the priority and sequence of different date and invoice number filters that are conditionally applied. <br> 2) Value should be with in last 24 months (if provided). <br> 3) Maximum of 90(Configurable) day’s duration allowed per search.  <br> 3) Maximum of 90(Configurable) day’s duration allowed per search.
          format: date
          pattern: '^\d{4}\d{2}\d{2}$'
          example: 20240225
        InvoiceToDate:   
          type: string
          nullable: true
          description: End date for transaction search by invoice date. <br> Note - <br>1) Refer introduction section of this operation for the priority and sequence of different date and invoice number filters that are conditionally app lied. <br> 2) When InvoiceFromDate is provided and InvoiceToDate is null, then InvoiceToDate will be calculated as (InvoiceFromDate + 90 days) or (CurrentDate) whichever is lesser.
          format: date
          pattern: '^\d{4}\d{2}\d{2}$'
          example: 20240225
        FuelOnly:
          type: boolean
          nullable: true
          description: True/False. <br> When passed as ‘True’ Only returned records with Fuel transactions. <br> When passed as ‘False’ the above condition will not be checked.
          default: false
          example: false
        IncludeFees:
          type: boolean
          nullable: true
          description: True/False. <br> When passed as ‘True’ then  ignore few filters, all sales items along with fees included on the same response
          default: false
          example: false
        SortOrder:
          type: string
          description: Allowed Sorting Options - <br> 1. TransactionDateAscending <br> 2.	TransactionDateDescending <br> 3.	GrossAmountDescending <br> 4.	GrossAmountAscending <br> 5.	DriverNameAscending (If Driver Name is null then VRN value will be considered) <br> 6.	DriverNameDescending (If Driver Name is null then VRN value will be considered) <br> 7.	VRNAscending (If VRN is null then Driver Name value will be considered) <br> 8.	VRNDescending (If VRN is null then Driver Name value will be considered) <br> 9.	NetAmountAscending <br> 10.	NetAmountDescensding
          example: 1,3 
      required:
        -  InvoiceStatus  
    pricedtransactionssummary:
      type: object
      properties:
        ColCoId:
          type: integer
          description: Collecting Company Id of the selected payer. <br><br> Optional if ColCoCode is passed else Mandatory.
          nullable: true
          example: 1
        ColCoCode:
          type: integer
          description: 'Collecting Company Code of the selected payer. <br><br>  Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.'
          nullable: true
          example: 86
        PayerId:
          type: integer
          description: 'Payer id of the selected customer. Optional if PayerNumber is passed, else Mandatory.'
          nullable: true
          example: 123456
        PayerNumber:
          type: string
          description: 'Payer Number of the selected payer.Optional if PayerId is passed else Mandatory'
          example: GB000000123
        CardId:
          type: integer
          description: 'Card Id  <br> When both Card Id and Card PAN are not present on request, the response will have transactions of all cards under the selected payer or account.'
          nullable: true
          example: 275549
        CardPAN:
          type: string
          description: 'Full Card PAN. <br> When both Card Id and Card PAN are not present on request, the response will have transactions of all cards under the selected payer or account.'
          example: 7002051006629890645
        DriverName:
          type: string
          description: 'Driver Name (of Card record). <br> Minimum of 4 characters should be provided else not considered. <br> Transactions of the card having the entered value at any part of the Driver Name will be returned'
          maxLength: 40
          minLength: 4
          example: ANDREW GILBERRY      
        VehicleRegistrationNumber:
          type: string
          description: 'Vehicle Registration (of Card record). <br>  Minimum of 4 characters should be provided else not considered. <br> Transactions of the card having the entered value at any part of the VRN will be returned.'
          minLength: 4
          example: 12345                
        InvoiceStatus:
          type: string
          description: 'Invoice status of the transactions. <br> Possible options: <br> I - Invoiced. <br> U – Un-Invoiced. <br> A – All.'
          maxLength: 1
          example: I
        ProductId:
          type: integer
          description: Product Id. <br> possible values <br> 21 - Unleaded - High octane <br> 22 - Unleaded - Medium octane <br> 23 - Unleaded - Low octane <br> 24 - Unleaded Environmental.'
          nullable: true
          example: 21
        ProductCode:
          type: string
          description: Product Code 
          maxLength: 8
          example: 10 - TMF Charges
        PurchasedInCountry: 
          type: string
          description: ISO Country Code. <br> <br>  Note - If IncludeFees is true then this filter will be ignored
          maxLength: 2
          example: UK
        CardGroupId:
          type: integer
          nullable: true
          description: Card Group Id
        FromDate:
          type: string
          nullable: true
          description: Transactions from Date/Time. <br> Optional – When provided, it should be with in last 24 months.
          format: date
          example: 20240225
        ToDate:
          type: string
          nullable: true
          description: Transactions to Date/Time. <br> Optional- Refer introduction section of this operation for the priority and sequence of different date and invoice number filters that are conditionally applied. <br> Note - <br> 1) When the value is blank and FromDate is provided on the input, all transactions took place  210(Configurable) days after the given FromDate is returned. <br> 2) Difference between FromDate and ToDate cannot be more than 210 (Configurable) days.
          format: date
          example: 20240225
        Period: 
          type: integer
          nullable: true
          description: Transactions Period. <br> Possible Values - <br> 1. Last 7 Days. <br> 2.	Last 30 Days <br> 3. Last 90 Days
          example: 1
        SiteCode:
          type: string
          description: Site Code <br> Note - If IncludeFees is true then this filter will be ignored
          example: 050001- CHARNOCK RICHARD NTHBOUND MWSA 0755
        SiteGroupId: 
          type: integer
          nullable: true
          description: Site Group Id  <br> Note - If IncludeFees is true then this filter will be ignored. 
          example: 202
        PostingDateFrom:
          type: string
          nullable: true
          description: Transaction Posting Date/time in the Cards Platform - From Date/time. <br> Optional <br> Note - <br> 1) When the value of both PostingDateFrom and PostingDateTo are present in the request then the value of PostingDateFrom must be less than PostingDateTo. <br> 2) If IncludeFees is true then this filter will be ignored
          format: date-time
          example: "2018-03-20T09:12:28Z"
        PostingDateTo:
          type: string
          nullable: true
          description: Transaction Posting Date/time in the Cards Platform – To Date/time.<br> note - <br> 1) If IncludeFees is true then this filter will be ignored. <br> 2) When the value of both PostingDateFrom and PostingDateTo are present in the request then the value of PostingDateFrom must be less than PostingDateTo.
          format: date-time
          example: "2018-03-20T09:12:28Z"
        SalesItemId:
          type: integer
          format: int64
          nullable: true
          description: Unique SalesItemId (Either Billed on Unbilled). <br> Note - If IncludeFees is true then this filter will be ignored.'
          example: 21
        TransactionId: 
          type: string
          description: Unique Transaction Id. <br> Note - If IncludeFees is true then this filter will be ignored
          example: A12345
        InvoiceDate:
          type: string
          nullable: true
          description: Invoice Date. <br> Note - <br> 1) If value is not blank then the system will ignore the InvoiceStatus parameter and it will return all the billed transactions for the given invoice date. <br>
          format: date
          pattern: '^\d{4}\d{2}\d{2}$'
          example: 20240225
        InvoiceNumber:
          type: string
          nullable: true
          description: Invoice Number. <br> Note - <br> 1) If value is not blank then the system will ignore the InvoiceStatus parameter and it will return all the billed transactions for the given invoice date. <br>
          example: A123456
        ValidInvoiceDateOnly:
          type: boolean
          nullable: true
          description: True/False. <br> When passed as ‘True’ the transactions records with report date not equal to 9999-12-30 will be returned. <br> When passed as ‘False’ the above condition will not be checked.
          default: true
          example: true 
        InvoiceFromDate:
          type: string
          nullable: true
          description: Start date for transaction search by invoice date. <br> 1) Value should be with in last 24 months (if provided). <br> 3) Maximum of 90(Configurable) day’s duration allowed per search.  <br> 3) Maximum of 90(Configurable) day’s duration allowed per search.
          format: date
          pattern: '^\d{4}\d{2}\d{2}$'
          example: 20240225
        InvoiceToDate:   
          type: string
          nullable: true
          description: End date for transaction search by invoice date. <br> 1) When InvoiceFromDate is provided and InvoiceToDate is null, then InvoiceToDate will be calculated as (InvoiceFromDate + 90 days) or (CurrentDate) whichever is lesser.
          format: date
          pattern: '^\d{4}\d{2}\d{2}$'
          example: 20240225
        FuelOnly:
          type: boolean
          nullable: true
          description: True/False. <br> When passed as ‘True’ Only returned records with Fuel transactions. <br> When passed as ‘False’ the above condition will not be checked.
          default: false
          example: false
      required:
        -  InvoiceStatus
    Responsepricedtransactionssummary:
      type: object
      required:
        - RequestId
        - Status
        - Data
      properties:
        RequestId:
          type: string
          description: "A unique request id in GUID format. The value is written to the Shell API Platform audit log for end to end traceability of a request.\r\n\r\n"
          pattern: '^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$'
          minLength: 36
          maxLength: 36
          example: eb621f45-a543-4d9a-a934-2f223b263c42
          format: uuid
        Status:
          description: Status of the response.
          example: SUCCESS
          enum:
            - SUCCESS
            - FAILED
            - PARTIAL_SUCCESS
        Data:
          type: array
          items:
            type: object
            properties:
              ProductId: 
                type: integer
                description: Product Id
                example: 1234
              ProductCode: 
                type: string
                description: Product Code
                example: TMF Charges
              ProductName: 
                type: string
                description: Product Name
                example: Unleaded - High octane
              ProductGroupId: 
                type: integer
                description: Product Group Id
                example: 1
              ProductGroupName: 
                type: string
                description: Product Group Name
                example: Parent Product Group
              SiteGroupId: 
                type: integer
                description: Site Group Id 
                example: 202
              SiteGroupName: 
                type: string
                description: Site Group Name 
                example: CZ 9100 ECONOMY NETWORK
              TotalFuelQuantity: 
                type: number 
                format: float
                description: Total Fuel Quantity (of Fuel products only)
                example: 123.23
              TotalNetAmount: 
                type: number
                format: float
                description: Total Net amount in invoice currency
                example: 123.23
              TotalGrossAmount: 
                type: number 
                format: float
                description: Total Gross amount in invoice currency
                example: 123.23
              InvoiceCurrencyCode: 
                type: string
                description: ISO currency code 
                example: GBP
              InvoiceCurrencySymbol: 
                type: string
                description: Currency symbol of the Invoice Currency Code 
                example: $
              CustomerRetailValueTotalNet: 
                type: number
                format: float
                description: Sum of the retail net price (or net pump price) in customer currency.
                example: 123.23
              CustomerRetailValueTotalGross: 
                type: number
                format: float
                description: Sum of the retail gross price (or gross pump price) in customer currency.
                example: 123.23
        Warnings:
          $ref: '#/components/schemas/Warnings'     
    Warnings:
        type: array
        description: "A list of Warning entity. \r\nThis entity will hold the details of the scheduled System Outages of any dependent applications of this service.\r\nNote: If there is no scheduled outage information available, in the configuration in AMS, for this service, this parameter won’t be present in output.\r\n"
        items:
          type: object
          properties:
            Message:
              type: string
              description: A custom message giving the detailed outage information. The message will contain the duration and the reason for the outage.
              example: System is down for upgradation.
            Type:
              type: string
              description: Type of warning
              example: System Outage
          required:
            - Message
            - Type     
    VolumeBasedBonus: 
      type: object
      properties:
        ColCoId: 
          type: integer
          nullable: true
          description: Collecting Company Id of the selected payer. <br><br> Optional if ColCoCode is passed else Mandatory.
          example: 1
        ColCoCode: 
          type: integer
          nullable: true
          description: Collecting Company Code (Shell Code) of the selected payer.  <br><br> Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.
          example: 86
        PayerId: 
          type: integer
          nullable: true
          description: Payer Id  of the selected payer. <br><br> Optional if PayerNumber is passed else Mandatory
          example: 12345
        PayerNumber: 
          type: string
          description: Payer Number of the selected payer. <br><br> Optional if PayerId is passed else Mandatory
          example: GB000000123
        IncludeHistory: 
          type: boolean
          nullable: true
          description: The API will return the details of the previously calculated/paid bonus and fuel consumption (Volume) in the response when this flag is ‘True’
          default: true
          example: true
        IncludeCurrentPeriodVolume: 
          type: boolean
          nullable: true
          description: The API will return the details of the monthly breakup of current period fuel consumption (Volume) in the response when this flag is ‘True’.
          default: false
          example: true                         
    ResponseVolumeBasedBonus:
      type: object
      required:
        - RequestId
        - Status
        - Data
      properties:
        RequestId:
          type: string
          description: "A unique request id in GUID format. The value is written to the Shell API Platform audit log for end to end traceability of a request.\r\n\r\n"
          pattern: '^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$'
          minLength: 36
          maxLength: 36
          example: eb621f45-a543-4d9a-a934-2f223b263c42
          format: uuid
        Status:
          description: Status of the response.
          example: SUCCESS
          enum:
            - SUCCESS
            - FAILED
            - PARTIAL_SUCCESS
        Data: 
          type: array
          description: List of Fee Item Summary records i.e. FeeItemSummary Entity
          items: 
            type: object
            properties:
              Configuration: 
                type: array
                description: Bonus configuration entity provides details of the Bonus or Association Bonus setup for the Payer.
                items: 
                  type: object
                  properties:
                    PricingAccountId: 
                      type: integer
                      description: Account identifier (in the Cards Platform) of the Pricing Account associated with the Payer. 
                      example: 123456
                    PricingAccountNumber: 
                      type: string
                      description: Account number of the Pricing Account associated with the Payer. 
                      example: GB000000123
                    PricingAccountShortName: 
                      type: string
                      description: Short name of the Pricing Account associated with the Payer.
                      example: MATTHEW
                    PricingAccountFullName: 
                      type: string
                      description: Full name of the Pricing Account associated with the Payer.
                      example: MATTHEW
                    FeeRuleId: 
                      type: integer
                      description: Bonus or association bonus configuration identifier (in the Cards Platform) that is associated to the payer.
                      example: 1
                    FeeRuleDescription: 
                      type: string
                      description: Bonus or association bonus configuration description that is associated to the payer.
                      example: NL/GAGO/D018/UP0.0120>1
                    FeeRuleDateEffective: 
                      type: string
                      nullable: true
                      description: The bonus or association bonus configuration becomes effective on the payer from this date.<br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    FeeRuleDateTerminated: 
                      type: string
                      nullable: true
                      description: The bonus or association bonus configuration is terminated for the payer on this date. <br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    BonusPaidTo: 
                      type: string
                      description: Configuration to specify how the bonus is paid. <br><br> Format - ID-Description <br><br> 1-Pay to Payer <br> 2-Pay to invoice levels before the payer <br> 3-Pay to specific customer <br> 4-Pay to Association Customer <br> 5-Pay to Associated Customers
                      example: 1-Pay to Payer
                    BonusPaidToAccountId: 
                      type: integer
                      nullable: true
                      description: Account identifier (in the Cards Platform) of the specific account to which the bonus is paid back (i.e., when “3-Pay to specific customer” is configured on “BonusPaidTo”). 
                      example: 123456
                    BonusPaidToAccountNumber:
                      type: string
                      description: Account number of the specific account to which the bonus is paid back (i.e., when “3-Pay to specific customer” is configured on “BonusPaidTo”).
                      example: GB000000123
                    BonusPaidToAccountShortName:
                      type: string
                      description: Short name of the specific account to which the bonus is paid back (i.e., when “3-Pay to specific customer” is configured on “BonusPaidTo”).
                      example: 12345
                    BonusPaidToAccountFullName:
                      type: string
                      description: Full name of the specific account to which the bonus is paid back (i.e., when “3-Pay to specific customer” is configured on “BonusPaidTo”).
                      example: GB000000123
                    Frequency:
                      type: string
                      description: Frequency of the configuration. <br><br> Format - ID-Description <br><br> 1-Daily (all days) <br> 2-Daily (only working days) <br> 3-Weekly – Monday
                      example: 3-Weekly – Monday
                    NextCalculationDate: 
                      type: string
                      nullable: true
                      description: The next bonus is calculated for the payer on this date. <br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    PreviousCalculatedDate:
                      type: string
                      nullable: true
                      description: The previous bonus was calculated for the payer on this date. <br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    FeeRuleBasis:
                      type: string
                      description: Fee Rule Basis configured. <br><br> format - ID-Description <br><br> 1-Currency Per Unit <br> 2-Percentage of Uplift <br> 3-Lump Sum
                      example: 3-Lump Sum
                    FeeRuleCurrencyCode: 
                      type: string
                      description: ISO currency code of the currency configured in the Bonus Configuration, if any.
                      example: GBP
                    FeeRuleCurrencySymbol: 
                      type: string
                      description: Currency symbol of the currency configured in the Bonus Configuration, if any.
                      example: £
                    FeeRuleAvailableFrom:
                      type: string
                      nullable: true
                      description: This bonus or association bonus is available from this date. <br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    FeeRuleAvailableTo:
                      type: string
                      nullable: true
                      description: This bonus or association bonus configuration will not be available from this date. <br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    FeeRuleLocations: 
                      type: array
                      description: List of locations where the bonus or association bonus configuration is applicable on the current date.
                      items: 
                        type: object
                        properties:
                          DelcoId:
                            type: integer
                            description: Delco Identifier.
                            example: 866 
                          Country: 
                            type: string
                            description: Country name.
                            example: United Kingdom
                          CountryCode: 
                            type: string
                            description: ISO Code of country.
                            example: UK
                          FuelNetworkId:
                            type: integer
                            nullable: true
                            description: Fuel Network Identifier.
                            example: 100007
                          NetworkName:
                            type: string
                            description: Network Name.
                            example: VALERO
                          SiteGroupId:
                            type: integer
                            nullable: true
                            description: Site-Group ID.
                            example: 100007
                          SiteGroupName: 
                            type: string
                            description: Site-Group name.
                            example: VALERO ENERGY LTD
                          SiteCode: 
                            type: integer
                            nullable: true
                            description: Site Code.
                            example: 999493
                          SiteId: 
                            type: integer
                            nullable: true
                            description: Site Identifier.
                            example: 100007
                          SiteName: 
                            type: string
                            description: Site Name.
                            example: VALERO ENERGY LTD
                    FeeRuleProducts: 
                      type: array
                      description: List of products on which the bonus or association bonus configuration is applicable on the current date.
                      items: 
                        type: object
                        properties:
                          ProductGroupID: 
                            type: integer
                            description: Product Group Id
                            example: 3
                          ProductGroupName:
                            type: string
                            description: Product Group name
                            example: Motor gasoline
                          ProductCode:
                            type: string
                            description: Client Product Code
                            example: 30 for Diesel AGO
                          ProductId:
                            type: integer
                            description: Product Id
                            example: 30 for Diesel AGO
                          ProductName:
                            type: string
                            description: Product name in English
                            example: Diesel AGO
                    FeeRuleTiers: 
                      type: array
                      description: List of fee rule tiers setup in the bonus or association bonus configuration on the current date.
                      items: 
                        type: object
                        properties:
                          TierMinimum:
                            type: integer
                            nullable: true
                            description: Minimum consumption configured in the tier.
                            example: 1234
                          TierMaximum:
                            type: integer
                            nullable: true
                            description: Maximum consumption configured in the tier.
                            example: 1234
                          Value:
                            type: number
                            format: float
                            description: Bonus value for the tier.
                            example: 1234.12
                    AssociatedAccounts: 
                      type: array
                      description: List of accounts associated with the payer setup for bonus and/or association bonus configuration.
                      items: 
                        type: object
                        properties:
                          AssociatedAccountId:
                            type: integer
                            description: Account identifier (in the Cards Platform) of the Associated Account associated with the Payer. 
                            example: 12345
                          AssociatedAccountNumber:
                            type: string
                            description: Account number of the Associated Account associated with the Payer. 
                            example: GB000000123  
                          AssociatedAccountShortName: 
                            type: string
                            description: Short name of the Associated Account associated with the Payer.
                            example: Account short name
                          AssociatedAccountFullName:
                            type: string
                            description: Full name of the Associated Account associated with the Payer.
                            example: Account Full name
              CurrentPeriodConsumption:
                type: array
                description: Consumption details of each bonus and/or association bonus that are currently setup for the payer (Monthly breakup).
                items: 
                  type: object
                  properties:
                    FeeRuleId:
                      type: integer
                      description: Bonus or association bonus configuration identifier (in the Cards Platform) that is associated to the payer.
                      example: 12345
                    FeeRuleDescription:
                      type: string
                      description: Bonus or association bonus configuration description that is associated to the payer.
                      example: NL/GAGO/D018/UP0.0120>1
                    Month:
                      type: integer
                      description: Consumption(Volume) of the month. <br><br> 1 for January, 12 for December
                      example: 1
                    Year:
                      type: integer
                      description: Consumption (Volume) of the year.
                      example: 2018 
                    TotalVolume:
                      type: number
                      format: float
                      description: Total volume consumption for the month/year above.
                      example: 10000.78
              HistoricalBonusPaid:
                type: array
                description: List of past 6 bonus periods consumption and bonus details as calculated of each bonus and/or association bonus setup for the payer.
                items: 
                  type: object
                  properties:
                    PayerId:
                      type: integer
                      description: Payer Id (i.e. Customer Id of the Payment Customer in Cards Platform).
                      example: 12345
                    PayerNumber:
                      type: string
                      description: Payer Number of the selected payer.
                      example: GB000000123
                    PayerShortName:
                      type: string
                      description: Payer short name.
                      example: Jorden
                    PayerFullName: 
                      type: string
                      description: Payer full name
                      example: MATTHEW
                    AccountId: 
                      type: integer
                      description: Account Id (i.e. Customer Id in Cards Platform).
                      example: 123456
                    AccountNumber:
                      type: string
                      description: Account Number of the selected payer.
                      example: GB000000123
                    AccountShortName:
                      type: string
                      description: Account short name.
                      example: SALT
                    AccountFullName:
                      type: string
                      description: Account full name.
                      example: ABCD1234
                    InvoiceAccountId: 
                      type: integer
                      description: Invoice Account Id (i.e. Customer Id in Cards Platform).
                      example: 12345
                    InvoiceAccountNumber: 
                      type: string
                      description: Invoice Account Number of the selected payer.
                      example: GB000000123
                    InvoiceAccountShortName:
                      type: string
                      description: Invoice Account short name.
                      example: DFE1234
                    InvoiceAccountFullName:
                      type: string
                      description: Invoice Account full name.
                      example: AZAD PVT LMT 
                    FeeRuleId:
                      type: integer
                      description: Bonus or association bonus configuration identifier (in the Cards Platform) that is associated to the bonus fee item.
                      example: 12345
                    FeeRuleDescription:
                      type: string
                      description: Bonus or association bonus configuration description that is associated to the bonus fee item.
                      example: NL/GAGO/D018/UP0.0120>1
                    FromDate:
                      type: string
                      nullable: true
                      description: Bonus was calculated from this date. <br><br> Note- Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    ToDate:
                      type: string
                      nullable: true
                      description: Bonus was calculated till this date. <br><br> Note -Clients to convert this to appropriate Date Time type.
                      format: YYYYMMDD
                      example: 20231223
                    BonusPaidTo:
                      type: string
                      description: Specifies how the bonus was paid back. <br><br> Format - ID-Description <br><br> 1-Pay to Payer <br> 2-Pay to invoice levels before the payer <br> 3-Pay to specific customer <br> 4-Pay to Association Customer <br> 5-Pay to Associated Customers
                      example: 5-Pay to Associated Customers
                    FeeItemId: 
                      type: integer
                      description: Bonus fee item identifier.
                      example: 12345
                    FeeRuleBasis:
                      type: string
                      description: Fee Rule Basis of the bonus fee item. <br><br> Format - ID-Description <br><br> 1-Currency Per Unit <br> 2-Percentage of Uplift <br> 3-Lump Sum
                      example: 2-Percentage of Uplift
                    FeeItemCurrencyCode: 
                      type: string
                      description: ISO currency code of the currency in which Bonus is paid.
                      example: GBP 
                    FeeItemCurrencySymbol:
                      type: string
                      description: Currency symbol of the currency in which Bonus is paid.
                      example: $
                    ProratedVolume: 
                      type: number
                      format: float
                      description: Prorated volume considered under the account as  configured for the bonus association.
                      example: 123.12
                    TotalVolume: 
                      type: number
                      format: float
                      description: Total volume considered for calculating the bonus.
                      example: 123.12
                    FeeProduct: 
                      type: string
                      description: Product as shown in the invoice for the bonus paid. <br><br> Format - ID-Description 
                      example: 1562-Bonus diesel Shell 
                    InvoiceGrossAmount: 
                      type: number
                      format: float
                      description: Gross Amount – Bonus Paid including VAT as shown on the Invoice
                      example: 123.12
                    InvoiceNetAmount: 
                      type: number
                      format: float
                      description: InvoiceNetAmount
                      example: 123.12
                    InvoiceVATAmount: 
                      type: number
                      format: float
                      description: VAT calculated for the bonus paid as shown on the Invoice
                      example: 123.12
                    IsFeeCancelled: 
                      type: boolean
                      description: True/False <br><br> True if bonus is generated but cancelled. When true, consider this as not paid.
                      example: true 
                    FeeItemTierProratedVolume: 
                      type: number
                      format: float
                      nullable: true
                      description: Prorated volume in the bonus fee item tier.
                      example: 123.12
                    FeeItemTierTotalVolume: 
                      type: number
                      format: float
                      nullable: true
                      description: Total volume in the bonus fee item tier.
                      example: 123.12
                    TierMinimum: 
                      type: integer
                      nullable: true
                      description: Tier minimum value considered for calculation
                      example: 123
                    TierRate: 
                      type: number
                      format: float
                      nullable: true
                      description: Tier rate considered for calculation
                      example: 123.12
        Warnings:
          $ref: '#/components/schemas/Warnings'     
    VolumeBasedPricing: 
      type: object
      properties:
        ColCoId: 
          type: integer
          nullable: true
          description: Collecting Company Id of the selected payer. <br><br> Optional if ColCoCode is passed else Mandatory.
          example: 1
        ColCoCode: 
          type: integer
          nullable: true
          description: Collecting Company Code (Shell Code) of the selected payer.  <br><br> Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.
          example: 86
        PayerId: 
          type: integer
          nullable: true
          description: Payer Id (i.e. Customer Id of the Payment of the selected payer. <br><br> Optional if PayerNumber is passed else Mandatory
          example: 12345
        PayerNumber: 
          type: string
          description: Payer Number of the selected payer. <br><br> Optional if PayerId is passed else Mandatory
          example: GB000000123
        IncludeHistory: 
          type: boolean
          nullable: true
          description: The API will return the details of the previously calculated/paid bonus and fuel consumption (Volume) in the response when this flag is ‘True’
          default: true
          example: true
        IncludeCurrentPeriodVolume: 
          type: boolean
          nullable: true
          description: The API will return the details of the monthly breakup of current period fuel consumption (Volume) in the response when this flag is ‘True’.
          default: false
          example: true 
    ResponseVolumeBasedPricing:
      type: object
      required:
        - RequestId
        - Status
        - Data
      properties:
        RequestId:
          type: string
          description: "A unique request id in GUID format. The value is written to the Shell API Platform audit log for end to end traceability of a request.\r\n\r\n"
          pattern: '^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$'
          minLength: 36
          maxLength: 36
          example: eb621f45-a543-4d9a-a934-2f223b263c42
          format: uuid
        Status:
          description: Status of the response.
          example: SUCCESS
          enum:
            - SUCCESS
            - FAILED
            - PARTIAL_SUCCESS
        Data: 
          type: array
          description: List of Fee Item Summary records i.e. FeeItemSummary Entity
          items: 
            type: object
            properties:
              Configuration: 
                type: array
                description: Bonus configuration entity provides details of the Bonus or Association Bonus setup for the Payer.
                items: 
                  type: object
                  properties:
                    PricingAccountId: 
                      type: integer
                      description: Account identifier (in the Cards Platform) of the Pricing Account associated with the Payer. 
                      example: 123456
                    PricingAccountNumber: 
                      type: string
                      description: Account number of the Pricing Account associated with the Payer. 
                      example: GB000000123
                    PricingAccountShortName: 
                      type: string
                      description: Short name of the Pricing Account associated with the Payer.
                      example: ABCD1234
                    PricingAccountFullName: 
                      type: string
                      description: Full name of the Pricing Account associated with the Payer.
                      example: ABCD1234
                    FeeRuleId: 
                      type: integer
                      description: Bonus or association bonus configuration identifier (in the Cards Platform) that is associated to the payer.
                      example: 12345
                    FeeRuleDescription: 
                      type: string
                      description: Bonus or association bonus configuration description that is associated to the payer.
                      example: NL/GAGO/D018/UP0.0120>1
                    FeeRuleDateEffective: 
                      type: string
                      nullable: true
                      description: The bonus or association bonus configuration becomes effective on the payer from this date.<br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    FeeRuleDateTerminated: 
                      type: string
                      nullable: true
                      description: The bonus or association bonus configuration is terminated for the payer on this date. <br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    BonusPaidTo: 
                      type: string
                      description: Configuration to specify how the bonus is paid. <br><br> Format - ID-Description <br><br> 1-Pay to Payer <br> 2-Pay to invoice levels before the payer <br> 3-Pay to specific customer <br> 4-Pay to Association Customer <br> 5-Pay to Associated Customers
                      example: 1-Pay to Payer
                    BonusPaidToAccountId: 
                      type: integer
                      nullable: true
                      description: Account identifier (in the Cards Platform) of the specific account to which the bonus is paid back (i.e., when “3-Pay to specific customer” is configured on “BonusPaidTo”). 
                      example: 123456
                    BonusPaidToAccountNumber:
                      type: string
                      description: Account number of the specific account to which the bonus is paid back (i.e., when “3-Pay to specific customer” is configured on “BonusPaidTo”).
                      example: GB000000123
                    BonusPaidToAccountShortName:
                      type: string
                      description: Short name of the specific account to which the bonus is paid back (i.e., when “3-Pay to specific customer” is configured on “BonusPaidTo”).
                      example: 12345
                    BonusPaidToAccountFullName:
                      type: string
                      description: Full name of the specific account to which the bonus is paid back (i.e., when “3-Pay to specific customer” is configured on “BonusPaidTo”).
                      example: GB000000123
                    Frequency:
                      type: string
                      description: Frequency of the configuration. <br><br> Format - ID-Description <br><br> 1-Daily (all days) <br> 2-Daily (only working days) <br> 3-Weekly – Monday
                      example: 3-Weekly – Monday
                    NextCalculationDate: 
                      type: string
                      nullable: true
                      description: The next bonus is calculated for the payer on this date. <br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    PreviousCalculatedDate:
                      type: string
                      nullable: true
                      description: The previous bonus was calculated for the payer on this date. <br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    FeeRuleBasis:
                      type: string
                      description: Fee Rule Basis configured. <br><br> format - ID-Description <br><br> 1-Currency Per Unit <br> 2-Percentage of Uplift <br> 3-Lump Sum
                      example: 3-Lump Sum
                    FeeRuleCurrencyCode: 
                      type: string
                      description: ISO currency code of the currency configured in the Bonus Configuration, if any.
                      example: GBP
                    FeeRuleCurrencySymbol: 
                      type: string
                      description: Currency symbol of the currency configured in the Bonus Configuration, if any.
                      example: £
                    FeeRuleAvailableFrom:
                      type: string
                      nullable: true
                      description: This bonus or association bonus is available from this date. <br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    FeeRuleAvailableTo:
                      type: string
                      nullable: true
                      description: This bonus or association bonus configuration will not be available from this date. <br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
                    FeeRuleLocations: 
                      type: array
                      description: List of locations where the bonus or association bonus configuration is applicable on the current date.
                      items: 
                        type: object
                        properties:
                          DelcoId:
                            type: integer
                            description: Delco Identifier.
                            example: 866 
                          Country: 
                            type: string
                            description: Country name.
                            example: United Kingdom
                          CountryCode: 
                            type: string
                            description: ISO Code of country.
                            example: UK
                          FuelNetworkId:
                            type: integer
                            nullable: true
                            description: Fuel Network Identifier.
                            example: 100007
                          NetworkName:
                            type: string
                            description: Network Name.
                            example: VALERO
                          SiteGroupId:
                            type: integer
                            nullable: true
                            description: Site-Group ID.
                            example: 100007
                          SiteGroupName: 
                            type: string
                            description: Site-Group name.
                            example: VALERO ENERGY LTD
                          SiteCode: 
                            type: integer
                            nullable: true
                            description: Site Code.
                            example: 999493
                          SiteId: 
                            type: integer
                            nullable: true
                            description: Site Identifier.
                            example: 100007
                          SiteName: 
                            type: string
                            description: Site Name.
                            example: VALERO ENERGY LTD
                    FeeRuleProducts: 
                      type: array
                      description: List of products on which the bonus or association bonus configuration is applicable on the current date.
                      items: 
                        type: object
                        properties:
                          ProductGroupID: 
                            type: integer
                            description: Product Group Id
                            example: 3
                          ProductGroupName:
                            type: string
                            description: Product Group name
                            example: Motor gasoline
                          ProductCode:
                            type: string
                            description: Client Product Code
                            example: 30 for Diesel AGO
                          ProductId:
                            type: integer
                            description: Product Id
                            example: 30 for Diesel AGO
                          ProductName:
                            type: string
                            description: Product name in English
                            example: Diesel AGO
                    FeeRuleTiers: 
                      type: array
                      description: List of fee rule tiers setup in the bonus or association bonus configuration on the current date.
                      items: 
                        type: object
                        properties:
                          TierMinimum:
                            type: integer
                            nullable: true
                            description: Minimum consumption configured in the tier.
                            example: 1234
                          TierMaximum:
                            type: integer
                            nullable: true
                            description: Maximum consumption configured in the tier.
                            example: 1234
                          Value:
                            type: number
                            format: float
                            description: Bonus value for the tier.
                            example: 1234.12
              CurrentPeriodConsumption:
                type: array
                description: Consumption details of each bonus and/or association bonus that are currently setup for the payer (Monthly breakup).
                items: 
                  type: object
                  properties:
                    FeeRuleId:
                      type: integer
                      description: Bonus or association bonus configuration identifier (in the Cards Platform) that is associated to the payer.
                      example: 12345
                    FeeRuleDescription:
                      type: string
                      description: Bonus or association bonus configuration description that is associated to the payer.
                      example: NL/GAGO/D018/UP0.0120>1
                    PriceRuleID: 
                      type: integer
                      description: Pricing current period Pricing Price Rule ID that is associated to the payer.
                      example: 100005
                    PriceRuleDescription: 
                      type: string
                      description: Pricing current period pricing rule description that is associated to the payer.
                      example: PL/GAGO/GMOT/UL0.055
                    TotalVolume: 
                      type: number
                      format: float
                      description: Total volume consumption for the current period.
                      example: 10000.78
                    NextFeeCreationDate: 
                      type: string
                      description: Next Fee Rule Creation Date for that is associated to the payer. <br><br> Note - Clients to convert this to appropriate Date Time type.
                      format: date
                      example: 20231223
              History: 
                type: array
                description: List of past 6 months consumption and Volume details of each pricing and/or association bonus setup for the payer.
                items: 
                  type: object
                  properties:
                    FromDate: 
                      type: string
                      description: Pricing History Period Start date and should be the first date of the month.
                      format: date
                      example: 20231223
                    ToDate: 
                      type: string
                      description: Pricing History Period Start date and should be the first date of the month.
                      format: date
                      example: 20231223
                    FeesRuleID: 
                      type: integer
                      description: Pricing History Period Fees Rule ID that is associated to the period of that associated payer
                      example: 8081
                    FeesRuleDescription: 
                      type: string
                      description: Pricing History Period Fees Rule Description that is associated to the period of that associated payer.  
                      example: PT/P067/D120/P4.0
                    TotalVolume: 
                      type: number
                      format: float
                      description: Total Quantity for the Pricing History Period that is associated to that payer.
                      example: 12356.66
              Warnings:
                $ref: '#/components/schemas/Warnings'  
    FeesSummary: 
      type: object
      properties:
        ColCoId: 
          type: integer
          nullable: true
          description: Collecting Company Id of the selected payer. <br><br> Optional if ColCoCode is passed else Mandatory.
          example: 1
        ColCoCode: 
          type: integer
          nullable: true
          description: Collecting Company Code (Shell Code) of the selected payer.  <br><br> Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.
          example: 86
        PayerId: 
          type: integer
          nullable: true
          description: Payer Id (i.e. Customer Id of the Payment Customer of the selected payer. <br><br> Optional if PayerNumber is passed else Mandatory
          example: 12345
        PayerNumber: 
          type: string
          description: Payer Number of the selected payer. <br><br> Optional if PayerId is passed else Mandatory
          example: GB000000123
        CardId: 
          type: integer
          nullable: true
          description: Card Id. <br><br> When both Card Id and Card PAN are not present on request, the response will have all the fee items under the selected payer or account.
          example: 275549
        CardPAN: 
          type: string
          description: Full Card PAN. <br><br> When both Card Id and Card PAN are not present on request, the response will have all the fee items under the selected payer or account or card group.
          example: 7002051006629890645
        InvoiceStatus: 
          type: string
          description: Invoice status of the fee items. <br><br> Possible options - <br> I - Invoiced <br> U – Un-Invoiced <br> A – All
          maxLength: 1
          example: I 
        FeeTypeGroup: 
          type: string
          description: Fee type group in under which the Fee item is generated. <br><br> Allowed values - <br> Account Charges <br> Card Charges <br> Others Charges
          example: Card Charges
        FeeTypeId: 
          type: integer
          nullable: true
          description: Fee Type Id. <br><br> 1	Simple Fee <br> 3	Card Event Fee <br> 4	Customer Event Fee
          example: 1
        FromDate: 
          type: string
          nullable: true
          description: Fee Item FromDate/Time. <br><br> Should be with in last 24 months. <br><br> Maximum of 210 days duration allowed per search, its configurable.
          format: date
          example: 20242312
        ToDate: 
          type: string
          nullable: true
          description: Fee Item To Date/Time. <br><br> When blank and FromDate is provided on the input, all fee items took place after the given from date/time should be returned. Note that the search is allowed for the maximum of 60 days. Hence if the FromDate is older than 60 days from current date then the fee items for 60 days from FromDate will be returned. 
          format: date
          example: 20252312
        Period: 
          type: integer
          nullable: true
          description: Fee items Period. This is ignored when FromDate/Todate is supplied on the request. <br><br> 1. Last 7 Days <br> 2. Last 30 Days <br> 3. Last 90 Days <br> 4. Last 180 Days 
          example: 1
        IncludeCancelledItems: 
          type: boolean
          nullable: true
          description: True or False. When True, cancelled fee items are included on API response
          default: False
          example: false
        ProductId: 
          type: integer
          nullable: true 
          description: Product Id. <br><br> 102	Invoice production fee <br> 103	Account fee <br> 104	Transaction fee <br> 105	Card membership fee
          example: 102
        ProductCode: 
          type: string
          description: Product Code 
          example: 2	Service fee
        LineItemDescription: 
          type: string
          description: Line item description. <br><br> Minimum of 4 characters should be provided else not considered <br><br> Those fee items that have the entered value at any part of the line item description will be returned.
          minLength: 4
          example: ABCD1234
        CurrentPage: 
          type: integer
          nullable: true
          description: Page Number (as shown to the users)
          default: 1
          example: 1
        PageSize: 
          type: integer
          nullable: true
          description: Page Size – Number of records to show on a page. <br><br> Return all rows if -1 is supplied as page size.
          default: 50 
          example: 1
        SortOrder: 
          type: string
          description: Allowed Sorting Options - <br> •	FeeDateAscending <br> •	FeeDateDescending <br> •	NetAmountAscending <br> •	NetAmountDescending
          default: 1
          example: 1,3
      required:
        - InvoiceStatus 
    ResponseFeesSummary:
      type: object
      required:
        - RequestId
        - Status
        - Data
      properties:
        RequestId:
          type: string
          description: "A unique request id in GUID format. The value is written to the Shell API Platform audit log for end to end traceability of a request.\r\n\r\n"
          pattern: '^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$'
          minLength: 36
          maxLength: 36
          example: eb621f45-a543-4d9a-a934-2f223b263c42
          format: uuid
        Status:
          description: Status of the response.
          example: SUCCESS
          enum:
            - SUCCESS
            - FAILED
            - PARTIAL_SUCCESS
        Data: 
          type: array
          description: List of Fee Item Summary records i.e. FeeItemSummary Entity
          items: 
            type: object
            properties:
              FeeTypeGroup: 
                type: string
                description: Fee type group in under which the Fee item is generated.
                example: Account Charges     
              FeeTypeId: 
                type: string
                description: Fee Type Id. <br><br> ID – Description.
                example: 1-Simple Fee
              PayerId: 
                type: integer
                nullable: true
                description: Payer Id of the selected payer. <br><br> Either PayerId or PayerNumber or both must be passed.
                example: 123456
              ProductId: 
                type: integer
                nullable: true
                description: Product Id. <br><br> Sample list of product ids and description.
                example: 100     
              ProductCode: 
                type: string
                description: Product Code. <br><br> Sample list of product codes and description. <br> 2 Service fee <br> 4 Invoice production fee <br> 5 Account fee <br> 6 Transaction fee <br> 7 Card membership fee
                example: 2
              ProductGroupId: 
                type: integer
                description: Product Group Name. <br><br> Sample list <br> 22 - Card related fees <br> 23- Monetary Adjustment
                example: 22
              TotalQuantity: 
                type: number
                format: float
                description: Total Quantity
                example: 123.12
              TotalInvoiceNetAmount: 
                type: number
                format: float
                description: Total Net amount in invoice currency
                example: 123.12
              TotalInvoiceGrossAmount: 
                type: number
                format: float
                description: Total Gross amount in invoice currency
                example: 123.12
              TotalInvoiceVATAmount: 
                type: number
                format: float
                description: Total VAT amount in invoice currency
                example: 123.12
              InvoiceCurrencyCode: 
                type: string
                description: ISO currency code 
                example: GBP
              InvoiceCurrencySymbol: 
                type: string
                description: Currency symbol of the Invoice Currency Code 
                example: £ 
        Warnings:
          $ref: '#/components/schemas/Warnings'
    Exceptions: 
      type: object
      properties:
        ColCoId: 
          type: integer
          nullable: true
          description: Collecting Company Id of the selected payer. <br><br> Optional if ColCoCode is passed else Mandatory.
          example: 1
        ColCoCode: 
          type: integer
          nullable: true
          description: Collecting Company Code (Shell Code) of the selected payer.  <br><br> Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.
          example: 86
        PayerId: 
          type: integer
          nullable: true
          description: Payer Id of the selected payer. <br><br> Optional if PayerNumber is passed else Mandatory
          example: 12345
        PayerNumber: 
          type: string
          description: Payer Number of the selected payer. <br><br> Optional if PayerId is passed else Mandatory
          example: GB000000123
        TransactionsFromDate: 
          type: string
          nullable: true
          description: Exceptions to be searched in transactions from date. <br><br> Should be with in last 24 months from the ToDate parameter. <br><br> Note - <br> 1.	For S, M, L customers allowed search period will be within 6 months. <br> 2.	For XL, XXL customers allowed search period will be within 3 months. <br> 3.	For Shell Admin/Service account allowed search period will be within 3 months. <br><br> MS will throw error if the search period crosses the limit as mentioned above.
          format: date
          example: 20231223
        TransactionsToDate: 
          type: string
          nullable: true
          description: Exceptions to be searched in transactions until date. <br><br> Note - <br> 1.	For S, M, L customers allowed search period will be within 6 months. <br> 2.	For XL, XXL customers allowed search period will be within 3 months. <br> 3.	For Shell Admin/Service account allowed search period will be within 3 months. <br><br> MS will throw error if the search period crosses the limit as mentioned above.
          format: date
          example: 20231223 
        Value: 
          type: number
          format: float
          description: Value to be used on the Filter Condition.
          example: 100 
        Condition: 
          type: integer
          description: Filter condition for the Exceptions. <br><br> •	VolumeGreaterThan <br> •	VolumeLessThan <br> •	UsageGreaterThan <br> •	UsageLessThan <br> •	ValueGreaterThan (in Customer Currency) <br> •	ValueLessThan  (in Customer Currency) <br><br> Note - <br><br> When “OutputType” = 1 is passed as input, above 3 and 4 Condition are not applicable.
          example: 123
        Accounts: 
          type: object
          description: List of Account entity. Used as criteria to search restrictions applied on cards that are under the given list of accounts. 
          properties:
            AccountId: 
              type: integer
              nullable: true
              description: Account ID of the customer. <br><br> Optional if AccountNumber is passed else Mandatory.
              example: 1234
            AccountNumber: 
              type: string
              description: Account Number of the customer. <br><br> Optional if AccountId is passed else Mandatory.
              example: GB000000123
        Products: 
          type: array
          description: List of Products configured in Card Platform for searching exceptions. 
          items: 
            type: object
            properties:
              Productid: 
                type: integer
                nullable: true
                description: Product Id as configured in Card Platform for searching exceptions for the requested product Id. <br><br> Optional if ProductCode is passed else Mandatory.
                example: 1234
              ProductCode: 
                type: string
                description: Product Code as Configured in Card Platform for searching exceptions for requested Product Code. <br><br> Optional if ProductId is passed else Mandatory.
                example: 30 for Diesel AGO
        ExceptionPeriod: 
          type: integer
          nullable: true
          description: Period in which the Exceptions such as Monthly/Weekly or Daily volume, value or usage to be identified in the given transactions date range. It is only applied when the Output Type is specified as "Cards". <br><br> Mandatory when Output Type is Cards <br> 1.	Month <br> 2.	Week <br> 3.	Day <br> 4.	Date Range
          example: 1
        OutputType: 
          type: integer
          description: Output Type for Exceptions. <br><br> Possible values - <br> 1.	Transactions <br> 2.	Cards
          example: 1
        FuelOnly: 
          type: boolean
          nullable: true
          description: True/False <br><br> When passed as ‘True’ Only returned records with Fuel transactions. <br><br> When passed as ‘False’ the above condition will not be checked.
          default: false
          example: false 
        SiteGroupIds: 
          type: array
          description: SiteGroupIds to be applied to the Filter Condition. <br><br> When not passed, ignored. <br><br> When passed, transactions that are matching with the provided list of site group id’s are only returned.
          items: 
            type: integer
          example: ['123', '234']
      required:
        - Condition
        - TransactionsToDate
        - TransactionsFromDate
        - OutputType
    ResponseExceptions:
      type: object
      required:
        - RequestId
        - Status
        - Data
      properties:
        RequestId:
          type: string
          description: "A unique request id in GUID format. The value is written to the Shell API Platform audit log for end to end traceability of a request.\r\n\r\n"
          pattern: '^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$'
          minLength: 36
          maxLength: 36
          example: eb621f45-a543-4d9a-a934-2f223b263c42
          format: uuid
        Status:
          description: Status of the response.
          example: SUCCESS
          enum:
            - SUCCESS
            - FAILED
            - PARTIAL_SUCCESS
        Data: 
          type: array
          description: List of exception details.
          items: 
            type: object
            properties:
              CardsExceptions:
                type: array
                description: List of all Card related Exceptions for the given search criteria. <br><br> -	This entity will be empty when the OutputType is passed as Transactions. <br><br> -	This list will not be populated if ‘UseFieldID’ is ‘True’ in the input.
                items: 
                  type: object
                  properties:
                    AccountId: 
                      type: integer
                      description: Account Id
                      example: 29484
                    CardId: 
                      type: integer
                      description: Unique Card Id
                      example: 1234
                    PAN: 
                      type: string
                      description: Card PAN <br><br> Mask PAN if enabled at configuration (Mask all digits except the Last 6 digits of the PAN)
                      example: ABCD1234
                    DriverName: 
                      type: string
                      description: Driver name
                      example: ANDREW GILBERRY
                    VRN: 
                      type: string
                      description: Vehicle Registration Number
                      example: 34235
                    PayerId: 
                      type: integer
                      description: Payment customer id of the customer.
                      example: 123455
                    PayerNumber: 
                      type: string
                      description: Payment customer number.
                      example: GB000000123
                    AccountNumber: 
                      type: string
                      description: Account Number
                      example: GB99215176
                    AccountShortName: 
                      type: string
                      description: Account Short Name
                      example: MATTHEW
                    PayerShortName: 
                      type: string
                      description: Payer Short Name
                      example: MATTHEW
                    Day: 
                      type: integer
                      nullable: true
                      description: Summary Day - Populated when the Period is passed as ‘Day’.
                      example: 2 
                    Week: 
                      type: integer
                      nullable: true
                      description: Summary Week Number with in the given date range. Populated when the Value of Period is Passed as ‘Week’.
                      example: 2 
                    Month: 
                      type: integer
                      nullable: true
                      description: Summary Month - Populated when the Value of Period is Passed as ‘Month’.
                      example: 5 
                    Year: 
                      type: integer
                      nullable: true
                      description: Summary Year - Populated when the Value of Period is Passed as Year.
                      example: 2017
                    TotalTransactions: 
                      type: integer
                      description: Total number of Transactions met with the given exception criteria.
                      example: 4 
                    TotalSalesItems: 
                      type: integer
                      description: Total number of Sales Items met with the given exception criteria.
                      example: 4 
                    TotalQuantity: 
                      type: number
                      format: float
                      description: Total Quantity of Transactions met with the given exceptions criteria.
                      example: 261 
                    TotalAmount: 
                      type: number
                      format: float
                      description: Total Amount (In Customer Currency) of Transactions met with the given exceptions criteria.
                      example: 100.21
                    CurrencyCode: 
                      type: string
                      description: ISO currency code 
                      example: GBP
                    CurrencySymbol: 
                      type: string
                      description: Currency symbol of the Invoice Currency Code 
                      example: $
              TransactionsExceptions: 
                type: array
                description: List of all Transaction related Exceptions for the given search criteria. <br><br> This entity will be empty when the OutputType is passed as Cards. <br><br> This list will not be populated if ‘UseFieldID’ is ‘True in the input.
                items: 
                  type: object
                  properties:
                    SalesItemId: 
                      type: integer
                      format: int64
                      description: Unique Sales Item Identifier
                      example: 18315958002
                    CardId: 
                      type: integer
                      description: Unique Card Identifier
                      example: 1234
                    ProductId: 
                      type: integer
                      description: Product Id
                      example: 2 
                    TransactionGUID: 
                      type: string
                      description: Transaction Unique Identifier
                      example: ABCD1234
                    TransactionDate: 
                      type: string
                      nullable: true
                      description: Local Transaction Date  of where the transaction took place. <br><br> Note - Clients to convert this to appropriate DateTime type  
                      format: Date
                      example: 20231223
                    CustomerInvoiceValueTotalGross: 
                      type: number
                      format: float
                      description: Total Gross Amount for the Invoice Customer
                      example: 123.12
                    CardPAN: 
                      type: string
                      description: Card PAN number. <br><br> Returns masked PAN number when masking is enabled at the configuration (Mask all digits except the last 6 digits of the PAN). <br><br> Masking at customer level is not supported in V1
                      example: 7002051006629890645
                    CardExpiry: 
                      type: string
                      nullable: true
                      description: Card Expiry Date. <br><br> Note - Clients to convert this to appropriate DateTime type.
                      example: 20311223 12:12:12
                    TransactionTime: 
                      type: string
                      nullable: true
                      description: Local Transaction Time of where the transaction took place. <br><br> format HH:mm:ss (24 hours format). <br><br> Note - Clients to convert this to appropriate type.
                      example: 12:12:12
                    UTCOffset: 
                      type: string
                      nullable: true
                      description: UTC Offset extracted from Sales Date time. Note - This may not be accurate for all TPN transactions. <br><br> format - +/-HH:mm:ss (24 hours format)
                      example: +12:12:12
                    FleetIdInput: 
                      type: string
                      nullable: true
                      description: Fleet Id Input as entered by the drivers at the time of transaction
                      example: XYZ1234
                    OdometerInput: 
                      type: integer
                      description: Odometer Input as entered by the drivers at the time of transaction
                      example: 1234
                    DriverName: 
                      type: string
                      description: Driver Name embossed on the card
                      example: SALT
                    VehicleRegistration: 
                      type: string
                      description: Vehicle Registration Number embossed on the card
                      example: MV65YLH
                    InvoiceCurrencyCode: 
                      type: string
                      description: ISO currency code 
                      example: GBP
                    InvoiceCurrencySymbol: 
                      type: string
                      description: Currency symbol of the Invoice Currency Code. <br>
                      example: $ 
                    TransactionCurrencyCode: 
                      type: string
                      description: ISO currency code 
                      example: GBP
                    TransactionCurrencySymbol: 
                      type: string
                      description: Currency symbol of the Transaction Currency Code. <br>
                      example: £ 
                    TransactionNetAmount: 
                      type: number
                      format: float
                      nullable: true
                      description: Net Amount 
                      example: 123.12
                    TransactionTax: 
                      type: number
                      format: float
                      description: Tax Amount
                      example: 123.12
                    TransactionGrossAmount: 
                      type: number
                      format: float
                      description: Gross Amount
                      example: 123.12
                    InvoiceNetAmount: 
                      type: number
                      format: float
                      description: Invoiced Net Amount 
                      example: 123.12
                    InvoiceTax: 
                      type: number
                      format: float
                      description: Invoiced Tax Amount
                      example: 123.12
                    InvoiceGrossAmount: 
                      type: number
                      format: float
                      description: Invoice Gross Amount
                      example: 123.1
                    PurchasedInCountry: 
                      type: string
                      description: Country of Purchase 
                      example: France
                    AccountId: 
                      type: integer
                      description: Account Id 
                      example: 1234
                    AccountNumber: 
                      type: string
                      description: Account Number
                      example: GB99215176
                    AccountName: 
                      type: string
                      description: Account Name
                      example: MATTHEW ALGIE & COMPANY LIMITED
                    AccountShortName: 
                      type: string
                      description: Account Short Name
                      example: MATTHEW ALGIE & COMPANY LIMITED
                    Quantity: 
                      type: number
                      format: float
                      description: Quantity/Volume
                      example: 123.12
                    FuelProduct: 
                      type: boolean
                      description: True if the product on transaction is listed as a fuel product else return false
                      example: true 
                    UnitPriceInTransactionCurrency: 
                      type: number
                      format: float
                      description: Product Unit Price in transaction currency
                      example: 123.12
                    UnitPriceInInvoiceCurrency: 
                      type: number
                      format: float
                      description: Product Unit Price in invoice currency
                      example: 123.12
                    UnitDiscountTransactionCurrency: 
                      type: number
                      format: float
                      description: Unit Discount in transaction currency
                      example: 123.12
                    UnitDiscountInvoiceCurrency: 
                      type: number
                      format: float
                      description: Unit Discount in invoice currency
                      example: 123.12
                    IsInvoiced: 
                      type: boolean
                      description: True when the transaction is already invoice, else return False
                      example: true 
                    InvoiceNumber: 
                      type: string
                      description: Invoice Number if invoiced
                      example: S04500493
                    InvoiceDate: 
                      type: string
                      nullable: true
                      description: Invoice Date. <br><br> Note -Clients to convert this to appropriate DateTime type.
                      format: date
                      example: 20231223
                    SiteCode: 
                      type: string
                      description: Site Code
                      example: 050001 
                    SiteName: 
                      type: string
                      description: Site Name
                      example: CHARNOCK RICHARD NTHBOUND MWSA 0755
                    SiteCountry: 
                      type: string
                      description: Site Country
                      example: Germany
                    Location: 
                      type: object
                      description: Geography Location entity for Site Location
                      properties:
                        Lat: 
                          type: string
                          description: Latitude for the Site Geographic Location
                          example: 37.4224764
                        Lng: 
                          type: string
                          description: Longitude for the Site Geographic Location
                          example: 122.0842499
                    CardGroupName: 
                      type: string
                      description: Card Group Name
                      example: 006240 FIRE BRIGHT SOLUTIONS
                    ReceiptNumber: 
                      type: string
                      description: Receipt Number
                      example: 01234
                    ProductCode: 
                      type: string
                      description: Product Code
                      example: TMF Charges
                    ProductName: 
                      type: string
                      description: Product Name
                      example: Unleaded - High octane
                    ProductGroupId: 
                      type: integer
                      description: Product Group Id
                      example: 1234
                    ProductGroupName: 
                      type: string
                      description: Product Group Name
                      example: Parent Product Group
                    DelCoExchangeRate: 
                      type: number
                      format: float
                      description: DelCo Exchange Rate (Site exchange rate)
                      example: 123.12
                    ColCoExchangeRate: 
                      type: number
                      format: float
                      description: ColCo Exchange Rate (Customer exchange rate)
                      example: 123.12
                    IsShellSite: 
                      type: boolean
                      description: True when transaction occurred at a Shell site else return False
                      example: true 
                    Network: 
                      type: string
                      description: Network as configured. (Shell PH, ESSO, etc.,)
                      example: Shell PH
                    SiteGroupId: 
                      type: integer
                      description: Site Group Id
                      example: 202 
                    SiteGroupName: 
                      type: string
                      description: Site GroupName
                      example: CZ 9100 ECONOMY NETWORK
                    PostingDate: 
                      type: string
                      nullable: true
                      description: Transaction Posting Date. <br><br> Note - Clients to convert this to appropriate DateTime type.
                      format: DateTime
                      example: 20231223 12:12:12
                    IssuerCode: 
                      type: string
                      description: First digits of the Card PAN. <br><br> 7002 = Fleet  <br> 7077 = CRT
                      example: 7077 = CRT
                    PurchasedInCountryCode: 
                      type: string
                      description: ISO code of the country where the transaction took place
                      example: NL
                    CustomerCountryCode: 
                      type: string
                      description: ISO code of the  Customer Country
                      example: NL 
                    CustomerCountry: 
                      type: string
                      description: Name of the Customer Country
                      example: Netherlands
                    ReleaseCode: 
                      type: string
                      description: Release code, 7th Digit of the Card PAN
                      example: 8 for 702188 
                    CardGroupId: 
                      type: string
                      description: Card group ID (auto generated by Cards Platform)
                      example: 200
                    CardSequenceNumber: 
                      type: string
                      description: 3 digits, Card sequence number and Check digit  (Digit 16,17 and 18 on the card pan)
                      example: 002
                    CheckDigit: 
                      type: string
                      description: Check digit, Last number of the card pan
                      example: GHE1234
                    FleetIDDescription: 
                      type: string
                      description: FleetId/CRN description in Card Platform configured at the account level
                      example: Example description 
                    VATRate: 
                      type: number
                      format: double
                      description: VAT Percentage
                      example: 0.20 
                    VATCategory: 
                      type: string
                      description: VAT Category Id-Description. <br><br> 1-Zero Rated <br> 2-A1 PH-O 12% Sales Domestic <br> 3-VAT exempt
                      example: 3-VAT exempt
                    VATonNetAmount: 
                      type: number
                      format: double
                      description: VAT on Net Amount (in transaction currency) 2 decimals
                      example: 12.21
                    VATCountry: 
                      type: string
                      description: VAT Country
                      example: Netherlands
                    EffectiveDiscountInTrxCurrency: 
                      type: number
                      format: double
                      description: Effective Discount (excluding VAT, in transaction currency)  4 digits
                      example: 0.0000
                    TransactionType: 
                      type: string
                      description: Transaction Type
                      example: Purchase when Card is Present else Blank
                    PINIndicator: 
                      type: string
                      nullable: true
                      description: Pin Indicator (Indicates whether PIN used or not used at the time of transaction)
                      example: Y 
                    VATApplicable: 
                      type: string
                      description: Is VAT Applicable for this transaction
                      example: Y 
                    NetInvoiceIndicator: 
                      type: string
                      nullable: true
                      description: Net Invoice Indicator, Will the customer receive an invoice without VAT?
                      example: Y 
                    CustomerCurrencyCode: 
                      type: string
                      description: Customer currency code
                      example: GBP
                    CustomerCurrencySymbol: 
                      type: string
                      description: Customer currency Symbol
                      example: £
                    EffectiveUnitDiscountInCustomerCurrency: 
                      type: number
                      format: float
                      nullable: true
                      description: Effective Unit Discount (excluding VAT in Customer currency)
                      example: 123.12
                    EffectiveDiscountInCustomerCurrency: 
                      type: number
                      format: float
                      nullable: true
                      description: Effective Discount (excluding VAT in Customer currency)
                      example: 123.12
                    VATonNetAmountInCustomerCurrency: 
                      type: number
                      format: float
                      description: VAT on Net Amount (in Customer currency)
                      example: 123.12
                    DiscountType: 
                      type: string
                      description: Discount Type. <br><br> 1-None <br> 2-Pence per unit <br> 3-Percentage
                      example: 3-Percentage
                    TransactionStatus: 
                      type: string
                      description: Transaction status  "U" or "I". <br><br> “U” stands for Uninvoiced <br> “U” stands for Uninvoiced
                      example: U 
                    PayerGroup: 
                      type: string
                      description: Payer Group applicable for the Large Customer NL+8 digit code
                      example: 12119008 
                    RefundFlag: 
                      type: string
                      description: Refund Flag “N” for Not Refunded and “Y” for Refunded.
                      example: 'N'
                    OriginalSalesItemId: 
                      type: string
                      description: Shows Sales Item Id of the original item that was refunded
                      example: 1231
                    DelcoName: 
                      type: string
                      description: Delco Name
                      example: SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV 
                    DelcoCode: 
                      type: string
                      description: Payer number (Country code+8 digits)
                      example: NL10042616 
                    PayerName: 
                      type: string
                      description: Payer name
                      example: V.M. LE COMTE  
                    CardExpiryPeriod: 
                      type: string
                      description: Year/Month of the Card Expiry captured on the transaction
                      example: 1901 
                    AuthorisationCode: 
                      type: string
                      description: Authorisation code of the transaction
                      example: 011256
                    TransactionId: 
                      type: string
                      description: Unique id of the transaction that may include one or more salesitems
                      example: io9KVXk1UkW57XWKyeaHHg
                    TransactionLine: 
                      type: string
                      description: Transaction line item number
                      example: 1
                    AllowClearing: 
                      type: string
                      description: Is the Sales Item allowed for clearing? i.e. not written off
                      example: 'Y'
                    CRMNumber: 
                      type: string
                      description: CRM Case number if the sales item is in dispute
                      example: ABCD1234
                    DisputeStatus: 
                      type: string
                      description: Sales Item Dispute Status if disputed. <br><br> 0	No Dispute <br> 1	In Dispute <br> 2	Re-Instated <br> 3	Adjusted <br> 4	Written Off by Colco <br> 5	Written Off by Delco <br> 6	Charged Back to Site
                      example: 6	Charged Back to Site
                    RebateRate: 
                      type: number
                      format: float
                      description: Unit discount in customer currency.
                      example: 28.279000
                    DelCoToColCoExchangeRate: 
                      type: number
                      format: float
                      description: Exchange rate from transaction currency to customer currency.
                      example: 1
                    NetEuroAmount: 
                      type: number
                      format: float
                      description: Net euro amount.
                      example: 37.93
                    EuroRebateAmount: 
                      type: number
                      format: float
                      description: Euro rebate amount.
                      example: 0 
                    EuroVATAmount: 
                      type: number
                      format: float 
                      description: Euro VAT amount.
                      example: 7.96 
                    ParentCustomerNumber: 
                      type: string 
                      description: Parent customer number.
                      example: DRG1234
        Warnings:
          $ref: '#/components/schemas/Warnings'    

    CardUsageSummary: 
      type: object
      properties:
        ColCoId: 
          type: integer
          nullable: true
          description: Collecting Company Id of the selected payer. <br><br> Optional if ColCoCode is passed else Mandatory.
          example: 1
        ColCoCode: 
          type: integer
          nullable: true
          description: Collecting Company Code (Shell Code) of the selected payer.  <br><br> Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.
          example: 86
        PayerId: 
          type: integer
          nullable: true
          description: Payer Id (i.e. Customer Id of the Payment of the selected payer. <br><br> Optional if PayerNumber is passed else Mandatory
          example: 12345
        PayerNumber: 
          type: string
          description: Payer Number of the selected payer. <br><br> Optional if PayerId is passed else Mandatory
          example: GB000000123
        AccountId: 
          type: integer
          nullable: true
          description: Account Id of the selected payer. <br><br> Optional if AccountNumber is passed else Mandatory
          example: 1234
        AccountNumber:
          type: string
          description: Account Number of the selected payer. <br><br> Optional if AccountId is passed else Mandatory
          example: GB000000123
        CardId: 
          type: integer
          description: Card Id of the selected payer. <br><br> Optional if PAN is passed else Mandatory
          example: 1234
        PAN: 
          type: string
          description: Card PAN of the selected payer. <br><br> Optional if CardId is passed else Mandatory
          example: 7882861007636000020
        CardExpiry: 
          type: string
          description: Card Expiry Date of the selected payer. <br><br> Optional if CardId is passed else Mandatory
          example: 20311223   


    ResponseCardUsageSummary:
      type: object
      required:
        - RequestId
        - Status
        - Data
      properties:
        RequestId:
          type: string
          description: "A unique request id in GUID format. The value is written to the Shell API Platform audit log for end to end traceability of a request.\r\n\r\n"
          pattern: '^[{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?$'
          minLength: 36
          maxLength: 36
          example: eb621f45-a543-4d9a-a934-2f223b263c42
          format: uuid
        Status:
          description: Status of the response.
          example: SUCCESS
          enum:
            - SUCCESS
            - FAILED
            - PARTIAL_SUCCESS
        Data: 
          type: array
          description: List of exception details.
          items: 
            type: object
            properties:
              UsageSummary:
                type: array
                description: List of all Card Usage Summary for the given search criteria. 
                items: 
                  type: object
                  properties:
                    Date: 
                      type: string
                      description: Transaction date. Format yyyyMMdd
                      example: 20170930
                      nullable: true
                    ProductId: 
                      type: integer
                      description: Product Id
                      example: 1
                    ProductCode: 
                      type: string
                      description: Product Code
                      example: 2
                    ProductName:
                      type: string
                      description: Product Name
                      example: Diesel AGO
                    IsFuelProduct: 
                      type: boolean
                      description: True if the product on transaction is listed as a fuel product else return false
                      example: true
                    SiteGroupId: 
                      type: integer
                      description: Site Group Id
                      example: 1234
                    SiteGroupName:
                      type: string
                      description: Site Group Name
                      example: UK 9500 MOTORWAY NETWORK
                    TotalVolume: 
                      type: number
                      format: float
                      description: Total Volume of transactions met with the given search criteria.
                      example: 123.12
                    TotalGross: 
                      type: number
                      format: float
                      description: Total Gross Amount in coustomer currency.
                      example: 123.12
                    TotalNet:
                      type: number
                      format: float
                      description: Total Net Amount in customer currency.
                      example: 123.12
                    CurrencyCode: 
                      type: string
                      description: ISO currency code 
                      example: GBP
                    CurrencySymbol:
                      type: string
                      description: Currency symbol of the Invoice Currency Code 
                      example: £
                    ProductGroupId: 
                      type: integer
                      description: Product Group Id
                      example: 1234
                    ProductGroupName:
                      type: string
                      description: Product Group Name
                      example: Motor gasoline

        Warnings:
          $ref: '#/components/schemas/Warnings'    
    MultiPricedTransactionReq:
      type: object
      title: MultiPricedTransactionReq
      properties:
        Filters:
          $ref: '#/components/schemas/MultiPricedTransactionRequestNew'
        Page: 
          type: integer
          nullable: true
          description: Page Number (as shown to the users)
          default: 1
          example: 1 
        PageSize: 
          type: integer
          nullable: true
          description: Page Size – Number of records to show on a page.
          default: 50 
          example: 100    
    MultiPricedTransactionRequestNew:
      title: MultiPricedTransactionRequest
      required:
      - ColCoCode
      - Accounts
      type: object
      properties:
        ColCoId:
          type: integer
          description: "Collecting Company Id of the selected payer. \r\nOptional if ColCoCode is passed else Mandatory.\r\nExample:\r\n1 for Philippines\r\n5 for UK"
          format: int32
        ColCoCode:
          type: integer
          description: "Collecting Company Code of the selected payer. \r\nMandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.\r\nExample:\r\n86 for Philippines\r\n5 for UK"
          format: int32
        Accounts:
          type: array
          items:
            $ref: '#/components/schemas/MultiPricedTransactionRequestAccountsItems'
          description: "List of Payers/Accounts entity.\r\nMandatory.\r\n•    Max number of payers allowed in the input is 10, if it exceeds in the input it will throw an error.\r\n•    This value is configurable. Initial configuration will be 100 and will change to 10 once SFH changes are integrated.\r\nNote: \r\n1.    At least one payer should be present.\r\nAccounts information are optional."
        InvoiceStatus:
          type: string
          description: >-
            Invoice status of the transactions

            Mandatory

            Possible options:

            I - Invoiced

            U – Un-Invoiced

            A – All

            Max Length: 1
        PurchasedInCountry:
          type: string
          description: >-
            ISO Country Code (ex: UK, FR)

            Optional



            Note: If IncludeFees is true then this filter will be ignored
        FromDate:
          type: string
          description: "Transactions from Date/Time. \r\nOptional – When provided, it should be with in last 24 months. \r\n\r\nFormat: yyyyMMdd"
        ToDate:
          type: string
          description: "Transactions to Date/Time.\r\n\r\n1) When the value is blank and FromDate is provided on the input, all transactions took place 210(Configurable) days after the given FromDate is returned. \r\n2) Difference between FromDate and ToDate cannot be more than 210 (Configurable) days.\r\n\r\nFormat: yyyyMMdd"
        Period:
          type: integer
          description: "Transactions Period. \r\nPossible values are:\r\n1.    Last 7 Days\r\n2.    Last 30 Days\r\n3.    Last 90 Days"
          format: int32
        PostingDateFrom:
          type: string
          description: >-
            Transaction Posting Date/time in the Cards Platform - From Date/time.





            Note:

            1) When the value of both PostingDateFrom and PostingDateTo are present in the request then the value of PostingDateFrom must be less than PostingDateTo.

            2) If IncludeFees is true then this filter will be ignored



            Format: yyyyMMdd HH:mm:ss
        PostingDateTo:
          type: string
          description: "Transaction Posting Date/time in the Cards Platform – To Date/time.\r\n\r\nNote: \r\n1) If IncludeFees is true then this filter will be ignored.\r\n2) When the value of both PostingDateFrom and PostingDateTo are present in the request then the value of PostingDateFrom must be less than PostingDateTo.\r\n\r\nFormat: yyyyMMdd HH:mm:ss"
        InvoiceDate:
          type: string
          description: "Invoice Date.\r\nOptional\r\n\r\nNote: \r\n1) If value is not blank then the system will ignore the InvoiceStatus parameter and it will return all the billed transactions for the given invoice date.\r\n\r\n2) If IncludeFees is true then this filter will be ignored\r\n \r\nFormat: yyyyMMdd"
        InvoiceNumber:
          type: string
          description: "Invoice Number.\r\nOptional\r\nNote: \r\n1) If value is not blank then the system will ignore the InvoiceStatus parameter and it will return all the billed transactions for the given invoice date."
        ValidInvoiceDateOnly:
          type: boolean
          description: "True/False\r\nOptional\r\nDefault value: True. \r\nWhen passed as ‘True’ the transactions records with report date not equal to 9999-12-30 will be returned.\r\nWhen passed as ‘False’ the above condition will not be checked.\r\nNote: If IncludeFees is ‘True’ then this filter will be ignored"
        InvoiceFromDate:
          type: string
          description: "Start date for transaction search by invoice date.\r\nOptional\r\nNote: \r\n1) Value should be with in last 24 months (if provided).\r\n2) Maximum of 90(Configurable) days duration allowed per search.\r\n3) When provided, InvoiceFromDate has to be less than or equal to InvoiceToDate.\r\n\r\nFormat: yyyyMMdd"
        InvoiceToDate:
          type: string
          description: "End date for transaction search by invoice date.\r\nOptional\r\nNote: \r\n\r\n1) When InvoiceFromDate is provided and InvoiceToDate is null, then InvoiceToDate will be calculated as (InvoiceFromDate + 90 days) or (CurrentDate) whichever is lesser.\r\n\r\nFormat: yyyyMMdd"
        FuelOnly:
          type: boolean
          description: "True/False\r\nOptional\r\nDefault value: False. \r\nWhen passed as ‘True’ Only returned records with Fuel transactions.\r\nWhen passed as ‘False’ the above condition will not be checked.\r\nNote: If IncludeFees is ‘True’ then this filter will be ignored"
        IncludeFees:
          type: boolean
          description: >-
            True/False

            Optional

            Default value: False

            When passed as ‘True’ then  ignore complex filters, all sales items along with fees included on the same response
        SortOrder:
          type: string
          description: >-
            Allowed Sorting Options:

            1.    TransactionDateAscending

            2.    TransactionDateDescending

            3.    GrossAmountDescending

            4.    GrossAmountAscending

            5.    NetAmountAscending

            6.    NetAmountDescensding

            Example value to be passed: 1,3

            Note: If IncludeFees is ‘True’ then sorting is not allowed. This parameter will be ignored.
        CurrentPage:
          type: integer
          description: >-
            Page Number (as shown to the users)

            Optional

            Default value 1

            Note: If IncludeFees is ‘True’ then pagination is not allowed. This parameter will be ignored.
          format: int32
        PageSize:
          type: integer
          description: >-
            Page Size – Number of records to show on a page

            Optional

            Default value 50



            Note: If IncludeFees is ‘True’ then pagination is not allowed. This parameter will be ignored.
          format: int32
    MultiPricedTransactionRequestAccountsItems:
      title: MultiPricedTransactionRequestAccountsItems
      type: object
      properties:
        PayerId:
          type: integer
          description: >-
            Payer Id of the selected payer.

            Optional if PayerNumber is passed else Mandatory

            Example: 123456
          format: int32
        PayerNumber:
          type: string
          description: >-
            Payer Number (Ex: GB000000123) of the selected payer.

            Optional if PayerId is passed else Mandatory

            Example: GB000000123
        AccountId:
          type: integer
          description: Account Id  of the selected account.
          format: int32
        AccountNumber:
          type: string
          description: 'Account Number (ex: GB000000123) of the selected account.'
    MultiPricedTransactionRes:
      type: object
      title: MultiPricedTransactionRes
      properties:
        RequestId:
          type: string
          description: Unique identifier for the request. This will be played back in the response from the request.
          example: 0e6fb42a-51b0-43b2-f010-92f822657f6a
        Status:
          type: string
          description: Status of the request
          example: SUCCESS
        Data:
          type: array
          items:
            $ref: '#/components/schemas/MultiPricedTransactionResponseNew'
        Page: 
          type: integer
          description: Current Page
          example: 1
        TotalRecords: 
          type: integer
          description: Total row count matched for the given input criteria
          example: 100
        TotalPages: 
          type: integer
          description: Calculated page count based on page size from the incoming API request and total number of rows matched for the given input criteria. Return 1 if the page size is -1 as all records are returned.
          example: 100
        PageSize: 
          type: integer
          description: Page Size – Number of records to show on current page.
          example: 100
        Warnings:
          $ref: '#/components/schemas/Warnings'   
    MultiPricedTransactionResponseNew:
      title: MultiPricedTransactionResponse
      type: object
      properties:
        Transactions:
          type: array
          items:
            $ref: '#/components/schemas/MultiPricedTransactionResponseTransactionsItems'
          description: ''
    MultiPricedTransactionResponseTransactionsItems:
      title: MultiPricedTransactionResponseTransactionsItems
      type: object
      properties:
        Type:
          type: string
          description: >-
            TransactionType is the type of transaction.

            Example: SalesItem /FeeItem
          nullable: true
        CardId:
          type: integer
          description: >-
            Unique Card Id in GFN

            Example: 275549
          format: int32
          nullable: true
        CardPAN:
          type: string
          description: >-
            Card PAN

            Mask PAN if enabled at Microservices configuration (Mask all digits except the Last 6 digits of the PAN)

            Example: 7002051006629890645
          nullable: true
        CardExpiry:
          type: string
          description: >-
            Card Expiry Date

            Format: yyyyMMdd
          nullable: true
        TransactionDate:
          type: string
          description: "Local Transaction Date of where the transaction took place\r\nFormat: yyyyMMdd \r\n\r\nNote: For a fee item, this parameter will be populated with fee date."
          nullable: true
        TransactionTime:
          type: string
          description: >-
            Local Transaction Time of where the transaction took place

            Format: HH:mm:ss (24 hours format)



            Note: For a fee item, this parameter will be populated with fee date.
          nullable: true
        UTCOffset:
          type: string
          description: "UTC Offset extracted from Sales Date time. \r\nNote: This may not be accurate for all TPN transactions\r\nFormat: +/-HH:mm:ss (24 hours format)"
          nullable: true
        FleetIdInput:
          type: string
          description: >-
            Fleet Id Input as entered by the drivers at the time of transaction

            Example: XYZ1234

            Note: - The value could be null/blank for fees item.
          nullable: true
        OdometerInput:
          type: integer
          description: >-
            Odometer Input as entered by the drivers at the time of transaction

            Example: 12345

            Note: - The value could be null/blank for fees item.
          format: int32
          nullable: true
        DriverName:
          type: string
          description: >-
            Driver Name embossed on the card

            Example:  ANDREW GILBERRY
          nullable: true
        VehicleRegistration:
          type: string
          description: Vehicle Registration Number embossed on the card
          nullable: true
        InvoiceCurrencyCode:
          type: string
          description: ISO currency code
          nullable: true
        InvoiceCurrencySymbol:
          type: string
          description: "Currency symbol of the Invoice Currency Code \r\nExample: £, $"
          nullable: true
        TransactionCurrencyCode:
          type: string
          description: >-
            ISO currency code

            Example: GBP
          nullable: true
        TransactionCurrencySymbol:
          type: string
          description: >-
            Currency symbol of the Transaction Currency Code

            Example: £, $
          nullable: true
        TransactionNetAmount:
          type: integer
          description: Net Amount
          format: int32
          nullable: true
        TransactionTax:
          type: integer
          description: Tax Amount
          format: int32
          nullable: true
        TransactionGrossAmount:
          type: integer
          description: Gross Amount
          format: int32
          nullable: true
        InvoiceNetAmount:
          type: integer
          description: "Invoiced Net Amount \r\nNote: For a fee item, this parameter will be populated with fee InvoiceNetAmount."
          format: int32
          nullable: true
        InvoiceTax:
          type: integer
          description: Invoiced Tax Amount
          format: int32
          nullable: true
        InvoiceGrossAmount:
          type: integer
          description: >-
            Invoice Gross Amount

            Note: For a fee item, this parameter will be populated with fee InvoiceGrossAmount.
          format: int32
          nullable: true
        PurchasedInCountry:
          type: string
          description: "Country of Purchase \r\nExample: France, Germany\r\nNote: - The value could be null/blank for fees item."
          nullable: true
        AccountId:
          type: integer
          description: Account Id
          format: int32
          nullable: true
        AccountNumber:
          type: string
          description: Account Number
          nullable: true
        AccountName:
          type: string
          description: Account Name
          nullable: true
        AccountShortName:
          type: string
          description: Account Short Name
          nullable: true
        Quantity:
          type: integer
          description: Quantity/Volume
          format: int32
          nullable: true
        FuelProduct:
          type: boolean
          description: True if the product on transaction is listed as a fuel product else return false
          nullable: true
        UnitPriceInTransactionCurrency:
          type: integer
          description: >-
            Product Unit Price in transaction currency

            Note: - The value could be null/blank for fees item
          format: int32
          nullable: true
        UnitPriceInInvoiceCurrency:
          type: integer
          description: >-
            Product Unit Price in invoice currency

            Note: - The value could be null/blank for fees item
          format: int32
          nullable: true
        UnitDiscountTransactionCurrency:
          type: integer
          description: >-
            Unit Discount in transaction currency

            Note: - The value could be null/blank for fees item
          format: int32
          nullable: true
        UnitDiscountInvoiceCurrency:
          type: integer
          description: >-
            Unit Discount in invoice currency

            Note: - The value could be null/blank for fees item.
          format: int32
          nullable: true
        IsInvoiced:
          type: boolean
          description: True when the transaction is already invoice, else return False
          nullable: true
        InvoiceNumber:
          type: string
          description: >-
            Invoice Number if invoiced

            Example:

            S04500493

            S04478304

            S04490319
          nullable: true
        InvoiceDate:
          type: string
          description: "Invoice Date \r\nFormat: yyyyMMdd HH:mm:ss"
          nullable: true
        SiteCode:
          type: string
          description: >-
            Site Code

            Example:

            050001 -    CHARNOCK RICHARD NTHBOUND MWSA 0755
          nullable: true
        SiteName:
          type: string
          description: >-
            Site Name

            Example:

            050001 -    CHARNOCK RICHARD NTHBOUND MWSA 0755
          nullable: true
        SiteCountry:
          type: string
          description: >-
            Site Country

            Example: France, Germany
          nullable: true
        Location:
          type: array
          items:
            $ref: '#/components/schemas/SiteLocation'
          description: ''
        CardGroupName:
          type: string
          description: Card Group Name
          nullable: true
        ReceiptNumber:
          type: string
          description: ReceiptNumber
          nullable: true
        ProductCode:
          type: string
          description: >-
            Product Code

            10    TMF Charges

            11    Tunnel/Bridges

            12    Motorway toll
          nullable: true
        ProductName:
          type: string
          description: >-
            Product Name

            Example:



            Unleaded - High octane

            Unleaded - Medium octane

            Unleaded - Low octane

            Unleaded Environmental
          nullable: true
        ProductGroupId:
          type: integer
          description: "Product Group Id\r\nExample: \r\n1    Parent Product Group\r\n2    All Fuels\r\n3    Motor gasoline\r\n4    2 stroke\r\n5    Autogas"
          format: int32
          nullable: true
        ProductGroupName:
          type: string
          description: "Product Group Name\r\nExample: \r\n1    Parent Product Group\r\n2    All Fuels\r\n3    Motor gasoline\r\n4    2 stroke\r\n5    Autogas"
          nullable: true
        DelCoExchangeRate:
          type: number
          description: >-
            DelCo Exchange Rate (Site exchange rate)

            Note: - The value could be null/blank for fees item.
          nullable: true
        ColCoExchangeRate:
          type: integer
          description: ColCo Exchange Rate (Customer exchange rate)
          format: int32
          nullable: true
        IsShellSite:
          type: boolean
          description: >-
            True when transaction occurred at a Shell site else return False

            Note: - The value could be null/blank for fees item.
          nullable: true
        Network:
          type: string
          description: >-
            Network  (Shell PH, ESSO, etc.,)

            100013    STEINDORFER

            100015    S.A. BELGIAN SHELL N.V.

            100016    ESSO BE

            Note: - The value could be null/blank for fees item.
          nullable: true
        SiteGroupId:
          type: integer
          description: >-
            Site Group Id

            Example: 202

            Note: - The value could be null/blank for fees item.
          format: int32
          nullable: true
        SiteGroupName:
          type: string
          description: >-
            Site GroupName

            Example: CZ 9100 ECONOMY NETWORK

            Note: - The value could be null/blank for fees item.
          nullable: true
        PostingDate:
          type: string
          description: >-
            Transaction Posting Date

            Format: yyyyMMdd HHmmss
          nullable: true
        IssuerCode:
          type: string
          description: "First digits of the Card PAN \r\n7002 = Fleet"
          nullable: true
        PurchasedInCountryCode:
          type: string
          description: >-
            ISO code of the country where the transaction took place

            Example: “NL”

            Note: - The value could be null/blank for fees item.
          nullable: true
        CustomerCountryCode:
          type: string
          description: >-
            ISO code of the Customer Country

            Example: NL
          nullable: true
        CustomerCountry:
          type: string
          description: >-
            Name of the Customer Country

            Example: Netherlands
          nullable: true
        ReleaseCode:
          type: string
          description: >-
            Release code, 7th Digit of the Card PAN

            Example: 8 for 7021882
          nullable: true
        CardGroupId:
          type: string
          description: Card group ID
          nullable: true
        CardSequenceNumber:
          type: string
          description: 3 digits, Card sequence number and Check digit (Digit 16,17 and 18 on the card pan)
          nullable: true
        CheckDigit:
          type: string
          description: Check digit, Last number of the card pan
          nullable: true
        FleetIDDescription:
          type: string
          description: FleetId/CRN description in Card Platform configured at the account level
          nullable: true
        VATRate:
          type: number
          description: >-
            VAT Percentage

            0.20 for 20%

            Note: This parameter will be populated in the response for both SalesItem and FeeItem
          nullable: true
        VATCategory:
          type: string
          description: >-
            VAT Category Id-Description

            1-Zero Rated
          nullable: true
        VATCountry:
          type: string
          description: >-
            VAT Country

            Example: Netherlands
          nullable: true
        EffectiveDiscountInTrxCurrency:
          type: number
          description: >-
            Effective Discount (excluding VAT, in transaction currency) 4 digits

            Example: 0.0000
          nullable: true
        TransactionType:
          type: string
          description: >-
            Transaction Type

            Example: Purchase when Card is Present else Blank

            Note: - The value could be null/blank for fees item.
          nullable: true
        PINIndicator:
          type: string
          description: "Pin Indicator (Indicates whether PIN used or not used at the time of transaction)\r\nExample: “PIN Used'” or “No PIN” or “Unknown” \r\nNote: - The value could be null/blank for fees item"
          nullable: true
        VATApplicable:
          type: string
          description: >-
            Is VAT Applicable for this transaction

            Example: “Y” or “N”
          nullable: true
        NetInvoiceIndicator:
          type: string
          description: >-
            Net Invoice Indicator, Will the customer receive an invoice without VAT?

            Example: “Y” or “N”

            Note: - The value could be null/blank for fees item.
          nullable: true
        CustomerCurrencyCode:
          type: string
          description: >-
            Customer currency code

            Example: GBP
          nullable: true
        CustomerCurrencySymbol:
          type: string
          description: Customer currency Symbol
          nullable: true
        EffectiveUnitDiscountInCustomerCurrency:
          type: integer
          description: >-
            Effective Unit Discount (excluding VAT in Customer currency)

            Note: - The value could be null/blank for fees item.
          format: int32
          nullable: true
        EffectiveDiscountInCustomerCurrency:
          type: integer
          description: >-
            Effective Discount (excluding VAT in Customer currency)

            Note: - The value could be null/blank for fees item.
          format: int32
          nullable: true
        VATonNetAmountInCustomerCurrency:
          type: integer
          description: VAT on Net Amount (in Customer currency)
          format: int32
          nullable: true
        DiscountType:
          type: string
          description: >-
            Discount Type

            Example: 1-None

            2-Pence per unit
          nullable: true
        TransactionStatus:
          type: string
          description: >-
            Transaction status "U" or "I"

            “U” stands for Uninvoiced

            “I” stands for Invoiced
          nullable: true
        SalesItemId:
          type: integer
          description: >-
            Unique Sales Item Identifier

            Example: 18315958002

            Note: For a fee item, this parameter will be populated with SalesItemId.
          format: int32
          nullable: true
        PayerGroup:
          type: string
          description: Payer Group applicable for the Large Customer NL+8 digit code
          nullable: true
        PayerGroupName:
          type: string
          description: Payer Group Name
          nullable: true
        RefundFlag:
          type: string
          description: >-
            Refund Flag “N” for Not Refunded and “Y” for Refunded.

            Note: - The value could be null/blank for fees item.
          nullable: true
        OriginalSalesItemId:
          type: string
          description: Shows Sales Item Id of the original item that was refunded
          nullable: true
        DelcoName:
          type: string
          description: >-
            Delco Name

            Example: SHELL NEDERLAND VERKOOPMAATSCHAPPIJ BV
          nullable: true
        DelcoCode:
          type: string
          description: >-
            Delco Code

            014, 018, etc.,
          nullable: true
        PayerNumber:
          type: string
          description: >-
            Payer number (Country code+8 digits)

            Example: NL10042616
          nullable: true
        PayerName:
          type: string
          description: >-
            Payer name

            Example: V.M. LE COMTE
          nullable: true
        CardExpiryPeriod:
          type: string
          description: >-
            Year/Month of the Card Expiry captured on the transaction

            Example: 1901
          nullable: true
        AuthorisationCode:
          type: string
          description: >-
            Authorisation code of the transaction

            Example: 011256

            Note: - The value could be null/blank for fees item.
          nullable: true
        TransactionId:
          type: string
          description: 'Unique id of the transaction that may include one or more salesitems

            Example: io9KVXk1UkW57XWKyeaHHg

            Note: - The value could be null/blank for fees item.'
          nullable: true
        TransactionLine:
          type: string
          description: >-
            Transaction line item number

            Example: 1

            Note: - The value could be null/blank for fees item.
          nullable: true
        AllowClearing:
          type: string
          description: >-
            Is the Sales Item allowed for clearing? i.e. not written off

            Example: “Y” or “N”

            Note: - The value could be null/blank for fees item.
          nullable: true
        CRMNumber:
          type: string
          description: >-
            CRM Case number if the sales item is in dispute.

            Note: - The value could be null/blank for fees item.
          nullable: true
        DisputeStatus:
          type: string
          description: >-
            Sales Item Dispute Status if disputed

            0    No Dispute

            1    In Dispute

            2    Re-Instated

            3    Adjusted

            4    Written Off by Colco

            5    Written Off by Delco

            6    Charged Back to Site
          nullable: true
        RebateRate:
          type: number
          description: >-
            Unit discount in customer currency.

            Example: 28.279000
          nullable: true
        DelCoToColCoExchangeRate:
          type: integer
          description: >-
            Exchange rate from transaction currency to customer currency.

            Example: 1
          format: int32
          nullable: true
        NetEuroAmount:
          type: number
          description: >-
            Net euro amount.

            Example: 37.93

            Note: - The value could be null/blank for fees item.
          nullable: true
        EuroRebateAmount:
          type: integer
          description: >-
            Euro rebate amount.

            Example: 0

            Note: - The value could be null/blank for fees item.
          format: int32
          nullable: true
        EuroVATAmount:
          type: number
          description: >-
            Euro VAT amount.

            Example: 7.96

            Note: - The value could be null/blank for fees item.
          nullable: true
        ParentCustomerNumber:
          type: string
          description: Parent customer number
          nullable: true
        ParentCustomerName:
          type: string
          description: Parent customer name.
          nullable: true
        ParentCustomerId:
          type: integer
          description: Parent customer id.
          format: int32
          nullable: true
        IncomingSiteNumber:
          type: string
          description: >-
            Incoming Site Number

            Example: 100021

            Note: - The value could be null/blank for fees item.
          nullable: true
        IncomingSiteDescription:
          type: string
          description: >-
            Incoming Site Description

            Example: HN3 INTI_02-82.02

            Note: - The value could be null/blank for fees item.
          nullable: true
        IncomingCurrencyCode:
          type: string
          description: >-
            Incoming Currency Code

            Example: GBP

            Note: - The value could be null/blank for fees item.
          nullable: true
        IncomingProductCode:
          type: string
          description: >-
            Incoming Product Code

            Example: 30
          nullable: true
        CreditDebitCode:
          type: string
          description: >-
            Credit Debit Code

            Example: “D” or “C”

            The value could be null/blank for fees item.
          nullable: true
        CorrectionFlag:
          type: string
          description: >-
            Correction Flag

            Example: “Y” or “N”

            Note: - The value could be null/blank for fees item.
          nullable: true
        Additional1:
          type: string
          description: Additional details
          nullable: true
        Additional2:
          type: string
          description: Additional details
          nullable: true
        Additional3:
          type: string
          description: Additional details
          nullable: true
        Additional4:
          type: string
          description: Additional details
          nullable: true
        RebateonNetAmountInCustomerCurrency:
          type: number
          description: >-
            Rebate on Net Amount in Customer Currency

            Example: -0.735000000000

            Note: - The value could be null/blank for fees item.
          nullable: true
        RebateonNetAmountInTransactionCurrency:
          type: number
          description: >-
            Rebate on Net Amount in Transaction Currency

            Example: -0.735000000000

            Note: - The value could be null/blank for fees item.
          nullable: true
        NetworkCode:
          type: string
          description: >-
            Network Code

            Example: AVEE PTUAZONW CUBFAO COSFS

            Note: - The value could be null/blank for fees item.
          nullable: true
        TrnIdentifier:
          type: string
          description: Transaction Identifier
          nullable: true
        CardType:
          type: string
          description: Card Type
          nullable: true
        DelcoListPriceUnitNet:
          type: number
          description: >-
            Delco List Price Unit Net

            Example: 30.500000

            Note: - The value could be null/blank for fees item
          nullable: true
        DelcoRetailPriceUnitNet:
          type: number
          description: >-
            Retail Net Price (or pump net price) per Unit in transaction currency

            Example: 1.921000

            Note: - The value could be null/blank for fees item
          nullable: true
        DelcoRetailPriceUnitGross:
          type: number
          description: >-
            Retail gross price (or pump gross price) per unit in transaction currency

            Note: - The value could be null/blank for fees item
          nullable: true
        DelcoRetailValueTotalNet:
          type: number
          description: >-
            Retail net price (or net pump price) in transaction currency

            Note: - The value could be null/blank for fees item
          nullable: true
        DelcoRetailValueTotalGross:
          type: number
          description: >-
            Retail gross price (or gross pump price) in transaction currency

            Note: - The value could be null/blank for fees item
          nullable: true
        CustomerRetailPriceUnitGross:
          type: number
          description: >-
            Retail gross price (or pump gross price) per unit in customer currency

            Note: - The value could be null/blank for fees item
          nullable: true
        CustomerRetailValueTotalGross:
          type: number
          description: >-
            Retail gross price (or gross pump price) in customer currency

            Note: - The value could be null/blank for fees item
          nullable: true
        CustomerRetailValueTotalNet:
          type: number
          description: >-
            Retail net price (or net pump price) in customer currency

            Note: - The value could be null/blank for fees item
          nullable: true
        TransactionTypeDescription:
          type: string
          description: >-
            Transaction Type Description

            Note: - The value could be null/blank for fees item
          nullable: true
    SiteLocation:
      title: SiteLocation
      type: object
      properties:
        Latitude:
          type: string
          description: >-
            Latitude for the Site Geographic Location

            Example: 37.4224764

            Note: - The value could be null/blank for fees item.
          nullable: true
        Longitude:
          type: string
          description: >-
            Longitude for the Site Geographic Location

            Example: 122.0842499

            Note: - The value could be null/blank for fees item.
          nullable: true
      description: Geography Location entity for Site Location

    FuelConsumptionReq:
      type: object
      title: FuelConsumptionReq
      properties:
        Filters:
          $ref: '#/components/schemas/FuelConsumptionRequest'
    FuelConsumptionRequest:
      title: FuelConsumptionRequest
      type: object
      properties:
        ColCoId:
          type: integer
          description: "Collecting Company Id  of the selected payer. \r\nOptional if ColCoCode is passed else Mandatory.\r\nExample:\r\n1 for Philippines\r\n5 for UK"
          format: int32
        ColCoCode:
          type: integer
          description: "Collecting Company Code  of the selected payer. \r\nMandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.\r\nExample:\r\n86 for Philippines\r\n5 for UK"
          format: int32
        PayerId:
          type: integer
          description: >-
            Payer Id  of the selected payer.

            Optional if PayerNumber is passed else Mandatory
          format: int32
        PayerNumber:
          type: string
          description: >-
            Payer Number of the selected payer.

            Optional if PayerId is passed else Mandatory
        Accounts:
          type: array
          items:
            $ref: '#/components/schemas/Accounts'
          description: ''
        CardGroupId:
          type: integer
          description: >-
            Card Group Id in GFN

            Optional

            Example: 200
          format: int32
        CardGroupName:
          type: string
          description: >-
            Card Group Name

            Optional

            This input is a search criterion, if given.
        Cards:
          type: array
          items:
            $ref: '#/components/schemas/FuelConsumptionCard'
          description: ''
        FromDate:
          type: string
          description: >-
            Transactions from Date

            Optional – ‘Period’ will be considered when this field is not provided.
        ToDate:
          type: string
          description: >-
            Transactions to Date

            Optional

            Format: yyyyMMdd
        Period:
          type: integer
          description: "Transactions Period. This is ignored when FromDate is supplied on the request \r\nAllowed values :\r\n1.    Last 7 Days\r\n2.    Last 30 Days\r\n3.    Last 90 Days\r\nOptional - When FromDate/ToDate and Period are not provided, ‘Last 7 Days’ value is considered as default Period."
          format: int32
    FuelConsumptionCard:
      title: FuelConsumptionCard
      type: object
      properties:
        CardId:
          type: integer
          description: "Card Id \r\nOptional, when PAN is provided else mandatory."
          format: int32
        PAN:
          type: string
          description: >-
            Full Card PAN

            Optional, when CardId is provided else mandatory.
        ExpiryDate:
          type: string
          description: >-
            Card Expiry Date

            Format: yyyyMMdd
    Accounts:
      title: Accounts
      type: object
      properties:
        AccountId:
          type: integer
          description: >-
            Account Id of the customer.

            Optional, if AccountNumber is passed, else mandatory.
          format: int32
          nullable: true
          example: 3453
        AccountNumber:
          type: string
          description: >-
            Account Number of the customer.

            Optional, if AccountId is passed, else mandatory.
          nullable: true
          example: GB000000124

    FuelConsumptionResponse:
      type: object
      title: FuelConsumptionResponse
      properties:
        RequestId:
          type: string
          description: Unique identifier for the request. This will be played back in the response from the request.
          example: 0e6fb42a-51b0-43b2-f010-92f822657f6a
        Status:
          type: string
          description: Status of the request
          example: SUCCESS
        Data:
          type: array
          items:
            $ref: '#/components/schemas/FuelConsumptionData'
        Warnings:
          $ref: '#/components/schemas/Warnings'
    FuelConsumptionData:
      title: FuelConsumptionData
      type: object
      properties:
        AccountName:
          type: string
          description: Account Name
          nullable: true
        AccountNumber:
          type: string
          description: Account Number
          nullable: true
        PayerName:
          type: string
          description: Payment customer Name
          nullable: true
        PayerNumber:
          type: string
          description: Payment customer number
          nullable: true
        CardNumber:
          type: string
          description: Card PAN
          nullable: true
        CardGroupId:
          type: integer
          description: Card group ID
          format: int32
          nullable: true
        CardGroupName:
          type: string
          description: Card group name
          nullable: true
        DriverName:
          type: string
          description: Driver name
          nullable: true
        LicenseNumber:
          type: string
          description: Vehicle registration number
          nullable: true
        InitialOdometer:
          type: number
          description: First transaction odometer reading
          nullable: true
        LastOdometer:
          type: number
          description: Last transaction odometer reading
          nullable: true
        Distance:
          type: number
          description: Distance in  KM or Miles based on Customer and Colco Settings
          nullable: true
        FuelConsumption:
          type: number
          description: Total Fuel Consumption.
          nullable: true
        FuelNetAmount:
          type: number
          description: Net Fuel Amount
          nullable: true
        Discount:
          type: number
          description: Total Discount
          nullable: true
        FuelTax:
          type: number
          description: Fuel Tax Amount
          nullable: true
        FuelVolume:
          type: number
          description: Total Fuel Volume in Litres
          nullable: true
        GrossNonFuelExpenses:
          type: number
          description: Gross Nonfuel Amount
          nullable: true
        CO2Produced:
          type: number
          description: Total Co2 produced
          nullable: true
        TransactionCount:
          type: number
          description: Total Transaction Count
          nullable: true
    UpdateOdometerRequest:
      title: UpdateOdometerRequest
      type: object
      properties:
        ColCoId:
          type: integer
          description: "Collecting Company Id  of the selected payer. \r\nOptional if ColCoCode is passed else Mandatory.\r\nExample:\r\n1 for Philippines\r\n5 for UK"
          format: int32
        ColCoCode:
          type: integer
          description: "Collecting Company Code (Shell Code) of the selected payer. \r\nMandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided."
          format: int32
        PayerId:
          type: integer
          description: >-
            Payer Id (i.e. Customer Id of the Payment Customer in Cards Platform) of the selected payer.

            Optional if PayerNumber is passed else Mandatory
          format: int32
        AccountId:
          type: integer
          description: >-
            Account Id (i.e. Customer Id of the Sub Account in GFN) of the selected account.

            Optional if AccountNumber is passed else Mandatory
          format: int32
        AccountNumber:
          type: string
          description: >-
            Account Number (ex: GB000000123) of the selected account.

            Optional if AccountId is passed else Mandatory
        UpdateOdometers:
          type: array
          items:
            $ref: '#/components/schemas/UpdateOdometer'
          description: ''
        NotifyCaller:
          type: boolean
          description: >-
            True/False.

            Optional.

            Default: False

            If true, the caller would be notified back with the status as success or failure after the update odometer is processed.
        Caller:
          type: string
          description: >-
            The caller to be notified with the status of the update odometer.

            Mandatory, if NotifyCaller is true.
    UpdateOdometer:
      title: UpdateOdometer
      required:
      - SalesItemId
      - NewOdometerValue
      type: object
      properties:
        SalesItemId:
          type: string
          description: >-
            Unique SalesItemId (Either Billed on Unbilled)

            Mandatory
          nullable: true
        NewOdometerValue:
          type: integer
          description: NewOdometerValue that needs to be updated
          format: int32
          nullable: true
    UpdateOdometerResp:
      type: object
      title: UpdateOdometerResp
      properties:
        RequestId:
          type: string
          description: Unique identifier for the request. This will be played back in the response from the request.
          example: 0e6fb42a-51b0-43b2-f010-92f822657f6a
        Status:
          type: string
          description: Status of the request
          example: SUCCESS
        Data:
          type: array
          items:
            $ref: '#/components/schemas/UpdateOdometerResponse'
        Warnings:
          $ref: '#/components/schemas/Warnings'
    UpdateOdometerResponse:
      title: UpdateOdometerResponse
      type: object
      properties:
        ServiceReference:
          type: integer
          description: Main reference number for tracking.
          format: int32
        UpdateOdometerReferences:
          type: array
          items:
            $ref: '#/components/schemas/UpdateOdometerReference'
          description: ''
    UpdateOdometerReference:
      title: UpdateOdometerReference
      type: object
      properties:
        SalesItemId:
          type: integer
          description: SalesItemId of input parameter
          format: int32
          nullable: true
        UpdateOdometerReferenceId:
          type: integer
          description: Reference number for each individual update odometer reference.
          format: int32
          nullable: true
    TransactionFeesReq:
      type: object
      title: TransactionFeesReq
      properties:
        Filters:
          $ref: '#/components/schemas/TransactionFeesRequest'
        Page: 
          type: integer
          nullable: true
          description: Page Number (as shown to the users)
          default: 1
          example: 1 
        PageSize: 
          type: integer
          nullable: true
          description: Page Size – Number of records to show on a page.
          default: 50 
          example: 100    
    TransactionFeesRequest:
      title: TransactionFeesRequest
      type: object
      properties:
        ColCoId:
          type: integer
          description: "Collecting Company Id  of the selected payer. \r\nOptional if ColCoCode is passed else Mandatory.\r\nExample:\r\n1 for Philippines\r\n5 for UK"
          format: int32
          nullable: true
        ColCoCode:
          type: integer
          description: "Collecting Company Code (Shell Code) of the selected payer. \r\nMandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.\r\nExample:\r\n86 for Philippines\r\n5 for UK"
          format: int32
          nullable: true
        PayerId:
          type: integer
          description: >-
            Payer Id of the selected payer.

            Optional if PayerNumber is passed else Mandatory

            Example: 123456
          format: int32
          nullable: true
        PayerNumber:
          type: string
          description: >-
            Payer Number (Ex: GB000000123) of the selected payer.

            Optional if PayerId is passed else Mandatory
          nullable: true
        Accounts:
          type: array
          items:
            $ref: '#/components/schemas/Accounts'
          description: ''
        CardId:
          type: integer
          description: "Card Id \r\nOptional\r\nWhen both Card Id and Card PAN are not present on request, the response will have all the fee items under the selected payer or account.\r\nExample: 275549"
          format: int32
          nullable: true
        CardPAN:
          type: string
          description: >-
            Full Card PAN

            Optional

            When both Card Id and Card PAN are not present on request, the response will have all the fee items under the selected payer or account or card group.
          nullable: true
        InvoiceStatus:
          type: string
          description: >-
            Invoice status of the fee items

            Mandatory

            Possible options:

            I - Invoiced

            U – Un-Invoiced

            A – All
          nullable: true
        FeeTypeGroup:
          type: string
          description: >-
            Fee type group in under which the Fee item is generated.

            Optional.

            Allowed values:

            - Account Charges

            - Card Charges

            - Others Charges
          nullable: true
        FeeTypeId:
          type: integer
          description: "Fee Type Id.\r\nOptional.\r\nExample: \r\n1. Simple Fee\r\n2. Card Event Fee\r\n3. Customer Event Fee"
          format: int32
          nullable: true
        FromDate:
          type: string
          description: "Fee Item FromDate/Time \r\nShould be with in last 24 months \r\nOptional\r\nMaximum of 210 days duration allowed per search, its configurable.\r\nFormat: yyyyMMdd"
          nullable: true
        ToDate:
          type: string
          description: "Fee Item To Date/Time\r\nOptional\r\nWhen blank and FromDate is provided on the input, all fee items took place after the given from date/time should be returned. Note that the search is allowed for the maximum of 60 days. Hence if the FromDate is older than 60 days from current date then the fee items for 60 days from FromDate will be returned. \r\nFormat: yyyyMMdd"
          nullable: true
        Period:
          type: integer
          description: "Fee items Period. This is ignored when FromDate/Todate is supplied on the request. \r\n1.    Last 7 Days\r\n2.    Last 30 Days\r\n3.    Last 90 Days\r\n4.    Last 180 Days\r\nExample : Pass 1 for Last 7 days fee items"
          format: int32
          nullable: true
        InvoiceNumber:
          type: string
          description: >-
            Invoice number of the fee items

            Optional

            When provided, the fee items for the given invoice number will be returned.
          nullable: true
          example: 123456
        PostingDateFrom:
          type: string
          description: >-
            Fee Item Posting Date From
            Optional
            Format: yyyyMMdd , when not provided then current date will be considered as default value.
          nullable: true
        PostingDateTo:
          type: string
          description: >-
            Fee Item Posting Date To
            Optional
            Format: yyyyMMdd
          nullable: true
        
        IncludeCancelledItems:
          type: boolean
          description: True or False. When True, cancelled fee items are included on API response
          nullable: true
        ProductId:
          type: integer
          description: >-
            Product Id

            Optional

            Example: Sample list of product ids and description.

            100    Service fee

            102    Invoice production fee

            103    Account fee

            104    Transaction fee

            105    Card membership fee
          format: int32
          nullable: true
        ProductCode:
          type: string
          description: "Product Code \r\nOptional\r\nExample: \r\n1. Service fee\r\n2. Invoice production fee\r\n3. Account fee\r\n4. Transaction fee\r\n5. Card membership fee"
          nullable: true
        LineItemDescription:
          type: string
          description: >-
            Line item description.

            Optional

            Minimum of 4 characters should be provided else not considered

            Those fee items that have the entered value at any part of the line item description will be returned.
          nullable: true
        SortOrder:
          type: string
          description: >-
            Allowed Sorting Options:

            •    FeeDateAscending

            •    FeeDateDescending

            •    NetAmountAscending

            •    NetAmountDescending

            Optional.

            Default: 1
          nullable: true
    TransactionFeesRes:
      type: object
      title: TransactionFeesRes
      properties:
        RequestId:
          type: string
          description: Unique identifier for the request. This will be played back in the response from the request.
          example: 0e6fb42a-51b0-43b2-f010-92f822657f6a
        Status:
          type: string
          description: Status of the request
          example: SUCCESS
        Data:
          type: array
          items:
            $ref: '#/components/schemas/FeeItemNew'
        Page: 
          type: integer
          description: Current Page
          example: 1
        TotalRecords: 
          type: integer
          description: Total row count matched for the given input criteria
          example: 100
        TotalPages: 
          type: integer
          description: Calculated page count based on page size from the incoming API request and total number of rows matched for the given input criteria. Return 1 if the page size is -1 as all records are returned.
          example: 100
        PageSize: 
          type: integer
          description: Page Size – Number of records to show on current page.
          example: 100
        Warnings:
          $ref: '#/components/schemas/Warnings'   
    FeeItemNew:
      title: FeeItem
      type: object
      properties:
        FeeItemId:
          type: integer
          description: Fee Item unique identifier in the H3 Cards Platform
          format: int32
          nullable: true
        AccountId:
          type: integer
          description: Account Id
          format: int32
          nullable: true
        AccountNumber:
          type: string
          description: Account Number
          nullable: true
        AccountShortName:
          type: string
          description: Account short Number
          nullable: true
        InvoiceAccountId:
          type: integer
          description: Invoice Account Id
          format: int32
          nullable: true
        InvoiceAccountNumber:
          type: string
          description: Invoice Account Number
          nullable: true
        InvoiceAccountShortName:
          type: string
          description: Invoice Account short Name
          nullable: true
        PayerId:
          type: integer
          description: Payer Id
          format: int32
          nullable: true
        PayerNumber:
          type: string
          description: Payer Number
          nullable: true
        PayerShortName:
          type: string
          description: Payer short Name
          nullable: true
        CardId:
          type: integer
          description: Unique Card Id
          format: int32
          nullable: true
        PAN:
          type: string
          description: Card PAN
          nullable: true
        CardGroupId:
          type: integer
          description: Card Group Id
          format: int32
          nullable: true
        CardGroupName:
          type: string
          description: Card Group Name
          nullable: true
        FeeTypeId:
          type: integer
          description: Fee type identifier.
          format: int32
          nullable: true
        FeeType:
          type: string
          description: Fee type description
          nullable: true
        FeeTypeGroup:
          type: string
          description: "Fee type group in under which the Fee item is generated.\r\nExample: \r\nAccount\r\nCard\r\nOthers"
          nullable: true
        FeeRuleId:
          type: integer
          description: Fee rule identifier
          format: int32
          nullable: true
        FeeRuleDescription:
          type: string
          description: Fee rule description
          nullable: true
        FeeRuleTiers:
          type: array
          items:
            $ref: '#/components/schemas/FeesFeeRuleTiers'
          description: ''
        FeeItemDate:
          type: string
          description: >-
            Local Fee Item Date of when the transaction took place

            Format: yyyyMMdd
          nullable: true
        FeeItemTime:
          type: string
          description: >-
            Local Fee Item Time of where the transaction took place

            Format: HH:mm:ss (24 hours format)
          nullable: true
        IsManual:
          type: boolean
          description: >-
            True/False.

            Is manual
          nullable: true
        IsCancelled:
          type: boolean
          description: >-
            True/False.

            Is cancelled
          nullable: true
        CustomerCurrencyCode:
          type: string
          description: "ISO currency code \r\nExample: GBP"
          nullable: true
        CustomerCurrencySymbol:
          type: string
          description: "Currency symbol of the Currency Code \r\nExample: £, $"
          nullable: true
        ProductId:
          type: integer
          description: >-
            Product Id

            Example: Sample list of product ids and description.

            100 Service fee

            102 Invoice production fee

            103 Account fee

            104 Transaction fee

            105 Card membership fee
          format: int32
          nullable: true
        ProductCode:
          type: string
          description: "Product Code – Global as per GFN configuration \r\nExample: \r\n2 Service fee\r\n4 Invoice production fee\r\n5 Account fee\r\n6 Transaction fee\r\n7 Card membership fee"
          nullable: true
        ProductName:
          type: string
          description: >-
            Product Name

            Example: Sample list of product ids and description.

            Service fee

            Invoice production fee
          nullable: true
        ProductGroupId:
          type: integer
          description: >-
            Product Group Id

            Example: Sample list

            22    Card related fees

            23    Monetary Adjustment
          format: int32
          nullable: true
        ProductGroupName:
          type: string
          description: >-
            Product Group Name

            Example: Sample list

            22    Card related fees

            23    Monetary Adjustment
          nullable: true
        LineItemDescription:
          type: string
          description: Line Item Description generally the quantity as printed on Invoice or the manually keyed in description for manual fees
          nullable: true
        Quantity:
          type: integer
          description: Quantity
          format: int32
          nullable: true
        IsInvoiced:
          type: boolean
          description: >-
            True/False.

            Is fee item invoiced
          nullable: true
        VATCountryCode:
          type: string
          description: VAT country ISO code
          nullable: true
        VATCountryName:
          type: string
          description: VAT country name
          nullable: true
        VATPercentage:
          type: number
          description: VAT percentage
          nullable: true
        VATCategoryID:
          type: integer
          description: VAT Category identifier
          format: int32
          nullable: true
        VATCategoryDescription:
          type: string
          description: VAT Category description
          nullable: true
        LegislativeRegionId:
          type: integer
          description: Legislative region id
          format: int32
          nullable: true
        LegislativeRegionName:
          type: string
          description: Legislative region name
          nullable: true
        SystemEntryDate:
          type: string
          description: System entry date
          nullable: true
        SystemEntryTime:
          type: string
          description: System entry time
          nullable: true
        ColCoNetAmount:
          type: number
          description: ColCo net amount
          nullable: true
        ColCoVATAmount:
          type: number
          description: ColCoVAT amount
          nullable: true
        ColCoGrossAmount:
          type: number
          description: ColCo gross amount
          nullable: true
        InterimInvoiceId:
          type: integer
          description: Interim invoice id
          format: int32
          nullable: true
        InterimInvoiceNumber:
          type: string
          description: Interim invoice number
          nullable: true
        InvoiceId:
          type: integer
          description: Invoice id
          format: int32
          nullable: true
        InvoiceNumber:
          type: string
          description: Invoice number
          nullable: true
        InvoiceDate:
          type: string
          description: "Invoice date \r\nFormat: yyyyMMdd"
          nullable: true
        CustomerExchangeRate:
          type: number
          description: Customer exchange rate
          nullable: true
        InvoiceNetAmount:
          type: number
          description: Invoice net amount
          nullable: true
        InvoiceGrossAmount:
          type: number
          description: Invoice gross amount
          nullable: true
        InvoiceVATAmount:
          type: number
          description: Invoice VAT amount
          nullable: true
        ReverseCharge:
          type: boolean
          description: >-
            True/False.

            Reverse charge.
          nullable: true
        OriginalFeeItemId:
          type: integer
          description: Original Fee Item id.
          format: int32
          nullable: true
        OriginalCurrencyCode:
          type: string
          description: Original FeeItem Currency ISO code.
          nullable: true
        OriginalCurrencySymbol:
          type: string
          description: Original FeeItem currency symbol
          nullable: true
        OriginalUnitPrice:
          type: number
          description: Original FeeItem unit price
          nullable: true
        OriginalNetAmount:
          type: number
          description: Original FeeItem net amount
          nullable: true
        OriginalVATAmount:
          type: number
          description: Original FeeItem VAT amount
          nullable: true
        OriginalGrossAmount:
          type: number
          description: Original FeeItem gross amount
          nullable: true
        OriginalExchangeRate:
          type: number
          description: Original FeeItem exchange rate
          nullable: true
        OriginalLegislativeRegionId:
          type: integer
          description: Original legislative region id
          format: int32
          nullable: true
        OriginalLegislativeRegionName:
          type: string
          description: Original legislative region name
          nullable: true
        Frequency:
          type: string
          description: "Fee frequency derived from Fee rules if applicable\r\nReturns ID-Description in one field\r\nExample: \r\n1- Daily (all days)\r\n2-Daily (only working days)\r\n3-Weekly – Monday\r\n4-Weekly - Tuesday"
          nullable: true
        FeeItemCardLevelBreakup:
          type: string
          description: Fee breakup at card level for Fee Items where applicable.
          nullable: true
        OriginalFeeItemInvoiceId:
          type: integer
          description: >-
            Invoice Id/ Billing Document Id of the original fee item (when not null).

            Applicable only for fee items that are refund to an original fee item that is already invoiced.
          format: int32
          nullable: true
        OriginalFeeItemInvoiceNumber:
          type: string
          description: >-
            Invoice Number of the original fee item (when not null).

            Applicable only for fee items that are refund to an original fee item that is already invoiced.
          nullable: true
        OriginalFeeItemInvoiceDate:
          type: string
          description: >-
            Invoice Date of the original fee item (when not null).

            Applicable only for fee items that are refund to an original fee item that is already invoiced.

            Format: yyyyMMdd
          nullable: true
        DriverName:
          type: string
          description: Driver name embossed on the Card
          nullable: true
        EmbossText:
          type: string
          description: Text embossed on the Card
          nullable: true
        VRN:
          type: string
          description: Reg. Number embossed on the Card
          nullable: true
    FeesFeeRuleTiers:
      title: FeesFeeRuleTiers
      type: object
      properties:
        TierMin:
          type: integer
          format: int32
          nullable: true
        TierMax:
          type: integer
          format: int32
          nullable: true
        DateEffective:
          type: string
          nullable: true
        DateTerminated:
          type: string
          nullable: true
        TierValue:
          type: number
          nullable: true
        FeeRuleBasisID:
          type: integer
          format: int32
          nullable: true
        FeeRuleBasisDescription:
          type: string
          nullable: true

tags:

  - name: Transaction - New
    description: |
      The Transaction API now supports OAuth 2.0 authentication for secure access. Please note the following important changes:

      - The Base URL has been updated.
      - All API endpoints are now versioned under the /v1 path in the new base URL.
       - Please refer [OAuth 2.0 Migration Support](https://developer.shell.com/support?filter=892&category=oauth-2.0-migration) for more details on the migration process.
  - name: Transaction
    description: Transaction API with Basic authentication.