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
518 lines • 16.7 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 { PricedTransactionResponseTransactionsItemsLocation } from './containers/pricedTransactionResponseTransactionsItemsLocation.js';
export interface PricedTransactionResponseTransactionsItems {
/**
* TransactionType is the type of transaction.
* Example: SalesItem /FeeItem
*/
type?: string | null;
/** Unique Card Id */
cardId?: number | null;
/** Card PAN */
cardPAN?: string | null;
/** Card Expiry Date */
cardExpiry?: string | null;
/** Local Transaction Date of where the transaction took place */
transactionDate?: string | null;
/** Local Transaction Time of where the transaction took place */
transactionTime?: string | null;
/**
* UTC Offset extracted from Sales Date time.
* Note: This may not be accurate for all TPN transactions
* Format: +/-HH:mm:ss (24 hours format)
* Note: - The value could be null/blank for fees item.
*/
uTCOffset?: string | null;
/**
* Fleet Id Input as entered by the drivers at the time of transaction
* Example: XYZ1234
* Note: - The value could be null/blank for fees item.
*/
fleetIdInput?: string | null;
/**
* Odometer Input as entered by the drivers at the time of transaction
* Example: 12345
* Note: - The value could be null/blank for fees item.
*/
odometerInput?: number | null;
/**
* Driver Name embossed on the card
* Example: ANDREW GILBERRY
*/
driverName?: string | null;
/**
* Vehicle Registration Number embossed on the card
* Example: MV65YLH
*/
vehicleRegistration?: string | null;
/**
* ISO currency code
* Example: GBP
*/
invoiceCurrencyCode?: string | null;
/**
* Currency symbol of the Invoice Currency Code
* Example: £, $
*/
invoiceCurrencySymbol?: string | null;
/** ISO currency code */
transactionCurrencyCode?: string | null;
/**
* Currency symbol of the Transaction Currency Code
* Example: £, $
*/
transactionCurrencySymbol?: string | null;
/** Net Amount */
transactionNetAmount?: number | null;
/** Tax Amount */
transactionTax?: number | null;
/** Gross Amount */
transactionGrossAmount?: number | null;
/**
* Invoiced Net Amount
* Note: For a fee item, this parameter will be populated with fee InvoiceNetAmount.
*/
invoiceNetAmount?: number | null;
/** Invoiced Tax Amount */
invoiceTax?: number | null;
/**
* Invoice Gross Amount
* Note: For a fee item, this parameter will be populated with fee InvoiceGrossAmount.
*/
invoiceGrossAmount?: number | null;
/** Country of Purchase */
purchasedInCountry?: string | null;
/**
* Account Id
* Example: 29484
*/
accountId?: number | null;
/** Account Number */
accountNumber?: string | null;
/** Account Name */
accountName?: string | null;
/** Account Short Name */
accountShortName?: string | null;
/** Quantity/Volume */
quantity?: number | null;
/** True if the product on transaction is listed as a fuel product else return false */
fuelProduct?: boolean | null;
/** Product Unit Price in transaction currency */
unitPriceInTransactionCurrency?: number | null;
/** Product Unit Price in invoice currency */
unitPriceInInvoiceCurrency?: number | null;
/** Unit Discount in transaction currency */
unitDiscountTransactionCurrency?: number | null;
/**
* Unit Discount in invoice currency
* Note: - The value could be null/blank for fees item.
*/
unitDiscountInvoiceCurrency?: number | null;
/** True when the transaction is already invoice, else return False */
isInvoiced?: boolean | null;
/**
* Invoice Number if invoiced
* S04500493
*/
invoiceNumber?: string | null;
/**
* Invoice Date
* Format: yyyyMMdd HH:mm:ss
*/
invoiceDate?: string | null;
/**
* Site Code
* Example:
* 050001 - CHARNOCK RICHARD NTHBOUND MWSA 0755
* 050002 - CHARNOCK RICHARD STHBOUND MWSA 0755
*/
siteCode?: string | null;
/**
* Site Name
* Example:
* 050001 - CHARNOCK RICHARD NTHBOUND MWSA 0755
* 050002 - CHARNOCK RICHARD STHBOUND MWSA 0755
*/
siteName?: string | null;
/**
* Site Country
* Example: France, Germany
* Note: - The value could be null/blank for fees item.
* Geography Location entity for Site Location
* Note: - The value could be null/blank for fees item.
*/
siteCountry?: string | null;
/**
* Geography Location entity for Site Location
* Note: - The value could be null/blank for fees item
*/
location?: PricedTransactionResponseTransactionsItemsLocation[];
/** Card Group Name */
cardGroupName?: string | null;
/** Receipt Number */
receiptNumber?: string | null;
/**
* Product Code
* 10 TMF Charges
* 11 Tunnel/Bridges
* 12 Motorway toll
* 13 Ferries
*/
productCode?: string | null;
/**
* Product Name
* Unleaded - High octane
* Unleaded - Medium octane
* Unleaded - Low octane
* Unleaded Environmental
*/
productName?: string | null;
/**
* Product Group Id
* Example:
* 1 Parent Product Group
* 2 All Fuels
* 3 Motor gasoline
* 4 2 stroke
* 5 Autogas
* 6 CNG
*/
productGroupId?: number | null;
/**
* Product Group Name
* Example:
* 1 Parent Product Group
* 2 All Fuels
* 3 Motor gasoline
* 4 2 stroke
* 5 Autogas
* 6 CNG
* 7 Automotive Gas Oil
*/
productGroupName?: string | null;
/** DelCo Exchange Rate (Site exchange rate) */
delCoExchangeRate?: number | null;
/** ColCo Exchange Rate (Customer exchange rate) */
colCoExchangeRate?: number | null;
/**
* True when transaction occurred at a Shell site else return False
* Note: - The value could be null/blank for fees item.
*/
isShellSite?: boolean | null;
/**
* Network as configured in GFN (Shell PH, ESSO, etc.,)
* 100013 STEINDORFER
* 100015 S.A. BELGIAN SHELL N.V.
* 100016 ESSO BE
* Note: - The value could be null/blank for fees item
*/
network?: string | null;
/**
* Site Group Id
* Example: 202
* Note: - The value could be null/blank for fees item.
*/
siteGroupId?: number | null;
/**
* Site Group Name
* Example: CZ 9100 ECONOMY NETWORK
*/
siteGroupName?: string | null;
/**
* Transaction Posting Date
* Format: yyyyMMdd HHmmss
*/
postingDate?: string | null;
/**
* First digits of the Card PAN
* 7002 = Fleet
* 7077 = CRT
*/
issuerCode?: string | null;
/**
* ISO code of the country where the transaction took place
* Example: “NL”
*/
purchasedInCountryCode?: string | null;
/** ISO code of the Customer Country */
customerCountryCode?: string | null;
/** Name of the Customer Country */
customerCountry?: string | null;
/** Release code, 7th Digit of the Card PAN */
releaseCode?: string | null;
/** Card group ID */
cardGroupId?: string | null;
/** 3 digits, Card sequence number and Check digit */
cardSequenceNumber?: string | null;
/** Check digit, Last number of the card pan */
checkDigit?: string | null;
/** FleetId/CRN description in Card Platform configured at the account level */
fleetIDDescription?: string | null;
/**
* VAT Percentage
* 0.20 for 20%
*/
vATRate?: number | null;
/**
* VAT Category Id-Description
* 1-Zero Rated
* 2-A1 PH-O 12% Sales Domestic
* 3-VAT exempt
*/
vATCategory?: string | null;
/** VAT Country */
vATCountry?: string | null;
/**
* Effective Discount (excluding VAT, in transaction currency) 4 digits
* Example: 0.0000
* Note: - The value could be null/blank for fees item.
*/
effectiveDiscountInTrxCurrency?: number | null;
/**
* Transaction Type
* Example: Purchase when Card is Present else Blank
* Note: - The value could be null/blank for fees item.
*/
transactionType?: string | null;
/**
* Pin Indicator (Indicates whether PIN used or not used at the time of transaction)
* Example: “PIN Used'” or “No PIN” or “Unknown”
* Note: - The value could be null/blank for fees item
*/
pINIndicator?: string | null;
/** Is VAT Applicable for this transaction */
vATApplicable?: string | null;
/**
* Net Invoice Indicator, Will the customer receive an invoice without VAT?
* Example: “Y” or “N”
*/
netInvoiceIndicator?: string | null;
/** Customer currency code */
customerCurrencyCode?: string | null;
/** Customer currency Symbol */
customerCurrencySymbol?: string | null;
/**
* Effective Unit Discount (excluding VAT in Customer currency)
* Note: - The value could be null/blank for fees item.
*/
effectiveUnitDiscountInCustomerCurrency?: number | null;
/**
* Effective Discount (excluding VAT in Customer currency)
* Note: - The value could be null/blank for fees item
*/
effectiveDiscountInCustomerCurrency?: number | null;
/** VAT on Net Amount (in Customer currency) */
vATonNetAmountInCustomerCurrency?: number | null;
/**
* Discount Type
* Example: 1-None
* 2-Pence per unit
* 3-Percentage
* Note: - The value could be null/blank for fees item
*/
discountType?: string | null;
/**
* Transaction status "U" or "I"
* “U” stands for Uninvoiced
* “I” stands for Invoiced
*/
transactionStatus?: string | null;
/**
* Unique Sales Item Identifier
* Example: 18315958002
* Note: For a fee item, this parameter will be populated with SalesItemId.
*/
salesItemId?: number | null;
/** Payer Group applicable for the Large Customer NL+8 digit code */
payerGroup?: string | null;
/** Payer Group Name */
payerGroupName?: string | null;
/** Refund Flag “N” for Not Refunded and “Y” for Refunded. */
refundFlag?: string | null;
/** Shows Sales Item Id of the original item that was refunded */
originalSalesItemId?: string | null;
/** Delco Name */
delcoName?: string | null;
/** Delco Code */
delcoCode?: string | null;
/** Payer number (Country code+8 digits) */
payerNumber?: string | null;
/**
* Payer name
* Example: V.M. LE COMTE
*/
payerName?: string | null;
/** Year/Month of the Card Expiry captured on the transaction */
cardExpiryPeriod?: string | null;
/**
* Authorisation code of the transaction
* Example: 011256
* Note: - The value could be null/blank for fees item
*/
authorisationCode?: string | null;
/** Unique id of the transaction that may include one or more salesitems */
transactionId?: string | null;
/** Transaction line item number */
transactionLine?: string | null;
/**
* Is the Sales Item allowed for clearing? i.e. not written off
* Example: “Y” or “N”
* Note: - The value could be null/blank for fees item.
*/
allowClearing?: string | null;
/**
* CRM Case number if the sales item is in dispute
* Note: - The value could be null/blank for fees item.
*/
cRMNumber?: string | null;
/**
* Sales Item Dispute Status if disputed
* 0 No Dispute
* 1 In Dispute
* 2 Re-Instated
* 3 Adjusted
* 4 Written Off by Colco
* 5 Written Off by Delco
* 6 Charged Back to Site
* Note: - The value could be null/blank for fees item.
*/
disputeStatus?: string | null;
/**
* Unit discount in customer currency.
* Example: 28.279000
* Note: - The value could be null/blank for fees item
*/
rebateRate?: number | null;
/**
* Exchange rate from transaction currency to customer currency.
* Example: 1
* Note: - The value could be null/blank for fees item
*/
delCoToColCoExchangeRate?: number | null;
/**
* Net euro amount.
* Example: 37.93
* Note: - The value could be null/blank for fees item
*/
netEuroAmount?: number | null;
/**
* Euro rebate amount.
* Example: 0
* Note: - The value could be null/blank for fees item
*/
euroRebateAmount?: number | null;
/**
* Euro VAT amount.
* Example: 7.96
* Note: - The value could be null/blank for fees item
*/
euroVATAmount?: number | null;
/** Parent customer number */
parentCustomerNumber?: string | null;
/** Parent customer name. */
parentCustomerName?: string | null;
/** Parent customer id. */
parentCustomerId?: number | null;
/**
* Incoming Site Number
* Example: 100021
* Note: - The value could be null/blank for fees item.
*/
incomingSiteNumber?: string | null;
/**
* Incoming Site Description
* Example: HN3 INTI_02-82.02
* Note: - The value could be null/blank for fees item.
*/
incomingSiteDescription?: string | null;
/**
* Incoming Currency Code
* Example: GBP
* Note: - The value could be null/blank for fees item
*/
incomingCurrencyCode?: string | null;
/**
* Incoming Product Code
* Example: 30
*/
incomingProductCode?: string | null;
/**
* Credit Debit Code
* Example: “D” or “C”
* The value could be null/blank for fees item.
*/
creditDebitCode?: string | null;
/**
* Correction Flag
* Example: “Y” or “N”
* The value could be null/blank for fees item.
*/
correctionFlag?: string | null;
/** Additional1 */
additional1?: string | null;
/** Additional2 */
additional2?: string | null;
/** Additional3 */
additional3?: string | null;
/** Additional4 */
additional4?: string | null;
/**
* Rebate on Net Amount In Customer Currency
* Example: -0.735000000000
* Note: - The value could be null/blank for fees item.
*/
rebateonNetAmountInCustomerCurrency?: number | null;
/**
* Rebate on Net Amount In Transaction Currency
* Example: -0.735000000000
* Note: - The value could be null/blank for fees item.
*/
rebateonNetAmountInTransactionCurrency?: number | null;
/**
* Network Code
* Example: AVEE PTUAZONW CUBFAO COSFS
* Note: - The value could be null/blank for fees item
*/
networkCode?: string | null;
/** Transaction Identifier */
trnIdentifier?: string | null;
/** Card Type */
cardType?: string | null;
/**
* Delco List Price Unit Net
* Example: 30.500000
*/
delcoListPriceUnitNet?: number | null;
/**
* Retail Net Price (or pump net price) per Unit in transaction currency
* Example: 1.921000
*/
delcoRetailPriceUnitNet?: number | null;
/** Retail gross price (or pump gross price) per unit in transaction currency */
delcoRetailPriceUnitGross?: number | null;
/** Retail net price (or net pump price) in transaction currency */
delcoRetailValueTotalNet?: number | null;
/** Retail gross price (or gross pump price) in transaction currency */
delcoRetailValueTotalGross?: number | null;
/** Retail gross price (or pump gross price) per unit in customer currency */
customerRetailPriceUnitGross?: number | null;
/** Retail gross price (or gross pump price) in customer currency */
customerRetailValueTotalGross?: number | null;
/**
* Retail gross price (or gross pump price) in customer currency
* Retail net price (or net pump price) in customer currency
*/
customerRetailValueTotalNet?: number | null;
/**
* Transaction Type Description
* Note: - The value could be null/blank for fees item
*/
transactionTypeDescription?: string | null;
}
export declare const pricedTransactionResponseTransactionsItemsSchema: Schema<PricedTransactionResponseTransactionsItems>;
//# sourceMappingURL=pricedTransactionResponseTransactionsItems.d.ts.map