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
101 lines • 3.95 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 { AssociatedAccount } from './associatedAccount.js';
import { FeeRuleLocation } from './feeRuleLocation.js';
import { FeeRuleProduct } from './feeRuleProduct.js';
import { FeeRuleTier } from './feeRuleTier.js';
export interface BonusConfiguration {
/** Account identifier of the Pricing Account associated with the Payer. */
pricingAccountId?: number | null;
/** Account number of the Pricing Account associated with the Payer. */
pricingAccountNumber?: string | null;
/** Short name of the Pricing Account associated with the Payer. */
pricingAccountShortName?: string | null;
/** Full name of the Pricing Account associated with the Payer. */
pricingAccountFullName?: string | null;
/** Bonus or association bonus configuration identifier that is associated to the payer. */
feeRuleId?: number | null;
/** Bonus or association bonus configuration description that is associated to the payer. */
feeRuleDescription?: string | null;
/**
* The bonus or association bonus configuration becomes effective on the payer from this date.
* Format: YYYYMMDD
*/
feeRuleDateEffective?: string | null;
/**
* The bonus or association bonus configuration is terminated for the payer on this date.
* Format: YYYYMMDD
*/
feeRuleDateTerminated?: string | null;
/**
* Configuration to specify how the bonus is paid.
* Format: ID-Description
* Example:
* 1-Pay to Payer
* 2-Pay to invoice levels before the payer
* 3-Pay to specific customer
* 4-Pay to Association Customer
* 5-Pay to Associated Customers
*/
bonusPaidTo?: string | null;
/** Account identifier of the specific account to which the bonus is paid back */
bonusPaidToAccountId?: number | null;
/** Account number of the specific account to which the bonus is paid back */
bonusPaidToAccountNumber?: string | null;
/** Short name of the specific account to which the bonus is paid back */
bonusPaidToAccountShortName?: string | null;
/** Full name of the specific account to which the bonus is paid back */
bonusPaidToAccountFullName?: string | null;
/**
* Frequency of the configuration.
* Format: ID-Description
* Examples:
* 1-Daily (all days)
* 2-Daily (only working days)
* 3-Weekly – Monday
*/
frequency?: string | null;
/**
* The next bonus is calculated for the payer on this date.
* Format: YYYYMMDD
*/
nextCalculationDate?: string | null;
/**
* The previous bonus was calculated for the payer on this date.
* Format: YYYYMMDD
*/
previousCalculatedDate?: string | null;
/**
* Fee Rule Basis configured.
* Format: ID-Description
* Example:
* 1-Currency Per Unit
* 2-Percentage of Uplift
* 3-Lump Sum
*/
feeRuleBasis?: string | null;
/** ISO currency code of the currency configured in the Bonus Configuration, if any. */
feeRuleCurrencyCode?: string | null;
/** Currency symbol of the currency configured in the Bonus Configuration, if any. */
feeRuleCurrencySymbol?: string | null;
/**
* This bonus or association bonus is available from this date.
* Format: YYYYMMDD
*/
feeRuleAvailableFrom?: string | null;
/**
* This bonus or association bonus configuration will not be available from this date.
* Format: YYYYMMDD
*/
feeRuleAvailableTo?: string | null;
feeRuleLocations?: FeeRuleLocation[];
feeRuleTiers?: FeeRuleTier[];
associatedAccounts?: AssociatedAccount[];
feeRuleProducts?: FeeRuleProduct[];
}
export declare const bonusConfigurationSchema: Schema<BonusConfiguration>;
//# sourceMappingURL=bonusConfiguration.d.ts.map