data-and-reporting-sdk
Version:
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
341 lines • 13.2 kB
TypeScript
/**
* Shell Data & Reporting APIsLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { Schema } from '../schema.js';
import { PricedTransactionRespV2RefundFlagEnum } from './pricedTransactionRespV2RefundFlagEnum.js';
export interface PricedResponseData {
/** Name of the account */
accountName?: string | null;
/** Account Id (i.e. Customer Id of the Sub Account in GFN) of the selected account. */
accountId?: number | null;
/** AccountNumber of the selected account. */
accountNumber?: string | null;
/** Nick name of the account */
accountShortName?: string | null;
/** Addtional SerialId or endpoint Id */
additional1?: string | null;
/** Addtional SerialId or endpoint Id */
additional2?: string | null;
/** Addtional SerialId or endpoint Id */
additional3?: string | null;
/** Addtional SerialId or endpoint Id */
additional4?: string | null;
/** Allow clearings */
allowClearing?: string | null;
/** Autorization code */
authorisationCode?: number | null;
/** Status of the transaction */
transactionStatus?: string | null;
/** Driver Name of Card record */
driverName?: string | null;
/** Expiry period of the card */
cardExpiryPeriod?: number | null;
/** Card Expiry Date */
cardExpiry?: string | null;
/** Card Group Code */
cardGroupId?: number | null;
/** Group nmae of the card */
cardGroupName?: string | null;
/** Issuer code */
issuerCode?: number | null;
/** Full Card PAN */
cardPAN?: string | null;
/** Release code */
releaseCode?: number | null;
/** Sequesnce number of the card */
cardSequenceNumber?: number | null;
/** Type of card */
cardType?: string | null;
/** Collecting Company Code (Shell Code) of the selected payer. */
colCoCode?: string | null;
/** Unit discount Invoice currency */
unitDiscountInvoiceCurrency?: number | null;
/** Colco exchange rate */
colCoExchangeRate?: number;
/** Currency symbol on which the invoice was raised */
invoiceCurrencySymbol?: string | null;
/** Is there any correction */
correctionFlag?: boolean | null;
/** CRM number */
cRMNumber?: number | null;
/** Customer country */
customerCountry?: string | null;
/** Curreny which customer uses to transact. */
customerCurrencyCode?: string | null;
/** Custome currency symbol */
customerCurrencySymbol?: string | null;
/** Rebate on net amount in customer currency */
rebateonNetAmountInCustomerCurrency?: number | null;
/** Effective discount in customers currency */
effectiveDiscountInCustomerCurrency?: number | null;
/** effectiive unit discount in customers currency */
effectiveUnitDiscountInCustomerCurrency?: number | null;
/** Unitpricing in invoice currency */
unitPriceInInvoiceCurrency?: number | null;
/** Invoice tax */
invoiceTax?: number | null;
/** Invoice amount befor tax */
invoiceGrossAmount?: number | null;
/** Invoice amount after tax */
invoiceNetAmount?: number | null;
/** Vat on net amount in customer currency */
vATonNetAmountInCustomerCurrency?: number | null;
/** Customer retail unit price before tax */
customerRetailPriceUnitGross?: number | null;
/** Total Customer retail value before tax */
customerRetailValueTotalGross?: number | null;
/** Total customer retail value after tax */
customerRetailValueTotalNet?: number | null;
/** Trasaction type description */
transactionTypeDescription?: number | null;
/** Rebate give to net amountin transaction currency that is used */
rebateonNetAmountInTransactionCurrency?: number | null;
/** Currency used to giveEffective discount on transactions */
effectiveDiscountInTrxCurrency?: number | null;
/** Exchange rate between Delco and Colco */
delCoToColCoExchangeRate?: number | null;
cards?: number[];
/** Currency used forto provide unit Transaction discount */
unitDiscountTransactionCurrency?: number | null;
/** Transactional amount before tax */
transactionGrossAmount?: number | null;
/** Transaction net amount after tax */
transactionNetAmount?: number | null;
/** Transaction tax */
transactionTax?: number | null;
/** Transactinal tax rates */
vATonNetAmount?: number | null;
/** Priv */
delcoListPriceUnitNet?: number | null;
/** Delco retail price per unit before tax */
delcoRetailPriceUnitGross?: number | null;
/** Delco retail price per unit after tax */
unitPriceInTransactionCurrency?: number | null;
/** Delco retail price per unit */
delcoRetailPriceUnitNet?: number | null;
/** Delco retail price before tax */
delcoRetailValueTotalGross?: number | null;
/** Delco per unit price after tax */
delcoRetailValueTotalNet?: number | null;
/** Currency used for transaction. */
transactionCurrencySymbol?: string | null;
/** Type of discount available */
discountType?: string | null;
/** Is there any dispute status?True or False */
disputeStatus?: boolean | null;
/** Is it a shell sites?True or False */
isShellSite?: boolean;
/** Fleet identifier */
fleetIdInput?: string | null;
/** In coming product code */
incomingProductCode?: number | null;
/** Date of Posting */
postingDate?: string | null;
/** Time whern posting happened */
postingTime?: string | null;
/** Product Code - 21 Unleaded - High octane,22 Unleaded - Medium octane,23 Unleaded - Low octane,24 Unleaded Environmental */
productCode?: number | null;
/** Name of the product */
productName?: string | null;
/** Id of the product to which group it belongs */
productGroupId?: number | null;
/** In coming currecncy code */
incomingCurrencyCode?: string | null;
/** In coming Site description */
incomingSiteDescription?: string | null;
/** Location of the Shell site */
location?: string | null;
/** Shell site name */
siteName?: string | null;
/** Shell site code */
siteCode?: number | null;
/** In coming site number */
incomingSiteNumber?: number | null;
/** Currency code on which the invoice is raised */
invoiceCurrencyCode?: string | null;
/** Date on which the invoice was raised */
invoiceDate?: string | null;
/** Invoice number */
invoiceNumber?: number | null;
/** Is it a fuel product? True or False */
fuelProduct?: boolean | null;
/** Is VAT applicable?Y or N */
vATApplicable?: string | null;
/** Name of the payer */
payerName?: string | null;
/** Payer account number */
payerNumber?: string | null;
/** Parent account number of the payer */
parentCustomerNumber?: string | null;
/** The group which the payer belongs to */
payerGroup?: string | null;
/** Name of the group to which the payer belongs to. */
payerGroupName?: string | null;
/** Check digit */
checkDigit?: number | null;
/** After tax net invoice number */
netInvoiceIndicator?: string | null;
/** Delco code */
delcoCode?: number | null;
/** Network code of the payer */
networkCode?: number | null;
/** Country of purchase */
purchasedInCountry?: string | null;
/** Country where the site exists */
siteCountry?: string | null;
/** Country where VAT is applicable */
vATCountry?: string | null;
/** Name of the delivery company */
delcoName?: string | null;
/** Network of the Delivery company */
network?: string | null;
/** Odometet input */
odometerInput?: number | null;
/** Original item identifier for sales */
originalSalesItemId?: string | null;
/** Fleet identifier description */
fleetIDDescription?: string | null;
/** Identifier of parent customer */
parentCustomerId?: number | null;
/** PIN indicator */
pINIndicator?: string | null;
/** Name og the group the product belongs to */
productGroupName?: string | null;
/** The countroy code where the purchase was made */
purchasedInCountryCode?: string | null;
/** Quantity of the product */
quantity?: number | null;
/** Rebate rate if any */
rebateRate?: number | null;
/** Reciept number */
receiptNumber?: number | null;
refundFlag?: PricedTransactionRespV2RefundFlagEnum;
/** Group identifier for the site */
siteGroupId?: number | null;
/** Name of the Site group */
siteGroupName?: string | null;
/** Latitude of the site */
latitude?: number | null;
/** Longitude of the site */
longitude?: number | null;
/** Delivery company exchange rate */
delCoExchangeRate?: number | null;
/** Rebate amount in Euros */
euroRebateAmount?: number | null;
/** Net amount in Euros */
netEuroAmount?: number | null;
/** Vat amount in Euros */
euroVATAmount?: number | null;
/** Customers parent name */
parentCustomerName?: string | null;
/** Is invoice raised */
isInvoiced?: boolean | null;
/** Transaction currency code */
transactionCurrencyCode?: string | null;
/** Is it Credit or debit C for credit D for Debit */
creditDebitCode?: string | null;
/** Date of transaction */
transactionDate?: string | null;
/** Time of transaction */
transactionTime?: string | null;
/** Identifier of the Iem in transaction */
transactionItemId?: string | null;
/** Transaction identifier */
trnIdentifier?: string | null;
/** Transaction type for Delco */
type?: string | null;
transactionLine?: number | null;
/** Transaction type Colco */
transactionType?: string | null;
/** Leaving country */
uTCOffset?: string | null;
/** To which category and counry does the VAT come under */
vATCategory?: string | null;
/** VAT rate */
vATRate?: number | null;
/** Vehicle registration number */
vehicleRegistration?: string | null;
/** Check if the pruchase is cancelled */
isCancelled?: string | null;
/** Gross amount from Colco */
colCoGrossAmount?: number | null;
/** Net amount from Colco */
colCoNetAmount?: number | null;
/** Colco VAT amount */
colCoVATAmount?: number | null;
/** Original currency code */
originalCurrencySymbol?: string | null;
/** Original currency code */
originalCurrencyCode?: string | null;
/** Original VAT amount */
originalVATAmount?: number | null;
/** Comapany name embosses in text */
embossText?: string | null;
/** Orginal exchange rate */
originalExchangeRate?: number | null;
/** Original treansaction date */
originalTransactionItemInvoiceDate?: string | null;
/** Fee type identifier */
feeTypeId?: number | null;
/** Line item identifier of the product */
lineItemDescription?: boolean | null;
/** Fee rule description */
feeRuleDescription?: string | null;
/** Frequency of transaction */
frequency?: number | null;
/** Fee rule identifier */
feeRuleId?: number | null;
/** Entry date in the system */
systemEntryDate?: string | null;
/** Entry time in the system */
systemEntryTime?: string | null;
/** Checking if its manual */
isManual?: string | null;
/** Is it manual */
originalTransactionItemId?: string | null;
/** Original invoice transaction number */
originalTransactionItemInvoiceNumber?: number | null;
/** Original Invoice transaction Identifier */
originalTransactionItemInvoiceId?: number | null;
/** Payers short name */
payerShortName?: string | null;
/** Is reverse charge? */
reverseCharge?: string | null;
/** Original gross amount */
originalGrossAmount?: number | null;
/** Original Net amount */
originalNetAmount?: number | null;
/** Unit of measure */
unitOfMeasure?: string | null;
/** Type of road */
roadType?: string | null;
/** Customer country ISO Code */
customerCountryIsoCode?: string | null;
/** EvOperator Name */
eVOperator?: string | null;
/** Ev Operator identifier */
eVSerialId?: string | null;
/** EV Charging point iserial identifier */
eVChargePointSerial?: string | null;
/** Ev chariging connector type */
eVChargePointConnectorType?: number | null;
/** EV charging point connector type description */
eVChargePointConnectorTypeDescription?: string | null;
/** Ev charging Duration */
eVChargeDuration?: string | null;
/** EvCharging start Date */
eVChargeStartDate?: string | null;
/** EvCharging start time */
eVChargeStartTime?: string | null;
/** EvCharging End Date */
eVChargeEndDate?: string | null;
/** EvCharging End time */
eVChargeEndTime?: string | null;
hostingCollectingCompanyNumber?: number | null;
transactionId?: number | null;
fuelOnly?: boolean | null;
}
export declare const pricedResponseDataSchema: Schema<PricedResponseData>;
//# sourceMappingURL=pricedResponseData.d.ts.map