data-and-reporting-sdk/src/models/priceList.ts

Data And Reporting product consists of API's which provides details of transaction and invoice informations about shell cards. The Shell Card Transaction and Invoice API is REST-based and employs Basic authentication in Version 1 and Oauth authentication

/**
 * Shell Data & Reporting APIsLib
 *
 * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import {
  array,
  lazy,
  nullable,
  number,
  object,
  optional,
  Schema,
  string,
} from '../schema';
import { Tier, tierSchema } from './tier';

export interface PriceList {
  /**
   * Date on which the price is applicable.
   * Format: yyyyMMdd
   * E.g.: 20180131
   */
  date?: string | null;
  /**
   * Day on which the price is applicable.
   * E.g.: Sunday, Monday etc.
   */
  day?: string | null;
  /**
   * Price list type.
   * E.g., List, Shell Standard International List
   */
  type?: string | null;
  /** Price list ID */
  priceListId?: number | null;
  /**
   * Price list description
   * E.g., UK Fuels CRT Reseller List Price
   */
  priceListDescription?: string | null;
  /** Price Rule Id */
  priceRuleId?: number | null;
  /** Price Rule Name */
  priceRuleName?: string | null;
  /** DelCo Id */
  delCoId?: number | null;
  /**
   * Country ISO Code
   * E.g., UK, NL, etc.,
   */
  countryCode?: string | null;
  /**
   * Country
   * E.g., United Kingdom, Netherlands etc
   */
  country?: string | null;
  /** Product Group Id */
  productGroupId?: number | null;
  /** Product Group name */
  productGroupName?: string | null;
  /** Client Product Code */
  productCode?: string | null;
  /** Product Id */
  productId?: number | null;
  /** Product name in English */
  productName?: string | null;
  /** Price per unit */
  pricePerUnit?: number | null;
  /**
   * Currency Code.
   * Format : 3 digit ISO code
   */
  currencyCode?: string | null;
  /**
   * Currency Symbol
   * Example: £
   */
  currencySymbol?: string | null;
  /**
   * Price Type
   * Possible Values are:
   * •    Country– Price rule defined at country whereas Price Rule DelcoId same as ColcoId.
   * •    TPNDelcoPrice – Price rule defined in the TPN whereas Price Rule DelcoId is different from ColcoId.
   * •    NetworkPrice – Price rule defined at Fuel Network level.
   * •    Other – Price rule defined at either Site or SiteGroup level.
   */
  priceType?: string | null;
  /**
   * Site-Group ID
   * E.g.: 100007
   */
  siteGroupId?: number | null;
  /** Site-Group name */
  siteGroupName?: string | null;
  /** Site Code */
  siteCode?: number | null;
  /** Site ID */
  siteId?: number | null;
  /** Site Name */
  siteName?: string | null;
  /** Fuel Network ID */
  fuelNetworkId?: number | null;
  /** Network Name */
  networkName?: string | null;
  /** PriceRuleDelcoId */
  priceRuleDelcoId?: number | null;
  /**
   * Company Name of the price rule DelCo.
   * E.g.:
   * •    Pilipinas Shell Petroleum Corp
   * •    Shell U.K. Oil Products Limited
   * •    G & V SERVICE STATIONS NV
   */
  priceRuleDelcoName?: string | null;
  /**
   * PriceRuleCountry
   * E.g.: United Kingdom
   */
  priceRuleCountry?: string | null;
  /**
   * ISO Code of PriceRuleCountry
   * E.g.: UK, NL, etc.,
   */
  priceRuleCountryCode?: string | null;
  /** PriceRuleBasisId */
  priceRuleBasisId?: number | null;
  /** Discount value */
  discountValue?: number | null;
  /** Price per unit after discount */
  pricePerUnitAfterDiscount?: number | null;
  /** VAT Percentage */
  vATPercentage?: number | null;
  /** PriceRuleCategoryId */
  priceRuleCategoryId?: number | null;
  tiers?: Tier[];
}

export const priceListSchema: Schema<PriceList> = object({
  date: ['Date', optional(nullable(string()))],
  day: ['Day', optional(nullable(string()))],
  type: ['Type', optional(nullable(string()))],
  priceListId: ['PriceListId', optional(nullable(number()))],
  priceListDescription: ['PriceListDescription', optional(nullable(string()))],
  priceRuleId: ['PriceRuleId', optional(nullable(number()))],
  priceRuleName: ['PriceRuleName', optional(nullable(string()))],
  delCoId: ['DelCoId', optional(nullable(number()))],
  countryCode: ['CountryCode', optional(nullable(string()))],
  country: ['Country', optional(nullable(string()))],
  productGroupId: ['ProductGroupId', optional(nullable(number()))],
  productGroupName: ['ProductGroupName', optional(nullable(string()))],
  productCode: ['ProductCode', optional(nullable(string()))],
  productId: ['ProductId', optional(nullable(number()))],
  productName: ['ProductName', optional(nullable(string()))],
  pricePerUnit: ['PricePerUnit', optional(nullable(number()))],
  currencyCode: ['CurrencyCode', optional(nullable(string()))],
  currencySymbol: ['CurrencySymbol', optional(nullable(string()))],
  priceType: ['PriceType', optional(nullable(string()))],
  siteGroupId: ['SiteGroupId', optional(nullable(number()))],
  siteGroupName: ['SiteGroupName', optional(nullable(string()))],
  siteCode: ['SiteCode', optional(nullable(number()))],
  siteId: ['SiteId', optional(nullable(number()))],
  siteName: ['SiteName', optional(nullable(string()))],
  fuelNetworkId: ['FuelNetworkId', optional(nullable(number()))],
  networkName: ['NetworkName', optional(nullable(string()))],
  priceRuleDelcoId: ['PriceRuleDelcoId', optional(nullable(number()))],
  priceRuleDelcoName: ['PriceRuleDelcoName', optional(nullable(string()))],
  priceRuleCountry: ['PriceRuleCountry', optional(nullable(string()))],
  priceRuleCountryCode: ['PriceRuleCountryCode', optional(nullable(string()))],
  priceRuleBasisId: ['PriceRuleBasisId', optional(nullable(number()))],
  discountValue: ['DiscountValue', optional(nullable(number()))],
  pricePerUnitAfterDiscount: [
    'PricePerUnitAfterDiscount',
    optional(nullable(number())),
  ],
  vATPercentage: ['VATPercentage', optional(nullable(number()))],
  priceRuleCategoryId: ['PriceRuleCategoryId', optional(nullable(number()))],
  tiers: ['Tiers', optional(array(lazy(() => tierSchema)))],
});