card-management-sdk
Version:
The Shell Card Management API is REST-based and employs OAUTH 2.0,Basic and ApiKey authentication. The API endpoints accept JSON-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes. All resources are located in the S
203 lines • 9.2 kB
JavaScript
/**
* Shell Card Management APIsLib
*
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
import { array, boolean, lazy, nullable, number, object, optional, string, } from '../schema.js';
import { addressSchema } from './address.js';
import { bankAccountSchema } from './bankAccount.js';
import { customerContractSchema, } from './customerContract.js';
import { financeCurrency2Schema, } from './financeCurrency2.js';
import { invoiceDistributionMethodSchema, } from './invoiceDistributionMethod.js';
export const payerDetailsSchema = lazy(() => object({
colCoId: ['ColCoId', optional(nullable(number()))],
colCoCode: ['ColCoCode', optional(nullable(number()))],
countryCode: ['CountryCode', optional(nullable(string()))],
country: ['Country', optional(nullable(string()))],
payerId: ['PayerId', optional(nullable(number()))],
payerNumber: ['PayerNumber', optional(nullable(string()))],
payerFullName: ['PayerFullName', optional(nullable(string()))],
payerShortName: ['PayerShortName', optional(nullable(string()))],
payerGroupId: ['PayerGroupId', optional(nullable(number()))],
amountDue: ['AmountDue', optional(nullable(number()))],
amountOverdue: ['AmountOverdue', optional(nullable(number()))],
amountNotOverdue: ['AmountNotOverdue', optional(nullable(number()))],
outstandingBalance: ['OutstandingBalance', optional(nullable(number()))],
unallocatedPayment: ['UnallocatedPayment', optional(nullable(number()))],
sOACurrencyCode: ['SOACurrencyCode', optional(nullable(string()))],
sOACurrencySymbol: ['SOACurrencySymbol', optional(nullable(string()))],
sOACreditLimitCurrencyCode: [
'SOACreditLimitCurrencyCode',
optional(nullable(string())),
],
sOACreditLimitCurrencySymbol: [
'SOACreditLimitCurrencySymbol',
optional(nullable(string())),
],
lastPaymentCurrencyCode: [
'LastPaymentCurrencyCode',
optional(nullable(string())),
],
lastPaymentCurrencySymbol: [
'LastPaymentCurrencySymbol',
optional(nullable(string())),
],
lastPaymentAmount: ['LastPaymentAmount', optional(nullable(number()))],
lastPaymentDate: ['LastPaymentDate', optional(nullable(string()))],
sOALastPaymentAmount: [
'SOALastPaymentAmount',
optional(nullable(number())),
],
sOALastPaymentDate: ['SOALastPaymentDate', optional(nullable(string()))],
currencyCode: ['CurrencyCode', optional(nullable(string()))],
currencySymbol: ['CurrencySymbol', optional(nullable(string()))],
colCoCountryCode: ['ColCoCountryCode', optional(nullable(string()))],
localCurrencyCode: ['LocalCurrencyCode', optional(nullable(string()))],
localCurrencySymbol: ['LocalCurrencySymbol', optional(nullable(string()))],
localCurrencyExchangeRate: [
'LocalCurrencyExchangeRate',
optional(nullable(number())),
],
localCurrencyExchangeRateSoA: [
'LocalCurrencyExchangeRate_SoA',
optional(nullable(number())),
],
billingFrequencyTypeId: [
'BillingFrequencyTypeId',
optional(nullable(number())),
],
billingFrequencyType: [
'BillingFrequencyType',
optional(nullable(string())),
],
billingRunFrequencyTypeId: [
'BillingRunFrequencyTypeId',
optional(nullable(number())),
],
billingRunFrequnecy: ['BillingRunFrequnecy', optional(nullable(string()))],
day1Run: ['Day1Run', optional(nullable(number()))],
day2Run: ['Day2Run', optional(nullable(number()))],
day3Run: ['Day3Run', optional(nullable(number()))],
day4Run: ['Day4Run', optional(nullable(number()))],
invoiceDistributionMethods: [
'InvoiceDistributionMethods',
optional(array(invoiceDistributionMethodSchema)),
],
outputType: ['OutputType', optional(nullable(string()))],
invoiceAccountID: ['InvoiceAccountID', optional(nullable(number()))],
invoiceAccountNumber: [
'InvoiceAccountNumber',
optional(nullable(string())),
],
invoiceAccountShortName: [
'InvoiceAccountShortName',
optional(nullable(string())),
],
bestOfIndicator: ['BestOfIndicator', optional(boolean())],
isInternational: ['IsInternational', optional(boolean())],
totalAccounts: ['TotalAccounts', optional(nullable(number()))],
totalActiveAccounts: ['TotalActiveAccounts', optional(nullable(number()))],
totalCards: ['TotalCards', optional(nullable(number()))],
totalActiveCards: ['TotalActiveCards', optional(nullable(number()))],
totalBlockedCards: ['TotalBlockedCards', optional(nullable(number()))],
totalCancelledCards: ['TotalCancelledCards', optional(nullable(number()))],
totalExpiredCards: ['TotalExpiredCards', optional(nullable(number()))],
totalRenewalPendingCards: [
'TotalRenewalPendingCards',
optional(nullable(number())),
],
totalReplacedCards: ['TotalReplacedCards', optional(nullable(number()))],
totalTemporaryBlockCardsByCustomer: [
'TotalTemporaryBlockCardsByCustomer',
optional(nullable(number())),
],
totalTemporaryBlockCardsByShell: [
'TotalTemporaryBlockCardsByShell',
optional(nullable(number())),
],
totalNewCards: ['TotalNewCards', optional(nullable(number()))],
totalFraudCards: ['TotalFraudCards', optional(nullable(number()))],
totalBlockedAccounts: [
'TotalBlockedAccounts',
optional(nullable(number())),
],
totalCancelledAccounts: [
'TotalCancelledAccounts',
optional(nullable(number())),
],
payerTradingName: ['PayerTradingName', optional(nullable(string()))],
status: ['Status', optional(string())],
billingLanguage: ['BillingLanguage', optional(nullable(string()))],
legalEntity: ['LegalEntity', optional(nullable(string()))],
dateEstablished: ['DateEstablished', optional(nullable(string()))],
customerClassification: [
'CustomerClassification',
optional(nullable(string())),
],
industryClass: ['IndustryClass', optional(nullable(string()))],
marketingSegmentation: [
'MarketingSegmentation',
optional(nullable(string())),
],
lineOfBusiness: ['LineOfBusiness', optional(nullable(string()))],
printCreditLimit: ['PrintCreditLimit', optional(boolean())],
cardGroupType: ['CardGroupType', optional(nullable(string()))],
renewCards: ['RenewCards', optional(boolean())],
allowSelectPIN: ['AllowSelectPIN', optional(boolean())],
useFleetPIN: ['UseFleetPIN', optional(boolean())],
vATRegNumber: ['VATRegNumber', optional(nullable(string()))],
vATRegNumber2: ['VATRegNumber2', optional(string())],
registrationNumber: ['RegistrationNumber', optional(nullable(string()))],
registrationNumber2: ['RegistrationNumber2', optional(nullable(string()))],
salesLedgerBalance: ['SalesLedgerBalance', optional(nullable(number()))],
exposure: ['Exposure', optional(nullable(number()))],
outstandingDebt: ['OutstandingDebt', optional(nullable(number()))],
availableCredit: ['AvailableCredit', optional(nullable(number()))],
band: ['Band', optional(nullable(string()))],
globalCustomerReferenceId: [
'GlobalCustomerReferenceId',
optional(nullable(string())),
],
creditLimit: ['CreditLimit', optional(nullable(number()))],
creditLimitInCustomerCurrency: [
'CreditLimitInCustomerCurrency',
optional(nullable(number())),
],
billingCurrencyCode: ['BillingCurrencyCode', optional(nullable(string()))],
billingCurrencySymbol: [
'BillingCurrencySymbol',
optional(nullable(string())),
],
paymentMethod: ['PaymentMethod', optional(nullable(string()))],
paymentTerms: ['PaymentTerms', optional(nullable(string()))],
temporaryCreditLimitIncrease: [
'TemporaryCreditLimitIncrease',
optional(nullable(number())),
],
temporaryCreditLimitIncreaseInCustomerCurrency: [
'TemporaryCreditLimitIncreaseInCustomerCurrency',
optional(nullable(number())),
],
temporaryCreditLimitExpiryDate: [
'TemporaryCreditLimitExpiryDate',
optional(nullable(string())),
],
payerBankAccount: ['PayerBankAccount', optional(array(bankAccountSchema))],
cardDeliveryAddress: ['CardDeliveryAddress', optional(addressSchema)],
correspondanceAddress: ['CorrespondanceAddress', optional(addressSchema)],
billingAddress: ['BillingAddress', optional(addressSchema)],
hasActiveVolBasedPricing: ['HasActiveVolBasedPricing', optional(boolean())],
hasActiveVolBasedBonus: ['HasActiveVolBasedBonus', optional(boolean())],
hasActiveVolBasedAssociationBonus: [
'HasActiveVolBasedAssociationBonus',
optional(boolean()),
],
financeCurrency: ['FinanceCurrency', optional(financeCurrency2Schema)],
tollsCustomerId: ['TollsCustomerId', optional(nullable(string()))],
tollsColcoCountryTypeId: [
'TollsColcoCountryTypeId',
optional(nullable(string())),
],
contracts: ['Contracts', optional(array(customerContractSchema))],
}));
//# sourceMappingURL=payerDetails.js.map