data-and-reporting-sdk/src/models/cardExceptions.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 { nullable, number, object, optional, Schema, string } from '../schema';

export interface CardExceptions {
  /** Account Id */
  accountId?: number | null;
  /** Account Number */
  accountNumber?: string | null;
  /** Account Short Name */
  accountShortName?: string | null;
  /** Unique Card Id */
  cardId?: number | null;
  /** ISO currency code */
  currencyCode?: string | null;
  /** Currency symbol of the Invoice Currency Code */
  currencySymbol?: string | null;
  /** Summary Day: Populated when the Period is passed as ‘Day’. */
  day?: number | null;
  /** Driver name */
  driverName?: string | null;
  /** Summary Month: Populated when the Value of Period is Passed as ‘Month’. */
  month?: number | null;
  /** Card PAN */
  pAN?: string | null;
  /** Payment customer id of the customer */
  payerId?: number | null;
  /** Payment customer number */
  payerNumber?: string | null;
  /** Payer Short Name */
  payerShortName?: string | null;
  /** Total Amount (In Customer Currency) of Transactions met with the given exceptions criteria. */
  totalAmount?: number | null;
  /** Total Quantity of Transactions met with the given exceptions criteria. */
  totalQuantity?: number | null;
  /** Total number of Sales Items met with the given exception criteria. */
  totalSalesItems?: number | null;
  /** Total number of Transactions met with the given exception criteria. */
  totalTransactions?: number | null;
  /** Vehicle Registration Number */
  vRN?: string | null;
  /** Summary Week Number with in the given date range. Populated when the Value of Period is Passed as ‘Week’. */
  week?: number | null;
  /** Summary Year: Populated when the Value of Period is Passed as ‘Month’. */
  year?: number | null;
}

export const cardExceptionsSchema: Schema<CardExceptions> = object({
  accountId: ['AccountId', optional(nullable(number()))],
  accountNumber: ['AccountNumber', optional(nullable(string()))],
  accountShortName: ['AccountShortName', optional(nullable(string()))],
  cardId: ['CardId', optional(nullable(number()))],
  currencyCode: ['CurrencyCode', optional(nullable(string()))],
  currencySymbol: ['CurrencySymbol', optional(nullable(string()))],
  day: ['Day', optional(nullable(number()))],
  driverName: ['DriverName', optional(nullable(string()))],
  month: ['Month', optional(nullable(number()))],
  pAN: ['PAN', optional(nullable(string()))],
  payerId: ['PayerId', optional(nullable(number()))],
  payerNumber: ['PayerNumber', optional(nullable(string()))],
  payerShortName: ['PayerShortName', optional(nullable(string()))],
  totalAmount: ['TotalAmount', optional(nullable(number()))],
  totalQuantity: ['TotalQuantity', optional(nullable(number()))],
  totalSalesItems: ['TotalSalesItems', optional(nullable(number()))],
  totalTransactions: ['TotalTransactions', optional(nullable(number()))],
  vRN: ['VRN', optional(nullable(string()))],
  week: ['Week', optional(nullable(number()))],
  year: ['Year', optional(nullable(number()))],
});