data-and-reporting-sdk/dist/types/models/volumeBasedBonusRequest.d.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 { Schema } from '../schema';
export interface VolumeBasedBonusRequest {
    /**
     * Collecting Company Id of the selected payer.
     * Optional if ColCoCode is passed else Mandatory.
     * Example:
     * 1 for Philippines
     * 5 for UK
     */
    colCoId?: number;
    /**
     * Collecting Company Code of the selected payer.
     * Mandatory for serviced OUs such as Romania, Latvia, Lithuania, Estonia, Ukraine etc. It is optional for other countries if ColCoID is provided.
     * Example:
     * 86 for Philippines
     * 5 for UK
     */
    colCoCode?: number;
    /**
     * Payer Id of the selected payer.
     * Optional if PayerNumber is passed else Mandatory
     */
    payerId?: number;
    /**
     * Payer Number of the selected payer.
     * Optional if PayerId is passed else Mandatory
     */
    payerNumber?: string;
    /** The API will return the details of the previously calculated/paid bonus and fuel consumption (Volume) in the response when this flag is ‘True’. */
    includeHistory?: boolean;
    /** The API will return the details of the monthly breakup of current period fuel consumption (Volume) in the response when this flag is ‘True’. */
    includeCurrentPeriodVolume?: boolean;
}
export declare const volumeBasedBonusRequestSchema: Schema<VolumeBasedBonusRequest>;