data-and-reporting-sdk/dist/types/models/pricedRequestData.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.js';
import { PricedTransactionReqV2InvoiceStatusEnum } from './pricedTransactionReqV2InvoiceStatusEnum.js';
import { PricedTransactionReqV2PeriodEnum } from './pricedTransactionReqV2PeriodEnum.js';
import { PricedTransactionReqV2SortOrderEnum } from './pricedTransactionReqV2SortOrderEnum.js';
/** 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 */
export interface PricedRequestData {
    /** Collecting Company Code (Shell Code) of the selected payer. */
    colCoCode: string | null;
    /** The Collecting Company Id in the Shell Card Platform. */
    colCoId?: number;
    invoiceStatus: PricedTransactionReqV2InvoiceStatusEnum;
    /** Payer Number of the selected payer. */
    payerNumber: string | null;
    /** Account Id (GFN customer id) */
    accountId?: number | null;
    /** Account Number of the selected account. */
    accountNumber?: string | null;
    /** Driver Name (of Card record) */
    driverName?: string | null;
    /** Unique Card Id in the Shell Card Platform */
    cardId?: number;
    /** Card Group Id in GFN */
    cardGroupId?: number | null;
    /** Full Card PAN */
    cardPAN?: string | null;
    /** Product Code – Global as per GFN configuration */
    productCode?: string | null;
    /** Product Name – Global as per GFN configuration */
    productName?: string | null;
    /** Site Code in GFN */
    siteCode?: string | null;
    /** Site Code as configured in GFN */
    incomingSiteNumber?: string | null;
    /** Returns the billed transaction for the given invoice date */
    invoiceDate?: string | null;
    /** Returns the billed transaction for the given invoice number */
    invoiceNumber?: string | null;
    /** Purchased InCountryCode */
    purchasedInCountryCode?: string | null;
    /** Network Delco PurchasedCountryName */
    purchasedInCountry?: string | null;
    /** Site Group Id in GFN */
    siteGroupId?: number | null;
    /** Vehicle Registration (of Card record) */
    vehicleRegistrationNumber?: string | null;
    /** Card Id (i.e. Unique Card Id in GFN) */
    feeTypeId?: number | null;
    /** Item identifier in the transaction. */
    lineItemDescription?: string | null;
    /**
     * 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.
     */
    cards?: number[];
    sortOrder?: PricedTransactionReqV2SortOrderEnum;
    /** From transaction delivery date */
    fromDate?: string | null;
    /** To transaction delivery date */
    toDate?: string | null;
    period?: PricedTransactionReqV2PeriodEnum;
    /** Transaction posting start date and time */
    postingDateFrom?: string | null;
    /** Transaction posting end date and time */
    postingDateTo?: string | null;
    /** Unique id of the transaction that may include one or more salesitems */
    transactionItemId?: string | null;
    /** Is FuelOnly indicator */
    fuelOnly?: boolean | null;
    /**
     * 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
     */
    includeFees?: boolean | null;
    /** If true then returns all the data linked tothe payer group of the provided PayerNumberin the request */
    isMultipayer?: boolean;
    /** 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. */
    validInvoiceDateOnly?: boolean;
    /** Invoice From Date, this is a search criterion to filter invoiced transactions with invoice date from this date. */
    invoiceFromDate?: string | null;
    /** Invoice To Date, this is a search criterion to filter invoiced transactions with invoice date until this date. */
    invoiceToDate?: string | null;
    /** Hosting Collecting Company Number of the selected payer. */
    hostingCollectingCompanyNumber?: string | null;
    /** Search based on DriverName or VRN */
    search?: string | null;
    /** Unique id of the transaction that may include one or more salesitems */
    transactionId?: string | null;
}
export declare const pricedRequestDataSchema: Schema<PricedRequestData>;
//# sourceMappingURL=pricedRequestData.d.ts.map