/** * Shell Data & Reporting APIsLib * * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ). */ import { Schema } from '../schema'; import { InvoiceSearchAdditionalDocument } from './invoiceSearchAdditionalDocument'; export interface InvoiceSearchDetails { /** * Account Full Name * Example: AT_reversal customer_FN */ accountFullName?: string | null; /** * Account ID * Example: 29484 */ accountId?: number | null; /** * Account Number * Example: GB99215176 */ accountNumber?: string | null; /** * Account Short Name * Example: AT Earth Movers-SN */ accountShortName?: string | null; /** * ColCo Id. * Example: 18 */ colCoId?: number | null; /** * ColCo’s OpCo Id. * Example: 018 */ colCoOpCoId?: string | null; /** * Current billing frequency of the account. * A few of the possible IDs and Description are below: * 1 Daily (all days) * 2 Daily (only working days) * 3 Weekly - Monday * 4 Weekly - Tuesday * 5 Weekly - Wednesday * 6 Weekly - Thursday * 7 Weekly - Friday * 8 Weekly - Saturday * 9 Weekly - Sunday * 10 Monthly - 1st * Example: Weekly – Wednesday */ currentBillingFrequency?: string | null; /** * Current billing frequency id of the account. * A few of the possible IDs and Description are below: * 1 Daily (all days) * 2 Daily (only working days) * 3 Weekly - Monday * 4 Weekly - Tuesday * 5 Weekly - Wednesday * 6 Weekly - Thursday * 7 Weekly - Friday * 8 Weekly - Saturday * 9 Weekly - Sunday * 10 Monthly - 1st * Example: 5 */ currentBillingFrequencyId?: number | null; /** * Current distribution method name of the account. * Example : Id & Description * 1 e-mail * 2 Fax * 3 Courier to Customer * 4 Courier to Client * 5 Print * 6 FTP * 7 SMS */ currentDistributionMethod?: string | null; /** * Current distribution method id of the account. * Example : Id & Description * 1 e-mail * 2 Fax * 3 Courier to Customer * 4 Courier to Client * 5 Print * 6 FTP * 7 SMS */ currentDistributionMethodId?: number | null; /** * Customer currency ISO code. * Example: EUR */ customerCurrencyCode?: string | null; /** * Customer currency code. * Example: € */ customerCurrencySymbol?: string | null; /** * DelCo’s client company number. * Example: 132 */ delCoClientNumber?: string | null; /** * DelCo Id. * Example: 132 */ delCoId?: number | null; /** * DelCo’s OpCo Id. * Example: 032 */ delCoOpCoId?: string | null; /** Document type Id description. */ documentType?: string | null; /** Document type Id. */ documentTypeId?: number | null; /** * Due date. Format: yyyyMMdd. * Example: 20170115 */ dueDate?: string | null; /** Gross amount in customer currency in the document. */ grossAmountCustomerCurrency?: number | null; /** Gross amount in transaction currency in the document */ grossAmountTransactionCurrency?: number | null; /** * Invoicing date. Format: yyyyMMdd * Example: 20170101 */ invoiceDate?: string | null; /** Company name. */ invoicedBy?: string | null; /** * Country Name. * Example: Czech Republic */ invoicedOnBehalfOf?: string | null; /** * Invoice id. * Example: 1 */ invoiceId?: number | null; /** * Invoice number. * Example: 0123456789 */ invoiceNumber?: string | null; /** * True/False. * True if this is an International invoice, else false. */ isInternational?: boolean | null; /** * True/False. * True if this is a National invoice, else false. */ isNational?: boolean | null; /** Net amount in customer currency in the document. */ netAmountCustomerCurrency?: number | null; /** Net amount in transaction currency in the document. */ netAmountTransactionCurrency?: number | null; /** * Payment customer id of the customer. * Example: 123456 */ payerId?: number | null; /** * Payment customer number. * Example: GB000000123 */ payerNumber?: string | null; /** * A few of the possible IDs and Descriptions are below: * 1 14 days after Invoice * 2 15 days after Invoice * 3 21 days after Invoice * 4 30 days after Invoice * 5 45 days after Invoice */ paymentTerms?: string | null; /** * Payment terms id of the payment customer. * A few of the possible IDs and Descriptions are below: * 1 14 days after Invoice * 2 15 days after Invoice * 3 21 days after Invoice * 4 30 days after Invoice * 5 45 days after Invoice */ paymentTermsId?: number | null; /** * Replaced document id. * Example: 2 */ replacementInvoiceId?: number | null; /** * Reversed document id. * Example: 3 */ reversalInvoiceId?: number | null; /** * Status of the document. Valid values – * • [Empty] – For all document types except for Invoice and Statement. * • Due – Invoices/Statements due for payment and is within the due date. * • Paid – Fully paid Invoices/Statements. * Overdue – Invoices/Statements due of payment and has crossed the due date. */ status?: string | null; /** * Billing type description. * Example: Id & Description * -3 Guarantee History * -1 Initial Balance * 0 Standard Invoice * 1 Immediate Invoice * 2 Guarantee * 4 Advanced DD Invoice */ summaryDocumentBillingType?: string | null; /** * Billing type id. * Example: Id & Description * -3 Guarantee History * -1 Initial Balance * 0 Standard Invoice * 1 Immediate Invoice * 2 Guarantee * 4 Advanced DD Invoice */ summaryDocumentBillingTypeId?: number | null; /** * Document generated date. Format: yyyyMMdd * Example: 20170101 */ summaryDocumentDate?: string | null; /** DD amount. */ summaryDocumentDDAmount?: number | null; /** * Due date for document. Format: yyyyMMdd * Example: 20170115 */ summaryDocumentDueDate?: string | null; /** * Summary document identifier * Example: 1 */ summaryDocumentId?: number | null; /** * True/False * True if invoice amount is fully paid, else false */ summaryDocumentIsFullyPaid?: boolean | null; /** * Summary document number * Example: ‘0/CZ0000000123456/2017’ */ summaryDocumentNumber?: string | null; /** Total amount paid. */ summaryDocumentPaidAmount?: number | null; /** Statement of Account reference number of the payment customer. */ summaryDocumentSoAReferenceNumber?: string | null; /** Statement of Account Id of the payment customer. */ summaryDocumentStatementOfAccountId?: number | null; /** * Transaction currency ISO code. * Example: EUR */ transactionCurrencyCode?: string | null; /** * Transaction currency symbol. * Example: € */ transactionCurrencySymbol?: string | null; /** * Invoice type description. * A few of the possible IDs and Description are below: * 1 Original * 2 Reversal * 3 Replacement * Example: Original */ type?: string | null; /** * Invoice type id. * A few of the possible IDs and Descriptions are below: * 1 Original * 2 Reversal * 3 Replacement * Example: 1 */ typeId?: number | null; /** VAT amount in customer currency in the document */ vATAmountCustomerCurrency?: number | null; /** VAT amount in transaction currency in the document */ vATAmountTransactionCurrency?: number | null; /** * Country name of the VAT country. * Example: France, Germany */ vATCountry?: string | null; /** * Country Id of the VAT country. * Example: 1,2 */ vATCountryId?: number | null; /** * Country ISO code of the VAT country. * Example : CZ, SK, UK, etc., */ vATCountryISOCode?: string | null; /** * VAT country’s OpCo Id. * Example: 032 */ vATCountryOpCoId?: string | null; /** document reference number of the Invoice file */ documentReference?: string | null; additionalDocuments?: InvoiceSearchAdditionalDocument[]; } export declare const invoiceSearchDetailsSchema: Schema;